diff --git a/.gitignore b/.gitignore index b0410ca1f..437eb5b98 100644 --- a/.gitignore +++ b/.gitignore @@ -48,3 +48,4 @@ application-mysql-*.yml .env *dependency-reduced-pom.xml +service/solace-config-client/.openapi-generator diff --git a/service/plugin/src/main/java/com/solace/maas/ep/event/management/agent/plugin/route/handler/base/ConfigExecutorRouteBuilder.java b/service/plugin/src/main/java/com/solace/maas/ep/event/management/agent/plugin/route/handler/base/ConfigExecutorRouteBuilder.java index 5995e2eb7..e371a0813 100644 --- a/service/plugin/src/main/java/com/solace/maas/ep/event/management/agent/plugin/route/handler/base/ConfigExecutorRouteBuilder.java +++ b/service/plugin/src/main/java/com/solace/maas/ep/event/management/agent/plugin/route/handler/base/ConfigExecutorRouteBuilder.java @@ -1,15 +1,11 @@ package com.solace.maas.ep.event.management.agent.plugin.route.handler.base; import com.solace.maas.ep.event.management.agent.plugin.constants.RouteConstants; -import com.solace.maas.ep.event.management.agent.plugin.constants.ScanStatus; import com.solace.maas.ep.event.management.agent.plugin.jacoco.ExcludeFromJacocoGeneratedReport; -import com.solace.maas.ep.event.management.agent.plugin.processor.EmptyScanEntityProcessor; import com.solace.maas.ep.event.management.agent.plugin.processor.logging.MDCProcessor; import com.solace.maas.ep.event.management.agent.plugin.route.manager.RouteManager; -import org.apache.camel.Exchange; import org.apache.camel.Processor; import org.apache.camel.builder.RouteBuilder; -import org.apache.camel.model.dataformat.JsonLibrary; import org.slf4j.MDC; import java.util.ArrayList; diff --git a/service/plugin/src/main/java/com/solace/maas/ep/event/management/agent/plugin/task/TemplateTaskProcessor.java b/service/plugin/src/main/java/com/solace/maas/ep/event/management/agent/plugin/task/TemplateTaskProcessor.java index e82d6240a..c601c5cdc 100644 --- a/service/plugin/src/main/java/com/solace/maas/ep/event/management/agent/plugin/task/TemplateTaskProcessor.java +++ b/service/plugin/src/main/java/com/solace/maas/ep/event/management/agent/plugin/task/TemplateTaskProcessor.java @@ -5,7 +5,6 @@ import com.solace.maas.ep.event.management.agent.plugin.service.MessagingServiceDelegateService; import org.springframework.beans.factory.annotation.Autowired; -import java.util.ArrayList; import java.util.List; import java.util.Map; diff --git a/service/solace-config-client/.github/workflows/maven.yml b/service/solace-config-client/.github/workflows/maven.yml deleted file mode 100644 index d03a63e83..000000000 --- a/service/solace-config-client/.github/workflows/maven.yml +++ /dev/null @@ -1,30 +0,0 @@ -# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time -# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven -# -# This file is auto-generated by OpenAPI Generator (https://openapi-generator.tech) - -name: Java CI with Maven - -on: - push: - branches: [ main, master ] - pull_request: - branches: [ main, master ] - -jobs: - build: - name: Build SEMP (Solace Element Management Protocol) - runs-on: ubuntu-latest - strategy: - matrix: - java: [ '8' ] - steps: - - uses: actions/checkout@v2 - - name: Set up JDK - uses: actions/setup-java@v2 - with: - java-version: ${{ matrix.java }} - distribution: 'temurin' - cache: maven - - name: Build with Maven - run: mvn -B package --no-transfer-progress --file pom.xml diff --git a/service/solace-config-client/.gitignore b/service/solace-config-client/.gitignore index a530464af..de657f21d 100644 --- a/service/solace-config-client/.gitignore +++ b/service/solace-config-client/.gitignore @@ -19,3 +19,8 @@ hs_err_pid* target .gradle build + +.openapi-generator/** + +src/main/java/** +src/test/java/** diff --git a/service/solace-config-client/.openapi-generator-ignore b/service/solace-config-client/.openapi-generator-ignore index 7484ee590..5628175c9 100644 --- a/service/solace-config-client/.openapi-generator-ignore +++ b/service/solace-config-client/.openapi-generator-ignore @@ -21,3 +21,26 @@ #docs/*.md # Then explicitly reverse the ignore rule for a single file: #!docs/README.md + +./pom.xml +pom.xml +**/pom.xml + +.openapi-generator-ignore + +.github/** +gradle* +gradle/** +*gradle* +*.gradle +docs/** +.openapi-generator/** +api/** +.travis.yml +*.sh +*.sbt +README.md + +**/AndroidManifest.xml + +.gitignore \ No newline at end of file diff --git a/service/solace-config-client/.openapi-generator/FILES b/service/solace-config-client/.openapi-generator/FILES deleted file mode 100644 index f9b9b852a..000000000 --- a/service/solace-config-client/.openapi-generator/FILES +++ /dev/null @@ -1,1070 +0,0 @@ -.github/workflows/maven.yml -.gitignore -.openapi-generator-ignore -.travis.yml -README.md -api/openapi.yaml -build.gradle -build.sbt -docs/AboutApi.md -docs/AboutApi.md -docs/AboutApiLinks.md -docs/AboutApiResponse.md -docs/AboutLinks.md -docs/AboutResponse.md -docs/AboutUser.md -docs/AboutUserLinks.md -docs/AboutUserMsgVpn.md -docs/AboutUserMsgVpnLinks.md -docs/AboutUserMsgVpnResponse.md -docs/AboutUserMsgVpnsResponse.md -docs/AboutUserResponse.md -docs/AclProfileApi.md -docs/AllApi.md -docs/AuthenticationOauthProfileApi.md -docs/AuthenticationOauthProviderApi.md -docs/AuthorizationGroupApi.md -docs/BridgeApi.md -docs/Broker.md -docs/BrokerLinks.md -docs/BrokerResponse.md -docs/CertAuthoritiesResponse.md -docs/CertAuthority.md -docs/CertAuthorityApi.md -docs/CertAuthorityLinks.md -docs/CertAuthorityOcspTlsTrustedCommonName.md -docs/CertAuthorityOcspTlsTrustedCommonNameLinks.md -docs/CertAuthorityOcspTlsTrustedCommonNameResponse.md -docs/CertAuthorityOcspTlsTrustedCommonNamesResponse.md -docs/CertAuthorityResponse.md -docs/CertMatchingRuleApi.md -docs/ClientCertAuthoritiesResponse.md -docs/ClientCertAuthority.md -docs/ClientCertAuthorityApi.md -docs/ClientCertAuthorityLinks.md -docs/ClientCertAuthorityOcspTlsTrustedCommonName.md -docs/ClientCertAuthorityOcspTlsTrustedCommonNameLinks.md -docs/ClientCertAuthorityOcspTlsTrustedCommonNameResponse.md -docs/ClientCertAuthorityOcspTlsTrustedCommonNamesResponse.md -docs/ClientCertAuthorityResponse.md -docs/ClientProfileApi.md -docs/ClientUsernameApi.md -docs/DistributedCacheApi.md -docs/DmrBridgeApi.md -docs/DmrCluster.md -docs/DmrClusterApi.md -docs/DmrClusterCertMatchingRule.md -docs/DmrClusterCertMatchingRuleAttributeFilter.md -docs/DmrClusterCertMatchingRuleAttributeFilterLinks.md -docs/DmrClusterCertMatchingRuleAttributeFilterResponse.md -docs/DmrClusterCertMatchingRuleAttributeFiltersResponse.md -docs/DmrClusterCertMatchingRuleCondition.md -docs/DmrClusterCertMatchingRuleConditionLinks.md -docs/DmrClusterCertMatchingRuleConditionResponse.md -docs/DmrClusterCertMatchingRuleConditionsResponse.md -docs/DmrClusterCertMatchingRuleLinks.md -docs/DmrClusterCertMatchingRuleResponse.md -docs/DmrClusterCertMatchingRulesResponse.md -docs/DmrClusterLink.md -docs/DmrClusterLinkAttribute.md -docs/DmrClusterLinkAttributeLinks.md -docs/DmrClusterLinkAttributeResponse.md -docs/DmrClusterLinkAttributesResponse.md -docs/DmrClusterLinkLinks.md -docs/DmrClusterLinkRemoteAddress.md -docs/DmrClusterLinkRemoteAddressLinks.md -docs/DmrClusterLinkRemoteAddressResponse.md -docs/DmrClusterLinkRemoteAddressesResponse.md -docs/DmrClusterLinkResponse.md -docs/DmrClusterLinkTlsTrustedCommonName.md -docs/DmrClusterLinkTlsTrustedCommonNameLinks.md -docs/DmrClusterLinkTlsTrustedCommonNameResponse.md -docs/DmrClusterLinkTlsTrustedCommonNamesResponse.md -docs/DmrClusterLinks.md -docs/DmrClusterLinksResponse.md -docs/DmrClusterResponse.md -docs/DmrClustersResponse.md -docs/DomainCertAuthoritiesResponse.md -docs/DomainCertAuthority.md -docs/DomainCertAuthorityApi.md -docs/DomainCertAuthorityLinks.md -docs/DomainCertAuthorityResponse.md -docs/EventThreshold.md -docs/EventThresholdByPercent.md -docs/EventThresholdByValue.md -docs/JndiApi.md -docs/MqttRetainCacheApi.md -docs/MqttSessionApi.md -docs/MsgVpn.md -docs/MsgVpnAclProfile.md -docs/MsgVpnAclProfileClientConnectException.md -docs/MsgVpnAclProfileClientConnectExceptionLinks.md -docs/MsgVpnAclProfileClientConnectExceptionResponse.md -docs/MsgVpnAclProfileClientConnectExceptionsResponse.md -docs/MsgVpnAclProfileLinks.md -docs/MsgVpnAclProfilePublishException.md -docs/MsgVpnAclProfilePublishExceptionLinks.md -docs/MsgVpnAclProfilePublishExceptionResponse.md -docs/MsgVpnAclProfilePublishExceptionsResponse.md -docs/MsgVpnAclProfilePublishTopicException.md -docs/MsgVpnAclProfilePublishTopicExceptionLinks.md -docs/MsgVpnAclProfilePublishTopicExceptionResponse.md -docs/MsgVpnAclProfilePublishTopicExceptionsResponse.md -docs/MsgVpnAclProfileResponse.md -docs/MsgVpnAclProfileSubscribeException.md -docs/MsgVpnAclProfileSubscribeExceptionLinks.md -docs/MsgVpnAclProfileSubscribeExceptionResponse.md -docs/MsgVpnAclProfileSubscribeExceptionsResponse.md -docs/MsgVpnAclProfileSubscribeShareNameException.md -docs/MsgVpnAclProfileSubscribeShareNameExceptionLinks.md -docs/MsgVpnAclProfileSubscribeShareNameExceptionResponse.md -docs/MsgVpnAclProfileSubscribeShareNameExceptionsResponse.md -docs/MsgVpnAclProfileSubscribeTopicException.md -docs/MsgVpnAclProfileSubscribeTopicExceptionLinks.md -docs/MsgVpnAclProfileSubscribeTopicExceptionResponse.md -docs/MsgVpnAclProfileSubscribeTopicExceptionsResponse.md -docs/MsgVpnAclProfilesResponse.md -docs/MsgVpnApi.md -docs/MsgVpnAuthenticationOauthProfile.md -docs/MsgVpnAuthenticationOauthProfileClientRequiredClaim.md -docs/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks.md -docs/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.md -docs/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.md -docs/MsgVpnAuthenticationOauthProfileLinks.md -docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.md -docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks.md -docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.md -docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.md -docs/MsgVpnAuthenticationOauthProfileResponse.md -docs/MsgVpnAuthenticationOauthProfilesResponse.md -docs/MsgVpnAuthenticationOauthProvider.md -docs/MsgVpnAuthenticationOauthProviderLinks.md -docs/MsgVpnAuthenticationOauthProviderResponse.md -docs/MsgVpnAuthenticationOauthProvidersResponse.md -docs/MsgVpnAuthorizationGroup.md -docs/MsgVpnAuthorizationGroupLinks.md -docs/MsgVpnAuthorizationGroupResponse.md -docs/MsgVpnAuthorizationGroupsResponse.md -docs/MsgVpnBridge.md -docs/MsgVpnBridgeLinks.md -docs/MsgVpnBridgeRemoteMsgVpn.md -docs/MsgVpnBridgeRemoteMsgVpnLinks.md -docs/MsgVpnBridgeRemoteMsgVpnResponse.md -docs/MsgVpnBridgeRemoteMsgVpnsResponse.md -docs/MsgVpnBridgeRemoteSubscription.md -docs/MsgVpnBridgeRemoteSubscriptionLinks.md -docs/MsgVpnBridgeRemoteSubscriptionResponse.md -docs/MsgVpnBridgeRemoteSubscriptionsResponse.md -docs/MsgVpnBridgeResponse.md -docs/MsgVpnBridgeTlsTrustedCommonName.md -docs/MsgVpnBridgeTlsTrustedCommonNameLinks.md -docs/MsgVpnBridgeTlsTrustedCommonNameResponse.md -docs/MsgVpnBridgeTlsTrustedCommonNamesResponse.md -docs/MsgVpnBridgesResponse.md -docs/MsgVpnCertMatchingRule.md -docs/MsgVpnCertMatchingRuleAttributeFilter.md -docs/MsgVpnCertMatchingRuleAttributeFilterLinks.md -docs/MsgVpnCertMatchingRuleAttributeFilterResponse.md -docs/MsgVpnCertMatchingRuleAttributeFiltersResponse.md -docs/MsgVpnCertMatchingRuleCondition.md -docs/MsgVpnCertMatchingRuleConditionLinks.md -docs/MsgVpnCertMatchingRuleConditionResponse.md -docs/MsgVpnCertMatchingRuleConditionsResponse.md -docs/MsgVpnCertMatchingRuleLinks.md -docs/MsgVpnCertMatchingRuleResponse.md -docs/MsgVpnCertMatchingRulesResponse.md -docs/MsgVpnClientProfile.md -docs/MsgVpnClientProfileLinks.md -docs/MsgVpnClientProfileResponse.md -docs/MsgVpnClientProfilesResponse.md -docs/MsgVpnClientUsername.md -docs/MsgVpnClientUsernameAttribute.md -docs/MsgVpnClientUsernameAttributeLinks.md -docs/MsgVpnClientUsernameAttributeResponse.md -docs/MsgVpnClientUsernameAttributesResponse.md -docs/MsgVpnClientUsernameLinks.md -docs/MsgVpnClientUsernameResponse.md -docs/MsgVpnClientUsernamesResponse.md -docs/MsgVpnDistributedCache.md -docs/MsgVpnDistributedCacheCluster.md -docs/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.md -docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks.md -docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.md -docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.md -docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks.md -docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.md -docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.md -docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.md -docs/MsgVpnDistributedCacheClusterInstance.md -docs/MsgVpnDistributedCacheClusterInstanceLinks.md -docs/MsgVpnDistributedCacheClusterInstanceResponse.md -docs/MsgVpnDistributedCacheClusterInstancesResponse.md -docs/MsgVpnDistributedCacheClusterLinks.md -docs/MsgVpnDistributedCacheClusterResponse.md -docs/MsgVpnDistributedCacheClusterTopic.md -docs/MsgVpnDistributedCacheClusterTopicLinks.md -docs/MsgVpnDistributedCacheClusterTopicResponse.md -docs/MsgVpnDistributedCacheClusterTopicsResponse.md -docs/MsgVpnDistributedCacheClustersResponse.md -docs/MsgVpnDistributedCacheLinks.md -docs/MsgVpnDistributedCacheResponse.md -docs/MsgVpnDistributedCachesResponse.md -docs/MsgVpnDmrBridge.md -docs/MsgVpnDmrBridgeLinks.md -docs/MsgVpnDmrBridgeResponse.md -docs/MsgVpnDmrBridgesResponse.md -docs/MsgVpnJndiConnectionFactoriesResponse.md -docs/MsgVpnJndiConnectionFactory.md -docs/MsgVpnJndiConnectionFactoryLinks.md -docs/MsgVpnJndiConnectionFactoryResponse.md -docs/MsgVpnJndiQueue.md -docs/MsgVpnJndiQueueLinks.md -docs/MsgVpnJndiQueueResponse.md -docs/MsgVpnJndiQueuesResponse.md -docs/MsgVpnJndiTopic.md -docs/MsgVpnJndiTopicLinks.md -docs/MsgVpnJndiTopicResponse.md -docs/MsgVpnJndiTopicsResponse.md -docs/MsgVpnLinks.md -docs/MsgVpnMqttRetainCache.md -docs/MsgVpnMqttRetainCacheLinks.md -docs/MsgVpnMqttRetainCacheResponse.md -docs/MsgVpnMqttRetainCachesResponse.md -docs/MsgVpnMqttSession.md -docs/MsgVpnMqttSessionLinks.md -docs/MsgVpnMqttSessionResponse.md -docs/MsgVpnMqttSessionSubscription.md -docs/MsgVpnMqttSessionSubscriptionLinks.md -docs/MsgVpnMqttSessionSubscriptionResponse.md -docs/MsgVpnMqttSessionSubscriptionsResponse.md -docs/MsgVpnMqttSessionsResponse.md -docs/MsgVpnQueue.md -docs/MsgVpnQueueLinks.md -docs/MsgVpnQueueResponse.md -docs/MsgVpnQueueSubscription.md -docs/MsgVpnQueueSubscriptionLinks.md -docs/MsgVpnQueueSubscriptionResponse.md -docs/MsgVpnQueueSubscriptionsResponse.md -docs/MsgVpnQueueTemplate.md -docs/MsgVpnQueueTemplateLinks.md -docs/MsgVpnQueueTemplateResponse.md -docs/MsgVpnQueueTemplatesResponse.md -docs/MsgVpnQueuesResponse.md -docs/MsgVpnReplayLog.md -docs/MsgVpnReplayLogLinks.md -docs/MsgVpnReplayLogResponse.md -docs/MsgVpnReplayLogTopicFilterSubscription.md -docs/MsgVpnReplayLogTopicFilterSubscriptionLinks.md -docs/MsgVpnReplayLogTopicFilterSubscriptionResponse.md -docs/MsgVpnReplayLogTopicFilterSubscriptionsResponse.md -docs/MsgVpnReplayLogsResponse.md -docs/MsgVpnReplicatedTopic.md -docs/MsgVpnReplicatedTopicLinks.md -docs/MsgVpnReplicatedTopicResponse.md -docs/MsgVpnReplicatedTopicsResponse.md -docs/MsgVpnResponse.md -docs/MsgVpnRestDeliveryPoint.md -docs/MsgVpnRestDeliveryPointLinks.md -docs/MsgVpnRestDeliveryPointQueueBinding.md -docs/MsgVpnRestDeliveryPointQueueBindingLinks.md -docs/MsgVpnRestDeliveryPointQueueBindingRequestHeader.md -docs/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks.md -docs/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md -docs/MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.md -docs/MsgVpnRestDeliveryPointQueueBindingResponse.md -docs/MsgVpnRestDeliveryPointQueueBindingsResponse.md -docs/MsgVpnRestDeliveryPointResponse.md -docs/MsgVpnRestDeliveryPointRestConsumer.md -docs/MsgVpnRestDeliveryPointRestConsumerLinks.md -docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.md -docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks.md -docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.md -docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.md -docs/MsgVpnRestDeliveryPointRestConsumerResponse.md -docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.md -docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks.md -docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.md -docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.md -docs/MsgVpnRestDeliveryPointRestConsumersResponse.md -docs/MsgVpnRestDeliveryPointsResponse.md -docs/MsgVpnSequencedTopic.md -docs/MsgVpnSequencedTopicLinks.md -docs/MsgVpnSequencedTopicResponse.md -docs/MsgVpnSequencedTopicsResponse.md -docs/MsgVpnTopicEndpoint.md -docs/MsgVpnTopicEndpointLinks.md -docs/MsgVpnTopicEndpointResponse.md -docs/MsgVpnTopicEndpointTemplate.md -docs/MsgVpnTopicEndpointTemplateLinks.md -docs/MsgVpnTopicEndpointTemplateResponse.md -docs/MsgVpnTopicEndpointTemplatesResponse.md -docs/MsgVpnTopicEndpointsResponse.md -docs/MsgVpnsResponse.md -docs/OauthProfile.md -docs/OauthProfileAccessLevelGroup.md -docs/OauthProfileAccessLevelGroupLinks.md -docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.md -docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks.md -docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.md -docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.md -docs/OauthProfileAccessLevelGroupResponse.md -docs/OauthProfileAccessLevelGroupsResponse.md -docs/OauthProfileApi.md -docs/OauthProfileClientAllowedHost.md -docs/OauthProfileClientAllowedHostLinks.md -docs/OauthProfileClientAllowedHostResponse.md -docs/OauthProfileClientAllowedHostsResponse.md -docs/OauthProfileClientAuthorizationParameter.md -docs/OauthProfileClientAuthorizationParameterLinks.md -docs/OauthProfileClientAuthorizationParameterResponse.md -docs/OauthProfileClientAuthorizationParametersResponse.md -docs/OauthProfileClientRequiredClaim.md -docs/OauthProfileClientRequiredClaimLinks.md -docs/OauthProfileClientRequiredClaimResponse.md -docs/OauthProfileClientRequiredClaimsResponse.md -docs/OauthProfileDefaultMsgVpnAccessLevelException.md -docs/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks.md -docs/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.md -docs/OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.md -docs/OauthProfileLinks.md -docs/OauthProfileResourceServerRequiredClaim.md -docs/OauthProfileResourceServerRequiredClaimLinks.md -docs/OauthProfileResourceServerRequiredClaimResponse.md -docs/OauthProfileResourceServerRequiredClaimsResponse.md -docs/OauthProfileResponse.md -docs/OauthProfilesResponse.md -docs/QueueApi.md -docs/QueueTemplateApi.md -docs/ReplayLogApi.md -docs/ReplicatedTopicApi.md -docs/RestDeliveryPointApi.md -docs/SempError.md -docs/SempMeta.md -docs/SempMetaOnlyResponse.md -docs/SempPaging.md -docs/SempRequest.md -docs/SystemInformation.md -docs/SystemInformationApi.md -docs/SystemInformationLinks.md -docs/SystemInformationResponse.md -docs/TopicEndpointApi.md -docs/TopicEndpointTemplateApi.md -docs/VirtualHostname.md -docs/VirtualHostnameApi.md -docs/VirtualHostnameLinks.md -docs/VirtualHostnameResponse.md -docs/VirtualHostnamesResponse.md -git_push.sh -gradle.properties -gradle/wrapper/gradle-wrapper.jar -gradle/wrapper/gradle-wrapper.properties -gradlew -gradlew.bat -pom.xml -settings.gradle -src/main/AndroidManifest.xml -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AboutApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AclProfileApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AllApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthenticationOauthProfileApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthenticationOauthProviderApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthorizationGroupApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/BridgeApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/CertAuthorityApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/CertMatchingRuleApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientCertAuthorityApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientProfileApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientUsernameApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DistributedCacheApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DmrBridgeApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DmrClusterApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DomainCertAuthorityApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/JndiApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MqttRetainCacheApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MqttSessionApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MsgVpnApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/OauthProfileApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/QueueApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/QueueTemplateApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ReplayLogApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ReplicatedTopicApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/RestDeliveryPointApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/SystemInformationApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/TopicEndpointApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/TopicEndpointTemplateApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/VirtualHostnameApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/ApiClient.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/JavaTimeFormatter.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/RFC3339DateFormat.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/ServerConfiguration.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/ServerVariable.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/auth/ApiKeyAuth.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/auth/Authentication.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/auth/HttpBasicAuth.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/auth/HttpBearerAuth.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApi.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUser.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpn.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/Broker.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthoritiesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthority.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonName.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNamesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthoritiesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthority.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonName.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNamesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrCluster.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRule.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilter.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFiltersResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleCondition.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRulesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLink.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttribute.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddress.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonName.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNamesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinksResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClustersResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthoritiesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthority.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThreshold.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdByPercent.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdByValue.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpn.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfile.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectException.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishException.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicException.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeException.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameException.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicException.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfile.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaim.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfilesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProvider.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProvidersResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroup.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridge.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpn.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscription.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonName.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNamesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRule.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilter.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFiltersResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleCondition.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRulesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfile.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfilesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsername.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttribute.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernamesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCache.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheCluster.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstance.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstancesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopic.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClustersResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCachesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridge.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoriesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactory.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueue.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueuesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopic.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCache.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCachesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSession.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscription.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueue.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscription.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplate.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplatesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueuesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLog.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscription.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopic.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPoint.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBinding.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeader.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumer.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumersResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopic.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpoint.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplate.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplatesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfile.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroup.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHost.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameter.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParametersResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaim.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelException.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaim.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimsResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfilesResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempError.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempMeta.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempMetaOnlyResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempPaging.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempRequest.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformation.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostname.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameLinks.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameResponse.java -src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnamesResponse.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AboutApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AclProfileApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AllApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthenticationOauthProfileApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthenticationOauthProviderApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthorizationGroupApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/BridgeApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/CertAuthorityApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/CertMatchingRuleApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientCertAuthorityApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientProfileApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientUsernameApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DistributedCacheApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DmrBridgeApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DmrClusterApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DomainCertAuthorityApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/JndiApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MqttRetainCacheApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MqttSessionApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MsgVpnApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/OauthProfileApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/QueueApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/QueueTemplateApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ReplayLogApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ReplicatedTopicApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/RestDeliveryPointApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/SystemInformationApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/TopicEndpointApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/TopicEndpointTemplateApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/VirtualHostnameApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthoritiesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNamesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthoritiesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNamesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFiltersResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRulesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNamesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinksResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClustersResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthoritiesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdByPercentTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdByValueTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfilesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProvidersResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNamesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFiltersResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRulesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfilesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernamesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstancesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClustersResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCachesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoriesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueuesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCachesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplatesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueuesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumersResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplatesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParametersResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimsResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfilesResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempErrorTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempMetaOnlyResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempMetaTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempPagingTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempRequestTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameLinksTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameResponseTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameTest.java -src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnamesResponseTest.java diff --git a/service/solace-config-client/.openapi-generator/VERSION b/service/solace-config-client/.openapi-generator/VERSION deleted file mode 100644 index 4be2c727a..000000000 --- a/service/solace-config-client/.openapi-generator/VERSION +++ /dev/null @@ -1 +0,0 @@ -6.5.0 \ No newline at end of file diff --git a/service/solace-config-client/README.md b/service/solace-config-client/README.md deleted file mode 100644 index 83d4277da..000000000 --- a/service/solace-config-client/README.md +++ /dev/null @@ -1,1711 +0,0 @@ -# ema-sempv2-api-client - -SEMP (Solace Element Management Protocol) - -- API version: 2.28 - -- Build date: 2023-04-25T11:27:30.946889+01:00[Europe/London] - -SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. - -SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: - - -API|Base Path|Purpose|Comments -:---|:---|:---|:--- -Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 - - - -The following APIs are also available: - - -API|Base Path|Purpose|Comments -:---|:---|:---|:--- -Action|/SEMP/v2/action|Performing actions|See note 2 -Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 - - - -Resources are always nouns, with individual objects being singular and collections being plural. - -Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. - -Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. - -Some examples: - -``` -/SEMP/v2/config/msgVpns ; MsgVpn collection -/SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" -/SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" -/SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" -/SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" -/SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" -/SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" -``` - -## Collection Resources - -Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. - -## Object and Action Resources - -Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. - -Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. - -Attributes in an object or action may have any combination of the following properties: - - -Property|Meaning|Comments -:---|:---|:--- -Identifying|Attribute is involved in unique identification of the object, and appears in its URI| -Const|Attribute value can only be chosen during object creation| -Required|Attribute must be provided in the request| -Read-Only|Attribute can only be read, not written.|See note 3 -Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property -Requires-Disable|Attribute can only be changed when object is disabled| -Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| -Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation - - - -In some requests, certain attributes may only be provided in certain combinations with other attributes: - - -Relationship|Meaning -:---|:--- -Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request -Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request - - - -In the monitoring API, any non-identifying attribute may not be returned in a GET. - -## HTTP Methods - -The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: - - -Method|Resource|Meaning|Request Body|Response Body|Notes -:---|:---|:---|:---|:---|:--- -POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned -PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) -PUT|Action|Performs action|Action arguments|Action metadata| -PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned -DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned -GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned -GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code - - - -## Common Query Parameters - -The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: - -``` -; Request for the MsgVpns collection using two hypothetical query parameters -; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively -/SEMP/v2/config/msgVpns?q1=val1&q2=val2 -``` - -### select - -Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. - -The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. - -All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. - -Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). - -Some examples: - -``` -; List of all MsgVpn names -/SEMP/v2/config/msgVpns?select=msgVpnName -; List of all MsgVpn and their attributes except for their names -/SEMP/v2/config/msgVpns?select=-msgVpnName -; Authentication attributes of MsgVpn \"finance\" -/SEMP/v2/config/msgVpns/finance?select=authentication* -; All attributes of MsgVpn \"finance\" except for authentication attributes -/SEMP/v2/config/msgVpns/finance?select=-authentication* -; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" -/SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission -``` - -### where - -Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. - -The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: - -``` -expression = attribute-name OP value -OP = '==' | '!=' | '<' | '>' | '<=' | '>=' -``` - -`value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: - -``` -; Only enabled MsgVpns -/SEMP/v2/config/msgVpns?where=enabled==true -; Only MsgVpns using basic non-LDAP authentication -/SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap -; Only MsgVpns that allow more than 100 client connections -/SEMP/v2/config/msgVpns?where=maxConnectionCount>100 -; Only MsgVpns with msgVpnName starting with \"B\": -/SEMP/v2/config/msgVpns?where=msgVpnName==B* -``` - -### count - -Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. - -`count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. - -For example: -``` -; Up to 25 MsgVpns -/SEMP/v2/config/msgVpns?count=25 -``` - -### cursor - -The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. - -When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. - -Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. - -### opaquePassword - -Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: - -1. the same password that was used to retrieve the opaque attribute values is provided; and - -2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. - -The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. - -The query parameter can only be used in the configuration API, and only over HTTPS. - -## Authentication - -When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. - -When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. - -There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. - -If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. - -A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. - -Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. - -## Help - -Visit [our website](https://solace.com) to learn more about Solace. - -You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). - -If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). - -## Notes - -Note|Description -:---:|:--- -1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" -2|This API is partially implemented. Only a subset of all objects are available. -3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. -4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - - - - For more information, please visit [http://www.solace.com](http://www.solace.com) - -*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)* - -## Requirements - -Building the API client library requires: - -1. Java 1.8+ -2. Maven/Gradle - -## Installation - -To install the API client library to your local Maven repository, simply execute: - -```shell -mvn clean install -``` - -To deploy it to a remote Maven repository instead, configure the settings of the repository and execute: - -```shell -mvn clean deploy -``` - -Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information. - -### Maven users - -Add this dependency to your project's POM: - -```xml - - com.solace - ema-sempv2-api-client - 0.0.1-SNAPSHOT - compile - -``` - -### Gradle users - -Add this dependency to your project's build file: - -```groovy - repositories { - mavenCentral() // Needed if the 'ema-sempv2-api-client' jar has been published to maven central. - mavenLocal() // Needed if the 'ema-sempv2-api-client' jar has been published to the local maven repo. - } - - dependencies { - implementation "com.solace:ema-sempv2-api-client:0.0.1-SNAPSHOT" - } -``` - -### Others - -At first generate the JAR by executing: - -```shell -mvn clean package -``` - -Then manually install the following JARs: - -- `target/ema-sempv2-api-client-0.0.1-SNAPSHOT.jar` -- `target/lib/*.jar` - -## Getting Started - -Please follow the [installation](#installation) instruction and execute the following Java code: - -```java - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AboutApi; - -public class AboutApiExample { - - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AboutApi apiInstance = new AboutApi(defaultClient); - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - AboutResponse result = apiInstance.getAbout(opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AboutApi#getAbout"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} - -``` - -## Documentation for API Endpoints - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -*AboutApi* | [**getAbout**](docs/AboutApi.md#getAbout) | **GET** /about | Get an About object. -*AboutApi* | [**getAboutApi**](docs/AboutApi.md#getAboutApi) | **GET** /about/api | Get an API Description object. -*AboutApi* | [**getAboutUser**](docs/AboutApi.md#getAboutUser) | **GET** /about/user | Get a User object. -*AboutApi* | [**getAboutUserMsgVpn**](docs/AboutApi.md#getAboutUserMsgVpn) | **GET** /about/user/msgVpns/{msgVpnName} | Get a User Message VPN object. -*AboutApi* | [**getAboutUserMsgVpns**](docs/AboutApi.md#getAboutUserMsgVpns) | **GET** /about/user/msgVpns | Get a list of User Message VPN objects. -*AclProfileApi* | [**createMsgVpnAclProfile**](docs/AclProfileApi.md#createMsgVpnAclProfile) | **POST** /msgVpns/{msgVpnName}/aclProfiles | Create an ACL Profile object. -*AclProfileApi* | [**createMsgVpnAclProfileClientConnectException**](docs/AclProfileApi.md#createMsgVpnAclProfileClientConnectException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions | Create a Client Connect Exception object. -*AclProfileApi* | [**createMsgVpnAclProfilePublishException**](docs/AclProfileApi.md#createMsgVpnAclProfilePublishException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions | Create a Publish Topic Exception object. -*AclProfileApi* | [**createMsgVpnAclProfilePublishTopicException**](docs/AclProfileApi.md#createMsgVpnAclProfilePublishTopicException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions | Create a Publish Topic Exception object. -*AclProfileApi* | [**createMsgVpnAclProfileSubscribeException**](docs/AclProfileApi.md#createMsgVpnAclProfileSubscribeException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions | Create a Subscribe Topic Exception object. -*AclProfileApi* | [**createMsgVpnAclProfileSubscribeShareNameException**](docs/AclProfileApi.md#createMsgVpnAclProfileSubscribeShareNameException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions | Create a Subscribe Share Name Exception object. -*AclProfileApi* | [**createMsgVpnAclProfileSubscribeTopicException**](docs/AclProfileApi.md#createMsgVpnAclProfileSubscribeTopicException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions | Create a Subscribe Topic Exception object. -*AclProfileApi* | [**deleteMsgVpnAclProfile**](docs/AclProfileApi.md#deleteMsgVpnAclProfile) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Delete an ACL Profile object. -*AclProfileApi* | [**deleteMsgVpnAclProfileClientConnectException**](docs/AclProfileApi.md#deleteMsgVpnAclProfileClientConnectException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress} | Delete a Client Connect Exception object. -*AclProfileApi* | [**deleteMsgVpnAclProfilePublishException**](docs/AclProfileApi.md#deleteMsgVpnAclProfilePublishException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic} | Delete a Publish Topic Exception object. -*AclProfileApi* | [**deleteMsgVpnAclProfilePublishTopicException**](docs/AclProfileApi.md#deleteMsgVpnAclProfilePublishTopicException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException} | Delete a Publish Topic Exception object. -*AclProfileApi* | [**deleteMsgVpnAclProfileSubscribeException**](docs/AclProfileApi.md#deleteMsgVpnAclProfileSubscribeException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic} | Delete a Subscribe Topic Exception object. -*AclProfileApi* | [**deleteMsgVpnAclProfileSubscribeShareNameException**](docs/AclProfileApi.md#deleteMsgVpnAclProfileSubscribeShareNameException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException} | Delete a Subscribe Share Name Exception object. -*AclProfileApi* | [**deleteMsgVpnAclProfileSubscribeTopicException**](docs/AclProfileApi.md#deleteMsgVpnAclProfileSubscribeTopicException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException} | Delete a Subscribe Topic Exception object. -*AclProfileApi* | [**getMsgVpnAclProfile**](docs/AclProfileApi.md#getMsgVpnAclProfile) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Get an ACL Profile object. -*AclProfileApi* | [**getMsgVpnAclProfileClientConnectException**](docs/AclProfileApi.md#getMsgVpnAclProfileClientConnectException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress} | Get a Client Connect Exception object. -*AclProfileApi* | [**getMsgVpnAclProfileClientConnectExceptions**](docs/AclProfileApi.md#getMsgVpnAclProfileClientConnectExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions | Get a list of Client Connect Exception objects. -*AclProfileApi* | [**getMsgVpnAclProfilePublishException**](docs/AclProfileApi.md#getMsgVpnAclProfilePublishException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic} | Get a Publish Topic Exception object. -*AclProfileApi* | [**getMsgVpnAclProfilePublishExceptions**](docs/AclProfileApi.md#getMsgVpnAclProfilePublishExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions | Get a list of Publish Topic Exception objects. -*AclProfileApi* | [**getMsgVpnAclProfilePublishTopicException**](docs/AclProfileApi.md#getMsgVpnAclProfilePublishTopicException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException} | Get a Publish Topic Exception object. -*AclProfileApi* | [**getMsgVpnAclProfilePublishTopicExceptions**](docs/AclProfileApi.md#getMsgVpnAclProfilePublishTopicExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions | Get a list of Publish Topic Exception objects. -*AclProfileApi* | [**getMsgVpnAclProfileSubscribeException**](docs/AclProfileApi.md#getMsgVpnAclProfileSubscribeException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic} | Get a Subscribe Topic Exception object. -*AclProfileApi* | [**getMsgVpnAclProfileSubscribeExceptions**](docs/AclProfileApi.md#getMsgVpnAclProfileSubscribeExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions | Get a list of Subscribe Topic Exception objects. -*AclProfileApi* | [**getMsgVpnAclProfileSubscribeShareNameException**](docs/AclProfileApi.md#getMsgVpnAclProfileSubscribeShareNameException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException} | Get a Subscribe Share Name Exception object. -*AclProfileApi* | [**getMsgVpnAclProfileSubscribeShareNameExceptions**](docs/AclProfileApi.md#getMsgVpnAclProfileSubscribeShareNameExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions | Get a list of Subscribe Share Name Exception objects. -*AclProfileApi* | [**getMsgVpnAclProfileSubscribeTopicException**](docs/AclProfileApi.md#getMsgVpnAclProfileSubscribeTopicException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException} | Get a Subscribe Topic Exception object. -*AclProfileApi* | [**getMsgVpnAclProfileSubscribeTopicExceptions**](docs/AclProfileApi.md#getMsgVpnAclProfileSubscribeTopicExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions | Get a list of Subscribe Topic Exception objects. -*AclProfileApi* | [**getMsgVpnAclProfiles**](docs/AclProfileApi.md#getMsgVpnAclProfiles) | **GET** /msgVpns/{msgVpnName}/aclProfiles | Get a list of ACL Profile objects. -*AclProfileApi* | [**replaceMsgVpnAclProfile**](docs/AclProfileApi.md#replaceMsgVpnAclProfile) | **PUT** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Replace an ACL Profile object. -*AclProfileApi* | [**updateMsgVpnAclProfile**](docs/AclProfileApi.md#updateMsgVpnAclProfile) | **PATCH** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Update an ACL Profile object. -*AllApi* | [**createCertAuthority**](docs/AllApi.md#createCertAuthority) | **POST** /certAuthorities | Create a Certificate Authority object. -*AllApi* | [**createCertAuthorityOcspTlsTrustedCommonName**](docs/AllApi.md#createCertAuthorityOcspTlsTrustedCommonName) | **POST** /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames | Create an OCSP Responder Trusted Common Name object. -*AllApi* | [**createClientCertAuthority**](docs/AllApi.md#createClientCertAuthority) | **POST** /clientCertAuthorities | Create a Client Certificate Authority object. -*AllApi* | [**createClientCertAuthorityOcspTlsTrustedCommonName**](docs/AllApi.md#createClientCertAuthorityOcspTlsTrustedCommonName) | **POST** /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames | Create an OCSP Responder Trusted Common Name object. -*AllApi* | [**createDmrCluster**](docs/AllApi.md#createDmrCluster) | **POST** /dmrClusters | Create a Cluster object. -*AllApi* | [**createDmrClusterCertMatchingRule**](docs/AllApi.md#createDmrClusterCertMatchingRule) | **POST** /dmrClusters/{dmrClusterName}/certMatchingRules | Create a Certificate Matching Rule object. -*AllApi* | [**createDmrClusterCertMatchingRuleAttributeFilter**](docs/AllApi.md#createDmrClusterCertMatchingRuleAttributeFilter) | **POST** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters | Create a Certificate Matching Rule Attribute Filter object. -*AllApi* | [**createDmrClusterCertMatchingRuleCondition**](docs/AllApi.md#createDmrClusterCertMatchingRuleCondition) | **POST** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions | Create a Certificate Matching Rule Condition object. -*AllApi* | [**createDmrClusterLink**](docs/AllApi.md#createDmrClusterLink) | **POST** /dmrClusters/{dmrClusterName}/links | Create a Link object. -*AllApi* | [**createDmrClusterLinkAttribute**](docs/AllApi.md#createDmrClusterLinkAttribute) | **POST** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes | Create a Link Attribute object. -*AllApi* | [**createDmrClusterLinkRemoteAddress**](docs/AllApi.md#createDmrClusterLinkRemoteAddress) | **POST** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses | Create a Remote Address object. -*AllApi* | [**createDmrClusterLinkTlsTrustedCommonName**](docs/AllApi.md#createDmrClusterLinkTlsTrustedCommonName) | **POST** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames | Create a Trusted Common Name object. -*AllApi* | [**createDomainCertAuthority**](docs/AllApi.md#createDomainCertAuthority) | **POST** /domainCertAuthorities | Create a Domain Certificate Authority object. -*AllApi* | [**createMsgVpn**](docs/AllApi.md#createMsgVpn) | **POST** /msgVpns | Create a Message VPN object. -*AllApi* | [**createMsgVpnAclProfile**](docs/AllApi.md#createMsgVpnAclProfile) | **POST** /msgVpns/{msgVpnName}/aclProfiles | Create an ACL Profile object. -*AllApi* | [**createMsgVpnAclProfileClientConnectException**](docs/AllApi.md#createMsgVpnAclProfileClientConnectException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions | Create a Client Connect Exception object. -*AllApi* | [**createMsgVpnAclProfilePublishException**](docs/AllApi.md#createMsgVpnAclProfilePublishException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions | Create a Publish Topic Exception object. -*AllApi* | [**createMsgVpnAclProfilePublishTopicException**](docs/AllApi.md#createMsgVpnAclProfilePublishTopicException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions | Create a Publish Topic Exception object. -*AllApi* | [**createMsgVpnAclProfileSubscribeException**](docs/AllApi.md#createMsgVpnAclProfileSubscribeException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions | Create a Subscribe Topic Exception object. -*AllApi* | [**createMsgVpnAclProfileSubscribeShareNameException**](docs/AllApi.md#createMsgVpnAclProfileSubscribeShareNameException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions | Create a Subscribe Share Name Exception object. -*AllApi* | [**createMsgVpnAclProfileSubscribeTopicException**](docs/AllApi.md#createMsgVpnAclProfileSubscribeTopicException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions | Create a Subscribe Topic Exception object. -*AllApi* | [**createMsgVpnAuthenticationOauthProfile**](docs/AllApi.md#createMsgVpnAuthenticationOauthProfile) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles | Create an OAuth Profile object. -*AllApi* | [**createMsgVpnAuthenticationOauthProfileClientRequiredClaim**](docs/AllApi.md#createMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims | Create a Required Claim object. -*AllApi* | [**createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](docs/AllApi.md#createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Create a Required Claim object. -*AllApi* | [**createMsgVpnAuthenticationOauthProvider**](docs/AllApi.md#createMsgVpnAuthenticationOauthProvider) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProviders | Create an OAuth Provider object. -*AllApi* | [**createMsgVpnAuthorizationGroup**](docs/AllApi.md#createMsgVpnAuthorizationGroup) | **POST** /msgVpns/{msgVpnName}/authorizationGroups | Create an Authorization Group object. -*AllApi* | [**createMsgVpnBridge**](docs/AllApi.md#createMsgVpnBridge) | **POST** /msgVpns/{msgVpnName}/bridges | Create a Bridge object. -*AllApi* | [**createMsgVpnBridgeRemoteMsgVpn**](docs/AllApi.md#createMsgVpnBridgeRemoteMsgVpn) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns | Create a Remote Message VPN object. -*AllApi* | [**createMsgVpnBridgeRemoteSubscription**](docs/AllApi.md#createMsgVpnBridgeRemoteSubscription) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions | Create a Remote Subscription object. -*AllApi* | [**createMsgVpnBridgeTlsTrustedCommonName**](docs/AllApi.md#createMsgVpnBridgeTlsTrustedCommonName) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames | Create a Trusted Common Name object. -*AllApi* | [**createMsgVpnCertMatchingRule**](docs/AllApi.md#createMsgVpnCertMatchingRule) | **POST** /msgVpns/{msgVpnName}/certMatchingRules | Create a Certificate Matching Rule object. -*AllApi* | [**createMsgVpnCertMatchingRuleAttributeFilter**](docs/AllApi.md#createMsgVpnCertMatchingRuleAttributeFilter) | **POST** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters | Create a Certificate Matching Rule Attribute Filter object. -*AllApi* | [**createMsgVpnCertMatchingRuleCondition**](docs/AllApi.md#createMsgVpnCertMatchingRuleCondition) | **POST** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions | Create a Certificate Matching Rule Condition object. -*AllApi* | [**createMsgVpnClientProfile**](docs/AllApi.md#createMsgVpnClientProfile) | **POST** /msgVpns/{msgVpnName}/clientProfiles | Create a Client Profile object. -*AllApi* | [**createMsgVpnClientUsername**](docs/AllApi.md#createMsgVpnClientUsername) | **POST** /msgVpns/{msgVpnName}/clientUsernames | Create a Client Username object. -*AllApi* | [**createMsgVpnClientUsernameAttribute**](docs/AllApi.md#createMsgVpnClientUsernameAttribute) | **POST** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes | Create a Client Username Attribute object. -*AllApi* | [**createMsgVpnDistributedCache**](docs/AllApi.md#createMsgVpnDistributedCache) | **POST** /msgVpns/{msgVpnName}/distributedCaches | Create a Distributed Cache object. -*AllApi* | [**createMsgVpnDistributedCacheCluster**](docs/AllApi.md#createMsgVpnDistributedCacheCluster) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters | Create a Cache Cluster object. -*AllApi* | [**createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](docs/AllApi.md#createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters | Create a Home Cache Cluster object. -*AllApi* | [**createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](docs/AllApi.md#createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes | Create a Topic Prefix object. -*AllApi* | [**createMsgVpnDistributedCacheClusterInstance**](docs/AllApi.md#createMsgVpnDistributedCacheClusterInstance) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances | Create a Cache Instance object. -*AllApi* | [**createMsgVpnDistributedCacheClusterTopic**](docs/AllApi.md#createMsgVpnDistributedCacheClusterTopic) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics | Create a Topic object. -*AllApi* | [**createMsgVpnDmrBridge**](docs/AllApi.md#createMsgVpnDmrBridge) | **POST** /msgVpns/{msgVpnName}/dmrBridges | Create a DMR Bridge object. -*AllApi* | [**createMsgVpnJndiConnectionFactory**](docs/AllApi.md#createMsgVpnJndiConnectionFactory) | **POST** /msgVpns/{msgVpnName}/jndiConnectionFactories | Create a JNDI Connection Factory object. -*AllApi* | [**createMsgVpnJndiQueue**](docs/AllApi.md#createMsgVpnJndiQueue) | **POST** /msgVpns/{msgVpnName}/jndiQueues | Create a JNDI Queue object. -*AllApi* | [**createMsgVpnJndiTopic**](docs/AllApi.md#createMsgVpnJndiTopic) | **POST** /msgVpns/{msgVpnName}/jndiTopics | Create a JNDI Topic object. -*AllApi* | [**createMsgVpnMqttRetainCache**](docs/AllApi.md#createMsgVpnMqttRetainCache) | **POST** /msgVpns/{msgVpnName}/mqttRetainCaches | Create an MQTT Retain Cache object. -*AllApi* | [**createMsgVpnMqttSession**](docs/AllApi.md#createMsgVpnMqttSession) | **POST** /msgVpns/{msgVpnName}/mqttSessions | Create an MQTT Session object. -*AllApi* | [**createMsgVpnMqttSessionSubscription**](docs/AllApi.md#createMsgVpnMqttSessionSubscription) | **POST** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions | Create a Subscription object. -*AllApi* | [**createMsgVpnQueue**](docs/AllApi.md#createMsgVpnQueue) | **POST** /msgVpns/{msgVpnName}/queues | Create a Queue object. -*AllApi* | [**createMsgVpnQueueSubscription**](docs/AllApi.md#createMsgVpnQueueSubscription) | **POST** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions | Create a Queue Subscription object. -*AllApi* | [**createMsgVpnQueueTemplate**](docs/AllApi.md#createMsgVpnQueueTemplate) | **POST** /msgVpns/{msgVpnName}/queueTemplates | Create a Queue Template object. -*AllApi* | [**createMsgVpnReplayLog**](docs/AllApi.md#createMsgVpnReplayLog) | **POST** /msgVpns/{msgVpnName}/replayLogs | Create a Replay Log object. -*AllApi* | [**createMsgVpnReplayLogTopicFilterSubscription**](docs/AllApi.md#createMsgVpnReplayLogTopicFilterSubscription) | **POST** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions | Create a Topic Filter Subscription object. -*AllApi* | [**createMsgVpnReplicatedTopic**](docs/AllApi.md#createMsgVpnReplicatedTopic) | **POST** /msgVpns/{msgVpnName}/replicatedTopics | Create a Replicated Topic object. -*AllApi* | [**createMsgVpnRestDeliveryPoint**](docs/AllApi.md#createMsgVpnRestDeliveryPoint) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints | Create a REST Delivery Point object. -*AllApi* | [**createMsgVpnRestDeliveryPointQueueBinding**](docs/AllApi.md#createMsgVpnRestDeliveryPointQueueBinding) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings | Create a Queue Binding object. -*AllApi* | [**createMsgVpnRestDeliveryPointQueueBindingRequestHeader**](docs/AllApi.md#createMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders | Create a Request Header object. -*AllApi* | [**createMsgVpnRestDeliveryPointRestConsumer**](docs/AllApi.md#createMsgVpnRestDeliveryPointRestConsumer) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers | Create a REST Consumer object. -*AllApi* | [**createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](docs/AllApi.md#createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims | Create a Claim object. -*AllApi* | [**createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](docs/AllApi.md#createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames | Create a Trusted Common Name object. -*AllApi* | [**createMsgVpnSequencedTopic**](docs/AllApi.md#createMsgVpnSequencedTopic) | **POST** /msgVpns/{msgVpnName}/sequencedTopics | Create a Sequenced Topic object. -*AllApi* | [**createMsgVpnTopicEndpoint**](docs/AllApi.md#createMsgVpnTopicEndpoint) | **POST** /msgVpns/{msgVpnName}/topicEndpoints | Create a Topic Endpoint object. -*AllApi* | [**createMsgVpnTopicEndpointTemplate**](docs/AllApi.md#createMsgVpnTopicEndpointTemplate) | **POST** /msgVpns/{msgVpnName}/topicEndpointTemplates | Create a Topic Endpoint Template object. -*AllApi* | [**createOauthProfile**](docs/AllApi.md#createOauthProfile) | **POST** /oauthProfiles | Create an OAuth Profile object. -*AllApi* | [**createOauthProfileAccessLevelGroup**](docs/AllApi.md#createOauthProfileAccessLevelGroup) | **POST** /oauthProfiles/{oauthProfileName}/accessLevelGroups | Create a Group Access Level object. -*AllApi* | [**createOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](docs/AllApi.md#createOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **POST** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions | Create a Message VPN Access-Level Exception object. -*AllApi* | [**createOauthProfileClientAllowedHost**](docs/AllApi.md#createOauthProfileClientAllowedHost) | **POST** /oauthProfiles/{oauthProfileName}/clientAllowedHosts | Create an Allowed Host Value object. -*AllApi* | [**createOauthProfileClientAuthorizationParameter**](docs/AllApi.md#createOauthProfileClientAuthorizationParameter) | **POST** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters | Create an Authorization Parameter object. -*AllApi* | [**createOauthProfileClientRequiredClaim**](docs/AllApi.md#createOauthProfileClientRequiredClaim) | **POST** /oauthProfiles/{oauthProfileName}/clientRequiredClaims | Create a Required Claim object. -*AllApi* | [**createOauthProfileDefaultMsgVpnAccessLevelException**](docs/AllApi.md#createOauthProfileDefaultMsgVpnAccessLevelException) | **POST** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions | Create a Message VPN Access-Level Exception object. -*AllApi* | [**createOauthProfileResourceServerRequiredClaim**](docs/AllApi.md#createOauthProfileResourceServerRequiredClaim) | **POST** /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Create a Required Claim object. -*AllApi* | [**createVirtualHostname**](docs/AllApi.md#createVirtualHostname) | **POST** /virtualHostnames | Create a Virtual Hostname object. -*AllApi* | [**deleteCertAuthority**](docs/AllApi.md#deleteCertAuthority) | **DELETE** /certAuthorities/{certAuthorityName} | Delete a Certificate Authority object. -*AllApi* | [**deleteCertAuthorityOcspTlsTrustedCommonName**](docs/AllApi.md#deleteCertAuthorityOcspTlsTrustedCommonName) | **DELETE** /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName} | Delete an OCSP Responder Trusted Common Name object. -*AllApi* | [**deleteClientCertAuthority**](docs/AllApi.md#deleteClientCertAuthority) | **DELETE** /clientCertAuthorities/{certAuthorityName} | Delete a Client Certificate Authority object. -*AllApi* | [**deleteClientCertAuthorityOcspTlsTrustedCommonName**](docs/AllApi.md#deleteClientCertAuthorityOcspTlsTrustedCommonName) | **DELETE** /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName} | Delete an OCSP Responder Trusted Common Name object. -*AllApi* | [**deleteDmrCluster**](docs/AllApi.md#deleteDmrCluster) | **DELETE** /dmrClusters/{dmrClusterName} | Delete a Cluster object. -*AllApi* | [**deleteDmrClusterCertMatchingRule**](docs/AllApi.md#deleteDmrClusterCertMatchingRule) | **DELETE** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName} | Delete a Certificate Matching Rule object. -*AllApi* | [**deleteDmrClusterCertMatchingRuleAttributeFilter**](docs/AllApi.md#deleteDmrClusterCertMatchingRuleAttributeFilter) | **DELETE** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Delete a Certificate Matching Rule Attribute Filter object. -*AllApi* | [**deleteDmrClusterCertMatchingRuleCondition**](docs/AllApi.md#deleteDmrClusterCertMatchingRuleCondition) | **DELETE** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source} | Delete a Certificate Matching Rule Condition object. -*AllApi* | [**deleteDmrClusterLink**](docs/AllApi.md#deleteDmrClusterLink) | **DELETE** /dmrClusters/{dmrClusterName}/links/{remoteNodeName} | Delete a Link object. -*AllApi* | [**deleteDmrClusterLinkAttribute**](docs/AllApi.md#deleteDmrClusterLinkAttribute) | **DELETE** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue} | Delete a Link Attribute object. -*AllApi* | [**deleteDmrClusterLinkRemoteAddress**](docs/AllApi.md#deleteDmrClusterLinkRemoteAddress) | **DELETE** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress} | Delete a Remote Address object. -*AllApi* | [**deleteDmrClusterLinkTlsTrustedCommonName**](docs/AllApi.md#deleteDmrClusterLinkTlsTrustedCommonName) | **DELETE** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Delete a Trusted Common Name object. -*AllApi* | [**deleteDomainCertAuthority**](docs/AllApi.md#deleteDomainCertAuthority) | **DELETE** /domainCertAuthorities/{certAuthorityName} | Delete a Domain Certificate Authority object. -*AllApi* | [**deleteMsgVpn**](docs/AllApi.md#deleteMsgVpn) | **DELETE** /msgVpns/{msgVpnName} | Delete a Message VPN object. -*AllApi* | [**deleteMsgVpnAclProfile**](docs/AllApi.md#deleteMsgVpnAclProfile) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Delete an ACL Profile object. -*AllApi* | [**deleteMsgVpnAclProfileClientConnectException**](docs/AllApi.md#deleteMsgVpnAclProfileClientConnectException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress} | Delete a Client Connect Exception object. -*AllApi* | [**deleteMsgVpnAclProfilePublishException**](docs/AllApi.md#deleteMsgVpnAclProfilePublishException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic} | Delete a Publish Topic Exception object. -*AllApi* | [**deleteMsgVpnAclProfilePublishTopicException**](docs/AllApi.md#deleteMsgVpnAclProfilePublishTopicException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException} | Delete a Publish Topic Exception object. -*AllApi* | [**deleteMsgVpnAclProfileSubscribeException**](docs/AllApi.md#deleteMsgVpnAclProfileSubscribeException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic} | Delete a Subscribe Topic Exception object. -*AllApi* | [**deleteMsgVpnAclProfileSubscribeShareNameException**](docs/AllApi.md#deleteMsgVpnAclProfileSubscribeShareNameException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException} | Delete a Subscribe Share Name Exception object. -*AllApi* | [**deleteMsgVpnAclProfileSubscribeTopicException**](docs/AllApi.md#deleteMsgVpnAclProfileSubscribeTopicException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException} | Delete a Subscribe Topic Exception object. -*AllApi* | [**deleteMsgVpnAuthenticationOauthProfile**](docs/AllApi.md#deleteMsgVpnAuthenticationOauthProfile) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Delete an OAuth Profile object. -*AllApi* | [**deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim**](docs/AllApi.md#deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Delete a Required Claim object. -*AllApi* | [**deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](docs/AllApi.md#deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Delete a Required Claim object. -*AllApi* | [**deleteMsgVpnAuthenticationOauthProvider**](docs/AllApi.md#deleteMsgVpnAuthenticationOauthProvider) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Delete an OAuth Provider object. -*AllApi* | [**deleteMsgVpnAuthorizationGroup**](docs/AllApi.md#deleteMsgVpnAuthorizationGroup) | **DELETE** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Delete an Authorization Group object. -*AllApi* | [**deleteMsgVpnBridge**](docs/AllApi.md#deleteMsgVpnBridge) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Delete a Bridge object. -*AllApi* | [**deleteMsgVpnBridgeRemoteMsgVpn**](docs/AllApi.md#deleteMsgVpnBridgeRemoteMsgVpn) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Delete a Remote Message VPN object. -*AllApi* | [**deleteMsgVpnBridgeRemoteSubscription**](docs/AllApi.md#deleteMsgVpnBridgeRemoteSubscription) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic} | Delete a Remote Subscription object. -*AllApi* | [**deleteMsgVpnBridgeTlsTrustedCommonName**](docs/AllApi.md#deleteMsgVpnBridgeTlsTrustedCommonName) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Delete a Trusted Common Name object. -*AllApi* | [**deleteMsgVpnCertMatchingRule**](docs/AllApi.md#deleteMsgVpnCertMatchingRule) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Delete a Certificate Matching Rule object. -*AllApi* | [**deleteMsgVpnCertMatchingRuleAttributeFilter**](docs/AllApi.md#deleteMsgVpnCertMatchingRuleAttributeFilter) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Delete a Certificate Matching Rule Attribute Filter object. -*AllApi* | [**deleteMsgVpnCertMatchingRuleCondition**](docs/AllApi.md#deleteMsgVpnCertMatchingRuleCondition) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source} | Delete a Certificate Matching Rule Condition object. -*AllApi* | [**deleteMsgVpnClientProfile**](docs/AllApi.md#deleteMsgVpnClientProfile) | **DELETE** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Delete a Client Profile object. -*AllApi* | [**deleteMsgVpnClientUsername**](docs/AllApi.md#deleteMsgVpnClientUsername) | **DELETE** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Delete a Client Username object. -*AllApi* | [**deleteMsgVpnClientUsernameAttribute**](docs/AllApi.md#deleteMsgVpnClientUsernameAttribute) | **DELETE** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue} | Delete a Client Username Attribute object. -*AllApi* | [**deleteMsgVpnDistributedCache**](docs/AllApi.md#deleteMsgVpnDistributedCache) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Delete a Distributed Cache object. -*AllApi* | [**deleteMsgVpnDistributedCacheCluster**](docs/AllApi.md#deleteMsgVpnDistributedCacheCluster) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Delete a Cache Cluster object. -*AllApi* | [**deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](docs/AllApi.md#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName} | Delete a Home Cache Cluster object. -*AllApi* | [**deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](docs/AllApi.md#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix} | Delete a Topic Prefix object. -*AllApi* | [**deleteMsgVpnDistributedCacheClusterInstance**](docs/AllApi.md#deleteMsgVpnDistributedCacheClusterInstance) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Delete a Cache Instance object. -*AllApi* | [**deleteMsgVpnDistributedCacheClusterTopic**](docs/AllApi.md#deleteMsgVpnDistributedCacheClusterTopic) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic} | Delete a Topic object. -*AllApi* | [**deleteMsgVpnDmrBridge**](docs/AllApi.md#deleteMsgVpnDmrBridge) | **DELETE** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Delete a DMR Bridge object. -*AllApi* | [**deleteMsgVpnJndiConnectionFactory**](docs/AllApi.md#deleteMsgVpnJndiConnectionFactory) | **DELETE** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Delete a JNDI Connection Factory object. -*AllApi* | [**deleteMsgVpnJndiQueue**](docs/AllApi.md#deleteMsgVpnJndiQueue) | **DELETE** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Delete a JNDI Queue object. -*AllApi* | [**deleteMsgVpnJndiTopic**](docs/AllApi.md#deleteMsgVpnJndiTopic) | **DELETE** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Delete a JNDI Topic object. -*AllApi* | [**deleteMsgVpnMqttRetainCache**](docs/AllApi.md#deleteMsgVpnMqttRetainCache) | **DELETE** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Delete an MQTT Retain Cache object. -*AllApi* | [**deleteMsgVpnMqttSession**](docs/AllApi.md#deleteMsgVpnMqttSession) | **DELETE** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Delete an MQTT Session object. -*AllApi* | [**deleteMsgVpnMqttSessionSubscription**](docs/AllApi.md#deleteMsgVpnMqttSessionSubscription) | **DELETE** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Delete a Subscription object. -*AllApi* | [**deleteMsgVpnQueue**](docs/AllApi.md#deleteMsgVpnQueue) | **DELETE** /msgVpns/{msgVpnName}/queues/{queueName} | Delete a Queue object. -*AllApi* | [**deleteMsgVpnQueueSubscription**](docs/AllApi.md#deleteMsgVpnQueueSubscription) | **DELETE** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic} | Delete a Queue Subscription object. -*AllApi* | [**deleteMsgVpnQueueTemplate**](docs/AllApi.md#deleteMsgVpnQueueTemplate) | **DELETE** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Delete a Queue Template object. -*AllApi* | [**deleteMsgVpnReplayLog**](docs/AllApi.md#deleteMsgVpnReplayLog) | **DELETE** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Delete a Replay Log object. -*AllApi* | [**deleteMsgVpnReplayLogTopicFilterSubscription**](docs/AllApi.md#deleteMsgVpnReplayLogTopicFilterSubscription) | **DELETE** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription} | Delete a Topic Filter Subscription object. -*AllApi* | [**deleteMsgVpnReplicatedTopic**](docs/AllApi.md#deleteMsgVpnReplicatedTopic) | **DELETE** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Delete a Replicated Topic object. -*AllApi* | [**deleteMsgVpnRestDeliveryPoint**](docs/AllApi.md#deleteMsgVpnRestDeliveryPoint) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Delete a REST Delivery Point object. -*AllApi* | [**deleteMsgVpnRestDeliveryPointQueueBinding**](docs/AllApi.md#deleteMsgVpnRestDeliveryPointQueueBinding) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Delete a Queue Binding object. -*AllApi* | [**deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader**](docs/AllApi.md#deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Delete a Request Header object. -*AllApi* | [**deleteMsgVpnRestDeliveryPointRestConsumer**](docs/AllApi.md#deleteMsgVpnRestDeliveryPointRestConsumer) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Delete a REST Consumer object. -*AllApi* | [**deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](docs/AllApi.md#deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName} | Delete a Claim object. -*AllApi* | [**deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](docs/AllApi.md#deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Delete a Trusted Common Name object. -*AllApi* | [**deleteMsgVpnSequencedTopic**](docs/AllApi.md#deleteMsgVpnSequencedTopic) | **DELETE** /msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic} | Delete a Sequenced Topic object. -*AllApi* | [**deleteMsgVpnTopicEndpoint**](docs/AllApi.md#deleteMsgVpnTopicEndpoint) | **DELETE** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Delete a Topic Endpoint object. -*AllApi* | [**deleteMsgVpnTopicEndpointTemplate**](docs/AllApi.md#deleteMsgVpnTopicEndpointTemplate) | **DELETE** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Delete a Topic Endpoint Template object. -*AllApi* | [**deleteOauthProfile**](docs/AllApi.md#deleteOauthProfile) | **DELETE** /oauthProfiles/{oauthProfileName} | Delete an OAuth Profile object. -*AllApi* | [**deleteOauthProfileAccessLevelGroup**](docs/AllApi.md#deleteOauthProfileAccessLevelGroup) | **DELETE** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName} | Delete a Group Access Level object. -*AllApi* | [**deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](docs/AllApi.md#deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **DELETE** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName} | Delete a Message VPN Access-Level Exception object. -*AllApi* | [**deleteOauthProfileClientAllowedHost**](docs/AllApi.md#deleteOauthProfileClientAllowedHost) | **DELETE** /oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost} | Delete an Allowed Host Value object. -*AllApi* | [**deleteOauthProfileClientAuthorizationParameter**](docs/AllApi.md#deleteOauthProfileClientAuthorizationParameter) | **DELETE** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName} | Delete an Authorization Parameter object. -*AllApi* | [**deleteOauthProfileClientRequiredClaim**](docs/AllApi.md#deleteOauthProfileClientRequiredClaim) | **DELETE** /oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Delete a Required Claim object. -*AllApi* | [**deleteOauthProfileDefaultMsgVpnAccessLevelException**](docs/AllApi.md#deleteOauthProfileDefaultMsgVpnAccessLevelException) | **DELETE** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName} | Delete a Message VPN Access-Level Exception object. -*AllApi* | [**deleteOauthProfileResourceServerRequiredClaim**](docs/AllApi.md#deleteOauthProfileResourceServerRequiredClaim) | **DELETE** /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Delete a Required Claim object. -*AllApi* | [**deleteVirtualHostname**](docs/AllApi.md#deleteVirtualHostname) | **DELETE** /virtualHostnames/{virtualHostname} | Delete a Virtual Hostname object. -*AllApi* | [**getAbout**](docs/AllApi.md#getAbout) | **GET** /about | Get an About object. -*AllApi* | [**getAboutApi**](docs/AllApi.md#getAboutApi) | **GET** /about/api | Get an API Description object. -*AllApi* | [**getAboutUser**](docs/AllApi.md#getAboutUser) | **GET** /about/user | Get a User object. -*AllApi* | [**getAboutUserMsgVpn**](docs/AllApi.md#getAboutUserMsgVpn) | **GET** /about/user/msgVpns/{msgVpnName} | Get a User Message VPN object. -*AllApi* | [**getAboutUserMsgVpns**](docs/AllApi.md#getAboutUserMsgVpns) | **GET** /about/user/msgVpns | Get a list of User Message VPN objects. -*AllApi* | [**getBroker**](docs/AllApi.md#getBroker) | **GET** / | Get a Broker object. -*AllApi* | [**getCertAuthorities**](docs/AllApi.md#getCertAuthorities) | **GET** /certAuthorities | Get a list of Certificate Authority objects. -*AllApi* | [**getCertAuthority**](docs/AllApi.md#getCertAuthority) | **GET** /certAuthorities/{certAuthorityName} | Get a Certificate Authority object. -*AllApi* | [**getCertAuthorityOcspTlsTrustedCommonName**](docs/AllApi.md#getCertAuthorityOcspTlsTrustedCommonName) | **GET** /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName} | Get an OCSP Responder Trusted Common Name object. -*AllApi* | [**getCertAuthorityOcspTlsTrustedCommonNames**](docs/AllApi.md#getCertAuthorityOcspTlsTrustedCommonNames) | **GET** /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames | Get a list of OCSP Responder Trusted Common Name objects. -*AllApi* | [**getClientCertAuthorities**](docs/AllApi.md#getClientCertAuthorities) | **GET** /clientCertAuthorities | Get a list of Client Certificate Authority objects. -*AllApi* | [**getClientCertAuthority**](docs/AllApi.md#getClientCertAuthority) | **GET** /clientCertAuthorities/{certAuthorityName} | Get a Client Certificate Authority object. -*AllApi* | [**getClientCertAuthorityOcspTlsTrustedCommonName**](docs/AllApi.md#getClientCertAuthorityOcspTlsTrustedCommonName) | **GET** /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName} | Get an OCSP Responder Trusted Common Name object. -*AllApi* | [**getClientCertAuthorityOcspTlsTrustedCommonNames**](docs/AllApi.md#getClientCertAuthorityOcspTlsTrustedCommonNames) | **GET** /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames | Get a list of OCSP Responder Trusted Common Name objects. -*AllApi* | [**getDmrCluster**](docs/AllApi.md#getDmrCluster) | **GET** /dmrClusters/{dmrClusterName} | Get a Cluster object. -*AllApi* | [**getDmrClusterCertMatchingRule**](docs/AllApi.md#getDmrClusterCertMatchingRule) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName} | Get a Certificate Matching Rule object. -*AllApi* | [**getDmrClusterCertMatchingRuleAttributeFilter**](docs/AllApi.md#getDmrClusterCertMatchingRuleAttributeFilter) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Get a Certificate Matching Rule Attribute Filter object. -*AllApi* | [**getDmrClusterCertMatchingRuleAttributeFilters**](docs/AllApi.md#getDmrClusterCertMatchingRuleAttributeFilters) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters | Get a list of Certificate Matching Rule Attribute Filter objects. -*AllApi* | [**getDmrClusterCertMatchingRuleCondition**](docs/AllApi.md#getDmrClusterCertMatchingRuleCondition) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source} | Get a Certificate Matching Rule Condition object. -*AllApi* | [**getDmrClusterCertMatchingRuleConditions**](docs/AllApi.md#getDmrClusterCertMatchingRuleConditions) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions | Get a list of Certificate Matching Rule Condition objects. -*AllApi* | [**getDmrClusterCertMatchingRules**](docs/AllApi.md#getDmrClusterCertMatchingRules) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules | Get a list of Certificate Matching Rule objects. -*AllApi* | [**getDmrClusterLink**](docs/AllApi.md#getDmrClusterLink) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName} | Get a Link object. -*AllApi* | [**getDmrClusterLinkAttribute**](docs/AllApi.md#getDmrClusterLinkAttribute) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue} | Get a Link Attribute object. -*AllApi* | [**getDmrClusterLinkAttributes**](docs/AllApi.md#getDmrClusterLinkAttributes) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes | Get a list of Link Attribute objects. -*AllApi* | [**getDmrClusterLinkRemoteAddress**](docs/AllApi.md#getDmrClusterLinkRemoteAddress) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress} | Get a Remote Address object. -*AllApi* | [**getDmrClusterLinkRemoteAddresses**](docs/AllApi.md#getDmrClusterLinkRemoteAddresses) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses | Get a list of Remote Address objects. -*AllApi* | [**getDmrClusterLinkTlsTrustedCommonName**](docs/AllApi.md#getDmrClusterLinkTlsTrustedCommonName) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Get a Trusted Common Name object. -*AllApi* | [**getDmrClusterLinkTlsTrustedCommonNames**](docs/AllApi.md#getDmrClusterLinkTlsTrustedCommonNames) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames | Get a list of Trusted Common Name objects. -*AllApi* | [**getDmrClusterLinks**](docs/AllApi.md#getDmrClusterLinks) | **GET** /dmrClusters/{dmrClusterName}/links | Get a list of Link objects. -*AllApi* | [**getDmrClusters**](docs/AllApi.md#getDmrClusters) | **GET** /dmrClusters | Get a list of Cluster objects. -*AllApi* | [**getDomainCertAuthorities**](docs/AllApi.md#getDomainCertAuthorities) | **GET** /domainCertAuthorities | Get a list of Domain Certificate Authority objects. -*AllApi* | [**getDomainCertAuthority**](docs/AllApi.md#getDomainCertAuthority) | **GET** /domainCertAuthorities/{certAuthorityName} | Get a Domain Certificate Authority object. -*AllApi* | [**getMsgVpn**](docs/AllApi.md#getMsgVpn) | **GET** /msgVpns/{msgVpnName} | Get a Message VPN object. -*AllApi* | [**getMsgVpnAclProfile**](docs/AllApi.md#getMsgVpnAclProfile) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Get an ACL Profile object. -*AllApi* | [**getMsgVpnAclProfileClientConnectException**](docs/AllApi.md#getMsgVpnAclProfileClientConnectException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress} | Get a Client Connect Exception object. -*AllApi* | [**getMsgVpnAclProfileClientConnectExceptions**](docs/AllApi.md#getMsgVpnAclProfileClientConnectExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions | Get a list of Client Connect Exception objects. -*AllApi* | [**getMsgVpnAclProfilePublishException**](docs/AllApi.md#getMsgVpnAclProfilePublishException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic} | Get a Publish Topic Exception object. -*AllApi* | [**getMsgVpnAclProfilePublishExceptions**](docs/AllApi.md#getMsgVpnAclProfilePublishExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions | Get a list of Publish Topic Exception objects. -*AllApi* | [**getMsgVpnAclProfilePublishTopicException**](docs/AllApi.md#getMsgVpnAclProfilePublishTopicException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException} | Get a Publish Topic Exception object. -*AllApi* | [**getMsgVpnAclProfilePublishTopicExceptions**](docs/AllApi.md#getMsgVpnAclProfilePublishTopicExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions | Get a list of Publish Topic Exception objects. -*AllApi* | [**getMsgVpnAclProfileSubscribeException**](docs/AllApi.md#getMsgVpnAclProfileSubscribeException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic} | Get a Subscribe Topic Exception object. -*AllApi* | [**getMsgVpnAclProfileSubscribeExceptions**](docs/AllApi.md#getMsgVpnAclProfileSubscribeExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions | Get a list of Subscribe Topic Exception objects. -*AllApi* | [**getMsgVpnAclProfileSubscribeShareNameException**](docs/AllApi.md#getMsgVpnAclProfileSubscribeShareNameException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException} | Get a Subscribe Share Name Exception object. -*AllApi* | [**getMsgVpnAclProfileSubscribeShareNameExceptions**](docs/AllApi.md#getMsgVpnAclProfileSubscribeShareNameExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions | Get a list of Subscribe Share Name Exception objects. -*AllApi* | [**getMsgVpnAclProfileSubscribeTopicException**](docs/AllApi.md#getMsgVpnAclProfileSubscribeTopicException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException} | Get a Subscribe Topic Exception object. -*AllApi* | [**getMsgVpnAclProfileSubscribeTopicExceptions**](docs/AllApi.md#getMsgVpnAclProfileSubscribeTopicExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions | Get a list of Subscribe Topic Exception objects. -*AllApi* | [**getMsgVpnAclProfiles**](docs/AllApi.md#getMsgVpnAclProfiles) | **GET** /msgVpns/{msgVpnName}/aclProfiles | Get a list of ACL Profile objects. -*AllApi* | [**getMsgVpnAuthenticationOauthProfile**](docs/AllApi.md#getMsgVpnAuthenticationOauthProfile) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Get an OAuth Profile object. -*AllApi* | [**getMsgVpnAuthenticationOauthProfileClientRequiredClaim**](docs/AllApi.md#getMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Get a Required Claim object. -*AllApi* | [**getMsgVpnAuthenticationOauthProfileClientRequiredClaims**](docs/AllApi.md#getMsgVpnAuthenticationOauthProfileClientRequiredClaims) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims | Get a list of Required Claim objects. -*AllApi* | [**getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](docs/AllApi.md#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Get a Required Claim object. -*AllApi* | [**getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims**](docs/AllApi.md#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Get a list of Required Claim objects. -*AllApi* | [**getMsgVpnAuthenticationOauthProfiles**](docs/AllApi.md#getMsgVpnAuthenticationOauthProfiles) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles | Get a list of OAuth Profile objects. -*AllApi* | [**getMsgVpnAuthenticationOauthProvider**](docs/AllApi.md#getMsgVpnAuthenticationOauthProvider) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Get an OAuth Provider object. -*AllApi* | [**getMsgVpnAuthenticationOauthProviders**](docs/AllApi.md#getMsgVpnAuthenticationOauthProviders) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProviders | Get a list of OAuth Provider objects. -*AllApi* | [**getMsgVpnAuthorizationGroup**](docs/AllApi.md#getMsgVpnAuthorizationGroup) | **GET** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Get an Authorization Group object. -*AllApi* | [**getMsgVpnAuthorizationGroups**](docs/AllApi.md#getMsgVpnAuthorizationGroups) | **GET** /msgVpns/{msgVpnName}/authorizationGroups | Get a list of Authorization Group objects. -*AllApi* | [**getMsgVpnBridge**](docs/AllApi.md#getMsgVpnBridge) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Get a Bridge object. -*AllApi* | [**getMsgVpnBridgeRemoteMsgVpn**](docs/AllApi.md#getMsgVpnBridgeRemoteMsgVpn) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Get a Remote Message VPN object. -*AllApi* | [**getMsgVpnBridgeRemoteMsgVpns**](docs/AllApi.md#getMsgVpnBridgeRemoteMsgVpns) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns | Get a list of Remote Message VPN objects. -*AllApi* | [**getMsgVpnBridgeRemoteSubscription**](docs/AllApi.md#getMsgVpnBridgeRemoteSubscription) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic} | Get a Remote Subscription object. -*AllApi* | [**getMsgVpnBridgeRemoteSubscriptions**](docs/AllApi.md#getMsgVpnBridgeRemoteSubscriptions) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions | Get a list of Remote Subscription objects. -*AllApi* | [**getMsgVpnBridgeTlsTrustedCommonName**](docs/AllApi.md#getMsgVpnBridgeTlsTrustedCommonName) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Get a Trusted Common Name object. -*AllApi* | [**getMsgVpnBridgeTlsTrustedCommonNames**](docs/AllApi.md#getMsgVpnBridgeTlsTrustedCommonNames) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames | Get a list of Trusted Common Name objects. -*AllApi* | [**getMsgVpnBridges**](docs/AllApi.md#getMsgVpnBridges) | **GET** /msgVpns/{msgVpnName}/bridges | Get a list of Bridge objects. -*AllApi* | [**getMsgVpnCertMatchingRule**](docs/AllApi.md#getMsgVpnCertMatchingRule) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Get a Certificate Matching Rule object. -*AllApi* | [**getMsgVpnCertMatchingRuleAttributeFilter**](docs/AllApi.md#getMsgVpnCertMatchingRuleAttributeFilter) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Get a Certificate Matching Rule Attribute Filter object. -*AllApi* | [**getMsgVpnCertMatchingRuleAttributeFilters**](docs/AllApi.md#getMsgVpnCertMatchingRuleAttributeFilters) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters | Get a list of Certificate Matching Rule Attribute Filter objects. -*AllApi* | [**getMsgVpnCertMatchingRuleCondition**](docs/AllApi.md#getMsgVpnCertMatchingRuleCondition) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source} | Get a Certificate Matching Rule Condition object. -*AllApi* | [**getMsgVpnCertMatchingRuleConditions**](docs/AllApi.md#getMsgVpnCertMatchingRuleConditions) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions | Get a list of Certificate Matching Rule Condition objects. -*AllApi* | [**getMsgVpnCertMatchingRules**](docs/AllApi.md#getMsgVpnCertMatchingRules) | **GET** /msgVpns/{msgVpnName}/certMatchingRules | Get a list of Certificate Matching Rule objects. -*AllApi* | [**getMsgVpnClientProfile**](docs/AllApi.md#getMsgVpnClientProfile) | **GET** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Get a Client Profile object. -*AllApi* | [**getMsgVpnClientProfiles**](docs/AllApi.md#getMsgVpnClientProfiles) | **GET** /msgVpns/{msgVpnName}/clientProfiles | Get a list of Client Profile objects. -*AllApi* | [**getMsgVpnClientUsername**](docs/AllApi.md#getMsgVpnClientUsername) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Get a Client Username object. -*AllApi* | [**getMsgVpnClientUsernameAttribute**](docs/AllApi.md#getMsgVpnClientUsernameAttribute) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue} | Get a Client Username Attribute object. -*AllApi* | [**getMsgVpnClientUsernameAttributes**](docs/AllApi.md#getMsgVpnClientUsernameAttributes) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes | Get a list of Client Username Attribute objects. -*AllApi* | [**getMsgVpnClientUsernames**](docs/AllApi.md#getMsgVpnClientUsernames) | **GET** /msgVpns/{msgVpnName}/clientUsernames | Get a list of Client Username objects. -*AllApi* | [**getMsgVpnDistributedCache**](docs/AllApi.md#getMsgVpnDistributedCache) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Get a Distributed Cache object. -*AllApi* | [**getMsgVpnDistributedCacheCluster**](docs/AllApi.md#getMsgVpnDistributedCacheCluster) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Get a Cache Cluster object. -*AllApi* | [**getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](docs/AllApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName} | Get a Home Cache Cluster object. -*AllApi* | [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](docs/AllApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix} | Get a Topic Prefix object. -*AllApi* | [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes**](docs/AllApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes | Get a list of Topic Prefix objects. -*AllApi* | [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters**](docs/AllApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters | Get a list of Home Cache Cluster objects. -*AllApi* | [**getMsgVpnDistributedCacheClusterInstance**](docs/AllApi.md#getMsgVpnDistributedCacheClusterInstance) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Get a Cache Instance object. -*AllApi* | [**getMsgVpnDistributedCacheClusterInstances**](docs/AllApi.md#getMsgVpnDistributedCacheClusterInstances) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances | Get a list of Cache Instance objects. -*AllApi* | [**getMsgVpnDistributedCacheClusterTopic**](docs/AllApi.md#getMsgVpnDistributedCacheClusterTopic) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic} | Get a Topic object. -*AllApi* | [**getMsgVpnDistributedCacheClusterTopics**](docs/AllApi.md#getMsgVpnDistributedCacheClusterTopics) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics | Get a list of Topic objects. -*AllApi* | [**getMsgVpnDistributedCacheClusters**](docs/AllApi.md#getMsgVpnDistributedCacheClusters) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters | Get a list of Cache Cluster objects. -*AllApi* | [**getMsgVpnDistributedCaches**](docs/AllApi.md#getMsgVpnDistributedCaches) | **GET** /msgVpns/{msgVpnName}/distributedCaches | Get a list of Distributed Cache objects. -*AllApi* | [**getMsgVpnDmrBridge**](docs/AllApi.md#getMsgVpnDmrBridge) | **GET** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Get a DMR Bridge object. -*AllApi* | [**getMsgVpnDmrBridges**](docs/AllApi.md#getMsgVpnDmrBridges) | **GET** /msgVpns/{msgVpnName}/dmrBridges | Get a list of DMR Bridge objects. -*AllApi* | [**getMsgVpnJndiConnectionFactories**](docs/AllApi.md#getMsgVpnJndiConnectionFactories) | **GET** /msgVpns/{msgVpnName}/jndiConnectionFactories | Get a list of JNDI Connection Factory objects. -*AllApi* | [**getMsgVpnJndiConnectionFactory**](docs/AllApi.md#getMsgVpnJndiConnectionFactory) | **GET** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Get a JNDI Connection Factory object. -*AllApi* | [**getMsgVpnJndiQueue**](docs/AllApi.md#getMsgVpnJndiQueue) | **GET** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Get a JNDI Queue object. -*AllApi* | [**getMsgVpnJndiQueues**](docs/AllApi.md#getMsgVpnJndiQueues) | **GET** /msgVpns/{msgVpnName}/jndiQueues | Get a list of JNDI Queue objects. -*AllApi* | [**getMsgVpnJndiTopic**](docs/AllApi.md#getMsgVpnJndiTopic) | **GET** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Get a JNDI Topic object. -*AllApi* | [**getMsgVpnJndiTopics**](docs/AllApi.md#getMsgVpnJndiTopics) | **GET** /msgVpns/{msgVpnName}/jndiTopics | Get a list of JNDI Topic objects. -*AllApi* | [**getMsgVpnMqttRetainCache**](docs/AllApi.md#getMsgVpnMqttRetainCache) | **GET** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Get an MQTT Retain Cache object. -*AllApi* | [**getMsgVpnMqttRetainCaches**](docs/AllApi.md#getMsgVpnMqttRetainCaches) | **GET** /msgVpns/{msgVpnName}/mqttRetainCaches | Get a list of MQTT Retain Cache objects. -*AllApi* | [**getMsgVpnMqttSession**](docs/AllApi.md#getMsgVpnMqttSession) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Get an MQTT Session object. -*AllApi* | [**getMsgVpnMqttSessionSubscription**](docs/AllApi.md#getMsgVpnMqttSessionSubscription) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Get a Subscription object. -*AllApi* | [**getMsgVpnMqttSessionSubscriptions**](docs/AllApi.md#getMsgVpnMqttSessionSubscriptions) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions | Get a list of Subscription objects. -*AllApi* | [**getMsgVpnMqttSessions**](docs/AllApi.md#getMsgVpnMqttSessions) | **GET** /msgVpns/{msgVpnName}/mqttSessions | Get a list of MQTT Session objects. -*AllApi* | [**getMsgVpnQueue**](docs/AllApi.md#getMsgVpnQueue) | **GET** /msgVpns/{msgVpnName}/queues/{queueName} | Get a Queue object. -*AllApi* | [**getMsgVpnQueueSubscription**](docs/AllApi.md#getMsgVpnQueueSubscription) | **GET** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic} | Get a Queue Subscription object. -*AllApi* | [**getMsgVpnQueueSubscriptions**](docs/AllApi.md#getMsgVpnQueueSubscriptions) | **GET** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions | Get a list of Queue Subscription objects. -*AllApi* | [**getMsgVpnQueueTemplate**](docs/AllApi.md#getMsgVpnQueueTemplate) | **GET** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Get a Queue Template object. -*AllApi* | [**getMsgVpnQueueTemplates**](docs/AllApi.md#getMsgVpnQueueTemplates) | **GET** /msgVpns/{msgVpnName}/queueTemplates | Get a list of Queue Template objects. -*AllApi* | [**getMsgVpnQueues**](docs/AllApi.md#getMsgVpnQueues) | **GET** /msgVpns/{msgVpnName}/queues | Get a list of Queue objects. -*AllApi* | [**getMsgVpnReplayLog**](docs/AllApi.md#getMsgVpnReplayLog) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Get a Replay Log object. -*AllApi* | [**getMsgVpnReplayLogTopicFilterSubscription**](docs/AllApi.md#getMsgVpnReplayLogTopicFilterSubscription) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription} | Get a Topic Filter Subscription object. -*AllApi* | [**getMsgVpnReplayLogTopicFilterSubscriptions**](docs/AllApi.md#getMsgVpnReplayLogTopicFilterSubscriptions) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions | Get a list of Topic Filter Subscription objects. -*AllApi* | [**getMsgVpnReplayLogs**](docs/AllApi.md#getMsgVpnReplayLogs) | **GET** /msgVpns/{msgVpnName}/replayLogs | Get a list of Replay Log objects. -*AllApi* | [**getMsgVpnReplicatedTopic**](docs/AllApi.md#getMsgVpnReplicatedTopic) | **GET** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Get a Replicated Topic object. -*AllApi* | [**getMsgVpnReplicatedTopics**](docs/AllApi.md#getMsgVpnReplicatedTopics) | **GET** /msgVpns/{msgVpnName}/replicatedTopics | Get a list of Replicated Topic objects. -*AllApi* | [**getMsgVpnRestDeliveryPoint**](docs/AllApi.md#getMsgVpnRestDeliveryPoint) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Get a REST Delivery Point object. -*AllApi* | [**getMsgVpnRestDeliveryPointQueueBinding**](docs/AllApi.md#getMsgVpnRestDeliveryPointQueueBinding) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Get a Queue Binding object. -*AllApi* | [**getMsgVpnRestDeliveryPointQueueBindingRequestHeader**](docs/AllApi.md#getMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Get a Request Header object. -*AllApi* | [**getMsgVpnRestDeliveryPointQueueBindingRequestHeaders**](docs/AllApi.md#getMsgVpnRestDeliveryPointQueueBindingRequestHeaders) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders | Get a list of Request Header objects. -*AllApi* | [**getMsgVpnRestDeliveryPointQueueBindings**](docs/AllApi.md#getMsgVpnRestDeliveryPointQueueBindings) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings | Get a list of Queue Binding objects. -*AllApi* | [**getMsgVpnRestDeliveryPointRestConsumer**](docs/AllApi.md#getMsgVpnRestDeliveryPointRestConsumer) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Get a REST Consumer object. -*AllApi* | [**getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](docs/AllApi.md#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName} | Get a Claim object. -*AllApi* | [**getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims**](docs/AllApi.md#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims | Get a list of Claim objects. -*AllApi* | [**getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](docs/AllApi.md#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Get a Trusted Common Name object. -*AllApi* | [**getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames**](docs/AllApi.md#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames | Get a list of Trusted Common Name objects. -*AllApi* | [**getMsgVpnRestDeliveryPointRestConsumers**](docs/AllApi.md#getMsgVpnRestDeliveryPointRestConsumers) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers | Get a list of REST Consumer objects. -*AllApi* | [**getMsgVpnRestDeliveryPoints**](docs/AllApi.md#getMsgVpnRestDeliveryPoints) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints | Get a list of REST Delivery Point objects. -*AllApi* | [**getMsgVpnSequencedTopic**](docs/AllApi.md#getMsgVpnSequencedTopic) | **GET** /msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic} | Get a Sequenced Topic object. -*AllApi* | [**getMsgVpnSequencedTopics**](docs/AllApi.md#getMsgVpnSequencedTopics) | **GET** /msgVpns/{msgVpnName}/sequencedTopics | Get a list of Sequenced Topic objects. -*AllApi* | [**getMsgVpnTopicEndpoint**](docs/AllApi.md#getMsgVpnTopicEndpoint) | **GET** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Get a Topic Endpoint object. -*AllApi* | [**getMsgVpnTopicEndpointTemplate**](docs/AllApi.md#getMsgVpnTopicEndpointTemplate) | **GET** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Get a Topic Endpoint Template object. -*AllApi* | [**getMsgVpnTopicEndpointTemplates**](docs/AllApi.md#getMsgVpnTopicEndpointTemplates) | **GET** /msgVpns/{msgVpnName}/topicEndpointTemplates | Get a list of Topic Endpoint Template objects. -*AllApi* | [**getMsgVpnTopicEndpoints**](docs/AllApi.md#getMsgVpnTopicEndpoints) | **GET** /msgVpns/{msgVpnName}/topicEndpoints | Get a list of Topic Endpoint objects. -*AllApi* | [**getMsgVpns**](docs/AllApi.md#getMsgVpns) | **GET** /msgVpns | Get a list of Message VPN objects. -*AllApi* | [**getOauthProfile**](docs/AllApi.md#getOauthProfile) | **GET** /oauthProfiles/{oauthProfileName} | Get an OAuth Profile object. -*AllApi* | [**getOauthProfileAccessLevelGroup**](docs/AllApi.md#getOauthProfileAccessLevelGroup) | **GET** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName} | Get a Group Access Level object. -*AllApi* | [**getOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](docs/AllApi.md#getOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **GET** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName} | Get a Message VPN Access-Level Exception object. -*AllApi* | [**getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions**](docs/AllApi.md#getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions) | **GET** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions | Get a list of Message VPN Access-Level Exception objects. -*AllApi* | [**getOauthProfileAccessLevelGroups**](docs/AllApi.md#getOauthProfileAccessLevelGroups) | **GET** /oauthProfiles/{oauthProfileName}/accessLevelGroups | Get a list of Group Access Level objects. -*AllApi* | [**getOauthProfileClientAllowedHost**](docs/AllApi.md#getOauthProfileClientAllowedHost) | **GET** /oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost} | Get an Allowed Host Value object. -*AllApi* | [**getOauthProfileClientAllowedHosts**](docs/AllApi.md#getOauthProfileClientAllowedHosts) | **GET** /oauthProfiles/{oauthProfileName}/clientAllowedHosts | Get a list of Allowed Host Value objects. -*AllApi* | [**getOauthProfileClientAuthorizationParameter**](docs/AllApi.md#getOauthProfileClientAuthorizationParameter) | **GET** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName} | Get an Authorization Parameter object. -*AllApi* | [**getOauthProfileClientAuthorizationParameters**](docs/AllApi.md#getOauthProfileClientAuthorizationParameters) | **GET** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters | Get a list of Authorization Parameter objects. -*AllApi* | [**getOauthProfileClientRequiredClaim**](docs/AllApi.md#getOauthProfileClientRequiredClaim) | **GET** /oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Get a Required Claim object. -*AllApi* | [**getOauthProfileClientRequiredClaims**](docs/AllApi.md#getOauthProfileClientRequiredClaims) | **GET** /oauthProfiles/{oauthProfileName}/clientRequiredClaims | Get a list of Required Claim objects. -*AllApi* | [**getOauthProfileDefaultMsgVpnAccessLevelException**](docs/AllApi.md#getOauthProfileDefaultMsgVpnAccessLevelException) | **GET** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName} | Get a Message VPN Access-Level Exception object. -*AllApi* | [**getOauthProfileDefaultMsgVpnAccessLevelExceptions**](docs/AllApi.md#getOauthProfileDefaultMsgVpnAccessLevelExceptions) | **GET** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions | Get a list of Message VPN Access-Level Exception objects. -*AllApi* | [**getOauthProfileResourceServerRequiredClaim**](docs/AllApi.md#getOauthProfileResourceServerRequiredClaim) | **GET** /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Get a Required Claim object. -*AllApi* | [**getOauthProfileResourceServerRequiredClaims**](docs/AllApi.md#getOauthProfileResourceServerRequiredClaims) | **GET** /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Get a list of Required Claim objects. -*AllApi* | [**getOauthProfiles**](docs/AllApi.md#getOauthProfiles) | **GET** /oauthProfiles | Get a list of OAuth Profile objects. -*AllApi* | [**getSystemInformation**](docs/AllApi.md#getSystemInformation) | **GET** /systemInformation | Get a System Information object. -*AllApi* | [**getVirtualHostname**](docs/AllApi.md#getVirtualHostname) | **GET** /virtualHostnames/{virtualHostname} | Get a Virtual Hostname object. -*AllApi* | [**getVirtualHostnames**](docs/AllApi.md#getVirtualHostnames) | **GET** /virtualHostnames | Get a list of Virtual Hostname objects. -*AllApi* | [**replaceCertAuthority**](docs/AllApi.md#replaceCertAuthority) | **PUT** /certAuthorities/{certAuthorityName} | Replace a Certificate Authority object. -*AllApi* | [**replaceClientCertAuthority**](docs/AllApi.md#replaceClientCertAuthority) | **PUT** /clientCertAuthorities/{certAuthorityName} | Replace a Client Certificate Authority object. -*AllApi* | [**replaceDmrCluster**](docs/AllApi.md#replaceDmrCluster) | **PUT** /dmrClusters/{dmrClusterName} | Replace a Cluster object. -*AllApi* | [**replaceDmrClusterCertMatchingRule**](docs/AllApi.md#replaceDmrClusterCertMatchingRule) | **PUT** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName} | Replace a Certificate Matching Rule object. -*AllApi* | [**replaceDmrClusterCertMatchingRuleAttributeFilter**](docs/AllApi.md#replaceDmrClusterCertMatchingRuleAttributeFilter) | **PUT** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Replace a Certificate Matching Rule Attribute Filter object. -*AllApi* | [**replaceDmrClusterLink**](docs/AllApi.md#replaceDmrClusterLink) | **PUT** /dmrClusters/{dmrClusterName}/links/{remoteNodeName} | Replace a Link object. -*AllApi* | [**replaceDomainCertAuthority**](docs/AllApi.md#replaceDomainCertAuthority) | **PUT** /domainCertAuthorities/{certAuthorityName} | Replace a Domain Certificate Authority object. -*AllApi* | [**replaceMsgVpn**](docs/AllApi.md#replaceMsgVpn) | **PUT** /msgVpns/{msgVpnName} | Replace a Message VPN object. -*AllApi* | [**replaceMsgVpnAclProfile**](docs/AllApi.md#replaceMsgVpnAclProfile) | **PUT** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Replace an ACL Profile object. -*AllApi* | [**replaceMsgVpnAuthenticationOauthProfile**](docs/AllApi.md#replaceMsgVpnAuthenticationOauthProfile) | **PUT** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Replace an OAuth Profile object. -*AllApi* | [**replaceMsgVpnAuthenticationOauthProvider**](docs/AllApi.md#replaceMsgVpnAuthenticationOauthProvider) | **PUT** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Replace an OAuth Provider object. -*AllApi* | [**replaceMsgVpnAuthorizationGroup**](docs/AllApi.md#replaceMsgVpnAuthorizationGroup) | **PUT** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Replace an Authorization Group object. -*AllApi* | [**replaceMsgVpnBridge**](docs/AllApi.md#replaceMsgVpnBridge) | **PUT** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Replace a Bridge object. -*AllApi* | [**replaceMsgVpnBridgeRemoteMsgVpn**](docs/AllApi.md#replaceMsgVpnBridgeRemoteMsgVpn) | **PUT** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Replace a Remote Message VPN object. -*AllApi* | [**replaceMsgVpnCertMatchingRule**](docs/AllApi.md#replaceMsgVpnCertMatchingRule) | **PUT** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Replace a Certificate Matching Rule object. -*AllApi* | [**replaceMsgVpnCertMatchingRuleAttributeFilter**](docs/AllApi.md#replaceMsgVpnCertMatchingRuleAttributeFilter) | **PUT** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Replace a Certificate Matching Rule Attribute Filter object. -*AllApi* | [**replaceMsgVpnClientProfile**](docs/AllApi.md#replaceMsgVpnClientProfile) | **PUT** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Replace a Client Profile object. -*AllApi* | [**replaceMsgVpnClientUsername**](docs/AllApi.md#replaceMsgVpnClientUsername) | **PUT** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Replace a Client Username object. -*AllApi* | [**replaceMsgVpnDistributedCache**](docs/AllApi.md#replaceMsgVpnDistributedCache) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Replace a Distributed Cache object. -*AllApi* | [**replaceMsgVpnDistributedCacheCluster**](docs/AllApi.md#replaceMsgVpnDistributedCacheCluster) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Replace a Cache Cluster object. -*AllApi* | [**replaceMsgVpnDistributedCacheClusterInstance**](docs/AllApi.md#replaceMsgVpnDistributedCacheClusterInstance) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Replace a Cache Instance object. -*AllApi* | [**replaceMsgVpnDmrBridge**](docs/AllApi.md#replaceMsgVpnDmrBridge) | **PUT** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Replace a DMR Bridge object. -*AllApi* | [**replaceMsgVpnJndiConnectionFactory**](docs/AllApi.md#replaceMsgVpnJndiConnectionFactory) | **PUT** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Replace a JNDI Connection Factory object. -*AllApi* | [**replaceMsgVpnJndiQueue**](docs/AllApi.md#replaceMsgVpnJndiQueue) | **PUT** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Replace a JNDI Queue object. -*AllApi* | [**replaceMsgVpnJndiTopic**](docs/AllApi.md#replaceMsgVpnJndiTopic) | **PUT** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Replace a JNDI Topic object. -*AllApi* | [**replaceMsgVpnMqttRetainCache**](docs/AllApi.md#replaceMsgVpnMqttRetainCache) | **PUT** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Replace an MQTT Retain Cache object. -*AllApi* | [**replaceMsgVpnMqttSession**](docs/AllApi.md#replaceMsgVpnMqttSession) | **PUT** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Replace an MQTT Session object. -*AllApi* | [**replaceMsgVpnMqttSessionSubscription**](docs/AllApi.md#replaceMsgVpnMqttSessionSubscription) | **PUT** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Replace a Subscription object. -*AllApi* | [**replaceMsgVpnQueue**](docs/AllApi.md#replaceMsgVpnQueue) | **PUT** /msgVpns/{msgVpnName}/queues/{queueName} | Replace a Queue object. -*AllApi* | [**replaceMsgVpnQueueTemplate**](docs/AllApi.md#replaceMsgVpnQueueTemplate) | **PUT** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Replace a Queue Template object. -*AllApi* | [**replaceMsgVpnReplayLog**](docs/AllApi.md#replaceMsgVpnReplayLog) | **PUT** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Replace a Replay Log object. -*AllApi* | [**replaceMsgVpnReplicatedTopic**](docs/AllApi.md#replaceMsgVpnReplicatedTopic) | **PUT** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Replace a Replicated Topic object. -*AllApi* | [**replaceMsgVpnRestDeliveryPoint**](docs/AllApi.md#replaceMsgVpnRestDeliveryPoint) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Replace a REST Delivery Point object. -*AllApi* | [**replaceMsgVpnRestDeliveryPointQueueBinding**](docs/AllApi.md#replaceMsgVpnRestDeliveryPointQueueBinding) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Replace a Queue Binding object. -*AllApi* | [**replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader**](docs/AllApi.md#replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Replace a Request Header object. -*AllApi* | [**replaceMsgVpnRestDeliveryPointRestConsumer**](docs/AllApi.md#replaceMsgVpnRestDeliveryPointRestConsumer) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Replace a REST Consumer object. -*AllApi* | [**replaceMsgVpnTopicEndpoint**](docs/AllApi.md#replaceMsgVpnTopicEndpoint) | **PUT** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Replace a Topic Endpoint object. -*AllApi* | [**replaceMsgVpnTopicEndpointTemplate**](docs/AllApi.md#replaceMsgVpnTopicEndpointTemplate) | **PUT** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Replace a Topic Endpoint Template object. -*AllApi* | [**replaceOauthProfile**](docs/AllApi.md#replaceOauthProfile) | **PUT** /oauthProfiles/{oauthProfileName} | Replace an OAuth Profile object. -*AllApi* | [**replaceOauthProfileAccessLevelGroup**](docs/AllApi.md#replaceOauthProfileAccessLevelGroup) | **PUT** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName} | Replace a Group Access Level object. -*AllApi* | [**replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](docs/AllApi.md#replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **PUT** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName} | Replace a Message VPN Access-Level Exception object. -*AllApi* | [**replaceOauthProfileClientAuthorizationParameter**](docs/AllApi.md#replaceOauthProfileClientAuthorizationParameter) | **PUT** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName} | Replace an Authorization Parameter object. -*AllApi* | [**replaceOauthProfileDefaultMsgVpnAccessLevelException**](docs/AllApi.md#replaceOauthProfileDefaultMsgVpnAccessLevelException) | **PUT** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName} | Replace a Message VPN Access-Level Exception object. -*AllApi* | [**replaceVirtualHostname**](docs/AllApi.md#replaceVirtualHostname) | **PUT** /virtualHostnames/{virtualHostname} | Replace a Virtual Hostname object. -*AllApi* | [**updateBroker**](docs/AllApi.md#updateBroker) | **PATCH** / | Update a Broker object. -*AllApi* | [**updateCertAuthority**](docs/AllApi.md#updateCertAuthority) | **PATCH** /certAuthorities/{certAuthorityName} | Update a Certificate Authority object. -*AllApi* | [**updateClientCertAuthority**](docs/AllApi.md#updateClientCertAuthority) | **PATCH** /clientCertAuthorities/{certAuthorityName} | Update a Client Certificate Authority object. -*AllApi* | [**updateDmrCluster**](docs/AllApi.md#updateDmrCluster) | **PATCH** /dmrClusters/{dmrClusterName} | Update a Cluster object. -*AllApi* | [**updateDmrClusterCertMatchingRule**](docs/AllApi.md#updateDmrClusterCertMatchingRule) | **PATCH** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName} | Update a Certificate Matching Rule object. -*AllApi* | [**updateDmrClusterCertMatchingRuleAttributeFilter**](docs/AllApi.md#updateDmrClusterCertMatchingRuleAttributeFilter) | **PATCH** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Update a Certificate Matching Rule Attribute Filter object. -*AllApi* | [**updateDmrClusterLink**](docs/AllApi.md#updateDmrClusterLink) | **PATCH** /dmrClusters/{dmrClusterName}/links/{remoteNodeName} | Update a Link object. -*AllApi* | [**updateDomainCertAuthority**](docs/AllApi.md#updateDomainCertAuthority) | **PATCH** /domainCertAuthorities/{certAuthorityName} | Update a Domain Certificate Authority object. -*AllApi* | [**updateMsgVpn**](docs/AllApi.md#updateMsgVpn) | **PATCH** /msgVpns/{msgVpnName} | Update a Message VPN object. -*AllApi* | [**updateMsgVpnAclProfile**](docs/AllApi.md#updateMsgVpnAclProfile) | **PATCH** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Update an ACL Profile object. -*AllApi* | [**updateMsgVpnAuthenticationOauthProfile**](docs/AllApi.md#updateMsgVpnAuthenticationOauthProfile) | **PATCH** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Update an OAuth Profile object. -*AllApi* | [**updateMsgVpnAuthenticationOauthProvider**](docs/AllApi.md#updateMsgVpnAuthenticationOauthProvider) | **PATCH** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Update an OAuth Provider object. -*AllApi* | [**updateMsgVpnAuthorizationGroup**](docs/AllApi.md#updateMsgVpnAuthorizationGroup) | **PATCH** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Update an Authorization Group object. -*AllApi* | [**updateMsgVpnBridge**](docs/AllApi.md#updateMsgVpnBridge) | **PATCH** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Update a Bridge object. -*AllApi* | [**updateMsgVpnBridgeRemoteMsgVpn**](docs/AllApi.md#updateMsgVpnBridgeRemoteMsgVpn) | **PATCH** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Update a Remote Message VPN object. -*AllApi* | [**updateMsgVpnCertMatchingRule**](docs/AllApi.md#updateMsgVpnCertMatchingRule) | **PATCH** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Update a Certificate Matching Rule object. -*AllApi* | [**updateMsgVpnCertMatchingRuleAttributeFilter**](docs/AllApi.md#updateMsgVpnCertMatchingRuleAttributeFilter) | **PATCH** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Update a Certificate Matching Rule Attribute Filter object. -*AllApi* | [**updateMsgVpnClientProfile**](docs/AllApi.md#updateMsgVpnClientProfile) | **PATCH** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Update a Client Profile object. -*AllApi* | [**updateMsgVpnClientUsername**](docs/AllApi.md#updateMsgVpnClientUsername) | **PATCH** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Update a Client Username object. -*AllApi* | [**updateMsgVpnDistributedCache**](docs/AllApi.md#updateMsgVpnDistributedCache) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Update a Distributed Cache object. -*AllApi* | [**updateMsgVpnDistributedCacheCluster**](docs/AllApi.md#updateMsgVpnDistributedCacheCluster) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Update a Cache Cluster object. -*AllApi* | [**updateMsgVpnDistributedCacheClusterInstance**](docs/AllApi.md#updateMsgVpnDistributedCacheClusterInstance) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Update a Cache Instance object. -*AllApi* | [**updateMsgVpnDmrBridge**](docs/AllApi.md#updateMsgVpnDmrBridge) | **PATCH** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Update a DMR Bridge object. -*AllApi* | [**updateMsgVpnJndiConnectionFactory**](docs/AllApi.md#updateMsgVpnJndiConnectionFactory) | **PATCH** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Update a JNDI Connection Factory object. -*AllApi* | [**updateMsgVpnJndiQueue**](docs/AllApi.md#updateMsgVpnJndiQueue) | **PATCH** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Update a JNDI Queue object. -*AllApi* | [**updateMsgVpnJndiTopic**](docs/AllApi.md#updateMsgVpnJndiTopic) | **PATCH** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Update a JNDI Topic object. -*AllApi* | [**updateMsgVpnMqttRetainCache**](docs/AllApi.md#updateMsgVpnMqttRetainCache) | **PATCH** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Update an MQTT Retain Cache object. -*AllApi* | [**updateMsgVpnMqttSession**](docs/AllApi.md#updateMsgVpnMqttSession) | **PATCH** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Update an MQTT Session object. -*AllApi* | [**updateMsgVpnMqttSessionSubscription**](docs/AllApi.md#updateMsgVpnMqttSessionSubscription) | **PATCH** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Update a Subscription object. -*AllApi* | [**updateMsgVpnQueue**](docs/AllApi.md#updateMsgVpnQueue) | **PATCH** /msgVpns/{msgVpnName}/queues/{queueName} | Update a Queue object. -*AllApi* | [**updateMsgVpnQueueTemplate**](docs/AllApi.md#updateMsgVpnQueueTemplate) | **PATCH** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Update a Queue Template object. -*AllApi* | [**updateMsgVpnReplayLog**](docs/AllApi.md#updateMsgVpnReplayLog) | **PATCH** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Update a Replay Log object. -*AllApi* | [**updateMsgVpnReplicatedTopic**](docs/AllApi.md#updateMsgVpnReplicatedTopic) | **PATCH** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Update a Replicated Topic object. -*AllApi* | [**updateMsgVpnRestDeliveryPoint**](docs/AllApi.md#updateMsgVpnRestDeliveryPoint) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Update a REST Delivery Point object. -*AllApi* | [**updateMsgVpnRestDeliveryPointQueueBinding**](docs/AllApi.md#updateMsgVpnRestDeliveryPointQueueBinding) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Update a Queue Binding object. -*AllApi* | [**updateMsgVpnRestDeliveryPointQueueBindingRequestHeader**](docs/AllApi.md#updateMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Update a Request Header object. -*AllApi* | [**updateMsgVpnRestDeliveryPointRestConsumer**](docs/AllApi.md#updateMsgVpnRestDeliveryPointRestConsumer) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Update a REST Consumer object. -*AllApi* | [**updateMsgVpnTopicEndpoint**](docs/AllApi.md#updateMsgVpnTopicEndpoint) | **PATCH** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Update a Topic Endpoint object. -*AllApi* | [**updateMsgVpnTopicEndpointTemplate**](docs/AllApi.md#updateMsgVpnTopicEndpointTemplate) | **PATCH** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Update a Topic Endpoint Template object. -*AllApi* | [**updateOauthProfile**](docs/AllApi.md#updateOauthProfile) | **PATCH** /oauthProfiles/{oauthProfileName} | Update an OAuth Profile object. -*AllApi* | [**updateOauthProfileAccessLevelGroup**](docs/AllApi.md#updateOauthProfileAccessLevelGroup) | **PATCH** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName} | Update a Group Access Level object. -*AllApi* | [**updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](docs/AllApi.md#updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **PATCH** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName} | Update a Message VPN Access-Level Exception object. -*AllApi* | [**updateOauthProfileClientAuthorizationParameter**](docs/AllApi.md#updateOauthProfileClientAuthorizationParameter) | **PATCH** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName} | Update an Authorization Parameter object. -*AllApi* | [**updateOauthProfileDefaultMsgVpnAccessLevelException**](docs/AllApi.md#updateOauthProfileDefaultMsgVpnAccessLevelException) | **PATCH** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName} | Update a Message VPN Access-Level Exception object. -*AllApi* | [**updateVirtualHostname**](docs/AllApi.md#updateVirtualHostname) | **PATCH** /virtualHostnames/{virtualHostname} | Update a Virtual Hostname object. -*AuthenticationOauthProfileApi* | [**createMsgVpnAuthenticationOauthProfile**](docs/AuthenticationOauthProfileApi.md#createMsgVpnAuthenticationOauthProfile) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles | Create an OAuth Profile object. -*AuthenticationOauthProfileApi* | [**createMsgVpnAuthenticationOauthProfileClientRequiredClaim**](docs/AuthenticationOauthProfileApi.md#createMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims | Create a Required Claim object. -*AuthenticationOauthProfileApi* | [**createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](docs/AuthenticationOauthProfileApi.md#createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Create a Required Claim object. -*AuthenticationOauthProfileApi* | [**deleteMsgVpnAuthenticationOauthProfile**](docs/AuthenticationOauthProfileApi.md#deleteMsgVpnAuthenticationOauthProfile) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Delete an OAuth Profile object. -*AuthenticationOauthProfileApi* | [**deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim**](docs/AuthenticationOauthProfileApi.md#deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Delete a Required Claim object. -*AuthenticationOauthProfileApi* | [**deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](docs/AuthenticationOauthProfileApi.md#deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Delete a Required Claim object. -*AuthenticationOauthProfileApi* | [**getMsgVpnAuthenticationOauthProfile**](docs/AuthenticationOauthProfileApi.md#getMsgVpnAuthenticationOauthProfile) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Get an OAuth Profile object. -*AuthenticationOauthProfileApi* | [**getMsgVpnAuthenticationOauthProfileClientRequiredClaim**](docs/AuthenticationOauthProfileApi.md#getMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Get a Required Claim object. -*AuthenticationOauthProfileApi* | [**getMsgVpnAuthenticationOauthProfileClientRequiredClaims**](docs/AuthenticationOauthProfileApi.md#getMsgVpnAuthenticationOauthProfileClientRequiredClaims) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims | Get a list of Required Claim objects. -*AuthenticationOauthProfileApi* | [**getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](docs/AuthenticationOauthProfileApi.md#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Get a Required Claim object. -*AuthenticationOauthProfileApi* | [**getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims**](docs/AuthenticationOauthProfileApi.md#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Get a list of Required Claim objects. -*AuthenticationOauthProfileApi* | [**getMsgVpnAuthenticationOauthProfiles**](docs/AuthenticationOauthProfileApi.md#getMsgVpnAuthenticationOauthProfiles) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles | Get a list of OAuth Profile objects. -*AuthenticationOauthProfileApi* | [**replaceMsgVpnAuthenticationOauthProfile**](docs/AuthenticationOauthProfileApi.md#replaceMsgVpnAuthenticationOauthProfile) | **PUT** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Replace an OAuth Profile object. -*AuthenticationOauthProfileApi* | [**updateMsgVpnAuthenticationOauthProfile**](docs/AuthenticationOauthProfileApi.md#updateMsgVpnAuthenticationOauthProfile) | **PATCH** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Update an OAuth Profile object. -*AuthenticationOauthProviderApi* | [**createMsgVpnAuthenticationOauthProvider**](docs/AuthenticationOauthProviderApi.md#createMsgVpnAuthenticationOauthProvider) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProviders | Create an OAuth Provider object. -*AuthenticationOauthProviderApi* | [**deleteMsgVpnAuthenticationOauthProvider**](docs/AuthenticationOauthProviderApi.md#deleteMsgVpnAuthenticationOauthProvider) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Delete an OAuth Provider object. -*AuthenticationOauthProviderApi* | [**getMsgVpnAuthenticationOauthProvider**](docs/AuthenticationOauthProviderApi.md#getMsgVpnAuthenticationOauthProvider) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Get an OAuth Provider object. -*AuthenticationOauthProviderApi* | [**getMsgVpnAuthenticationOauthProviders**](docs/AuthenticationOauthProviderApi.md#getMsgVpnAuthenticationOauthProviders) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProviders | Get a list of OAuth Provider objects. -*AuthenticationOauthProviderApi* | [**replaceMsgVpnAuthenticationOauthProvider**](docs/AuthenticationOauthProviderApi.md#replaceMsgVpnAuthenticationOauthProvider) | **PUT** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Replace an OAuth Provider object. -*AuthenticationOauthProviderApi* | [**updateMsgVpnAuthenticationOauthProvider**](docs/AuthenticationOauthProviderApi.md#updateMsgVpnAuthenticationOauthProvider) | **PATCH** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Update an OAuth Provider object. -*AuthorizationGroupApi* | [**createMsgVpnAuthorizationGroup**](docs/AuthorizationGroupApi.md#createMsgVpnAuthorizationGroup) | **POST** /msgVpns/{msgVpnName}/authorizationGroups | Create an Authorization Group object. -*AuthorizationGroupApi* | [**deleteMsgVpnAuthorizationGroup**](docs/AuthorizationGroupApi.md#deleteMsgVpnAuthorizationGroup) | **DELETE** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Delete an Authorization Group object. -*AuthorizationGroupApi* | [**getMsgVpnAuthorizationGroup**](docs/AuthorizationGroupApi.md#getMsgVpnAuthorizationGroup) | **GET** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Get an Authorization Group object. -*AuthorizationGroupApi* | [**getMsgVpnAuthorizationGroups**](docs/AuthorizationGroupApi.md#getMsgVpnAuthorizationGroups) | **GET** /msgVpns/{msgVpnName}/authorizationGroups | Get a list of Authorization Group objects. -*AuthorizationGroupApi* | [**replaceMsgVpnAuthorizationGroup**](docs/AuthorizationGroupApi.md#replaceMsgVpnAuthorizationGroup) | **PUT** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Replace an Authorization Group object. -*AuthorizationGroupApi* | [**updateMsgVpnAuthorizationGroup**](docs/AuthorizationGroupApi.md#updateMsgVpnAuthorizationGroup) | **PATCH** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Update an Authorization Group object. -*BridgeApi* | [**createMsgVpnBridge**](docs/BridgeApi.md#createMsgVpnBridge) | **POST** /msgVpns/{msgVpnName}/bridges | Create a Bridge object. -*BridgeApi* | [**createMsgVpnBridgeRemoteMsgVpn**](docs/BridgeApi.md#createMsgVpnBridgeRemoteMsgVpn) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns | Create a Remote Message VPN object. -*BridgeApi* | [**createMsgVpnBridgeRemoteSubscription**](docs/BridgeApi.md#createMsgVpnBridgeRemoteSubscription) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions | Create a Remote Subscription object. -*BridgeApi* | [**createMsgVpnBridgeTlsTrustedCommonName**](docs/BridgeApi.md#createMsgVpnBridgeTlsTrustedCommonName) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames | Create a Trusted Common Name object. -*BridgeApi* | [**deleteMsgVpnBridge**](docs/BridgeApi.md#deleteMsgVpnBridge) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Delete a Bridge object. -*BridgeApi* | [**deleteMsgVpnBridgeRemoteMsgVpn**](docs/BridgeApi.md#deleteMsgVpnBridgeRemoteMsgVpn) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Delete a Remote Message VPN object. -*BridgeApi* | [**deleteMsgVpnBridgeRemoteSubscription**](docs/BridgeApi.md#deleteMsgVpnBridgeRemoteSubscription) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic} | Delete a Remote Subscription object. -*BridgeApi* | [**deleteMsgVpnBridgeTlsTrustedCommonName**](docs/BridgeApi.md#deleteMsgVpnBridgeTlsTrustedCommonName) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Delete a Trusted Common Name object. -*BridgeApi* | [**getMsgVpnBridge**](docs/BridgeApi.md#getMsgVpnBridge) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Get a Bridge object. -*BridgeApi* | [**getMsgVpnBridgeRemoteMsgVpn**](docs/BridgeApi.md#getMsgVpnBridgeRemoteMsgVpn) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Get a Remote Message VPN object. -*BridgeApi* | [**getMsgVpnBridgeRemoteMsgVpns**](docs/BridgeApi.md#getMsgVpnBridgeRemoteMsgVpns) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns | Get a list of Remote Message VPN objects. -*BridgeApi* | [**getMsgVpnBridgeRemoteSubscription**](docs/BridgeApi.md#getMsgVpnBridgeRemoteSubscription) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic} | Get a Remote Subscription object. -*BridgeApi* | [**getMsgVpnBridgeRemoteSubscriptions**](docs/BridgeApi.md#getMsgVpnBridgeRemoteSubscriptions) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions | Get a list of Remote Subscription objects. -*BridgeApi* | [**getMsgVpnBridgeTlsTrustedCommonName**](docs/BridgeApi.md#getMsgVpnBridgeTlsTrustedCommonName) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Get a Trusted Common Name object. -*BridgeApi* | [**getMsgVpnBridgeTlsTrustedCommonNames**](docs/BridgeApi.md#getMsgVpnBridgeTlsTrustedCommonNames) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames | Get a list of Trusted Common Name objects. -*BridgeApi* | [**getMsgVpnBridges**](docs/BridgeApi.md#getMsgVpnBridges) | **GET** /msgVpns/{msgVpnName}/bridges | Get a list of Bridge objects. -*BridgeApi* | [**replaceMsgVpnBridge**](docs/BridgeApi.md#replaceMsgVpnBridge) | **PUT** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Replace a Bridge object. -*BridgeApi* | [**replaceMsgVpnBridgeRemoteMsgVpn**](docs/BridgeApi.md#replaceMsgVpnBridgeRemoteMsgVpn) | **PUT** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Replace a Remote Message VPN object. -*BridgeApi* | [**updateMsgVpnBridge**](docs/BridgeApi.md#updateMsgVpnBridge) | **PATCH** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Update a Bridge object. -*BridgeApi* | [**updateMsgVpnBridgeRemoteMsgVpn**](docs/BridgeApi.md#updateMsgVpnBridgeRemoteMsgVpn) | **PATCH** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Update a Remote Message VPN object. -*CertAuthorityApi* | [**createCertAuthority**](docs/CertAuthorityApi.md#createCertAuthority) | **POST** /certAuthorities | Create a Certificate Authority object. -*CertAuthorityApi* | [**createCertAuthorityOcspTlsTrustedCommonName**](docs/CertAuthorityApi.md#createCertAuthorityOcspTlsTrustedCommonName) | **POST** /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames | Create an OCSP Responder Trusted Common Name object. -*CertAuthorityApi* | [**deleteCertAuthority**](docs/CertAuthorityApi.md#deleteCertAuthority) | **DELETE** /certAuthorities/{certAuthorityName} | Delete a Certificate Authority object. -*CertAuthorityApi* | [**deleteCertAuthorityOcspTlsTrustedCommonName**](docs/CertAuthorityApi.md#deleteCertAuthorityOcspTlsTrustedCommonName) | **DELETE** /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName} | Delete an OCSP Responder Trusted Common Name object. -*CertAuthorityApi* | [**getCertAuthorities**](docs/CertAuthorityApi.md#getCertAuthorities) | **GET** /certAuthorities | Get a list of Certificate Authority objects. -*CertAuthorityApi* | [**getCertAuthority**](docs/CertAuthorityApi.md#getCertAuthority) | **GET** /certAuthorities/{certAuthorityName} | Get a Certificate Authority object. -*CertAuthorityApi* | [**getCertAuthorityOcspTlsTrustedCommonName**](docs/CertAuthorityApi.md#getCertAuthorityOcspTlsTrustedCommonName) | **GET** /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName} | Get an OCSP Responder Trusted Common Name object. -*CertAuthorityApi* | [**getCertAuthorityOcspTlsTrustedCommonNames**](docs/CertAuthorityApi.md#getCertAuthorityOcspTlsTrustedCommonNames) | **GET** /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames | Get a list of OCSP Responder Trusted Common Name objects. -*CertAuthorityApi* | [**replaceCertAuthority**](docs/CertAuthorityApi.md#replaceCertAuthority) | **PUT** /certAuthorities/{certAuthorityName} | Replace a Certificate Authority object. -*CertAuthorityApi* | [**updateCertAuthority**](docs/CertAuthorityApi.md#updateCertAuthority) | **PATCH** /certAuthorities/{certAuthorityName} | Update a Certificate Authority object. -*CertMatchingRuleApi* | [**createMsgVpnCertMatchingRule**](docs/CertMatchingRuleApi.md#createMsgVpnCertMatchingRule) | **POST** /msgVpns/{msgVpnName}/certMatchingRules | Create a Certificate Matching Rule object. -*CertMatchingRuleApi* | [**createMsgVpnCertMatchingRuleAttributeFilter**](docs/CertMatchingRuleApi.md#createMsgVpnCertMatchingRuleAttributeFilter) | **POST** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters | Create a Certificate Matching Rule Attribute Filter object. -*CertMatchingRuleApi* | [**createMsgVpnCertMatchingRuleCondition**](docs/CertMatchingRuleApi.md#createMsgVpnCertMatchingRuleCondition) | **POST** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions | Create a Certificate Matching Rule Condition object. -*CertMatchingRuleApi* | [**deleteMsgVpnCertMatchingRule**](docs/CertMatchingRuleApi.md#deleteMsgVpnCertMatchingRule) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Delete a Certificate Matching Rule object. -*CertMatchingRuleApi* | [**deleteMsgVpnCertMatchingRuleAttributeFilter**](docs/CertMatchingRuleApi.md#deleteMsgVpnCertMatchingRuleAttributeFilter) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Delete a Certificate Matching Rule Attribute Filter object. -*CertMatchingRuleApi* | [**deleteMsgVpnCertMatchingRuleCondition**](docs/CertMatchingRuleApi.md#deleteMsgVpnCertMatchingRuleCondition) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source} | Delete a Certificate Matching Rule Condition object. -*CertMatchingRuleApi* | [**getMsgVpnCertMatchingRule**](docs/CertMatchingRuleApi.md#getMsgVpnCertMatchingRule) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Get a Certificate Matching Rule object. -*CertMatchingRuleApi* | [**getMsgVpnCertMatchingRuleAttributeFilter**](docs/CertMatchingRuleApi.md#getMsgVpnCertMatchingRuleAttributeFilter) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Get a Certificate Matching Rule Attribute Filter object. -*CertMatchingRuleApi* | [**getMsgVpnCertMatchingRuleAttributeFilters**](docs/CertMatchingRuleApi.md#getMsgVpnCertMatchingRuleAttributeFilters) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters | Get a list of Certificate Matching Rule Attribute Filter objects. -*CertMatchingRuleApi* | [**getMsgVpnCertMatchingRuleCondition**](docs/CertMatchingRuleApi.md#getMsgVpnCertMatchingRuleCondition) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source} | Get a Certificate Matching Rule Condition object. -*CertMatchingRuleApi* | [**getMsgVpnCertMatchingRuleConditions**](docs/CertMatchingRuleApi.md#getMsgVpnCertMatchingRuleConditions) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions | Get a list of Certificate Matching Rule Condition objects. -*CertMatchingRuleApi* | [**getMsgVpnCertMatchingRules**](docs/CertMatchingRuleApi.md#getMsgVpnCertMatchingRules) | **GET** /msgVpns/{msgVpnName}/certMatchingRules | Get a list of Certificate Matching Rule objects. -*CertMatchingRuleApi* | [**replaceMsgVpnCertMatchingRule**](docs/CertMatchingRuleApi.md#replaceMsgVpnCertMatchingRule) | **PUT** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Replace a Certificate Matching Rule object. -*CertMatchingRuleApi* | [**replaceMsgVpnCertMatchingRuleAttributeFilter**](docs/CertMatchingRuleApi.md#replaceMsgVpnCertMatchingRuleAttributeFilter) | **PUT** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Replace a Certificate Matching Rule Attribute Filter object. -*CertMatchingRuleApi* | [**updateMsgVpnCertMatchingRule**](docs/CertMatchingRuleApi.md#updateMsgVpnCertMatchingRule) | **PATCH** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Update a Certificate Matching Rule object. -*CertMatchingRuleApi* | [**updateMsgVpnCertMatchingRuleAttributeFilter**](docs/CertMatchingRuleApi.md#updateMsgVpnCertMatchingRuleAttributeFilter) | **PATCH** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Update a Certificate Matching Rule Attribute Filter object. -*ClientCertAuthorityApi* | [**createClientCertAuthority**](docs/ClientCertAuthorityApi.md#createClientCertAuthority) | **POST** /clientCertAuthorities | Create a Client Certificate Authority object. -*ClientCertAuthorityApi* | [**createClientCertAuthorityOcspTlsTrustedCommonName**](docs/ClientCertAuthorityApi.md#createClientCertAuthorityOcspTlsTrustedCommonName) | **POST** /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames | Create an OCSP Responder Trusted Common Name object. -*ClientCertAuthorityApi* | [**deleteClientCertAuthority**](docs/ClientCertAuthorityApi.md#deleteClientCertAuthority) | **DELETE** /clientCertAuthorities/{certAuthorityName} | Delete a Client Certificate Authority object. -*ClientCertAuthorityApi* | [**deleteClientCertAuthorityOcspTlsTrustedCommonName**](docs/ClientCertAuthorityApi.md#deleteClientCertAuthorityOcspTlsTrustedCommonName) | **DELETE** /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName} | Delete an OCSP Responder Trusted Common Name object. -*ClientCertAuthorityApi* | [**getClientCertAuthorities**](docs/ClientCertAuthorityApi.md#getClientCertAuthorities) | **GET** /clientCertAuthorities | Get a list of Client Certificate Authority objects. -*ClientCertAuthorityApi* | [**getClientCertAuthority**](docs/ClientCertAuthorityApi.md#getClientCertAuthority) | **GET** /clientCertAuthorities/{certAuthorityName} | Get a Client Certificate Authority object. -*ClientCertAuthorityApi* | [**getClientCertAuthorityOcspTlsTrustedCommonName**](docs/ClientCertAuthorityApi.md#getClientCertAuthorityOcspTlsTrustedCommonName) | **GET** /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName} | Get an OCSP Responder Trusted Common Name object. -*ClientCertAuthorityApi* | [**getClientCertAuthorityOcspTlsTrustedCommonNames**](docs/ClientCertAuthorityApi.md#getClientCertAuthorityOcspTlsTrustedCommonNames) | **GET** /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames | Get a list of OCSP Responder Trusted Common Name objects. -*ClientCertAuthorityApi* | [**replaceClientCertAuthority**](docs/ClientCertAuthorityApi.md#replaceClientCertAuthority) | **PUT** /clientCertAuthorities/{certAuthorityName} | Replace a Client Certificate Authority object. -*ClientCertAuthorityApi* | [**updateClientCertAuthority**](docs/ClientCertAuthorityApi.md#updateClientCertAuthority) | **PATCH** /clientCertAuthorities/{certAuthorityName} | Update a Client Certificate Authority object. -*ClientProfileApi* | [**createMsgVpnClientProfile**](docs/ClientProfileApi.md#createMsgVpnClientProfile) | **POST** /msgVpns/{msgVpnName}/clientProfiles | Create a Client Profile object. -*ClientProfileApi* | [**deleteMsgVpnClientProfile**](docs/ClientProfileApi.md#deleteMsgVpnClientProfile) | **DELETE** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Delete a Client Profile object. -*ClientProfileApi* | [**getMsgVpnClientProfile**](docs/ClientProfileApi.md#getMsgVpnClientProfile) | **GET** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Get a Client Profile object. -*ClientProfileApi* | [**getMsgVpnClientProfiles**](docs/ClientProfileApi.md#getMsgVpnClientProfiles) | **GET** /msgVpns/{msgVpnName}/clientProfiles | Get a list of Client Profile objects. -*ClientProfileApi* | [**replaceMsgVpnClientProfile**](docs/ClientProfileApi.md#replaceMsgVpnClientProfile) | **PUT** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Replace a Client Profile object. -*ClientProfileApi* | [**updateMsgVpnClientProfile**](docs/ClientProfileApi.md#updateMsgVpnClientProfile) | **PATCH** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Update a Client Profile object. -*ClientUsernameApi* | [**createMsgVpnClientUsername**](docs/ClientUsernameApi.md#createMsgVpnClientUsername) | **POST** /msgVpns/{msgVpnName}/clientUsernames | Create a Client Username object. -*ClientUsernameApi* | [**createMsgVpnClientUsernameAttribute**](docs/ClientUsernameApi.md#createMsgVpnClientUsernameAttribute) | **POST** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes | Create a Client Username Attribute object. -*ClientUsernameApi* | [**deleteMsgVpnClientUsername**](docs/ClientUsernameApi.md#deleteMsgVpnClientUsername) | **DELETE** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Delete a Client Username object. -*ClientUsernameApi* | [**deleteMsgVpnClientUsernameAttribute**](docs/ClientUsernameApi.md#deleteMsgVpnClientUsernameAttribute) | **DELETE** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue} | Delete a Client Username Attribute object. -*ClientUsernameApi* | [**getMsgVpnClientUsername**](docs/ClientUsernameApi.md#getMsgVpnClientUsername) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Get a Client Username object. -*ClientUsernameApi* | [**getMsgVpnClientUsernameAttribute**](docs/ClientUsernameApi.md#getMsgVpnClientUsernameAttribute) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue} | Get a Client Username Attribute object. -*ClientUsernameApi* | [**getMsgVpnClientUsernameAttributes**](docs/ClientUsernameApi.md#getMsgVpnClientUsernameAttributes) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes | Get a list of Client Username Attribute objects. -*ClientUsernameApi* | [**getMsgVpnClientUsernames**](docs/ClientUsernameApi.md#getMsgVpnClientUsernames) | **GET** /msgVpns/{msgVpnName}/clientUsernames | Get a list of Client Username objects. -*ClientUsernameApi* | [**replaceMsgVpnClientUsername**](docs/ClientUsernameApi.md#replaceMsgVpnClientUsername) | **PUT** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Replace a Client Username object. -*ClientUsernameApi* | [**updateMsgVpnClientUsername**](docs/ClientUsernameApi.md#updateMsgVpnClientUsername) | **PATCH** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Update a Client Username object. -*DistributedCacheApi* | [**createMsgVpnDistributedCache**](docs/DistributedCacheApi.md#createMsgVpnDistributedCache) | **POST** /msgVpns/{msgVpnName}/distributedCaches | Create a Distributed Cache object. -*DistributedCacheApi* | [**createMsgVpnDistributedCacheCluster**](docs/DistributedCacheApi.md#createMsgVpnDistributedCacheCluster) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters | Create a Cache Cluster object. -*DistributedCacheApi* | [**createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](docs/DistributedCacheApi.md#createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters | Create a Home Cache Cluster object. -*DistributedCacheApi* | [**createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](docs/DistributedCacheApi.md#createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes | Create a Topic Prefix object. -*DistributedCacheApi* | [**createMsgVpnDistributedCacheClusterInstance**](docs/DistributedCacheApi.md#createMsgVpnDistributedCacheClusterInstance) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances | Create a Cache Instance object. -*DistributedCacheApi* | [**createMsgVpnDistributedCacheClusterTopic**](docs/DistributedCacheApi.md#createMsgVpnDistributedCacheClusterTopic) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics | Create a Topic object. -*DistributedCacheApi* | [**deleteMsgVpnDistributedCache**](docs/DistributedCacheApi.md#deleteMsgVpnDistributedCache) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Delete a Distributed Cache object. -*DistributedCacheApi* | [**deleteMsgVpnDistributedCacheCluster**](docs/DistributedCacheApi.md#deleteMsgVpnDistributedCacheCluster) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Delete a Cache Cluster object. -*DistributedCacheApi* | [**deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](docs/DistributedCacheApi.md#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName} | Delete a Home Cache Cluster object. -*DistributedCacheApi* | [**deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](docs/DistributedCacheApi.md#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix} | Delete a Topic Prefix object. -*DistributedCacheApi* | [**deleteMsgVpnDistributedCacheClusterInstance**](docs/DistributedCacheApi.md#deleteMsgVpnDistributedCacheClusterInstance) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Delete a Cache Instance object. -*DistributedCacheApi* | [**deleteMsgVpnDistributedCacheClusterTopic**](docs/DistributedCacheApi.md#deleteMsgVpnDistributedCacheClusterTopic) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic} | Delete a Topic object. -*DistributedCacheApi* | [**getMsgVpnDistributedCache**](docs/DistributedCacheApi.md#getMsgVpnDistributedCache) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Get a Distributed Cache object. -*DistributedCacheApi* | [**getMsgVpnDistributedCacheCluster**](docs/DistributedCacheApi.md#getMsgVpnDistributedCacheCluster) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Get a Cache Cluster object. -*DistributedCacheApi* | [**getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](docs/DistributedCacheApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName} | Get a Home Cache Cluster object. -*DistributedCacheApi* | [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](docs/DistributedCacheApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix} | Get a Topic Prefix object. -*DistributedCacheApi* | [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes**](docs/DistributedCacheApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes | Get a list of Topic Prefix objects. -*DistributedCacheApi* | [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters**](docs/DistributedCacheApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters | Get a list of Home Cache Cluster objects. -*DistributedCacheApi* | [**getMsgVpnDistributedCacheClusterInstance**](docs/DistributedCacheApi.md#getMsgVpnDistributedCacheClusterInstance) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Get a Cache Instance object. -*DistributedCacheApi* | [**getMsgVpnDistributedCacheClusterInstances**](docs/DistributedCacheApi.md#getMsgVpnDistributedCacheClusterInstances) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances | Get a list of Cache Instance objects. -*DistributedCacheApi* | [**getMsgVpnDistributedCacheClusterTopic**](docs/DistributedCacheApi.md#getMsgVpnDistributedCacheClusterTopic) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic} | Get a Topic object. -*DistributedCacheApi* | [**getMsgVpnDistributedCacheClusterTopics**](docs/DistributedCacheApi.md#getMsgVpnDistributedCacheClusterTopics) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics | Get a list of Topic objects. -*DistributedCacheApi* | [**getMsgVpnDistributedCacheClusters**](docs/DistributedCacheApi.md#getMsgVpnDistributedCacheClusters) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters | Get a list of Cache Cluster objects. -*DistributedCacheApi* | [**getMsgVpnDistributedCaches**](docs/DistributedCacheApi.md#getMsgVpnDistributedCaches) | **GET** /msgVpns/{msgVpnName}/distributedCaches | Get a list of Distributed Cache objects. -*DistributedCacheApi* | [**replaceMsgVpnDistributedCache**](docs/DistributedCacheApi.md#replaceMsgVpnDistributedCache) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Replace a Distributed Cache object. -*DistributedCacheApi* | [**replaceMsgVpnDistributedCacheCluster**](docs/DistributedCacheApi.md#replaceMsgVpnDistributedCacheCluster) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Replace a Cache Cluster object. -*DistributedCacheApi* | [**replaceMsgVpnDistributedCacheClusterInstance**](docs/DistributedCacheApi.md#replaceMsgVpnDistributedCacheClusterInstance) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Replace a Cache Instance object. -*DistributedCacheApi* | [**updateMsgVpnDistributedCache**](docs/DistributedCacheApi.md#updateMsgVpnDistributedCache) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Update a Distributed Cache object. -*DistributedCacheApi* | [**updateMsgVpnDistributedCacheCluster**](docs/DistributedCacheApi.md#updateMsgVpnDistributedCacheCluster) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Update a Cache Cluster object. -*DistributedCacheApi* | [**updateMsgVpnDistributedCacheClusterInstance**](docs/DistributedCacheApi.md#updateMsgVpnDistributedCacheClusterInstance) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Update a Cache Instance object. -*DmrBridgeApi* | [**createMsgVpnDmrBridge**](docs/DmrBridgeApi.md#createMsgVpnDmrBridge) | **POST** /msgVpns/{msgVpnName}/dmrBridges | Create a DMR Bridge object. -*DmrBridgeApi* | [**deleteMsgVpnDmrBridge**](docs/DmrBridgeApi.md#deleteMsgVpnDmrBridge) | **DELETE** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Delete a DMR Bridge object. -*DmrBridgeApi* | [**getMsgVpnDmrBridge**](docs/DmrBridgeApi.md#getMsgVpnDmrBridge) | **GET** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Get a DMR Bridge object. -*DmrBridgeApi* | [**getMsgVpnDmrBridges**](docs/DmrBridgeApi.md#getMsgVpnDmrBridges) | **GET** /msgVpns/{msgVpnName}/dmrBridges | Get a list of DMR Bridge objects. -*DmrBridgeApi* | [**replaceMsgVpnDmrBridge**](docs/DmrBridgeApi.md#replaceMsgVpnDmrBridge) | **PUT** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Replace a DMR Bridge object. -*DmrBridgeApi* | [**updateMsgVpnDmrBridge**](docs/DmrBridgeApi.md#updateMsgVpnDmrBridge) | **PATCH** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Update a DMR Bridge object. -*DmrClusterApi* | [**createDmrCluster**](docs/DmrClusterApi.md#createDmrCluster) | **POST** /dmrClusters | Create a Cluster object. -*DmrClusterApi* | [**createDmrClusterCertMatchingRule**](docs/DmrClusterApi.md#createDmrClusterCertMatchingRule) | **POST** /dmrClusters/{dmrClusterName}/certMatchingRules | Create a Certificate Matching Rule object. -*DmrClusterApi* | [**createDmrClusterCertMatchingRuleAttributeFilter**](docs/DmrClusterApi.md#createDmrClusterCertMatchingRuleAttributeFilter) | **POST** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters | Create a Certificate Matching Rule Attribute Filter object. -*DmrClusterApi* | [**createDmrClusterCertMatchingRuleCondition**](docs/DmrClusterApi.md#createDmrClusterCertMatchingRuleCondition) | **POST** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions | Create a Certificate Matching Rule Condition object. -*DmrClusterApi* | [**createDmrClusterLink**](docs/DmrClusterApi.md#createDmrClusterLink) | **POST** /dmrClusters/{dmrClusterName}/links | Create a Link object. -*DmrClusterApi* | [**createDmrClusterLinkAttribute**](docs/DmrClusterApi.md#createDmrClusterLinkAttribute) | **POST** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes | Create a Link Attribute object. -*DmrClusterApi* | [**createDmrClusterLinkRemoteAddress**](docs/DmrClusterApi.md#createDmrClusterLinkRemoteAddress) | **POST** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses | Create a Remote Address object. -*DmrClusterApi* | [**createDmrClusterLinkTlsTrustedCommonName**](docs/DmrClusterApi.md#createDmrClusterLinkTlsTrustedCommonName) | **POST** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames | Create a Trusted Common Name object. -*DmrClusterApi* | [**deleteDmrCluster**](docs/DmrClusterApi.md#deleteDmrCluster) | **DELETE** /dmrClusters/{dmrClusterName} | Delete a Cluster object. -*DmrClusterApi* | [**deleteDmrClusterCertMatchingRule**](docs/DmrClusterApi.md#deleteDmrClusterCertMatchingRule) | **DELETE** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName} | Delete a Certificate Matching Rule object. -*DmrClusterApi* | [**deleteDmrClusterCertMatchingRuleAttributeFilter**](docs/DmrClusterApi.md#deleteDmrClusterCertMatchingRuleAttributeFilter) | **DELETE** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Delete a Certificate Matching Rule Attribute Filter object. -*DmrClusterApi* | [**deleteDmrClusterCertMatchingRuleCondition**](docs/DmrClusterApi.md#deleteDmrClusterCertMatchingRuleCondition) | **DELETE** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source} | Delete a Certificate Matching Rule Condition object. -*DmrClusterApi* | [**deleteDmrClusterLink**](docs/DmrClusterApi.md#deleteDmrClusterLink) | **DELETE** /dmrClusters/{dmrClusterName}/links/{remoteNodeName} | Delete a Link object. -*DmrClusterApi* | [**deleteDmrClusterLinkAttribute**](docs/DmrClusterApi.md#deleteDmrClusterLinkAttribute) | **DELETE** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue} | Delete a Link Attribute object. -*DmrClusterApi* | [**deleteDmrClusterLinkRemoteAddress**](docs/DmrClusterApi.md#deleteDmrClusterLinkRemoteAddress) | **DELETE** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress} | Delete a Remote Address object. -*DmrClusterApi* | [**deleteDmrClusterLinkTlsTrustedCommonName**](docs/DmrClusterApi.md#deleteDmrClusterLinkTlsTrustedCommonName) | **DELETE** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Delete a Trusted Common Name object. -*DmrClusterApi* | [**getDmrCluster**](docs/DmrClusterApi.md#getDmrCluster) | **GET** /dmrClusters/{dmrClusterName} | Get a Cluster object. -*DmrClusterApi* | [**getDmrClusterCertMatchingRule**](docs/DmrClusterApi.md#getDmrClusterCertMatchingRule) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName} | Get a Certificate Matching Rule object. -*DmrClusterApi* | [**getDmrClusterCertMatchingRuleAttributeFilter**](docs/DmrClusterApi.md#getDmrClusterCertMatchingRuleAttributeFilter) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Get a Certificate Matching Rule Attribute Filter object. -*DmrClusterApi* | [**getDmrClusterCertMatchingRuleAttributeFilters**](docs/DmrClusterApi.md#getDmrClusterCertMatchingRuleAttributeFilters) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters | Get a list of Certificate Matching Rule Attribute Filter objects. -*DmrClusterApi* | [**getDmrClusterCertMatchingRuleCondition**](docs/DmrClusterApi.md#getDmrClusterCertMatchingRuleCondition) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source} | Get a Certificate Matching Rule Condition object. -*DmrClusterApi* | [**getDmrClusterCertMatchingRuleConditions**](docs/DmrClusterApi.md#getDmrClusterCertMatchingRuleConditions) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions | Get a list of Certificate Matching Rule Condition objects. -*DmrClusterApi* | [**getDmrClusterCertMatchingRules**](docs/DmrClusterApi.md#getDmrClusterCertMatchingRules) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules | Get a list of Certificate Matching Rule objects. -*DmrClusterApi* | [**getDmrClusterLink**](docs/DmrClusterApi.md#getDmrClusterLink) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName} | Get a Link object. -*DmrClusterApi* | [**getDmrClusterLinkAttribute**](docs/DmrClusterApi.md#getDmrClusterLinkAttribute) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue} | Get a Link Attribute object. -*DmrClusterApi* | [**getDmrClusterLinkAttributes**](docs/DmrClusterApi.md#getDmrClusterLinkAttributes) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes | Get a list of Link Attribute objects. -*DmrClusterApi* | [**getDmrClusterLinkRemoteAddress**](docs/DmrClusterApi.md#getDmrClusterLinkRemoteAddress) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress} | Get a Remote Address object. -*DmrClusterApi* | [**getDmrClusterLinkRemoteAddresses**](docs/DmrClusterApi.md#getDmrClusterLinkRemoteAddresses) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses | Get a list of Remote Address objects. -*DmrClusterApi* | [**getDmrClusterLinkTlsTrustedCommonName**](docs/DmrClusterApi.md#getDmrClusterLinkTlsTrustedCommonName) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Get a Trusted Common Name object. -*DmrClusterApi* | [**getDmrClusterLinkTlsTrustedCommonNames**](docs/DmrClusterApi.md#getDmrClusterLinkTlsTrustedCommonNames) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames | Get a list of Trusted Common Name objects. -*DmrClusterApi* | [**getDmrClusterLinks**](docs/DmrClusterApi.md#getDmrClusterLinks) | **GET** /dmrClusters/{dmrClusterName}/links | Get a list of Link objects. -*DmrClusterApi* | [**getDmrClusters**](docs/DmrClusterApi.md#getDmrClusters) | **GET** /dmrClusters | Get a list of Cluster objects. -*DmrClusterApi* | [**replaceDmrCluster**](docs/DmrClusterApi.md#replaceDmrCluster) | **PUT** /dmrClusters/{dmrClusterName} | Replace a Cluster object. -*DmrClusterApi* | [**replaceDmrClusterCertMatchingRule**](docs/DmrClusterApi.md#replaceDmrClusterCertMatchingRule) | **PUT** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName} | Replace a Certificate Matching Rule object. -*DmrClusterApi* | [**replaceDmrClusterCertMatchingRuleAttributeFilter**](docs/DmrClusterApi.md#replaceDmrClusterCertMatchingRuleAttributeFilter) | **PUT** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Replace a Certificate Matching Rule Attribute Filter object. -*DmrClusterApi* | [**replaceDmrClusterLink**](docs/DmrClusterApi.md#replaceDmrClusterLink) | **PUT** /dmrClusters/{dmrClusterName}/links/{remoteNodeName} | Replace a Link object. -*DmrClusterApi* | [**updateDmrCluster**](docs/DmrClusterApi.md#updateDmrCluster) | **PATCH** /dmrClusters/{dmrClusterName} | Update a Cluster object. -*DmrClusterApi* | [**updateDmrClusterCertMatchingRule**](docs/DmrClusterApi.md#updateDmrClusterCertMatchingRule) | **PATCH** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName} | Update a Certificate Matching Rule object. -*DmrClusterApi* | [**updateDmrClusterCertMatchingRuleAttributeFilter**](docs/DmrClusterApi.md#updateDmrClusterCertMatchingRuleAttributeFilter) | **PATCH** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Update a Certificate Matching Rule Attribute Filter object. -*DmrClusterApi* | [**updateDmrClusterLink**](docs/DmrClusterApi.md#updateDmrClusterLink) | **PATCH** /dmrClusters/{dmrClusterName}/links/{remoteNodeName} | Update a Link object. -*DomainCertAuthorityApi* | [**createDomainCertAuthority**](docs/DomainCertAuthorityApi.md#createDomainCertAuthority) | **POST** /domainCertAuthorities | Create a Domain Certificate Authority object. -*DomainCertAuthorityApi* | [**deleteDomainCertAuthority**](docs/DomainCertAuthorityApi.md#deleteDomainCertAuthority) | **DELETE** /domainCertAuthorities/{certAuthorityName} | Delete a Domain Certificate Authority object. -*DomainCertAuthorityApi* | [**getDomainCertAuthorities**](docs/DomainCertAuthorityApi.md#getDomainCertAuthorities) | **GET** /domainCertAuthorities | Get a list of Domain Certificate Authority objects. -*DomainCertAuthorityApi* | [**getDomainCertAuthority**](docs/DomainCertAuthorityApi.md#getDomainCertAuthority) | **GET** /domainCertAuthorities/{certAuthorityName} | Get a Domain Certificate Authority object. -*DomainCertAuthorityApi* | [**replaceDomainCertAuthority**](docs/DomainCertAuthorityApi.md#replaceDomainCertAuthority) | **PUT** /domainCertAuthorities/{certAuthorityName} | Replace a Domain Certificate Authority object. -*DomainCertAuthorityApi* | [**updateDomainCertAuthority**](docs/DomainCertAuthorityApi.md#updateDomainCertAuthority) | **PATCH** /domainCertAuthorities/{certAuthorityName} | Update a Domain Certificate Authority object. -*JndiApi* | [**createMsgVpnJndiConnectionFactory**](docs/JndiApi.md#createMsgVpnJndiConnectionFactory) | **POST** /msgVpns/{msgVpnName}/jndiConnectionFactories | Create a JNDI Connection Factory object. -*JndiApi* | [**createMsgVpnJndiQueue**](docs/JndiApi.md#createMsgVpnJndiQueue) | **POST** /msgVpns/{msgVpnName}/jndiQueues | Create a JNDI Queue object. -*JndiApi* | [**createMsgVpnJndiTopic**](docs/JndiApi.md#createMsgVpnJndiTopic) | **POST** /msgVpns/{msgVpnName}/jndiTopics | Create a JNDI Topic object. -*JndiApi* | [**deleteMsgVpnJndiConnectionFactory**](docs/JndiApi.md#deleteMsgVpnJndiConnectionFactory) | **DELETE** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Delete a JNDI Connection Factory object. -*JndiApi* | [**deleteMsgVpnJndiQueue**](docs/JndiApi.md#deleteMsgVpnJndiQueue) | **DELETE** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Delete a JNDI Queue object. -*JndiApi* | [**deleteMsgVpnJndiTopic**](docs/JndiApi.md#deleteMsgVpnJndiTopic) | **DELETE** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Delete a JNDI Topic object. -*JndiApi* | [**getMsgVpnJndiConnectionFactories**](docs/JndiApi.md#getMsgVpnJndiConnectionFactories) | **GET** /msgVpns/{msgVpnName}/jndiConnectionFactories | Get a list of JNDI Connection Factory objects. -*JndiApi* | [**getMsgVpnJndiConnectionFactory**](docs/JndiApi.md#getMsgVpnJndiConnectionFactory) | **GET** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Get a JNDI Connection Factory object. -*JndiApi* | [**getMsgVpnJndiQueue**](docs/JndiApi.md#getMsgVpnJndiQueue) | **GET** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Get a JNDI Queue object. -*JndiApi* | [**getMsgVpnJndiQueues**](docs/JndiApi.md#getMsgVpnJndiQueues) | **GET** /msgVpns/{msgVpnName}/jndiQueues | Get a list of JNDI Queue objects. -*JndiApi* | [**getMsgVpnJndiTopic**](docs/JndiApi.md#getMsgVpnJndiTopic) | **GET** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Get a JNDI Topic object. -*JndiApi* | [**getMsgVpnJndiTopics**](docs/JndiApi.md#getMsgVpnJndiTopics) | **GET** /msgVpns/{msgVpnName}/jndiTopics | Get a list of JNDI Topic objects. -*JndiApi* | [**replaceMsgVpnJndiConnectionFactory**](docs/JndiApi.md#replaceMsgVpnJndiConnectionFactory) | **PUT** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Replace a JNDI Connection Factory object. -*JndiApi* | [**replaceMsgVpnJndiQueue**](docs/JndiApi.md#replaceMsgVpnJndiQueue) | **PUT** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Replace a JNDI Queue object. -*JndiApi* | [**replaceMsgVpnJndiTopic**](docs/JndiApi.md#replaceMsgVpnJndiTopic) | **PUT** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Replace a JNDI Topic object. -*JndiApi* | [**updateMsgVpnJndiConnectionFactory**](docs/JndiApi.md#updateMsgVpnJndiConnectionFactory) | **PATCH** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Update a JNDI Connection Factory object. -*JndiApi* | [**updateMsgVpnJndiQueue**](docs/JndiApi.md#updateMsgVpnJndiQueue) | **PATCH** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Update a JNDI Queue object. -*JndiApi* | [**updateMsgVpnJndiTopic**](docs/JndiApi.md#updateMsgVpnJndiTopic) | **PATCH** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Update a JNDI Topic object. -*MqttRetainCacheApi* | [**createMsgVpnMqttRetainCache**](docs/MqttRetainCacheApi.md#createMsgVpnMqttRetainCache) | **POST** /msgVpns/{msgVpnName}/mqttRetainCaches | Create an MQTT Retain Cache object. -*MqttRetainCacheApi* | [**deleteMsgVpnMqttRetainCache**](docs/MqttRetainCacheApi.md#deleteMsgVpnMqttRetainCache) | **DELETE** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Delete an MQTT Retain Cache object. -*MqttRetainCacheApi* | [**getMsgVpnMqttRetainCache**](docs/MqttRetainCacheApi.md#getMsgVpnMqttRetainCache) | **GET** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Get an MQTT Retain Cache object. -*MqttRetainCacheApi* | [**getMsgVpnMqttRetainCaches**](docs/MqttRetainCacheApi.md#getMsgVpnMqttRetainCaches) | **GET** /msgVpns/{msgVpnName}/mqttRetainCaches | Get a list of MQTT Retain Cache objects. -*MqttRetainCacheApi* | [**replaceMsgVpnMqttRetainCache**](docs/MqttRetainCacheApi.md#replaceMsgVpnMqttRetainCache) | **PUT** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Replace an MQTT Retain Cache object. -*MqttRetainCacheApi* | [**updateMsgVpnMqttRetainCache**](docs/MqttRetainCacheApi.md#updateMsgVpnMqttRetainCache) | **PATCH** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Update an MQTT Retain Cache object. -*MqttSessionApi* | [**createMsgVpnMqttSession**](docs/MqttSessionApi.md#createMsgVpnMqttSession) | **POST** /msgVpns/{msgVpnName}/mqttSessions | Create an MQTT Session object. -*MqttSessionApi* | [**createMsgVpnMqttSessionSubscription**](docs/MqttSessionApi.md#createMsgVpnMqttSessionSubscription) | **POST** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions | Create a Subscription object. -*MqttSessionApi* | [**deleteMsgVpnMqttSession**](docs/MqttSessionApi.md#deleteMsgVpnMqttSession) | **DELETE** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Delete an MQTT Session object. -*MqttSessionApi* | [**deleteMsgVpnMqttSessionSubscription**](docs/MqttSessionApi.md#deleteMsgVpnMqttSessionSubscription) | **DELETE** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Delete a Subscription object. -*MqttSessionApi* | [**getMsgVpnMqttSession**](docs/MqttSessionApi.md#getMsgVpnMqttSession) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Get an MQTT Session object. -*MqttSessionApi* | [**getMsgVpnMqttSessionSubscription**](docs/MqttSessionApi.md#getMsgVpnMqttSessionSubscription) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Get a Subscription object. -*MqttSessionApi* | [**getMsgVpnMqttSessionSubscriptions**](docs/MqttSessionApi.md#getMsgVpnMqttSessionSubscriptions) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions | Get a list of Subscription objects. -*MqttSessionApi* | [**getMsgVpnMqttSessions**](docs/MqttSessionApi.md#getMsgVpnMqttSessions) | **GET** /msgVpns/{msgVpnName}/mqttSessions | Get a list of MQTT Session objects. -*MqttSessionApi* | [**replaceMsgVpnMqttSession**](docs/MqttSessionApi.md#replaceMsgVpnMqttSession) | **PUT** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Replace an MQTT Session object. -*MqttSessionApi* | [**replaceMsgVpnMqttSessionSubscription**](docs/MqttSessionApi.md#replaceMsgVpnMqttSessionSubscription) | **PUT** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Replace a Subscription object. -*MqttSessionApi* | [**updateMsgVpnMqttSession**](docs/MqttSessionApi.md#updateMsgVpnMqttSession) | **PATCH** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Update an MQTT Session object. -*MqttSessionApi* | [**updateMsgVpnMqttSessionSubscription**](docs/MqttSessionApi.md#updateMsgVpnMqttSessionSubscription) | **PATCH** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Update a Subscription object. -*MsgVpnApi* | [**createMsgVpn**](docs/MsgVpnApi.md#createMsgVpn) | **POST** /msgVpns | Create a Message VPN object. -*MsgVpnApi* | [**createMsgVpnAclProfile**](docs/MsgVpnApi.md#createMsgVpnAclProfile) | **POST** /msgVpns/{msgVpnName}/aclProfiles | Create an ACL Profile object. -*MsgVpnApi* | [**createMsgVpnAclProfileClientConnectException**](docs/MsgVpnApi.md#createMsgVpnAclProfileClientConnectException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions | Create a Client Connect Exception object. -*MsgVpnApi* | [**createMsgVpnAclProfilePublishException**](docs/MsgVpnApi.md#createMsgVpnAclProfilePublishException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions | Create a Publish Topic Exception object. -*MsgVpnApi* | [**createMsgVpnAclProfilePublishTopicException**](docs/MsgVpnApi.md#createMsgVpnAclProfilePublishTopicException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions | Create a Publish Topic Exception object. -*MsgVpnApi* | [**createMsgVpnAclProfileSubscribeException**](docs/MsgVpnApi.md#createMsgVpnAclProfileSubscribeException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions | Create a Subscribe Topic Exception object. -*MsgVpnApi* | [**createMsgVpnAclProfileSubscribeShareNameException**](docs/MsgVpnApi.md#createMsgVpnAclProfileSubscribeShareNameException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions | Create a Subscribe Share Name Exception object. -*MsgVpnApi* | [**createMsgVpnAclProfileSubscribeTopicException**](docs/MsgVpnApi.md#createMsgVpnAclProfileSubscribeTopicException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions | Create a Subscribe Topic Exception object. -*MsgVpnApi* | [**createMsgVpnAuthenticationOauthProfile**](docs/MsgVpnApi.md#createMsgVpnAuthenticationOauthProfile) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles | Create an OAuth Profile object. -*MsgVpnApi* | [**createMsgVpnAuthenticationOauthProfileClientRequiredClaim**](docs/MsgVpnApi.md#createMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims | Create a Required Claim object. -*MsgVpnApi* | [**createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](docs/MsgVpnApi.md#createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Create a Required Claim object. -*MsgVpnApi* | [**createMsgVpnAuthenticationOauthProvider**](docs/MsgVpnApi.md#createMsgVpnAuthenticationOauthProvider) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProviders | Create an OAuth Provider object. -*MsgVpnApi* | [**createMsgVpnAuthorizationGroup**](docs/MsgVpnApi.md#createMsgVpnAuthorizationGroup) | **POST** /msgVpns/{msgVpnName}/authorizationGroups | Create an Authorization Group object. -*MsgVpnApi* | [**createMsgVpnBridge**](docs/MsgVpnApi.md#createMsgVpnBridge) | **POST** /msgVpns/{msgVpnName}/bridges | Create a Bridge object. -*MsgVpnApi* | [**createMsgVpnBridgeRemoteMsgVpn**](docs/MsgVpnApi.md#createMsgVpnBridgeRemoteMsgVpn) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns | Create a Remote Message VPN object. -*MsgVpnApi* | [**createMsgVpnBridgeRemoteSubscription**](docs/MsgVpnApi.md#createMsgVpnBridgeRemoteSubscription) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions | Create a Remote Subscription object. -*MsgVpnApi* | [**createMsgVpnBridgeTlsTrustedCommonName**](docs/MsgVpnApi.md#createMsgVpnBridgeTlsTrustedCommonName) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames | Create a Trusted Common Name object. -*MsgVpnApi* | [**createMsgVpnCertMatchingRule**](docs/MsgVpnApi.md#createMsgVpnCertMatchingRule) | **POST** /msgVpns/{msgVpnName}/certMatchingRules | Create a Certificate Matching Rule object. -*MsgVpnApi* | [**createMsgVpnCertMatchingRuleAttributeFilter**](docs/MsgVpnApi.md#createMsgVpnCertMatchingRuleAttributeFilter) | **POST** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters | Create a Certificate Matching Rule Attribute Filter object. -*MsgVpnApi* | [**createMsgVpnCertMatchingRuleCondition**](docs/MsgVpnApi.md#createMsgVpnCertMatchingRuleCondition) | **POST** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions | Create a Certificate Matching Rule Condition object. -*MsgVpnApi* | [**createMsgVpnClientProfile**](docs/MsgVpnApi.md#createMsgVpnClientProfile) | **POST** /msgVpns/{msgVpnName}/clientProfiles | Create a Client Profile object. -*MsgVpnApi* | [**createMsgVpnClientUsername**](docs/MsgVpnApi.md#createMsgVpnClientUsername) | **POST** /msgVpns/{msgVpnName}/clientUsernames | Create a Client Username object. -*MsgVpnApi* | [**createMsgVpnClientUsernameAttribute**](docs/MsgVpnApi.md#createMsgVpnClientUsernameAttribute) | **POST** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes | Create a Client Username Attribute object. -*MsgVpnApi* | [**createMsgVpnDistributedCache**](docs/MsgVpnApi.md#createMsgVpnDistributedCache) | **POST** /msgVpns/{msgVpnName}/distributedCaches | Create a Distributed Cache object. -*MsgVpnApi* | [**createMsgVpnDistributedCacheCluster**](docs/MsgVpnApi.md#createMsgVpnDistributedCacheCluster) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters | Create a Cache Cluster object. -*MsgVpnApi* | [**createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](docs/MsgVpnApi.md#createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters | Create a Home Cache Cluster object. -*MsgVpnApi* | [**createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](docs/MsgVpnApi.md#createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes | Create a Topic Prefix object. -*MsgVpnApi* | [**createMsgVpnDistributedCacheClusterInstance**](docs/MsgVpnApi.md#createMsgVpnDistributedCacheClusterInstance) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances | Create a Cache Instance object. -*MsgVpnApi* | [**createMsgVpnDistributedCacheClusterTopic**](docs/MsgVpnApi.md#createMsgVpnDistributedCacheClusterTopic) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics | Create a Topic object. -*MsgVpnApi* | [**createMsgVpnDmrBridge**](docs/MsgVpnApi.md#createMsgVpnDmrBridge) | **POST** /msgVpns/{msgVpnName}/dmrBridges | Create a DMR Bridge object. -*MsgVpnApi* | [**createMsgVpnJndiConnectionFactory**](docs/MsgVpnApi.md#createMsgVpnJndiConnectionFactory) | **POST** /msgVpns/{msgVpnName}/jndiConnectionFactories | Create a JNDI Connection Factory object. -*MsgVpnApi* | [**createMsgVpnJndiQueue**](docs/MsgVpnApi.md#createMsgVpnJndiQueue) | **POST** /msgVpns/{msgVpnName}/jndiQueues | Create a JNDI Queue object. -*MsgVpnApi* | [**createMsgVpnJndiTopic**](docs/MsgVpnApi.md#createMsgVpnJndiTopic) | **POST** /msgVpns/{msgVpnName}/jndiTopics | Create a JNDI Topic object. -*MsgVpnApi* | [**createMsgVpnMqttRetainCache**](docs/MsgVpnApi.md#createMsgVpnMqttRetainCache) | **POST** /msgVpns/{msgVpnName}/mqttRetainCaches | Create an MQTT Retain Cache object. -*MsgVpnApi* | [**createMsgVpnMqttSession**](docs/MsgVpnApi.md#createMsgVpnMqttSession) | **POST** /msgVpns/{msgVpnName}/mqttSessions | Create an MQTT Session object. -*MsgVpnApi* | [**createMsgVpnMqttSessionSubscription**](docs/MsgVpnApi.md#createMsgVpnMqttSessionSubscription) | **POST** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions | Create a Subscription object. -*MsgVpnApi* | [**createMsgVpnQueue**](docs/MsgVpnApi.md#createMsgVpnQueue) | **POST** /msgVpns/{msgVpnName}/queues | Create a Queue object. -*MsgVpnApi* | [**createMsgVpnQueueSubscription**](docs/MsgVpnApi.md#createMsgVpnQueueSubscription) | **POST** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions | Create a Queue Subscription object. -*MsgVpnApi* | [**createMsgVpnQueueTemplate**](docs/MsgVpnApi.md#createMsgVpnQueueTemplate) | **POST** /msgVpns/{msgVpnName}/queueTemplates | Create a Queue Template object. -*MsgVpnApi* | [**createMsgVpnReplayLog**](docs/MsgVpnApi.md#createMsgVpnReplayLog) | **POST** /msgVpns/{msgVpnName}/replayLogs | Create a Replay Log object. -*MsgVpnApi* | [**createMsgVpnReplayLogTopicFilterSubscription**](docs/MsgVpnApi.md#createMsgVpnReplayLogTopicFilterSubscription) | **POST** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions | Create a Topic Filter Subscription object. -*MsgVpnApi* | [**createMsgVpnReplicatedTopic**](docs/MsgVpnApi.md#createMsgVpnReplicatedTopic) | **POST** /msgVpns/{msgVpnName}/replicatedTopics | Create a Replicated Topic object. -*MsgVpnApi* | [**createMsgVpnRestDeliveryPoint**](docs/MsgVpnApi.md#createMsgVpnRestDeliveryPoint) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints | Create a REST Delivery Point object. -*MsgVpnApi* | [**createMsgVpnRestDeliveryPointQueueBinding**](docs/MsgVpnApi.md#createMsgVpnRestDeliveryPointQueueBinding) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings | Create a Queue Binding object. -*MsgVpnApi* | [**createMsgVpnRestDeliveryPointQueueBindingRequestHeader**](docs/MsgVpnApi.md#createMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders | Create a Request Header object. -*MsgVpnApi* | [**createMsgVpnRestDeliveryPointRestConsumer**](docs/MsgVpnApi.md#createMsgVpnRestDeliveryPointRestConsumer) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers | Create a REST Consumer object. -*MsgVpnApi* | [**createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](docs/MsgVpnApi.md#createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims | Create a Claim object. -*MsgVpnApi* | [**createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](docs/MsgVpnApi.md#createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames | Create a Trusted Common Name object. -*MsgVpnApi* | [**createMsgVpnSequencedTopic**](docs/MsgVpnApi.md#createMsgVpnSequencedTopic) | **POST** /msgVpns/{msgVpnName}/sequencedTopics | Create a Sequenced Topic object. -*MsgVpnApi* | [**createMsgVpnTopicEndpoint**](docs/MsgVpnApi.md#createMsgVpnTopicEndpoint) | **POST** /msgVpns/{msgVpnName}/topicEndpoints | Create a Topic Endpoint object. -*MsgVpnApi* | [**createMsgVpnTopicEndpointTemplate**](docs/MsgVpnApi.md#createMsgVpnTopicEndpointTemplate) | **POST** /msgVpns/{msgVpnName}/topicEndpointTemplates | Create a Topic Endpoint Template object. -*MsgVpnApi* | [**deleteMsgVpn**](docs/MsgVpnApi.md#deleteMsgVpn) | **DELETE** /msgVpns/{msgVpnName} | Delete a Message VPN object. -*MsgVpnApi* | [**deleteMsgVpnAclProfile**](docs/MsgVpnApi.md#deleteMsgVpnAclProfile) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Delete an ACL Profile object. -*MsgVpnApi* | [**deleteMsgVpnAclProfileClientConnectException**](docs/MsgVpnApi.md#deleteMsgVpnAclProfileClientConnectException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress} | Delete a Client Connect Exception object. -*MsgVpnApi* | [**deleteMsgVpnAclProfilePublishException**](docs/MsgVpnApi.md#deleteMsgVpnAclProfilePublishException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic} | Delete a Publish Topic Exception object. -*MsgVpnApi* | [**deleteMsgVpnAclProfilePublishTopicException**](docs/MsgVpnApi.md#deleteMsgVpnAclProfilePublishTopicException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException} | Delete a Publish Topic Exception object. -*MsgVpnApi* | [**deleteMsgVpnAclProfileSubscribeException**](docs/MsgVpnApi.md#deleteMsgVpnAclProfileSubscribeException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic} | Delete a Subscribe Topic Exception object. -*MsgVpnApi* | [**deleteMsgVpnAclProfileSubscribeShareNameException**](docs/MsgVpnApi.md#deleteMsgVpnAclProfileSubscribeShareNameException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException} | Delete a Subscribe Share Name Exception object. -*MsgVpnApi* | [**deleteMsgVpnAclProfileSubscribeTopicException**](docs/MsgVpnApi.md#deleteMsgVpnAclProfileSubscribeTopicException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException} | Delete a Subscribe Topic Exception object. -*MsgVpnApi* | [**deleteMsgVpnAuthenticationOauthProfile**](docs/MsgVpnApi.md#deleteMsgVpnAuthenticationOauthProfile) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Delete an OAuth Profile object. -*MsgVpnApi* | [**deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim**](docs/MsgVpnApi.md#deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Delete a Required Claim object. -*MsgVpnApi* | [**deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](docs/MsgVpnApi.md#deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Delete a Required Claim object. -*MsgVpnApi* | [**deleteMsgVpnAuthenticationOauthProvider**](docs/MsgVpnApi.md#deleteMsgVpnAuthenticationOauthProvider) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Delete an OAuth Provider object. -*MsgVpnApi* | [**deleteMsgVpnAuthorizationGroup**](docs/MsgVpnApi.md#deleteMsgVpnAuthorizationGroup) | **DELETE** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Delete an Authorization Group object. -*MsgVpnApi* | [**deleteMsgVpnBridge**](docs/MsgVpnApi.md#deleteMsgVpnBridge) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Delete a Bridge object. -*MsgVpnApi* | [**deleteMsgVpnBridgeRemoteMsgVpn**](docs/MsgVpnApi.md#deleteMsgVpnBridgeRemoteMsgVpn) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Delete a Remote Message VPN object. -*MsgVpnApi* | [**deleteMsgVpnBridgeRemoteSubscription**](docs/MsgVpnApi.md#deleteMsgVpnBridgeRemoteSubscription) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic} | Delete a Remote Subscription object. -*MsgVpnApi* | [**deleteMsgVpnBridgeTlsTrustedCommonName**](docs/MsgVpnApi.md#deleteMsgVpnBridgeTlsTrustedCommonName) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Delete a Trusted Common Name object. -*MsgVpnApi* | [**deleteMsgVpnCertMatchingRule**](docs/MsgVpnApi.md#deleteMsgVpnCertMatchingRule) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Delete a Certificate Matching Rule object. -*MsgVpnApi* | [**deleteMsgVpnCertMatchingRuleAttributeFilter**](docs/MsgVpnApi.md#deleteMsgVpnCertMatchingRuleAttributeFilter) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Delete a Certificate Matching Rule Attribute Filter object. -*MsgVpnApi* | [**deleteMsgVpnCertMatchingRuleCondition**](docs/MsgVpnApi.md#deleteMsgVpnCertMatchingRuleCondition) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source} | Delete a Certificate Matching Rule Condition object. -*MsgVpnApi* | [**deleteMsgVpnClientProfile**](docs/MsgVpnApi.md#deleteMsgVpnClientProfile) | **DELETE** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Delete a Client Profile object. -*MsgVpnApi* | [**deleteMsgVpnClientUsername**](docs/MsgVpnApi.md#deleteMsgVpnClientUsername) | **DELETE** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Delete a Client Username object. -*MsgVpnApi* | [**deleteMsgVpnClientUsernameAttribute**](docs/MsgVpnApi.md#deleteMsgVpnClientUsernameAttribute) | **DELETE** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue} | Delete a Client Username Attribute object. -*MsgVpnApi* | [**deleteMsgVpnDistributedCache**](docs/MsgVpnApi.md#deleteMsgVpnDistributedCache) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Delete a Distributed Cache object. -*MsgVpnApi* | [**deleteMsgVpnDistributedCacheCluster**](docs/MsgVpnApi.md#deleteMsgVpnDistributedCacheCluster) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Delete a Cache Cluster object. -*MsgVpnApi* | [**deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](docs/MsgVpnApi.md#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName} | Delete a Home Cache Cluster object. -*MsgVpnApi* | [**deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](docs/MsgVpnApi.md#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix} | Delete a Topic Prefix object. -*MsgVpnApi* | [**deleteMsgVpnDistributedCacheClusterInstance**](docs/MsgVpnApi.md#deleteMsgVpnDistributedCacheClusterInstance) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Delete a Cache Instance object. -*MsgVpnApi* | [**deleteMsgVpnDistributedCacheClusterTopic**](docs/MsgVpnApi.md#deleteMsgVpnDistributedCacheClusterTopic) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic} | Delete a Topic object. -*MsgVpnApi* | [**deleteMsgVpnDmrBridge**](docs/MsgVpnApi.md#deleteMsgVpnDmrBridge) | **DELETE** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Delete a DMR Bridge object. -*MsgVpnApi* | [**deleteMsgVpnJndiConnectionFactory**](docs/MsgVpnApi.md#deleteMsgVpnJndiConnectionFactory) | **DELETE** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Delete a JNDI Connection Factory object. -*MsgVpnApi* | [**deleteMsgVpnJndiQueue**](docs/MsgVpnApi.md#deleteMsgVpnJndiQueue) | **DELETE** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Delete a JNDI Queue object. -*MsgVpnApi* | [**deleteMsgVpnJndiTopic**](docs/MsgVpnApi.md#deleteMsgVpnJndiTopic) | **DELETE** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Delete a JNDI Topic object. -*MsgVpnApi* | [**deleteMsgVpnMqttRetainCache**](docs/MsgVpnApi.md#deleteMsgVpnMqttRetainCache) | **DELETE** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Delete an MQTT Retain Cache object. -*MsgVpnApi* | [**deleteMsgVpnMqttSession**](docs/MsgVpnApi.md#deleteMsgVpnMqttSession) | **DELETE** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Delete an MQTT Session object. -*MsgVpnApi* | [**deleteMsgVpnMqttSessionSubscription**](docs/MsgVpnApi.md#deleteMsgVpnMqttSessionSubscription) | **DELETE** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Delete a Subscription object. -*MsgVpnApi* | [**deleteMsgVpnQueue**](docs/MsgVpnApi.md#deleteMsgVpnQueue) | **DELETE** /msgVpns/{msgVpnName}/queues/{queueName} | Delete a Queue object. -*MsgVpnApi* | [**deleteMsgVpnQueueSubscription**](docs/MsgVpnApi.md#deleteMsgVpnQueueSubscription) | **DELETE** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic} | Delete a Queue Subscription object. -*MsgVpnApi* | [**deleteMsgVpnQueueTemplate**](docs/MsgVpnApi.md#deleteMsgVpnQueueTemplate) | **DELETE** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Delete a Queue Template object. -*MsgVpnApi* | [**deleteMsgVpnReplayLog**](docs/MsgVpnApi.md#deleteMsgVpnReplayLog) | **DELETE** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Delete a Replay Log object. -*MsgVpnApi* | [**deleteMsgVpnReplayLogTopicFilterSubscription**](docs/MsgVpnApi.md#deleteMsgVpnReplayLogTopicFilterSubscription) | **DELETE** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription} | Delete a Topic Filter Subscription object. -*MsgVpnApi* | [**deleteMsgVpnReplicatedTopic**](docs/MsgVpnApi.md#deleteMsgVpnReplicatedTopic) | **DELETE** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Delete a Replicated Topic object. -*MsgVpnApi* | [**deleteMsgVpnRestDeliveryPoint**](docs/MsgVpnApi.md#deleteMsgVpnRestDeliveryPoint) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Delete a REST Delivery Point object. -*MsgVpnApi* | [**deleteMsgVpnRestDeliveryPointQueueBinding**](docs/MsgVpnApi.md#deleteMsgVpnRestDeliveryPointQueueBinding) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Delete a Queue Binding object. -*MsgVpnApi* | [**deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader**](docs/MsgVpnApi.md#deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Delete a Request Header object. -*MsgVpnApi* | [**deleteMsgVpnRestDeliveryPointRestConsumer**](docs/MsgVpnApi.md#deleteMsgVpnRestDeliveryPointRestConsumer) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Delete a REST Consumer object. -*MsgVpnApi* | [**deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](docs/MsgVpnApi.md#deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName} | Delete a Claim object. -*MsgVpnApi* | [**deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](docs/MsgVpnApi.md#deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Delete a Trusted Common Name object. -*MsgVpnApi* | [**deleteMsgVpnSequencedTopic**](docs/MsgVpnApi.md#deleteMsgVpnSequencedTopic) | **DELETE** /msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic} | Delete a Sequenced Topic object. -*MsgVpnApi* | [**deleteMsgVpnTopicEndpoint**](docs/MsgVpnApi.md#deleteMsgVpnTopicEndpoint) | **DELETE** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Delete a Topic Endpoint object. -*MsgVpnApi* | [**deleteMsgVpnTopicEndpointTemplate**](docs/MsgVpnApi.md#deleteMsgVpnTopicEndpointTemplate) | **DELETE** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Delete a Topic Endpoint Template object. -*MsgVpnApi* | [**getMsgVpn**](docs/MsgVpnApi.md#getMsgVpn) | **GET** /msgVpns/{msgVpnName} | Get a Message VPN object. -*MsgVpnApi* | [**getMsgVpnAclProfile**](docs/MsgVpnApi.md#getMsgVpnAclProfile) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Get an ACL Profile object. -*MsgVpnApi* | [**getMsgVpnAclProfileClientConnectException**](docs/MsgVpnApi.md#getMsgVpnAclProfileClientConnectException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress} | Get a Client Connect Exception object. -*MsgVpnApi* | [**getMsgVpnAclProfileClientConnectExceptions**](docs/MsgVpnApi.md#getMsgVpnAclProfileClientConnectExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions | Get a list of Client Connect Exception objects. -*MsgVpnApi* | [**getMsgVpnAclProfilePublishException**](docs/MsgVpnApi.md#getMsgVpnAclProfilePublishException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic} | Get a Publish Topic Exception object. -*MsgVpnApi* | [**getMsgVpnAclProfilePublishExceptions**](docs/MsgVpnApi.md#getMsgVpnAclProfilePublishExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions | Get a list of Publish Topic Exception objects. -*MsgVpnApi* | [**getMsgVpnAclProfilePublishTopicException**](docs/MsgVpnApi.md#getMsgVpnAclProfilePublishTopicException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException} | Get a Publish Topic Exception object. -*MsgVpnApi* | [**getMsgVpnAclProfilePublishTopicExceptions**](docs/MsgVpnApi.md#getMsgVpnAclProfilePublishTopicExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions | Get a list of Publish Topic Exception objects. -*MsgVpnApi* | [**getMsgVpnAclProfileSubscribeException**](docs/MsgVpnApi.md#getMsgVpnAclProfileSubscribeException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic} | Get a Subscribe Topic Exception object. -*MsgVpnApi* | [**getMsgVpnAclProfileSubscribeExceptions**](docs/MsgVpnApi.md#getMsgVpnAclProfileSubscribeExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions | Get a list of Subscribe Topic Exception objects. -*MsgVpnApi* | [**getMsgVpnAclProfileSubscribeShareNameException**](docs/MsgVpnApi.md#getMsgVpnAclProfileSubscribeShareNameException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException} | Get a Subscribe Share Name Exception object. -*MsgVpnApi* | [**getMsgVpnAclProfileSubscribeShareNameExceptions**](docs/MsgVpnApi.md#getMsgVpnAclProfileSubscribeShareNameExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions | Get a list of Subscribe Share Name Exception objects. -*MsgVpnApi* | [**getMsgVpnAclProfileSubscribeTopicException**](docs/MsgVpnApi.md#getMsgVpnAclProfileSubscribeTopicException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException} | Get a Subscribe Topic Exception object. -*MsgVpnApi* | [**getMsgVpnAclProfileSubscribeTopicExceptions**](docs/MsgVpnApi.md#getMsgVpnAclProfileSubscribeTopicExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions | Get a list of Subscribe Topic Exception objects. -*MsgVpnApi* | [**getMsgVpnAclProfiles**](docs/MsgVpnApi.md#getMsgVpnAclProfiles) | **GET** /msgVpns/{msgVpnName}/aclProfiles | Get a list of ACL Profile objects. -*MsgVpnApi* | [**getMsgVpnAuthenticationOauthProfile**](docs/MsgVpnApi.md#getMsgVpnAuthenticationOauthProfile) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Get an OAuth Profile object. -*MsgVpnApi* | [**getMsgVpnAuthenticationOauthProfileClientRequiredClaim**](docs/MsgVpnApi.md#getMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Get a Required Claim object. -*MsgVpnApi* | [**getMsgVpnAuthenticationOauthProfileClientRequiredClaims**](docs/MsgVpnApi.md#getMsgVpnAuthenticationOauthProfileClientRequiredClaims) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims | Get a list of Required Claim objects. -*MsgVpnApi* | [**getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](docs/MsgVpnApi.md#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Get a Required Claim object. -*MsgVpnApi* | [**getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims**](docs/MsgVpnApi.md#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Get a list of Required Claim objects. -*MsgVpnApi* | [**getMsgVpnAuthenticationOauthProfiles**](docs/MsgVpnApi.md#getMsgVpnAuthenticationOauthProfiles) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles | Get a list of OAuth Profile objects. -*MsgVpnApi* | [**getMsgVpnAuthenticationOauthProvider**](docs/MsgVpnApi.md#getMsgVpnAuthenticationOauthProvider) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Get an OAuth Provider object. -*MsgVpnApi* | [**getMsgVpnAuthenticationOauthProviders**](docs/MsgVpnApi.md#getMsgVpnAuthenticationOauthProviders) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProviders | Get a list of OAuth Provider objects. -*MsgVpnApi* | [**getMsgVpnAuthorizationGroup**](docs/MsgVpnApi.md#getMsgVpnAuthorizationGroup) | **GET** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Get an Authorization Group object. -*MsgVpnApi* | [**getMsgVpnAuthorizationGroups**](docs/MsgVpnApi.md#getMsgVpnAuthorizationGroups) | **GET** /msgVpns/{msgVpnName}/authorizationGroups | Get a list of Authorization Group objects. -*MsgVpnApi* | [**getMsgVpnBridge**](docs/MsgVpnApi.md#getMsgVpnBridge) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Get a Bridge object. -*MsgVpnApi* | [**getMsgVpnBridgeRemoteMsgVpn**](docs/MsgVpnApi.md#getMsgVpnBridgeRemoteMsgVpn) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Get a Remote Message VPN object. -*MsgVpnApi* | [**getMsgVpnBridgeRemoteMsgVpns**](docs/MsgVpnApi.md#getMsgVpnBridgeRemoteMsgVpns) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns | Get a list of Remote Message VPN objects. -*MsgVpnApi* | [**getMsgVpnBridgeRemoteSubscription**](docs/MsgVpnApi.md#getMsgVpnBridgeRemoteSubscription) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic} | Get a Remote Subscription object. -*MsgVpnApi* | [**getMsgVpnBridgeRemoteSubscriptions**](docs/MsgVpnApi.md#getMsgVpnBridgeRemoteSubscriptions) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions | Get a list of Remote Subscription objects. -*MsgVpnApi* | [**getMsgVpnBridgeTlsTrustedCommonName**](docs/MsgVpnApi.md#getMsgVpnBridgeTlsTrustedCommonName) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Get a Trusted Common Name object. -*MsgVpnApi* | [**getMsgVpnBridgeTlsTrustedCommonNames**](docs/MsgVpnApi.md#getMsgVpnBridgeTlsTrustedCommonNames) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames | Get a list of Trusted Common Name objects. -*MsgVpnApi* | [**getMsgVpnBridges**](docs/MsgVpnApi.md#getMsgVpnBridges) | **GET** /msgVpns/{msgVpnName}/bridges | Get a list of Bridge objects. -*MsgVpnApi* | [**getMsgVpnCertMatchingRule**](docs/MsgVpnApi.md#getMsgVpnCertMatchingRule) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Get a Certificate Matching Rule object. -*MsgVpnApi* | [**getMsgVpnCertMatchingRuleAttributeFilter**](docs/MsgVpnApi.md#getMsgVpnCertMatchingRuleAttributeFilter) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Get a Certificate Matching Rule Attribute Filter object. -*MsgVpnApi* | [**getMsgVpnCertMatchingRuleAttributeFilters**](docs/MsgVpnApi.md#getMsgVpnCertMatchingRuleAttributeFilters) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters | Get a list of Certificate Matching Rule Attribute Filter objects. -*MsgVpnApi* | [**getMsgVpnCertMatchingRuleCondition**](docs/MsgVpnApi.md#getMsgVpnCertMatchingRuleCondition) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source} | Get a Certificate Matching Rule Condition object. -*MsgVpnApi* | [**getMsgVpnCertMatchingRuleConditions**](docs/MsgVpnApi.md#getMsgVpnCertMatchingRuleConditions) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions | Get a list of Certificate Matching Rule Condition objects. -*MsgVpnApi* | [**getMsgVpnCertMatchingRules**](docs/MsgVpnApi.md#getMsgVpnCertMatchingRules) | **GET** /msgVpns/{msgVpnName}/certMatchingRules | Get a list of Certificate Matching Rule objects. -*MsgVpnApi* | [**getMsgVpnClientProfile**](docs/MsgVpnApi.md#getMsgVpnClientProfile) | **GET** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Get a Client Profile object. -*MsgVpnApi* | [**getMsgVpnClientProfiles**](docs/MsgVpnApi.md#getMsgVpnClientProfiles) | **GET** /msgVpns/{msgVpnName}/clientProfiles | Get a list of Client Profile objects. -*MsgVpnApi* | [**getMsgVpnClientUsername**](docs/MsgVpnApi.md#getMsgVpnClientUsername) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Get a Client Username object. -*MsgVpnApi* | [**getMsgVpnClientUsernameAttribute**](docs/MsgVpnApi.md#getMsgVpnClientUsernameAttribute) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue} | Get a Client Username Attribute object. -*MsgVpnApi* | [**getMsgVpnClientUsernameAttributes**](docs/MsgVpnApi.md#getMsgVpnClientUsernameAttributes) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes | Get a list of Client Username Attribute objects. -*MsgVpnApi* | [**getMsgVpnClientUsernames**](docs/MsgVpnApi.md#getMsgVpnClientUsernames) | **GET** /msgVpns/{msgVpnName}/clientUsernames | Get a list of Client Username objects. -*MsgVpnApi* | [**getMsgVpnDistributedCache**](docs/MsgVpnApi.md#getMsgVpnDistributedCache) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Get a Distributed Cache object. -*MsgVpnApi* | [**getMsgVpnDistributedCacheCluster**](docs/MsgVpnApi.md#getMsgVpnDistributedCacheCluster) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Get a Cache Cluster object. -*MsgVpnApi* | [**getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](docs/MsgVpnApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName} | Get a Home Cache Cluster object. -*MsgVpnApi* | [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](docs/MsgVpnApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix} | Get a Topic Prefix object. -*MsgVpnApi* | [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes**](docs/MsgVpnApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes | Get a list of Topic Prefix objects. -*MsgVpnApi* | [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters**](docs/MsgVpnApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters | Get a list of Home Cache Cluster objects. -*MsgVpnApi* | [**getMsgVpnDistributedCacheClusterInstance**](docs/MsgVpnApi.md#getMsgVpnDistributedCacheClusterInstance) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Get a Cache Instance object. -*MsgVpnApi* | [**getMsgVpnDistributedCacheClusterInstances**](docs/MsgVpnApi.md#getMsgVpnDistributedCacheClusterInstances) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances | Get a list of Cache Instance objects. -*MsgVpnApi* | [**getMsgVpnDistributedCacheClusterTopic**](docs/MsgVpnApi.md#getMsgVpnDistributedCacheClusterTopic) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic} | Get a Topic object. -*MsgVpnApi* | [**getMsgVpnDistributedCacheClusterTopics**](docs/MsgVpnApi.md#getMsgVpnDistributedCacheClusterTopics) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics | Get a list of Topic objects. -*MsgVpnApi* | [**getMsgVpnDistributedCacheClusters**](docs/MsgVpnApi.md#getMsgVpnDistributedCacheClusters) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters | Get a list of Cache Cluster objects. -*MsgVpnApi* | [**getMsgVpnDistributedCaches**](docs/MsgVpnApi.md#getMsgVpnDistributedCaches) | **GET** /msgVpns/{msgVpnName}/distributedCaches | Get a list of Distributed Cache objects. -*MsgVpnApi* | [**getMsgVpnDmrBridge**](docs/MsgVpnApi.md#getMsgVpnDmrBridge) | **GET** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Get a DMR Bridge object. -*MsgVpnApi* | [**getMsgVpnDmrBridges**](docs/MsgVpnApi.md#getMsgVpnDmrBridges) | **GET** /msgVpns/{msgVpnName}/dmrBridges | Get a list of DMR Bridge objects. -*MsgVpnApi* | [**getMsgVpnJndiConnectionFactories**](docs/MsgVpnApi.md#getMsgVpnJndiConnectionFactories) | **GET** /msgVpns/{msgVpnName}/jndiConnectionFactories | Get a list of JNDI Connection Factory objects. -*MsgVpnApi* | [**getMsgVpnJndiConnectionFactory**](docs/MsgVpnApi.md#getMsgVpnJndiConnectionFactory) | **GET** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Get a JNDI Connection Factory object. -*MsgVpnApi* | [**getMsgVpnJndiQueue**](docs/MsgVpnApi.md#getMsgVpnJndiQueue) | **GET** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Get a JNDI Queue object. -*MsgVpnApi* | [**getMsgVpnJndiQueues**](docs/MsgVpnApi.md#getMsgVpnJndiQueues) | **GET** /msgVpns/{msgVpnName}/jndiQueues | Get a list of JNDI Queue objects. -*MsgVpnApi* | [**getMsgVpnJndiTopic**](docs/MsgVpnApi.md#getMsgVpnJndiTopic) | **GET** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Get a JNDI Topic object. -*MsgVpnApi* | [**getMsgVpnJndiTopics**](docs/MsgVpnApi.md#getMsgVpnJndiTopics) | **GET** /msgVpns/{msgVpnName}/jndiTopics | Get a list of JNDI Topic objects. -*MsgVpnApi* | [**getMsgVpnMqttRetainCache**](docs/MsgVpnApi.md#getMsgVpnMqttRetainCache) | **GET** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Get an MQTT Retain Cache object. -*MsgVpnApi* | [**getMsgVpnMqttRetainCaches**](docs/MsgVpnApi.md#getMsgVpnMqttRetainCaches) | **GET** /msgVpns/{msgVpnName}/mqttRetainCaches | Get a list of MQTT Retain Cache objects. -*MsgVpnApi* | [**getMsgVpnMqttSession**](docs/MsgVpnApi.md#getMsgVpnMqttSession) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Get an MQTT Session object. -*MsgVpnApi* | [**getMsgVpnMqttSessionSubscription**](docs/MsgVpnApi.md#getMsgVpnMqttSessionSubscription) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Get a Subscription object. -*MsgVpnApi* | [**getMsgVpnMqttSessionSubscriptions**](docs/MsgVpnApi.md#getMsgVpnMqttSessionSubscriptions) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions | Get a list of Subscription objects. -*MsgVpnApi* | [**getMsgVpnMqttSessions**](docs/MsgVpnApi.md#getMsgVpnMqttSessions) | **GET** /msgVpns/{msgVpnName}/mqttSessions | Get a list of MQTT Session objects. -*MsgVpnApi* | [**getMsgVpnQueue**](docs/MsgVpnApi.md#getMsgVpnQueue) | **GET** /msgVpns/{msgVpnName}/queues/{queueName} | Get a Queue object. -*MsgVpnApi* | [**getMsgVpnQueueSubscription**](docs/MsgVpnApi.md#getMsgVpnQueueSubscription) | **GET** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic} | Get a Queue Subscription object. -*MsgVpnApi* | [**getMsgVpnQueueSubscriptions**](docs/MsgVpnApi.md#getMsgVpnQueueSubscriptions) | **GET** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions | Get a list of Queue Subscription objects. -*MsgVpnApi* | [**getMsgVpnQueueTemplate**](docs/MsgVpnApi.md#getMsgVpnQueueTemplate) | **GET** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Get a Queue Template object. -*MsgVpnApi* | [**getMsgVpnQueueTemplates**](docs/MsgVpnApi.md#getMsgVpnQueueTemplates) | **GET** /msgVpns/{msgVpnName}/queueTemplates | Get a list of Queue Template objects. -*MsgVpnApi* | [**getMsgVpnQueues**](docs/MsgVpnApi.md#getMsgVpnQueues) | **GET** /msgVpns/{msgVpnName}/queues | Get a list of Queue objects. -*MsgVpnApi* | [**getMsgVpnReplayLog**](docs/MsgVpnApi.md#getMsgVpnReplayLog) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Get a Replay Log object. -*MsgVpnApi* | [**getMsgVpnReplayLogTopicFilterSubscription**](docs/MsgVpnApi.md#getMsgVpnReplayLogTopicFilterSubscription) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription} | Get a Topic Filter Subscription object. -*MsgVpnApi* | [**getMsgVpnReplayLogTopicFilterSubscriptions**](docs/MsgVpnApi.md#getMsgVpnReplayLogTopicFilterSubscriptions) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions | Get a list of Topic Filter Subscription objects. -*MsgVpnApi* | [**getMsgVpnReplayLogs**](docs/MsgVpnApi.md#getMsgVpnReplayLogs) | **GET** /msgVpns/{msgVpnName}/replayLogs | Get a list of Replay Log objects. -*MsgVpnApi* | [**getMsgVpnReplicatedTopic**](docs/MsgVpnApi.md#getMsgVpnReplicatedTopic) | **GET** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Get a Replicated Topic object. -*MsgVpnApi* | [**getMsgVpnReplicatedTopics**](docs/MsgVpnApi.md#getMsgVpnReplicatedTopics) | **GET** /msgVpns/{msgVpnName}/replicatedTopics | Get a list of Replicated Topic objects. -*MsgVpnApi* | [**getMsgVpnRestDeliveryPoint**](docs/MsgVpnApi.md#getMsgVpnRestDeliveryPoint) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Get a REST Delivery Point object. -*MsgVpnApi* | [**getMsgVpnRestDeliveryPointQueueBinding**](docs/MsgVpnApi.md#getMsgVpnRestDeliveryPointQueueBinding) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Get a Queue Binding object. -*MsgVpnApi* | [**getMsgVpnRestDeliveryPointQueueBindingRequestHeader**](docs/MsgVpnApi.md#getMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Get a Request Header object. -*MsgVpnApi* | [**getMsgVpnRestDeliveryPointQueueBindingRequestHeaders**](docs/MsgVpnApi.md#getMsgVpnRestDeliveryPointQueueBindingRequestHeaders) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders | Get a list of Request Header objects. -*MsgVpnApi* | [**getMsgVpnRestDeliveryPointQueueBindings**](docs/MsgVpnApi.md#getMsgVpnRestDeliveryPointQueueBindings) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings | Get a list of Queue Binding objects. -*MsgVpnApi* | [**getMsgVpnRestDeliveryPointRestConsumer**](docs/MsgVpnApi.md#getMsgVpnRestDeliveryPointRestConsumer) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Get a REST Consumer object. -*MsgVpnApi* | [**getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](docs/MsgVpnApi.md#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName} | Get a Claim object. -*MsgVpnApi* | [**getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims**](docs/MsgVpnApi.md#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims | Get a list of Claim objects. -*MsgVpnApi* | [**getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](docs/MsgVpnApi.md#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Get a Trusted Common Name object. -*MsgVpnApi* | [**getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames**](docs/MsgVpnApi.md#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames | Get a list of Trusted Common Name objects. -*MsgVpnApi* | [**getMsgVpnRestDeliveryPointRestConsumers**](docs/MsgVpnApi.md#getMsgVpnRestDeliveryPointRestConsumers) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers | Get a list of REST Consumer objects. -*MsgVpnApi* | [**getMsgVpnRestDeliveryPoints**](docs/MsgVpnApi.md#getMsgVpnRestDeliveryPoints) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints | Get a list of REST Delivery Point objects. -*MsgVpnApi* | [**getMsgVpnSequencedTopic**](docs/MsgVpnApi.md#getMsgVpnSequencedTopic) | **GET** /msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic} | Get a Sequenced Topic object. -*MsgVpnApi* | [**getMsgVpnSequencedTopics**](docs/MsgVpnApi.md#getMsgVpnSequencedTopics) | **GET** /msgVpns/{msgVpnName}/sequencedTopics | Get a list of Sequenced Topic objects. -*MsgVpnApi* | [**getMsgVpnTopicEndpoint**](docs/MsgVpnApi.md#getMsgVpnTopicEndpoint) | **GET** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Get a Topic Endpoint object. -*MsgVpnApi* | [**getMsgVpnTopicEndpointTemplate**](docs/MsgVpnApi.md#getMsgVpnTopicEndpointTemplate) | **GET** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Get a Topic Endpoint Template object. -*MsgVpnApi* | [**getMsgVpnTopicEndpointTemplates**](docs/MsgVpnApi.md#getMsgVpnTopicEndpointTemplates) | **GET** /msgVpns/{msgVpnName}/topicEndpointTemplates | Get a list of Topic Endpoint Template objects. -*MsgVpnApi* | [**getMsgVpnTopicEndpoints**](docs/MsgVpnApi.md#getMsgVpnTopicEndpoints) | **GET** /msgVpns/{msgVpnName}/topicEndpoints | Get a list of Topic Endpoint objects. -*MsgVpnApi* | [**getMsgVpns**](docs/MsgVpnApi.md#getMsgVpns) | **GET** /msgVpns | Get a list of Message VPN objects. -*MsgVpnApi* | [**replaceMsgVpn**](docs/MsgVpnApi.md#replaceMsgVpn) | **PUT** /msgVpns/{msgVpnName} | Replace a Message VPN object. -*MsgVpnApi* | [**replaceMsgVpnAclProfile**](docs/MsgVpnApi.md#replaceMsgVpnAclProfile) | **PUT** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Replace an ACL Profile object. -*MsgVpnApi* | [**replaceMsgVpnAuthenticationOauthProfile**](docs/MsgVpnApi.md#replaceMsgVpnAuthenticationOauthProfile) | **PUT** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Replace an OAuth Profile object. -*MsgVpnApi* | [**replaceMsgVpnAuthenticationOauthProvider**](docs/MsgVpnApi.md#replaceMsgVpnAuthenticationOauthProvider) | **PUT** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Replace an OAuth Provider object. -*MsgVpnApi* | [**replaceMsgVpnAuthorizationGroup**](docs/MsgVpnApi.md#replaceMsgVpnAuthorizationGroup) | **PUT** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Replace an Authorization Group object. -*MsgVpnApi* | [**replaceMsgVpnBridge**](docs/MsgVpnApi.md#replaceMsgVpnBridge) | **PUT** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Replace a Bridge object. -*MsgVpnApi* | [**replaceMsgVpnBridgeRemoteMsgVpn**](docs/MsgVpnApi.md#replaceMsgVpnBridgeRemoteMsgVpn) | **PUT** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Replace a Remote Message VPN object. -*MsgVpnApi* | [**replaceMsgVpnCertMatchingRule**](docs/MsgVpnApi.md#replaceMsgVpnCertMatchingRule) | **PUT** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Replace a Certificate Matching Rule object. -*MsgVpnApi* | [**replaceMsgVpnCertMatchingRuleAttributeFilter**](docs/MsgVpnApi.md#replaceMsgVpnCertMatchingRuleAttributeFilter) | **PUT** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Replace a Certificate Matching Rule Attribute Filter object. -*MsgVpnApi* | [**replaceMsgVpnClientProfile**](docs/MsgVpnApi.md#replaceMsgVpnClientProfile) | **PUT** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Replace a Client Profile object. -*MsgVpnApi* | [**replaceMsgVpnClientUsername**](docs/MsgVpnApi.md#replaceMsgVpnClientUsername) | **PUT** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Replace a Client Username object. -*MsgVpnApi* | [**replaceMsgVpnDistributedCache**](docs/MsgVpnApi.md#replaceMsgVpnDistributedCache) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Replace a Distributed Cache object. -*MsgVpnApi* | [**replaceMsgVpnDistributedCacheCluster**](docs/MsgVpnApi.md#replaceMsgVpnDistributedCacheCluster) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Replace a Cache Cluster object. -*MsgVpnApi* | [**replaceMsgVpnDistributedCacheClusterInstance**](docs/MsgVpnApi.md#replaceMsgVpnDistributedCacheClusterInstance) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Replace a Cache Instance object. -*MsgVpnApi* | [**replaceMsgVpnDmrBridge**](docs/MsgVpnApi.md#replaceMsgVpnDmrBridge) | **PUT** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Replace a DMR Bridge object. -*MsgVpnApi* | [**replaceMsgVpnJndiConnectionFactory**](docs/MsgVpnApi.md#replaceMsgVpnJndiConnectionFactory) | **PUT** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Replace a JNDI Connection Factory object. -*MsgVpnApi* | [**replaceMsgVpnJndiQueue**](docs/MsgVpnApi.md#replaceMsgVpnJndiQueue) | **PUT** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Replace a JNDI Queue object. -*MsgVpnApi* | [**replaceMsgVpnJndiTopic**](docs/MsgVpnApi.md#replaceMsgVpnJndiTopic) | **PUT** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Replace a JNDI Topic object. -*MsgVpnApi* | [**replaceMsgVpnMqttRetainCache**](docs/MsgVpnApi.md#replaceMsgVpnMqttRetainCache) | **PUT** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Replace an MQTT Retain Cache object. -*MsgVpnApi* | [**replaceMsgVpnMqttSession**](docs/MsgVpnApi.md#replaceMsgVpnMqttSession) | **PUT** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Replace an MQTT Session object. -*MsgVpnApi* | [**replaceMsgVpnMqttSessionSubscription**](docs/MsgVpnApi.md#replaceMsgVpnMqttSessionSubscription) | **PUT** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Replace a Subscription object. -*MsgVpnApi* | [**replaceMsgVpnQueue**](docs/MsgVpnApi.md#replaceMsgVpnQueue) | **PUT** /msgVpns/{msgVpnName}/queues/{queueName} | Replace a Queue object. -*MsgVpnApi* | [**replaceMsgVpnQueueTemplate**](docs/MsgVpnApi.md#replaceMsgVpnQueueTemplate) | **PUT** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Replace a Queue Template object. -*MsgVpnApi* | [**replaceMsgVpnReplayLog**](docs/MsgVpnApi.md#replaceMsgVpnReplayLog) | **PUT** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Replace a Replay Log object. -*MsgVpnApi* | [**replaceMsgVpnReplicatedTopic**](docs/MsgVpnApi.md#replaceMsgVpnReplicatedTopic) | **PUT** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Replace a Replicated Topic object. -*MsgVpnApi* | [**replaceMsgVpnRestDeliveryPoint**](docs/MsgVpnApi.md#replaceMsgVpnRestDeliveryPoint) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Replace a REST Delivery Point object. -*MsgVpnApi* | [**replaceMsgVpnRestDeliveryPointQueueBinding**](docs/MsgVpnApi.md#replaceMsgVpnRestDeliveryPointQueueBinding) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Replace a Queue Binding object. -*MsgVpnApi* | [**replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader**](docs/MsgVpnApi.md#replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Replace a Request Header object. -*MsgVpnApi* | [**replaceMsgVpnRestDeliveryPointRestConsumer**](docs/MsgVpnApi.md#replaceMsgVpnRestDeliveryPointRestConsumer) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Replace a REST Consumer object. -*MsgVpnApi* | [**replaceMsgVpnTopicEndpoint**](docs/MsgVpnApi.md#replaceMsgVpnTopicEndpoint) | **PUT** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Replace a Topic Endpoint object. -*MsgVpnApi* | [**replaceMsgVpnTopicEndpointTemplate**](docs/MsgVpnApi.md#replaceMsgVpnTopicEndpointTemplate) | **PUT** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Replace a Topic Endpoint Template object. -*MsgVpnApi* | [**updateMsgVpn**](docs/MsgVpnApi.md#updateMsgVpn) | **PATCH** /msgVpns/{msgVpnName} | Update a Message VPN object. -*MsgVpnApi* | [**updateMsgVpnAclProfile**](docs/MsgVpnApi.md#updateMsgVpnAclProfile) | **PATCH** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Update an ACL Profile object. -*MsgVpnApi* | [**updateMsgVpnAuthenticationOauthProfile**](docs/MsgVpnApi.md#updateMsgVpnAuthenticationOauthProfile) | **PATCH** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Update an OAuth Profile object. -*MsgVpnApi* | [**updateMsgVpnAuthenticationOauthProvider**](docs/MsgVpnApi.md#updateMsgVpnAuthenticationOauthProvider) | **PATCH** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Update an OAuth Provider object. -*MsgVpnApi* | [**updateMsgVpnAuthorizationGroup**](docs/MsgVpnApi.md#updateMsgVpnAuthorizationGroup) | **PATCH** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Update an Authorization Group object. -*MsgVpnApi* | [**updateMsgVpnBridge**](docs/MsgVpnApi.md#updateMsgVpnBridge) | **PATCH** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Update a Bridge object. -*MsgVpnApi* | [**updateMsgVpnBridgeRemoteMsgVpn**](docs/MsgVpnApi.md#updateMsgVpnBridgeRemoteMsgVpn) | **PATCH** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Update a Remote Message VPN object. -*MsgVpnApi* | [**updateMsgVpnCertMatchingRule**](docs/MsgVpnApi.md#updateMsgVpnCertMatchingRule) | **PATCH** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Update a Certificate Matching Rule object. -*MsgVpnApi* | [**updateMsgVpnCertMatchingRuleAttributeFilter**](docs/MsgVpnApi.md#updateMsgVpnCertMatchingRuleAttributeFilter) | **PATCH** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Update a Certificate Matching Rule Attribute Filter object. -*MsgVpnApi* | [**updateMsgVpnClientProfile**](docs/MsgVpnApi.md#updateMsgVpnClientProfile) | **PATCH** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Update a Client Profile object. -*MsgVpnApi* | [**updateMsgVpnClientUsername**](docs/MsgVpnApi.md#updateMsgVpnClientUsername) | **PATCH** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Update a Client Username object. -*MsgVpnApi* | [**updateMsgVpnDistributedCache**](docs/MsgVpnApi.md#updateMsgVpnDistributedCache) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Update a Distributed Cache object. -*MsgVpnApi* | [**updateMsgVpnDistributedCacheCluster**](docs/MsgVpnApi.md#updateMsgVpnDistributedCacheCluster) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Update a Cache Cluster object. -*MsgVpnApi* | [**updateMsgVpnDistributedCacheClusterInstance**](docs/MsgVpnApi.md#updateMsgVpnDistributedCacheClusterInstance) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Update a Cache Instance object. -*MsgVpnApi* | [**updateMsgVpnDmrBridge**](docs/MsgVpnApi.md#updateMsgVpnDmrBridge) | **PATCH** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Update a DMR Bridge object. -*MsgVpnApi* | [**updateMsgVpnJndiConnectionFactory**](docs/MsgVpnApi.md#updateMsgVpnJndiConnectionFactory) | **PATCH** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Update a JNDI Connection Factory object. -*MsgVpnApi* | [**updateMsgVpnJndiQueue**](docs/MsgVpnApi.md#updateMsgVpnJndiQueue) | **PATCH** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Update a JNDI Queue object. -*MsgVpnApi* | [**updateMsgVpnJndiTopic**](docs/MsgVpnApi.md#updateMsgVpnJndiTopic) | **PATCH** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Update a JNDI Topic object. -*MsgVpnApi* | [**updateMsgVpnMqttRetainCache**](docs/MsgVpnApi.md#updateMsgVpnMqttRetainCache) | **PATCH** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Update an MQTT Retain Cache object. -*MsgVpnApi* | [**updateMsgVpnMqttSession**](docs/MsgVpnApi.md#updateMsgVpnMqttSession) | **PATCH** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Update an MQTT Session object. -*MsgVpnApi* | [**updateMsgVpnMqttSessionSubscription**](docs/MsgVpnApi.md#updateMsgVpnMqttSessionSubscription) | **PATCH** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Update a Subscription object. -*MsgVpnApi* | [**updateMsgVpnQueue**](docs/MsgVpnApi.md#updateMsgVpnQueue) | **PATCH** /msgVpns/{msgVpnName}/queues/{queueName} | Update a Queue object. -*MsgVpnApi* | [**updateMsgVpnQueueTemplate**](docs/MsgVpnApi.md#updateMsgVpnQueueTemplate) | **PATCH** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Update a Queue Template object. -*MsgVpnApi* | [**updateMsgVpnReplayLog**](docs/MsgVpnApi.md#updateMsgVpnReplayLog) | **PATCH** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Update a Replay Log object. -*MsgVpnApi* | [**updateMsgVpnReplicatedTopic**](docs/MsgVpnApi.md#updateMsgVpnReplicatedTopic) | **PATCH** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Update a Replicated Topic object. -*MsgVpnApi* | [**updateMsgVpnRestDeliveryPoint**](docs/MsgVpnApi.md#updateMsgVpnRestDeliveryPoint) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Update a REST Delivery Point object. -*MsgVpnApi* | [**updateMsgVpnRestDeliveryPointQueueBinding**](docs/MsgVpnApi.md#updateMsgVpnRestDeliveryPointQueueBinding) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Update a Queue Binding object. -*MsgVpnApi* | [**updateMsgVpnRestDeliveryPointQueueBindingRequestHeader**](docs/MsgVpnApi.md#updateMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Update a Request Header object. -*MsgVpnApi* | [**updateMsgVpnRestDeliveryPointRestConsumer**](docs/MsgVpnApi.md#updateMsgVpnRestDeliveryPointRestConsumer) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Update a REST Consumer object. -*MsgVpnApi* | [**updateMsgVpnTopicEndpoint**](docs/MsgVpnApi.md#updateMsgVpnTopicEndpoint) | **PATCH** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Update a Topic Endpoint object. -*MsgVpnApi* | [**updateMsgVpnTopicEndpointTemplate**](docs/MsgVpnApi.md#updateMsgVpnTopicEndpointTemplate) | **PATCH** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Update a Topic Endpoint Template object. -*OauthProfileApi* | [**createOauthProfile**](docs/OauthProfileApi.md#createOauthProfile) | **POST** /oauthProfiles | Create an OAuth Profile object. -*OauthProfileApi* | [**createOauthProfileAccessLevelGroup**](docs/OauthProfileApi.md#createOauthProfileAccessLevelGroup) | **POST** /oauthProfiles/{oauthProfileName}/accessLevelGroups | Create a Group Access Level object. -*OauthProfileApi* | [**createOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](docs/OauthProfileApi.md#createOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **POST** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions | Create a Message VPN Access-Level Exception object. -*OauthProfileApi* | [**createOauthProfileClientAllowedHost**](docs/OauthProfileApi.md#createOauthProfileClientAllowedHost) | **POST** /oauthProfiles/{oauthProfileName}/clientAllowedHosts | Create an Allowed Host Value object. -*OauthProfileApi* | [**createOauthProfileClientAuthorizationParameter**](docs/OauthProfileApi.md#createOauthProfileClientAuthorizationParameter) | **POST** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters | Create an Authorization Parameter object. -*OauthProfileApi* | [**createOauthProfileClientRequiredClaim**](docs/OauthProfileApi.md#createOauthProfileClientRequiredClaim) | **POST** /oauthProfiles/{oauthProfileName}/clientRequiredClaims | Create a Required Claim object. -*OauthProfileApi* | [**createOauthProfileDefaultMsgVpnAccessLevelException**](docs/OauthProfileApi.md#createOauthProfileDefaultMsgVpnAccessLevelException) | **POST** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions | Create a Message VPN Access-Level Exception object. -*OauthProfileApi* | [**createOauthProfileResourceServerRequiredClaim**](docs/OauthProfileApi.md#createOauthProfileResourceServerRequiredClaim) | **POST** /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Create a Required Claim object. -*OauthProfileApi* | [**deleteOauthProfile**](docs/OauthProfileApi.md#deleteOauthProfile) | **DELETE** /oauthProfiles/{oauthProfileName} | Delete an OAuth Profile object. -*OauthProfileApi* | [**deleteOauthProfileAccessLevelGroup**](docs/OauthProfileApi.md#deleteOauthProfileAccessLevelGroup) | **DELETE** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName} | Delete a Group Access Level object. -*OauthProfileApi* | [**deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](docs/OauthProfileApi.md#deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **DELETE** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName} | Delete a Message VPN Access-Level Exception object. -*OauthProfileApi* | [**deleteOauthProfileClientAllowedHost**](docs/OauthProfileApi.md#deleteOauthProfileClientAllowedHost) | **DELETE** /oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost} | Delete an Allowed Host Value object. -*OauthProfileApi* | [**deleteOauthProfileClientAuthorizationParameter**](docs/OauthProfileApi.md#deleteOauthProfileClientAuthorizationParameter) | **DELETE** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName} | Delete an Authorization Parameter object. -*OauthProfileApi* | [**deleteOauthProfileClientRequiredClaim**](docs/OauthProfileApi.md#deleteOauthProfileClientRequiredClaim) | **DELETE** /oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Delete a Required Claim object. -*OauthProfileApi* | [**deleteOauthProfileDefaultMsgVpnAccessLevelException**](docs/OauthProfileApi.md#deleteOauthProfileDefaultMsgVpnAccessLevelException) | **DELETE** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName} | Delete a Message VPN Access-Level Exception object. -*OauthProfileApi* | [**deleteOauthProfileResourceServerRequiredClaim**](docs/OauthProfileApi.md#deleteOauthProfileResourceServerRequiredClaim) | **DELETE** /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Delete a Required Claim object. -*OauthProfileApi* | [**getOauthProfile**](docs/OauthProfileApi.md#getOauthProfile) | **GET** /oauthProfiles/{oauthProfileName} | Get an OAuth Profile object. -*OauthProfileApi* | [**getOauthProfileAccessLevelGroup**](docs/OauthProfileApi.md#getOauthProfileAccessLevelGroup) | **GET** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName} | Get a Group Access Level object. -*OauthProfileApi* | [**getOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](docs/OauthProfileApi.md#getOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **GET** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName} | Get a Message VPN Access-Level Exception object. -*OauthProfileApi* | [**getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions**](docs/OauthProfileApi.md#getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions) | **GET** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions | Get a list of Message VPN Access-Level Exception objects. -*OauthProfileApi* | [**getOauthProfileAccessLevelGroups**](docs/OauthProfileApi.md#getOauthProfileAccessLevelGroups) | **GET** /oauthProfiles/{oauthProfileName}/accessLevelGroups | Get a list of Group Access Level objects. -*OauthProfileApi* | [**getOauthProfileClientAllowedHost**](docs/OauthProfileApi.md#getOauthProfileClientAllowedHost) | **GET** /oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost} | Get an Allowed Host Value object. -*OauthProfileApi* | [**getOauthProfileClientAllowedHosts**](docs/OauthProfileApi.md#getOauthProfileClientAllowedHosts) | **GET** /oauthProfiles/{oauthProfileName}/clientAllowedHosts | Get a list of Allowed Host Value objects. -*OauthProfileApi* | [**getOauthProfileClientAuthorizationParameter**](docs/OauthProfileApi.md#getOauthProfileClientAuthorizationParameter) | **GET** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName} | Get an Authorization Parameter object. -*OauthProfileApi* | [**getOauthProfileClientAuthorizationParameters**](docs/OauthProfileApi.md#getOauthProfileClientAuthorizationParameters) | **GET** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters | Get a list of Authorization Parameter objects. -*OauthProfileApi* | [**getOauthProfileClientRequiredClaim**](docs/OauthProfileApi.md#getOauthProfileClientRequiredClaim) | **GET** /oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Get a Required Claim object. -*OauthProfileApi* | [**getOauthProfileClientRequiredClaims**](docs/OauthProfileApi.md#getOauthProfileClientRequiredClaims) | **GET** /oauthProfiles/{oauthProfileName}/clientRequiredClaims | Get a list of Required Claim objects. -*OauthProfileApi* | [**getOauthProfileDefaultMsgVpnAccessLevelException**](docs/OauthProfileApi.md#getOauthProfileDefaultMsgVpnAccessLevelException) | **GET** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName} | Get a Message VPN Access-Level Exception object. -*OauthProfileApi* | [**getOauthProfileDefaultMsgVpnAccessLevelExceptions**](docs/OauthProfileApi.md#getOauthProfileDefaultMsgVpnAccessLevelExceptions) | **GET** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions | Get a list of Message VPN Access-Level Exception objects. -*OauthProfileApi* | [**getOauthProfileResourceServerRequiredClaim**](docs/OauthProfileApi.md#getOauthProfileResourceServerRequiredClaim) | **GET** /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Get a Required Claim object. -*OauthProfileApi* | [**getOauthProfileResourceServerRequiredClaims**](docs/OauthProfileApi.md#getOauthProfileResourceServerRequiredClaims) | **GET** /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Get a list of Required Claim objects. -*OauthProfileApi* | [**getOauthProfiles**](docs/OauthProfileApi.md#getOauthProfiles) | **GET** /oauthProfiles | Get a list of OAuth Profile objects. -*OauthProfileApi* | [**replaceOauthProfile**](docs/OauthProfileApi.md#replaceOauthProfile) | **PUT** /oauthProfiles/{oauthProfileName} | Replace an OAuth Profile object. -*OauthProfileApi* | [**replaceOauthProfileAccessLevelGroup**](docs/OauthProfileApi.md#replaceOauthProfileAccessLevelGroup) | **PUT** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName} | Replace a Group Access Level object. -*OauthProfileApi* | [**replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](docs/OauthProfileApi.md#replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **PUT** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName} | Replace a Message VPN Access-Level Exception object. -*OauthProfileApi* | [**replaceOauthProfileClientAuthorizationParameter**](docs/OauthProfileApi.md#replaceOauthProfileClientAuthorizationParameter) | **PUT** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName} | Replace an Authorization Parameter object. -*OauthProfileApi* | [**replaceOauthProfileDefaultMsgVpnAccessLevelException**](docs/OauthProfileApi.md#replaceOauthProfileDefaultMsgVpnAccessLevelException) | **PUT** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName} | Replace a Message VPN Access-Level Exception object. -*OauthProfileApi* | [**updateOauthProfile**](docs/OauthProfileApi.md#updateOauthProfile) | **PATCH** /oauthProfiles/{oauthProfileName} | Update an OAuth Profile object. -*OauthProfileApi* | [**updateOauthProfileAccessLevelGroup**](docs/OauthProfileApi.md#updateOauthProfileAccessLevelGroup) | **PATCH** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName} | Update a Group Access Level object. -*OauthProfileApi* | [**updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](docs/OauthProfileApi.md#updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **PATCH** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName} | Update a Message VPN Access-Level Exception object. -*OauthProfileApi* | [**updateOauthProfileClientAuthorizationParameter**](docs/OauthProfileApi.md#updateOauthProfileClientAuthorizationParameter) | **PATCH** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName} | Update an Authorization Parameter object. -*OauthProfileApi* | [**updateOauthProfileDefaultMsgVpnAccessLevelException**](docs/OauthProfileApi.md#updateOauthProfileDefaultMsgVpnAccessLevelException) | **PATCH** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName} | Update a Message VPN Access-Level Exception object. -*QueueApi* | [**createMsgVpnQueue**](docs/QueueApi.md#createMsgVpnQueue) | **POST** /msgVpns/{msgVpnName}/queues | Create a Queue object. -*QueueApi* | [**createMsgVpnQueueSubscription**](docs/QueueApi.md#createMsgVpnQueueSubscription) | **POST** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions | Create a Queue Subscription object. -*QueueApi* | [**deleteMsgVpnQueue**](docs/QueueApi.md#deleteMsgVpnQueue) | **DELETE** /msgVpns/{msgVpnName}/queues/{queueName} | Delete a Queue object. -*QueueApi* | [**deleteMsgVpnQueueSubscription**](docs/QueueApi.md#deleteMsgVpnQueueSubscription) | **DELETE** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic} | Delete a Queue Subscription object. -*QueueApi* | [**getMsgVpnQueue**](docs/QueueApi.md#getMsgVpnQueue) | **GET** /msgVpns/{msgVpnName}/queues/{queueName} | Get a Queue object. -*QueueApi* | [**getMsgVpnQueueSubscription**](docs/QueueApi.md#getMsgVpnQueueSubscription) | **GET** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic} | Get a Queue Subscription object. -*QueueApi* | [**getMsgVpnQueueSubscriptions**](docs/QueueApi.md#getMsgVpnQueueSubscriptions) | **GET** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions | Get a list of Queue Subscription objects. -*QueueApi* | [**getMsgVpnQueues**](docs/QueueApi.md#getMsgVpnQueues) | **GET** /msgVpns/{msgVpnName}/queues | Get a list of Queue objects. -*QueueApi* | [**replaceMsgVpnQueue**](docs/QueueApi.md#replaceMsgVpnQueue) | **PUT** /msgVpns/{msgVpnName}/queues/{queueName} | Replace a Queue object. -*QueueApi* | [**updateMsgVpnQueue**](docs/QueueApi.md#updateMsgVpnQueue) | **PATCH** /msgVpns/{msgVpnName}/queues/{queueName} | Update a Queue object. -*QueueTemplateApi* | [**createMsgVpnQueueTemplate**](docs/QueueTemplateApi.md#createMsgVpnQueueTemplate) | **POST** /msgVpns/{msgVpnName}/queueTemplates | Create a Queue Template object. -*QueueTemplateApi* | [**deleteMsgVpnQueueTemplate**](docs/QueueTemplateApi.md#deleteMsgVpnQueueTemplate) | **DELETE** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Delete a Queue Template object. -*QueueTemplateApi* | [**getMsgVpnQueueTemplate**](docs/QueueTemplateApi.md#getMsgVpnQueueTemplate) | **GET** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Get a Queue Template object. -*QueueTemplateApi* | [**getMsgVpnQueueTemplates**](docs/QueueTemplateApi.md#getMsgVpnQueueTemplates) | **GET** /msgVpns/{msgVpnName}/queueTemplates | Get a list of Queue Template objects. -*QueueTemplateApi* | [**replaceMsgVpnQueueTemplate**](docs/QueueTemplateApi.md#replaceMsgVpnQueueTemplate) | **PUT** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Replace a Queue Template object. -*QueueTemplateApi* | [**updateMsgVpnQueueTemplate**](docs/QueueTemplateApi.md#updateMsgVpnQueueTemplate) | **PATCH** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Update a Queue Template object. -*ReplayLogApi* | [**createMsgVpnReplayLog**](docs/ReplayLogApi.md#createMsgVpnReplayLog) | **POST** /msgVpns/{msgVpnName}/replayLogs | Create a Replay Log object. -*ReplayLogApi* | [**createMsgVpnReplayLogTopicFilterSubscription**](docs/ReplayLogApi.md#createMsgVpnReplayLogTopicFilterSubscription) | **POST** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions | Create a Topic Filter Subscription object. -*ReplayLogApi* | [**deleteMsgVpnReplayLog**](docs/ReplayLogApi.md#deleteMsgVpnReplayLog) | **DELETE** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Delete a Replay Log object. -*ReplayLogApi* | [**deleteMsgVpnReplayLogTopicFilterSubscription**](docs/ReplayLogApi.md#deleteMsgVpnReplayLogTopicFilterSubscription) | **DELETE** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription} | Delete a Topic Filter Subscription object. -*ReplayLogApi* | [**getMsgVpnReplayLog**](docs/ReplayLogApi.md#getMsgVpnReplayLog) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Get a Replay Log object. -*ReplayLogApi* | [**getMsgVpnReplayLogTopicFilterSubscription**](docs/ReplayLogApi.md#getMsgVpnReplayLogTopicFilterSubscription) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription} | Get a Topic Filter Subscription object. -*ReplayLogApi* | [**getMsgVpnReplayLogTopicFilterSubscriptions**](docs/ReplayLogApi.md#getMsgVpnReplayLogTopicFilterSubscriptions) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions | Get a list of Topic Filter Subscription objects. -*ReplayLogApi* | [**getMsgVpnReplayLogs**](docs/ReplayLogApi.md#getMsgVpnReplayLogs) | **GET** /msgVpns/{msgVpnName}/replayLogs | Get a list of Replay Log objects. -*ReplayLogApi* | [**replaceMsgVpnReplayLog**](docs/ReplayLogApi.md#replaceMsgVpnReplayLog) | **PUT** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Replace a Replay Log object. -*ReplayLogApi* | [**updateMsgVpnReplayLog**](docs/ReplayLogApi.md#updateMsgVpnReplayLog) | **PATCH** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Update a Replay Log object. -*ReplicatedTopicApi* | [**createMsgVpnReplicatedTopic**](docs/ReplicatedTopicApi.md#createMsgVpnReplicatedTopic) | **POST** /msgVpns/{msgVpnName}/replicatedTopics | Create a Replicated Topic object. -*ReplicatedTopicApi* | [**deleteMsgVpnReplicatedTopic**](docs/ReplicatedTopicApi.md#deleteMsgVpnReplicatedTopic) | **DELETE** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Delete a Replicated Topic object. -*ReplicatedTopicApi* | [**getMsgVpnReplicatedTopic**](docs/ReplicatedTopicApi.md#getMsgVpnReplicatedTopic) | **GET** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Get a Replicated Topic object. -*ReplicatedTopicApi* | [**getMsgVpnReplicatedTopics**](docs/ReplicatedTopicApi.md#getMsgVpnReplicatedTopics) | **GET** /msgVpns/{msgVpnName}/replicatedTopics | Get a list of Replicated Topic objects. -*ReplicatedTopicApi* | [**replaceMsgVpnReplicatedTopic**](docs/ReplicatedTopicApi.md#replaceMsgVpnReplicatedTopic) | **PUT** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Replace a Replicated Topic object. -*ReplicatedTopicApi* | [**updateMsgVpnReplicatedTopic**](docs/ReplicatedTopicApi.md#updateMsgVpnReplicatedTopic) | **PATCH** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Update a Replicated Topic object. -*RestDeliveryPointApi* | [**createMsgVpnRestDeliveryPoint**](docs/RestDeliveryPointApi.md#createMsgVpnRestDeliveryPoint) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints | Create a REST Delivery Point object. -*RestDeliveryPointApi* | [**createMsgVpnRestDeliveryPointQueueBinding**](docs/RestDeliveryPointApi.md#createMsgVpnRestDeliveryPointQueueBinding) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings | Create a Queue Binding object. -*RestDeliveryPointApi* | [**createMsgVpnRestDeliveryPointQueueBindingRequestHeader**](docs/RestDeliveryPointApi.md#createMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders | Create a Request Header object. -*RestDeliveryPointApi* | [**createMsgVpnRestDeliveryPointRestConsumer**](docs/RestDeliveryPointApi.md#createMsgVpnRestDeliveryPointRestConsumer) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers | Create a REST Consumer object. -*RestDeliveryPointApi* | [**createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](docs/RestDeliveryPointApi.md#createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims | Create a Claim object. -*RestDeliveryPointApi* | [**createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](docs/RestDeliveryPointApi.md#createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames | Create a Trusted Common Name object. -*RestDeliveryPointApi* | [**deleteMsgVpnRestDeliveryPoint**](docs/RestDeliveryPointApi.md#deleteMsgVpnRestDeliveryPoint) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Delete a REST Delivery Point object. -*RestDeliveryPointApi* | [**deleteMsgVpnRestDeliveryPointQueueBinding**](docs/RestDeliveryPointApi.md#deleteMsgVpnRestDeliveryPointQueueBinding) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Delete a Queue Binding object. -*RestDeliveryPointApi* | [**deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader**](docs/RestDeliveryPointApi.md#deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Delete a Request Header object. -*RestDeliveryPointApi* | [**deleteMsgVpnRestDeliveryPointRestConsumer**](docs/RestDeliveryPointApi.md#deleteMsgVpnRestDeliveryPointRestConsumer) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Delete a REST Consumer object. -*RestDeliveryPointApi* | [**deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](docs/RestDeliveryPointApi.md#deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName} | Delete a Claim object. -*RestDeliveryPointApi* | [**deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](docs/RestDeliveryPointApi.md#deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Delete a Trusted Common Name object. -*RestDeliveryPointApi* | [**getMsgVpnRestDeliveryPoint**](docs/RestDeliveryPointApi.md#getMsgVpnRestDeliveryPoint) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Get a REST Delivery Point object. -*RestDeliveryPointApi* | [**getMsgVpnRestDeliveryPointQueueBinding**](docs/RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointQueueBinding) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Get a Queue Binding object. -*RestDeliveryPointApi* | [**getMsgVpnRestDeliveryPointQueueBindingRequestHeader**](docs/RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Get a Request Header object. -*RestDeliveryPointApi* | [**getMsgVpnRestDeliveryPointQueueBindingRequestHeaders**](docs/RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointQueueBindingRequestHeaders) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders | Get a list of Request Header objects. -*RestDeliveryPointApi* | [**getMsgVpnRestDeliveryPointQueueBindings**](docs/RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointQueueBindings) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings | Get a list of Queue Binding objects. -*RestDeliveryPointApi* | [**getMsgVpnRestDeliveryPointRestConsumer**](docs/RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointRestConsumer) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Get a REST Consumer object. -*RestDeliveryPointApi* | [**getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](docs/RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName} | Get a Claim object. -*RestDeliveryPointApi* | [**getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims**](docs/RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims | Get a list of Claim objects. -*RestDeliveryPointApi* | [**getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](docs/RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Get a Trusted Common Name object. -*RestDeliveryPointApi* | [**getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames**](docs/RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames | Get a list of Trusted Common Name objects. -*RestDeliveryPointApi* | [**getMsgVpnRestDeliveryPointRestConsumers**](docs/RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointRestConsumers) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers | Get a list of REST Consumer objects. -*RestDeliveryPointApi* | [**getMsgVpnRestDeliveryPoints**](docs/RestDeliveryPointApi.md#getMsgVpnRestDeliveryPoints) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints | Get a list of REST Delivery Point objects. -*RestDeliveryPointApi* | [**replaceMsgVpnRestDeliveryPoint**](docs/RestDeliveryPointApi.md#replaceMsgVpnRestDeliveryPoint) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Replace a REST Delivery Point object. -*RestDeliveryPointApi* | [**replaceMsgVpnRestDeliveryPointQueueBinding**](docs/RestDeliveryPointApi.md#replaceMsgVpnRestDeliveryPointQueueBinding) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Replace a Queue Binding object. -*RestDeliveryPointApi* | [**replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader**](docs/RestDeliveryPointApi.md#replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Replace a Request Header object. -*RestDeliveryPointApi* | [**replaceMsgVpnRestDeliveryPointRestConsumer**](docs/RestDeliveryPointApi.md#replaceMsgVpnRestDeliveryPointRestConsumer) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Replace a REST Consumer object. -*RestDeliveryPointApi* | [**updateMsgVpnRestDeliveryPoint**](docs/RestDeliveryPointApi.md#updateMsgVpnRestDeliveryPoint) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Update a REST Delivery Point object. -*RestDeliveryPointApi* | [**updateMsgVpnRestDeliveryPointQueueBinding**](docs/RestDeliveryPointApi.md#updateMsgVpnRestDeliveryPointQueueBinding) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Update a Queue Binding object. -*RestDeliveryPointApi* | [**updateMsgVpnRestDeliveryPointQueueBindingRequestHeader**](docs/RestDeliveryPointApi.md#updateMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Update a Request Header object. -*RestDeliveryPointApi* | [**updateMsgVpnRestDeliveryPointRestConsumer**](docs/RestDeliveryPointApi.md#updateMsgVpnRestDeliveryPointRestConsumer) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Update a REST Consumer object. -*SystemInformationApi* | [**getSystemInformation**](docs/SystemInformationApi.md#getSystemInformation) | **GET** /systemInformation | Get a System Information object. -*TopicEndpointApi* | [**createMsgVpnTopicEndpoint**](docs/TopicEndpointApi.md#createMsgVpnTopicEndpoint) | **POST** /msgVpns/{msgVpnName}/topicEndpoints | Create a Topic Endpoint object. -*TopicEndpointApi* | [**deleteMsgVpnTopicEndpoint**](docs/TopicEndpointApi.md#deleteMsgVpnTopicEndpoint) | **DELETE** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Delete a Topic Endpoint object. -*TopicEndpointApi* | [**getMsgVpnTopicEndpoint**](docs/TopicEndpointApi.md#getMsgVpnTopicEndpoint) | **GET** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Get a Topic Endpoint object. -*TopicEndpointApi* | [**getMsgVpnTopicEndpoints**](docs/TopicEndpointApi.md#getMsgVpnTopicEndpoints) | **GET** /msgVpns/{msgVpnName}/topicEndpoints | Get a list of Topic Endpoint objects. -*TopicEndpointApi* | [**replaceMsgVpnTopicEndpoint**](docs/TopicEndpointApi.md#replaceMsgVpnTopicEndpoint) | **PUT** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Replace a Topic Endpoint object. -*TopicEndpointApi* | [**updateMsgVpnTopicEndpoint**](docs/TopicEndpointApi.md#updateMsgVpnTopicEndpoint) | **PATCH** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Update a Topic Endpoint object. -*TopicEndpointTemplateApi* | [**createMsgVpnTopicEndpointTemplate**](docs/TopicEndpointTemplateApi.md#createMsgVpnTopicEndpointTemplate) | **POST** /msgVpns/{msgVpnName}/topicEndpointTemplates | Create a Topic Endpoint Template object. -*TopicEndpointTemplateApi* | [**deleteMsgVpnTopicEndpointTemplate**](docs/TopicEndpointTemplateApi.md#deleteMsgVpnTopicEndpointTemplate) | **DELETE** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Delete a Topic Endpoint Template object. -*TopicEndpointTemplateApi* | [**getMsgVpnTopicEndpointTemplate**](docs/TopicEndpointTemplateApi.md#getMsgVpnTopicEndpointTemplate) | **GET** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Get a Topic Endpoint Template object. -*TopicEndpointTemplateApi* | [**getMsgVpnTopicEndpointTemplates**](docs/TopicEndpointTemplateApi.md#getMsgVpnTopicEndpointTemplates) | **GET** /msgVpns/{msgVpnName}/topicEndpointTemplates | Get a list of Topic Endpoint Template objects. -*TopicEndpointTemplateApi* | [**replaceMsgVpnTopicEndpointTemplate**](docs/TopicEndpointTemplateApi.md#replaceMsgVpnTopicEndpointTemplate) | **PUT** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Replace a Topic Endpoint Template object. -*TopicEndpointTemplateApi* | [**updateMsgVpnTopicEndpointTemplate**](docs/TopicEndpointTemplateApi.md#updateMsgVpnTopicEndpointTemplate) | **PATCH** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Update a Topic Endpoint Template object. -*VirtualHostnameApi* | [**createVirtualHostname**](docs/VirtualHostnameApi.md#createVirtualHostname) | **POST** /virtualHostnames | Create a Virtual Hostname object. -*VirtualHostnameApi* | [**deleteVirtualHostname**](docs/VirtualHostnameApi.md#deleteVirtualHostname) | **DELETE** /virtualHostnames/{virtualHostname} | Delete a Virtual Hostname object. -*VirtualHostnameApi* | [**getVirtualHostname**](docs/VirtualHostnameApi.md#getVirtualHostname) | **GET** /virtualHostnames/{virtualHostname} | Get a Virtual Hostname object. -*VirtualHostnameApi* | [**getVirtualHostnames**](docs/VirtualHostnameApi.md#getVirtualHostnames) | **GET** /virtualHostnames | Get a list of Virtual Hostname objects. -*VirtualHostnameApi* | [**replaceVirtualHostname**](docs/VirtualHostnameApi.md#replaceVirtualHostname) | **PUT** /virtualHostnames/{virtualHostname} | Replace a Virtual Hostname object. -*VirtualHostnameApi* | [**updateVirtualHostname**](docs/VirtualHostnameApi.md#updateVirtualHostname) | **PATCH** /virtualHostnames/{virtualHostname} | Update a Virtual Hostname object. - - -## Documentation for Models - - - [AboutApi](docs/AboutApi.md) - - [AboutApiLinks](docs/AboutApiLinks.md) - - [AboutApiResponse](docs/AboutApiResponse.md) - - [AboutLinks](docs/AboutLinks.md) - - [AboutResponse](docs/AboutResponse.md) - - [AboutUser](docs/AboutUser.md) - - [AboutUserLinks](docs/AboutUserLinks.md) - - [AboutUserMsgVpn](docs/AboutUserMsgVpn.md) - - [AboutUserMsgVpnLinks](docs/AboutUserMsgVpnLinks.md) - - [AboutUserMsgVpnResponse](docs/AboutUserMsgVpnResponse.md) - - [AboutUserMsgVpnsResponse](docs/AboutUserMsgVpnsResponse.md) - - [AboutUserResponse](docs/AboutUserResponse.md) - - [Broker](docs/Broker.md) - - [BrokerLinks](docs/BrokerLinks.md) - - [BrokerResponse](docs/BrokerResponse.md) - - [CertAuthoritiesResponse](docs/CertAuthoritiesResponse.md) - - [CertAuthority](docs/CertAuthority.md) - - [CertAuthorityLinks](docs/CertAuthorityLinks.md) - - [CertAuthorityOcspTlsTrustedCommonName](docs/CertAuthorityOcspTlsTrustedCommonName.md) - - [CertAuthorityOcspTlsTrustedCommonNameLinks](docs/CertAuthorityOcspTlsTrustedCommonNameLinks.md) - - [CertAuthorityOcspTlsTrustedCommonNameResponse](docs/CertAuthorityOcspTlsTrustedCommonNameResponse.md) - - [CertAuthorityOcspTlsTrustedCommonNamesResponse](docs/CertAuthorityOcspTlsTrustedCommonNamesResponse.md) - - [CertAuthorityResponse](docs/CertAuthorityResponse.md) - - [ClientCertAuthoritiesResponse](docs/ClientCertAuthoritiesResponse.md) - - [ClientCertAuthority](docs/ClientCertAuthority.md) - - [ClientCertAuthorityLinks](docs/ClientCertAuthorityLinks.md) - - [ClientCertAuthorityOcspTlsTrustedCommonName](docs/ClientCertAuthorityOcspTlsTrustedCommonName.md) - - [ClientCertAuthorityOcspTlsTrustedCommonNameLinks](docs/ClientCertAuthorityOcspTlsTrustedCommonNameLinks.md) - - [ClientCertAuthorityOcspTlsTrustedCommonNameResponse](docs/ClientCertAuthorityOcspTlsTrustedCommonNameResponse.md) - - [ClientCertAuthorityOcspTlsTrustedCommonNamesResponse](docs/ClientCertAuthorityOcspTlsTrustedCommonNamesResponse.md) - - [ClientCertAuthorityResponse](docs/ClientCertAuthorityResponse.md) - - [DmrCluster](docs/DmrCluster.md) - - [DmrClusterCertMatchingRule](docs/DmrClusterCertMatchingRule.md) - - [DmrClusterCertMatchingRuleAttributeFilter](docs/DmrClusterCertMatchingRuleAttributeFilter.md) - - [DmrClusterCertMatchingRuleAttributeFilterLinks](docs/DmrClusterCertMatchingRuleAttributeFilterLinks.md) - - [DmrClusterCertMatchingRuleAttributeFilterResponse](docs/DmrClusterCertMatchingRuleAttributeFilterResponse.md) - - [DmrClusterCertMatchingRuleAttributeFiltersResponse](docs/DmrClusterCertMatchingRuleAttributeFiltersResponse.md) - - [DmrClusterCertMatchingRuleCondition](docs/DmrClusterCertMatchingRuleCondition.md) - - [DmrClusterCertMatchingRuleConditionLinks](docs/DmrClusterCertMatchingRuleConditionLinks.md) - - [DmrClusterCertMatchingRuleConditionResponse](docs/DmrClusterCertMatchingRuleConditionResponse.md) - - [DmrClusterCertMatchingRuleConditionsResponse](docs/DmrClusterCertMatchingRuleConditionsResponse.md) - - [DmrClusterCertMatchingRuleLinks](docs/DmrClusterCertMatchingRuleLinks.md) - - [DmrClusterCertMatchingRuleResponse](docs/DmrClusterCertMatchingRuleResponse.md) - - [DmrClusterCertMatchingRulesResponse](docs/DmrClusterCertMatchingRulesResponse.md) - - [DmrClusterLink](docs/DmrClusterLink.md) - - [DmrClusterLinkAttribute](docs/DmrClusterLinkAttribute.md) - - [DmrClusterLinkAttributeLinks](docs/DmrClusterLinkAttributeLinks.md) - - [DmrClusterLinkAttributeResponse](docs/DmrClusterLinkAttributeResponse.md) - - [DmrClusterLinkAttributesResponse](docs/DmrClusterLinkAttributesResponse.md) - - [DmrClusterLinkLinks](docs/DmrClusterLinkLinks.md) - - [DmrClusterLinkRemoteAddress](docs/DmrClusterLinkRemoteAddress.md) - - [DmrClusterLinkRemoteAddressLinks](docs/DmrClusterLinkRemoteAddressLinks.md) - - [DmrClusterLinkRemoteAddressResponse](docs/DmrClusterLinkRemoteAddressResponse.md) - - [DmrClusterLinkRemoteAddressesResponse](docs/DmrClusterLinkRemoteAddressesResponse.md) - - [DmrClusterLinkResponse](docs/DmrClusterLinkResponse.md) - - [DmrClusterLinkTlsTrustedCommonName](docs/DmrClusterLinkTlsTrustedCommonName.md) - - [DmrClusterLinkTlsTrustedCommonNameLinks](docs/DmrClusterLinkTlsTrustedCommonNameLinks.md) - - [DmrClusterLinkTlsTrustedCommonNameResponse](docs/DmrClusterLinkTlsTrustedCommonNameResponse.md) - - [DmrClusterLinkTlsTrustedCommonNamesResponse](docs/DmrClusterLinkTlsTrustedCommonNamesResponse.md) - - [DmrClusterLinks](docs/DmrClusterLinks.md) - - [DmrClusterLinksResponse](docs/DmrClusterLinksResponse.md) - - [DmrClusterResponse](docs/DmrClusterResponse.md) - - [DmrClustersResponse](docs/DmrClustersResponse.md) - - [DomainCertAuthoritiesResponse](docs/DomainCertAuthoritiesResponse.md) - - [DomainCertAuthority](docs/DomainCertAuthority.md) - - [DomainCertAuthorityLinks](docs/DomainCertAuthorityLinks.md) - - [DomainCertAuthorityResponse](docs/DomainCertAuthorityResponse.md) - - [EventThreshold](docs/EventThreshold.md) - - [EventThresholdByPercent](docs/EventThresholdByPercent.md) - - [EventThresholdByValue](docs/EventThresholdByValue.md) - - [MsgVpn](docs/MsgVpn.md) - - [MsgVpnAclProfile](docs/MsgVpnAclProfile.md) - - [MsgVpnAclProfileClientConnectException](docs/MsgVpnAclProfileClientConnectException.md) - - [MsgVpnAclProfileClientConnectExceptionLinks](docs/MsgVpnAclProfileClientConnectExceptionLinks.md) - - [MsgVpnAclProfileClientConnectExceptionResponse](docs/MsgVpnAclProfileClientConnectExceptionResponse.md) - - [MsgVpnAclProfileClientConnectExceptionsResponse](docs/MsgVpnAclProfileClientConnectExceptionsResponse.md) - - [MsgVpnAclProfileLinks](docs/MsgVpnAclProfileLinks.md) - - [MsgVpnAclProfilePublishException](docs/MsgVpnAclProfilePublishException.md) - - [MsgVpnAclProfilePublishExceptionLinks](docs/MsgVpnAclProfilePublishExceptionLinks.md) - - [MsgVpnAclProfilePublishExceptionResponse](docs/MsgVpnAclProfilePublishExceptionResponse.md) - - [MsgVpnAclProfilePublishExceptionsResponse](docs/MsgVpnAclProfilePublishExceptionsResponse.md) - - [MsgVpnAclProfilePublishTopicException](docs/MsgVpnAclProfilePublishTopicException.md) - - [MsgVpnAclProfilePublishTopicExceptionLinks](docs/MsgVpnAclProfilePublishTopicExceptionLinks.md) - - [MsgVpnAclProfilePublishTopicExceptionResponse](docs/MsgVpnAclProfilePublishTopicExceptionResponse.md) - - [MsgVpnAclProfilePublishTopicExceptionsResponse](docs/MsgVpnAclProfilePublishTopicExceptionsResponse.md) - - [MsgVpnAclProfileResponse](docs/MsgVpnAclProfileResponse.md) - - [MsgVpnAclProfileSubscribeException](docs/MsgVpnAclProfileSubscribeException.md) - - [MsgVpnAclProfileSubscribeExceptionLinks](docs/MsgVpnAclProfileSubscribeExceptionLinks.md) - - [MsgVpnAclProfileSubscribeExceptionResponse](docs/MsgVpnAclProfileSubscribeExceptionResponse.md) - - [MsgVpnAclProfileSubscribeExceptionsResponse](docs/MsgVpnAclProfileSubscribeExceptionsResponse.md) - - [MsgVpnAclProfileSubscribeShareNameException](docs/MsgVpnAclProfileSubscribeShareNameException.md) - - [MsgVpnAclProfileSubscribeShareNameExceptionLinks](docs/MsgVpnAclProfileSubscribeShareNameExceptionLinks.md) - - [MsgVpnAclProfileSubscribeShareNameExceptionResponse](docs/MsgVpnAclProfileSubscribeShareNameExceptionResponse.md) - - [MsgVpnAclProfileSubscribeShareNameExceptionsResponse](docs/MsgVpnAclProfileSubscribeShareNameExceptionsResponse.md) - - [MsgVpnAclProfileSubscribeTopicException](docs/MsgVpnAclProfileSubscribeTopicException.md) - - [MsgVpnAclProfileSubscribeTopicExceptionLinks](docs/MsgVpnAclProfileSubscribeTopicExceptionLinks.md) - - [MsgVpnAclProfileSubscribeTopicExceptionResponse](docs/MsgVpnAclProfileSubscribeTopicExceptionResponse.md) - - [MsgVpnAclProfileSubscribeTopicExceptionsResponse](docs/MsgVpnAclProfileSubscribeTopicExceptionsResponse.md) - - [MsgVpnAclProfilesResponse](docs/MsgVpnAclProfilesResponse.md) - - [MsgVpnAuthenticationOauthProfile](docs/MsgVpnAuthenticationOauthProfile.md) - - [MsgVpnAuthenticationOauthProfileClientRequiredClaim](docs/MsgVpnAuthenticationOauthProfileClientRequiredClaim.md) - - [MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks](docs/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks.md) - - [MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse](docs/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.md) - - [MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse](docs/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.md) - - [MsgVpnAuthenticationOauthProfileLinks](docs/MsgVpnAuthenticationOauthProfileLinks.md) - - [MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim](docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.md) - - [MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks](docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks.md) - - [MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse](docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.md) - - [MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse](docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.md) - - [MsgVpnAuthenticationOauthProfileResponse](docs/MsgVpnAuthenticationOauthProfileResponse.md) - - [MsgVpnAuthenticationOauthProfilesResponse](docs/MsgVpnAuthenticationOauthProfilesResponse.md) - - [MsgVpnAuthenticationOauthProvider](docs/MsgVpnAuthenticationOauthProvider.md) - - [MsgVpnAuthenticationOauthProviderLinks](docs/MsgVpnAuthenticationOauthProviderLinks.md) - - [MsgVpnAuthenticationOauthProviderResponse](docs/MsgVpnAuthenticationOauthProviderResponse.md) - - [MsgVpnAuthenticationOauthProvidersResponse](docs/MsgVpnAuthenticationOauthProvidersResponse.md) - - [MsgVpnAuthorizationGroup](docs/MsgVpnAuthorizationGroup.md) - - [MsgVpnAuthorizationGroupLinks](docs/MsgVpnAuthorizationGroupLinks.md) - - [MsgVpnAuthorizationGroupResponse](docs/MsgVpnAuthorizationGroupResponse.md) - - [MsgVpnAuthorizationGroupsResponse](docs/MsgVpnAuthorizationGroupsResponse.md) - - [MsgVpnBridge](docs/MsgVpnBridge.md) - - [MsgVpnBridgeLinks](docs/MsgVpnBridgeLinks.md) - - [MsgVpnBridgeRemoteMsgVpn](docs/MsgVpnBridgeRemoteMsgVpn.md) - - [MsgVpnBridgeRemoteMsgVpnLinks](docs/MsgVpnBridgeRemoteMsgVpnLinks.md) - - [MsgVpnBridgeRemoteMsgVpnResponse](docs/MsgVpnBridgeRemoteMsgVpnResponse.md) - - [MsgVpnBridgeRemoteMsgVpnsResponse](docs/MsgVpnBridgeRemoteMsgVpnsResponse.md) - - [MsgVpnBridgeRemoteSubscription](docs/MsgVpnBridgeRemoteSubscription.md) - - [MsgVpnBridgeRemoteSubscriptionLinks](docs/MsgVpnBridgeRemoteSubscriptionLinks.md) - - [MsgVpnBridgeRemoteSubscriptionResponse](docs/MsgVpnBridgeRemoteSubscriptionResponse.md) - - [MsgVpnBridgeRemoteSubscriptionsResponse](docs/MsgVpnBridgeRemoteSubscriptionsResponse.md) - - [MsgVpnBridgeResponse](docs/MsgVpnBridgeResponse.md) - - [MsgVpnBridgeTlsTrustedCommonName](docs/MsgVpnBridgeTlsTrustedCommonName.md) - - [MsgVpnBridgeTlsTrustedCommonNameLinks](docs/MsgVpnBridgeTlsTrustedCommonNameLinks.md) - - [MsgVpnBridgeTlsTrustedCommonNameResponse](docs/MsgVpnBridgeTlsTrustedCommonNameResponse.md) - - [MsgVpnBridgeTlsTrustedCommonNamesResponse](docs/MsgVpnBridgeTlsTrustedCommonNamesResponse.md) - - [MsgVpnBridgesResponse](docs/MsgVpnBridgesResponse.md) - - [MsgVpnCertMatchingRule](docs/MsgVpnCertMatchingRule.md) - - [MsgVpnCertMatchingRuleAttributeFilter](docs/MsgVpnCertMatchingRuleAttributeFilter.md) - - [MsgVpnCertMatchingRuleAttributeFilterLinks](docs/MsgVpnCertMatchingRuleAttributeFilterLinks.md) - - [MsgVpnCertMatchingRuleAttributeFilterResponse](docs/MsgVpnCertMatchingRuleAttributeFilterResponse.md) - - [MsgVpnCertMatchingRuleAttributeFiltersResponse](docs/MsgVpnCertMatchingRuleAttributeFiltersResponse.md) - - [MsgVpnCertMatchingRuleCondition](docs/MsgVpnCertMatchingRuleCondition.md) - - [MsgVpnCertMatchingRuleConditionLinks](docs/MsgVpnCertMatchingRuleConditionLinks.md) - - [MsgVpnCertMatchingRuleConditionResponse](docs/MsgVpnCertMatchingRuleConditionResponse.md) - - [MsgVpnCertMatchingRuleConditionsResponse](docs/MsgVpnCertMatchingRuleConditionsResponse.md) - - [MsgVpnCertMatchingRuleLinks](docs/MsgVpnCertMatchingRuleLinks.md) - - [MsgVpnCertMatchingRuleResponse](docs/MsgVpnCertMatchingRuleResponse.md) - - [MsgVpnCertMatchingRulesResponse](docs/MsgVpnCertMatchingRulesResponse.md) - - [MsgVpnClientProfile](docs/MsgVpnClientProfile.md) - - [MsgVpnClientProfileLinks](docs/MsgVpnClientProfileLinks.md) - - [MsgVpnClientProfileResponse](docs/MsgVpnClientProfileResponse.md) - - [MsgVpnClientProfilesResponse](docs/MsgVpnClientProfilesResponse.md) - - [MsgVpnClientUsername](docs/MsgVpnClientUsername.md) - - [MsgVpnClientUsernameAttribute](docs/MsgVpnClientUsernameAttribute.md) - - [MsgVpnClientUsernameAttributeLinks](docs/MsgVpnClientUsernameAttributeLinks.md) - - [MsgVpnClientUsernameAttributeResponse](docs/MsgVpnClientUsernameAttributeResponse.md) - - [MsgVpnClientUsernameAttributesResponse](docs/MsgVpnClientUsernameAttributesResponse.md) - - [MsgVpnClientUsernameLinks](docs/MsgVpnClientUsernameLinks.md) - - [MsgVpnClientUsernameResponse](docs/MsgVpnClientUsernameResponse.md) - - [MsgVpnClientUsernamesResponse](docs/MsgVpnClientUsernamesResponse.md) - - [MsgVpnDistributedCache](docs/MsgVpnDistributedCache.md) - - [MsgVpnDistributedCacheCluster](docs/MsgVpnDistributedCacheCluster.md) - - [MsgVpnDistributedCacheClusterGlobalCachingHomeCluster](docs/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.md) - - [MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks](docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks.md) - - [MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse](docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.md) - - [MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix](docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.md) - - [MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks](docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks.md) - - [MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse](docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.md) - - [MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse](docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.md) - - [MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse](docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.md) - - [MsgVpnDistributedCacheClusterInstance](docs/MsgVpnDistributedCacheClusterInstance.md) - - [MsgVpnDistributedCacheClusterInstanceLinks](docs/MsgVpnDistributedCacheClusterInstanceLinks.md) - - [MsgVpnDistributedCacheClusterInstanceResponse](docs/MsgVpnDistributedCacheClusterInstanceResponse.md) - - [MsgVpnDistributedCacheClusterInstancesResponse](docs/MsgVpnDistributedCacheClusterInstancesResponse.md) - - [MsgVpnDistributedCacheClusterLinks](docs/MsgVpnDistributedCacheClusterLinks.md) - - [MsgVpnDistributedCacheClusterResponse](docs/MsgVpnDistributedCacheClusterResponse.md) - - [MsgVpnDistributedCacheClusterTopic](docs/MsgVpnDistributedCacheClusterTopic.md) - - [MsgVpnDistributedCacheClusterTopicLinks](docs/MsgVpnDistributedCacheClusterTopicLinks.md) - - [MsgVpnDistributedCacheClusterTopicResponse](docs/MsgVpnDistributedCacheClusterTopicResponse.md) - - [MsgVpnDistributedCacheClusterTopicsResponse](docs/MsgVpnDistributedCacheClusterTopicsResponse.md) - - [MsgVpnDistributedCacheClustersResponse](docs/MsgVpnDistributedCacheClustersResponse.md) - - [MsgVpnDistributedCacheLinks](docs/MsgVpnDistributedCacheLinks.md) - - [MsgVpnDistributedCacheResponse](docs/MsgVpnDistributedCacheResponse.md) - - [MsgVpnDistributedCachesResponse](docs/MsgVpnDistributedCachesResponse.md) - - [MsgVpnDmrBridge](docs/MsgVpnDmrBridge.md) - - [MsgVpnDmrBridgeLinks](docs/MsgVpnDmrBridgeLinks.md) - - [MsgVpnDmrBridgeResponse](docs/MsgVpnDmrBridgeResponse.md) - - [MsgVpnDmrBridgesResponse](docs/MsgVpnDmrBridgesResponse.md) - - [MsgVpnJndiConnectionFactoriesResponse](docs/MsgVpnJndiConnectionFactoriesResponse.md) - - [MsgVpnJndiConnectionFactory](docs/MsgVpnJndiConnectionFactory.md) - - [MsgVpnJndiConnectionFactoryLinks](docs/MsgVpnJndiConnectionFactoryLinks.md) - - [MsgVpnJndiConnectionFactoryResponse](docs/MsgVpnJndiConnectionFactoryResponse.md) - - [MsgVpnJndiQueue](docs/MsgVpnJndiQueue.md) - - [MsgVpnJndiQueueLinks](docs/MsgVpnJndiQueueLinks.md) - - [MsgVpnJndiQueueResponse](docs/MsgVpnJndiQueueResponse.md) - - [MsgVpnJndiQueuesResponse](docs/MsgVpnJndiQueuesResponse.md) - - [MsgVpnJndiTopic](docs/MsgVpnJndiTopic.md) - - [MsgVpnJndiTopicLinks](docs/MsgVpnJndiTopicLinks.md) - - [MsgVpnJndiTopicResponse](docs/MsgVpnJndiTopicResponse.md) - - [MsgVpnJndiTopicsResponse](docs/MsgVpnJndiTopicsResponse.md) - - [MsgVpnLinks](docs/MsgVpnLinks.md) - - [MsgVpnMqttRetainCache](docs/MsgVpnMqttRetainCache.md) - - [MsgVpnMqttRetainCacheLinks](docs/MsgVpnMqttRetainCacheLinks.md) - - [MsgVpnMqttRetainCacheResponse](docs/MsgVpnMqttRetainCacheResponse.md) - - [MsgVpnMqttRetainCachesResponse](docs/MsgVpnMqttRetainCachesResponse.md) - - [MsgVpnMqttSession](docs/MsgVpnMqttSession.md) - - [MsgVpnMqttSessionLinks](docs/MsgVpnMqttSessionLinks.md) - - [MsgVpnMqttSessionResponse](docs/MsgVpnMqttSessionResponse.md) - - [MsgVpnMqttSessionSubscription](docs/MsgVpnMqttSessionSubscription.md) - - [MsgVpnMqttSessionSubscriptionLinks](docs/MsgVpnMqttSessionSubscriptionLinks.md) - - [MsgVpnMqttSessionSubscriptionResponse](docs/MsgVpnMqttSessionSubscriptionResponse.md) - - [MsgVpnMqttSessionSubscriptionsResponse](docs/MsgVpnMqttSessionSubscriptionsResponse.md) - - [MsgVpnMqttSessionsResponse](docs/MsgVpnMqttSessionsResponse.md) - - [MsgVpnQueue](docs/MsgVpnQueue.md) - - [MsgVpnQueueLinks](docs/MsgVpnQueueLinks.md) - - [MsgVpnQueueResponse](docs/MsgVpnQueueResponse.md) - - [MsgVpnQueueSubscription](docs/MsgVpnQueueSubscription.md) - - [MsgVpnQueueSubscriptionLinks](docs/MsgVpnQueueSubscriptionLinks.md) - - [MsgVpnQueueSubscriptionResponse](docs/MsgVpnQueueSubscriptionResponse.md) - - [MsgVpnQueueSubscriptionsResponse](docs/MsgVpnQueueSubscriptionsResponse.md) - - [MsgVpnQueueTemplate](docs/MsgVpnQueueTemplate.md) - - [MsgVpnQueueTemplateLinks](docs/MsgVpnQueueTemplateLinks.md) - - [MsgVpnQueueTemplateResponse](docs/MsgVpnQueueTemplateResponse.md) - - [MsgVpnQueueTemplatesResponse](docs/MsgVpnQueueTemplatesResponse.md) - - [MsgVpnQueuesResponse](docs/MsgVpnQueuesResponse.md) - - [MsgVpnReplayLog](docs/MsgVpnReplayLog.md) - - [MsgVpnReplayLogLinks](docs/MsgVpnReplayLogLinks.md) - - [MsgVpnReplayLogResponse](docs/MsgVpnReplayLogResponse.md) - - [MsgVpnReplayLogTopicFilterSubscription](docs/MsgVpnReplayLogTopicFilterSubscription.md) - - [MsgVpnReplayLogTopicFilterSubscriptionLinks](docs/MsgVpnReplayLogTopicFilterSubscriptionLinks.md) - - [MsgVpnReplayLogTopicFilterSubscriptionResponse](docs/MsgVpnReplayLogTopicFilterSubscriptionResponse.md) - - [MsgVpnReplayLogTopicFilterSubscriptionsResponse](docs/MsgVpnReplayLogTopicFilterSubscriptionsResponse.md) - - [MsgVpnReplayLogsResponse](docs/MsgVpnReplayLogsResponse.md) - - [MsgVpnReplicatedTopic](docs/MsgVpnReplicatedTopic.md) - - [MsgVpnReplicatedTopicLinks](docs/MsgVpnReplicatedTopicLinks.md) - - [MsgVpnReplicatedTopicResponse](docs/MsgVpnReplicatedTopicResponse.md) - - [MsgVpnReplicatedTopicsResponse](docs/MsgVpnReplicatedTopicsResponse.md) - - [MsgVpnResponse](docs/MsgVpnResponse.md) - - [MsgVpnRestDeliveryPoint](docs/MsgVpnRestDeliveryPoint.md) - - [MsgVpnRestDeliveryPointLinks](docs/MsgVpnRestDeliveryPointLinks.md) - - [MsgVpnRestDeliveryPointQueueBinding](docs/MsgVpnRestDeliveryPointQueueBinding.md) - - [MsgVpnRestDeliveryPointQueueBindingLinks](docs/MsgVpnRestDeliveryPointQueueBindingLinks.md) - - [MsgVpnRestDeliveryPointQueueBindingRequestHeader](docs/MsgVpnRestDeliveryPointQueueBindingRequestHeader.md) - - [MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks](docs/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks.md) - - [MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse](docs/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md) - - [MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse](docs/MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.md) - - [MsgVpnRestDeliveryPointQueueBindingResponse](docs/MsgVpnRestDeliveryPointQueueBindingResponse.md) - - [MsgVpnRestDeliveryPointQueueBindingsResponse](docs/MsgVpnRestDeliveryPointQueueBindingsResponse.md) - - [MsgVpnRestDeliveryPointResponse](docs/MsgVpnRestDeliveryPointResponse.md) - - [MsgVpnRestDeliveryPointRestConsumer](docs/MsgVpnRestDeliveryPointRestConsumer.md) - - [MsgVpnRestDeliveryPointRestConsumerLinks](docs/MsgVpnRestDeliveryPointRestConsumerLinks.md) - - [MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim](docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.md) - - [MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks](docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks.md) - - [MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse](docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.md) - - [MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse](docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.md) - - [MsgVpnRestDeliveryPointRestConsumerResponse](docs/MsgVpnRestDeliveryPointRestConsumerResponse.md) - - [MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName](docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.md) - - [MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks](docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks.md) - - [MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse](docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.md) - - [MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse](docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.md) - - [MsgVpnRestDeliveryPointRestConsumersResponse](docs/MsgVpnRestDeliveryPointRestConsumersResponse.md) - - [MsgVpnRestDeliveryPointsResponse](docs/MsgVpnRestDeliveryPointsResponse.md) - - [MsgVpnSequencedTopic](docs/MsgVpnSequencedTopic.md) - - [MsgVpnSequencedTopicLinks](docs/MsgVpnSequencedTopicLinks.md) - - [MsgVpnSequencedTopicResponse](docs/MsgVpnSequencedTopicResponse.md) - - [MsgVpnSequencedTopicsResponse](docs/MsgVpnSequencedTopicsResponse.md) - - [MsgVpnTopicEndpoint](docs/MsgVpnTopicEndpoint.md) - - [MsgVpnTopicEndpointLinks](docs/MsgVpnTopicEndpointLinks.md) - - [MsgVpnTopicEndpointResponse](docs/MsgVpnTopicEndpointResponse.md) - - [MsgVpnTopicEndpointTemplate](docs/MsgVpnTopicEndpointTemplate.md) - - [MsgVpnTopicEndpointTemplateLinks](docs/MsgVpnTopicEndpointTemplateLinks.md) - - [MsgVpnTopicEndpointTemplateResponse](docs/MsgVpnTopicEndpointTemplateResponse.md) - - [MsgVpnTopicEndpointTemplatesResponse](docs/MsgVpnTopicEndpointTemplatesResponse.md) - - [MsgVpnTopicEndpointsResponse](docs/MsgVpnTopicEndpointsResponse.md) - - [MsgVpnsResponse](docs/MsgVpnsResponse.md) - - [OauthProfile](docs/OauthProfile.md) - - [OauthProfileAccessLevelGroup](docs/OauthProfileAccessLevelGroup.md) - - [OauthProfileAccessLevelGroupLinks](docs/OauthProfileAccessLevelGroupLinks.md) - - [OauthProfileAccessLevelGroupMsgVpnAccessLevelException](docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.md) - - [OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks](docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks.md) - - [OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse](docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.md) - - [OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse](docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.md) - - [OauthProfileAccessLevelGroupResponse](docs/OauthProfileAccessLevelGroupResponse.md) - - [OauthProfileAccessLevelGroupsResponse](docs/OauthProfileAccessLevelGroupsResponse.md) - - [OauthProfileClientAllowedHost](docs/OauthProfileClientAllowedHost.md) - - [OauthProfileClientAllowedHostLinks](docs/OauthProfileClientAllowedHostLinks.md) - - [OauthProfileClientAllowedHostResponse](docs/OauthProfileClientAllowedHostResponse.md) - - [OauthProfileClientAllowedHostsResponse](docs/OauthProfileClientAllowedHostsResponse.md) - - [OauthProfileClientAuthorizationParameter](docs/OauthProfileClientAuthorizationParameter.md) - - [OauthProfileClientAuthorizationParameterLinks](docs/OauthProfileClientAuthorizationParameterLinks.md) - - [OauthProfileClientAuthorizationParameterResponse](docs/OauthProfileClientAuthorizationParameterResponse.md) - - [OauthProfileClientAuthorizationParametersResponse](docs/OauthProfileClientAuthorizationParametersResponse.md) - - [OauthProfileClientRequiredClaim](docs/OauthProfileClientRequiredClaim.md) - - [OauthProfileClientRequiredClaimLinks](docs/OauthProfileClientRequiredClaimLinks.md) - - [OauthProfileClientRequiredClaimResponse](docs/OauthProfileClientRequiredClaimResponse.md) - - [OauthProfileClientRequiredClaimsResponse](docs/OauthProfileClientRequiredClaimsResponse.md) - - [OauthProfileDefaultMsgVpnAccessLevelException](docs/OauthProfileDefaultMsgVpnAccessLevelException.md) - - [OauthProfileDefaultMsgVpnAccessLevelExceptionLinks](docs/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks.md) - - [OauthProfileDefaultMsgVpnAccessLevelExceptionResponse](docs/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.md) - - [OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse](docs/OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.md) - - [OauthProfileLinks](docs/OauthProfileLinks.md) - - [OauthProfileResourceServerRequiredClaim](docs/OauthProfileResourceServerRequiredClaim.md) - - [OauthProfileResourceServerRequiredClaimLinks](docs/OauthProfileResourceServerRequiredClaimLinks.md) - - [OauthProfileResourceServerRequiredClaimResponse](docs/OauthProfileResourceServerRequiredClaimResponse.md) - - [OauthProfileResourceServerRequiredClaimsResponse](docs/OauthProfileResourceServerRequiredClaimsResponse.md) - - [OauthProfileResponse](docs/OauthProfileResponse.md) - - [OauthProfilesResponse](docs/OauthProfilesResponse.md) - - [SempError](docs/SempError.md) - - [SempMeta](docs/SempMeta.md) - - [SempMetaOnlyResponse](docs/SempMetaOnlyResponse.md) - - [SempPaging](docs/SempPaging.md) - - [SempRequest](docs/SempRequest.md) - - [SystemInformation](docs/SystemInformation.md) - - [SystemInformationLinks](docs/SystemInformationLinks.md) - - [SystemInformationResponse](docs/SystemInformationResponse.md) - - [VirtualHostname](docs/VirtualHostname.md) - - [VirtualHostnameLinks](docs/VirtualHostnameLinks.md) - - [VirtualHostnameResponse](docs/VirtualHostnameResponse.md) - - [VirtualHostnamesResponse](docs/VirtualHostnamesResponse.md) - - -## Documentation for Authorization - -Authentication schemes defined for the API: -### basicAuth - - -- **Type**: HTTP basic authentication - - -## Recommendation - -It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues. - -## Author - -support@solace.com - diff --git a/service/solace-config-client/api/openapi.yaml b/service/solace-config-client/api/openapi.yaml deleted file mode 100644 index 527039869..000000000 --- a/service/solace-config-client/api/openapi.yaml +++ /dev/null @@ -1,47139 +0,0 @@ -openapi: 3.0.1 -info: - contact: - email: support@solace.com - name: Solace - url: http://www.solace.com - description: |+ - SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. - - SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: - - - API|Base Path|Purpose|Comments - :---|:---|:---|:--- - Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 - - - - The following APIs are also available: - - - API|Base Path|Purpose|Comments - :---|:---|:---|:--- - Action|/SEMP/v2/action|Performing actions|See note 2 - Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 - - - - Resources are always nouns, with individual objects being singular and collections being plural. - - Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. - - Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. - - Some examples: - - ``` - /SEMP/v2/config/msgVpns ; MsgVpn collection - /SEMP/v2/config/msgVpns/a ; MsgVpn object named "a" - /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn "a" - /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named "b" in MsgVpn "a" - /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue "b" in MsgVpn "a" - /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn "a" - /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named "c" in MsgVpn "a" - ``` - - ## Collection Resources - - Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. - - ## Object and Action Resources - - Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. - - Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. - - Attributes in an object or action may have any combination of the following properties: - - - Property|Meaning|Comments - :---|:---|:--- - Identifying|Attribute is involved in unique identification of the object, and appears in its URI| - Const|Attribute value can only be chosen during object creation| - Required|Attribute must be provided in the request| - Read-Only|Attribute can only be read, not written.|See note 3 - Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property - Requires-Disable|Attribute can only be changed when object is disabled| - Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| - Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation - - - - In some requests, certain attributes may only be provided in certain combinations with other attributes: - - - Relationship|Meaning - :---|:--- - Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request - Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request - - - - In the monitoring API, any non-identifying attribute may not be returned in a GET. - - ## HTTP Methods - - The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: - - - Method|Resource|Meaning|Request Body|Response Body|Notes - :---|:---|:---|:---|:---|:--- - POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned - PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) - PUT|Action|Performs action|Action arguments|Action metadata| - PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned - DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned - GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned - GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code - - - - ## Common Query Parameters - - The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: - - ``` - ; Request for the MsgVpns collection using two hypothetical query parameters - ; "q1" and "q2" with values "val1" and "val2" respectively - /SEMP/v2/config/msgVpns?q1=val1&q2=val2 - ``` - - ### select - - Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. - - The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. - - All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. - - Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). - - Some examples: - - ``` - ; List of all MsgVpn names - /SEMP/v2/config/msgVpns?select=msgVpnName - ; List of all MsgVpn and their attributes except for their names - /SEMP/v2/config/msgVpns?select=-msgVpnName - ; Authentication attributes of MsgVpn "finance" - /SEMP/v2/config/msgVpns/finance?select=authentication* - ; All attributes of MsgVpn "finance" except for authentication attributes - /SEMP/v2/config/msgVpns/finance?select=-authentication* - ; Access related attributes of Queue "orderQ" of MsgVpn "finance" - /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission - ``` - - ### where - - Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. - - The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: - - ``` - expression = attribute-name OP value - OP = '==' | '!=' | '<' | '>' | '<=' | '>=' - ``` - - `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: - - ``` - ; Only enabled MsgVpns - /SEMP/v2/config/msgVpns?where=enabled==true - ; Only MsgVpns using basic non-LDAP authentication - /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap - ; Only MsgVpns that allow more than 100 client connections - /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 - ; Only MsgVpns with msgVpnName starting with "B": - /SEMP/v2/config/msgVpns?where=msgVpnName==B* - ``` - - ### count - - Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. - - `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. - - For example: - ``` - ; Up to 25 MsgVpns - /SEMP/v2/config/msgVpns?count=25 - ``` - - ### cursor - - The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. - - When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. - - Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. - - ### opaquePassword - - Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: - - 1. the same password that was used to retrieve the opaque attribute values is provided; and - - 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. - - The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. - - The query parameter can only be used in the configuration API, and only over HTTPS. - - ## Authentication - - When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. - - When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. - - There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. - - If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. - - A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. - - Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. - - ## Help - - Visit [our website](https://solace.com) to learn more about Solace. - - You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). - - If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). - - ## Notes - - Note|Description - :---:|:--- - 1|This specification defines SEMP starting in "v2", and not the original SEMP "v1" interface. Request and response formats between "v1" and "v2" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either "/SEMP/" or "/SEMP/v2/" - 2|This API is partially implemented. Only a subset of all objects are available. - 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. - 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - - title: SEMP (Solace Element Management Protocol) - version: "2.28" -servers: -- url: http://www.solace.com/SEMP/v2/config -- url: https://www.solace.com/SEMP/v2/config -tags: [] -paths: - /: - get: - description: |- - Get a Broker object. - - This object contains global configuration for the message broker. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - tlsServerCertContent||x||x - tlsServerCertPassword||x|| - - - - A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation. Requests which include the following attributes require greater access scope/level: - - - Attribute|Access Scope/Level - :---|:---: - configSyncAuthenticationClientCertMaxChainDepth|global/read-only - configSyncAuthenticationClientCertValidateDateEnabled|global/read-only - configSyncClientProfileTcpInitialCongestionWindow|global/read-only - configSyncClientProfileTcpKeepaliveCount|global/read-only - configSyncClientProfileTcpKeepaliveIdle|global/read-only - configSyncClientProfileTcpKeepaliveInterval|global/read-only - configSyncClientProfileTcpMaxWindow|global/read-only - configSyncClientProfileTcpMss|global/read-only - configSyncEnabled|global/read-only - configSyncSynchronizeUsernameEnabled|global/read-only - configSyncTlsEnabled|global/read-only - guaranteedMsgingDefragmentationScheduleDayList|global/read-only - guaranteedMsgingDefragmentationScheduleEnabled|global/read-only - guaranteedMsgingDefragmentationScheduleTimeList|global/read-only - guaranteedMsgingDefragmentationThresholdEnabled|global/read-only - guaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-only - guaranteedMsgingDefragmentationThresholdMinInterval|global/read-only - guaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-only - guaranteedMsgingEnabled|global/read-only - guaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-only - guaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-only - guaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-only - guaranteedMsgingEventCacheUsageThreshold.setValue|global/read-only - guaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-only - guaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-only - guaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-only - guaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-only - guaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-only - guaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-only - guaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-only - guaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-only - guaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-only - guaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-only - guaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-only - guaranteedMsgingEventEndpointCountThreshold.setValue|global/read-only - guaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-only - guaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-only - guaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-only - guaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-only - guaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-only - guaranteedMsgingEventMsgCountThreshold.setPercent|global/read-only - guaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-only - guaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-only - guaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-only - guaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-only - guaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-only - guaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-only - guaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-only - guaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-only - guaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-only - guaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-only - guaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-only - guaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-only - guaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-only - guaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-only - guaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-only - guaranteedMsgingEventTransactionCountThreshold.setValue|global/read-only - guaranteedMsgingMaxCacheUsage|global/read-only - guaranteedMsgingMaxMsgSpoolUsage|global/read-only - guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-only - guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-only - guaranteedMsgingTransactionReplicationCompatibilityMode|global/read-only - oauthProfileDefault|global/read-only - serviceAmqpEnabled|global/read-only - serviceAmqpTlsListenPort|global/read-only - serviceEventConnectionCountThreshold.clearPercent|global/read-only - serviceEventConnectionCountThreshold.clearValue|global/read-only - serviceEventConnectionCountThreshold.setPercent|global/read-only - serviceEventConnectionCountThreshold.setValue|global/read-only - serviceHealthCheckEnabled|global/read-only - serviceHealthCheckListenPort|global/read-only - serviceMateLinkEnabled|global/read-only - serviceMateLinkListenPort|global/read-only - serviceMqttEnabled|global/read-only - serviceMsgBackboneEnabled|global/read-only - serviceRedundancyEnabled|global/read-only - serviceRedundancyFirstListenPort|global/read-only - serviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-only - serviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-only - serviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-only - serviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-only - serviceRestIncomingEnabled|global/read-only - serviceRestOutgoingEnabled|global/read-only - serviceSempCorsAllowAnyHostEnabled|global/read-only - serviceSempLegacyTimeoutEnabled|global/read-only - serviceSempPlainTextEnabled|global/read-only - serviceSempPlainTextListenPort|global/read-only - serviceSempSessionIdleTimeout|global/read-only - serviceSempSessionMaxLifetime|global/read-only - serviceSempTlsEnabled|global/read-only - serviceSempTlsListenPort|global/read-only - serviceSmfCompressionListenPort|global/read-only - serviceSmfEnabled|global/read-only - serviceSmfEventConnectionCountThreshold.clearPercent|global/read-only - serviceSmfEventConnectionCountThreshold.clearValue|global/read-only - serviceSmfEventConnectionCountThreshold.setPercent|global/read-only - serviceSmfEventConnectionCountThreshold.setValue|global/read-only - serviceSmfPlainTextListenPort|global/read-only - serviceSmfRoutingControlListenPort|global/read-only - serviceSmfTlsListenPort|global/read-only - serviceTlsEventConnectionCountThreshold.clearPercent|global/read-only - serviceTlsEventConnectionCountThreshold.clearValue|global/read-only - serviceTlsEventConnectionCountThreshold.setPercent|global/read-only - serviceTlsEventConnectionCountThreshold.setValue|global/read-only - serviceWebTransportEnabled|global/read-only - serviceWebTransportPlainTextListenPort|global/read-only - serviceWebTransportTlsListenPort|global/read-only - serviceWebTransportWebUrlSuffix|global/read-only - tlsBlockVersion11Enabled|global/read-only - tlsCipherSuiteManagementList|global/read-only - tlsCipherSuiteMsgBackboneList|global/read-only - tlsCipherSuiteSecureShellList|global/read-only - tlsCrimeExploitProtectionEnabled|global/read-only - tlsServerCertContent|global/read-only - tlsStandardDomainCertificateAuthoritiesEnabled|vpn/read-only - tlsTicketLifetime|global/read-only - webManagerAllowUnencryptedWizardsEnabled|vpn/read-only - webManagerCustomization|vpn/read-only - webManagerRedirectHttpEnabled|vpn/read-only - webManagerRedirectHttpOverrideTlsPort|vpn/read-only - - - - This has been available since 2.13. - operationId: getBroker - parameters: - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/BrokerResponse' - description: "The Broker object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Broker object. - tags: - - all - x-accepts: application/json - patch: - description: |- - Update a Broker object. Any attribute missing from the request will be left unchanged. - - This object contains global configuration for the message broker. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - serviceAmqpTlsListenPort||||x|| - serviceHealthCheckListenPort||||x|| - serviceMateLinkListenPort||||x|| - serviceRedundancyFirstListenPort||||x|| - serviceSempPlainTextListenPort||||x|| - serviceSempTlsListenPort||||x|| - serviceSmfCompressionListenPort||||x|| - serviceSmfPlainTextListenPort||||x|| - serviceSmfRoutingControlListenPort||||x|| - serviceSmfTlsListenPort||||x|| - serviceWebTransportPlainTextListenPort||||x|| - serviceWebTransportTlsListenPort||||x|| - serviceWebTransportWebUrlSuffix||||x|| - tlsServerCertContent|||x|||x - tlsServerCertPassword|||x||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - Broker|tlsServerCertPassword|tlsServerCertContent| - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - EventThresholdByPercent|clearPercent|setPercent| - EventThresholdByPercent|setPercent|clearPercent| - - - - A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation. Requests which include the following attributes require greater access scope/level: - - - Attribute|Access Scope/Level - :---|:---: - authClientCertRevocationCheckMode|global/admin - configSyncAuthenticationClientCertMaxChainDepth|global/read-write - configSyncAuthenticationClientCertValidateDateEnabled|global/read-write - configSyncClientProfileTcpInitialCongestionWindow|global/read-write - configSyncClientProfileTcpKeepaliveCount|global/read-write - configSyncClientProfileTcpKeepaliveIdle|global/read-write - configSyncClientProfileTcpKeepaliveInterval|global/read-write - configSyncClientProfileTcpMaxWindow|global/read-write - configSyncClientProfileTcpMss|global/read-write - configSyncEnabled|global/read-write - configSyncSynchronizeUsernameEnabled|global/read-write - configSyncTlsEnabled|global/read-write - guaranteedMsgingDefragmentationScheduleDayList|global/read-write - guaranteedMsgingDefragmentationScheduleEnabled|global/read-write - guaranteedMsgingDefragmentationScheduleTimeList|global/read-write - guaranteedMsgingDefragmentationThresholdEnabled|global/read-write - guaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-write - guaranteedMsgingDefragmentationThresholdMinInterval|global/read-write - guaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-write - guaranteedMsgingEnabled|global/read-write - guaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-write - guaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-write - guaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-write - guaranteedMsgingEventCacheUsageThreshold.setValue|global/read-write - guaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-write - guaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-write - guaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-write - guaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-write - guaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-write - guaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-write - guaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-write - guaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-write - guaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-write - guaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-write - guaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-write - guaranteedMsgingEventEndpointCountThreshold.setValue|global/read-write - guaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-write - guaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-write - guaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-write - guaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-write - guaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-write - guaranteedMsgingEventMsgCountThreshold.setPercent|global/read-write - guaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-write - guaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-write - guaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-write - guaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-write - guaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-write - guaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-write - guaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-write - guaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-write - guaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-write - guaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-write - guaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-write - guaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-write - guaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-write - guaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-write - guaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-write - guaranteedMsgingEventTransactionCountThreshold.setValue|global/read-write - guaranteedMsgingMaxCacheUsage|global/read-write - guaranteedMsgingMaxMsgSpoolUsage|global/read-write - guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-write - guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-write - guaranteedMsgingTransactionReplicationCompatibilityMode|global/read-write - oauthProfileDefault|global/admin - serviceAmqpEnabled|global/read-write - serviceAmqpTlsListenPort|global/read-write - serviceEventConnectionCountThreshold.clearPercent|global/read-write - serviceEventConnectionCountThreshold.clearValue|global/read-write - serviceEventConnectionCountThreshold.setPercent|global/read-write - serviceEventConnectionCountThreshold.setValue|global/read-write - serviceHealthCheckEnabled|global/read-write - serviceHealthCheckListenPort|global/read-write - serviceMateLinkEnabled|global/read-write - serviceMateLinkListenPort|global/read-write - serviceMqttEnabled|global/read-write - serviceMsgBackboneEnabled|global/read-write - serviceRedundancyEnabled|global/read-write - serviceRedundancyFirstListenPort|global/read-write - serviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-write - serviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-write - serviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-write - serviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-write - serviceRestIncomingEnabled|global/read-write - serviceRestOutgoingEnabled|global/read-write - serviceSempCorsAllowAnyHostEnabled|global/read-write - serviceSempLegacyTimeoutEnabled|global/read-write - serviceSempPlainTextEnabled|global/read-write - serviceSempPlainTextListenPort|global/read-write - serviceSempSessionIdleTimeout|global/read-write - serviceSempSessionMaxLifetime|global/read-write - serviceSempTlsEnabled|global/read-write - serviceSempTlsListenPort|global/read-write - serviceSmfCompressionListenPort|global/read-write - serviceSmfEnabled|global/read-write - serviceSmfEventConnectionCountThreshold.clearPercent|global/read-write - serviceSmfEventConnectionCountThreshold.clearValue|global/read-write - serviceSmfEventConnectionCountThreshold.setPercent|global/read-write - serviceSmfEventConnectionCountThreshold.setValue|global/read-write - serviceSmfPlainTextListenPort|global/read-write - serviceSmfRoutingControlListenPort|global/read-write - serviceSmfTlsListenPort|global/read-write - serviceTlsEventConnectionCountThreshold.clearPercent|global/read-write - serviceTlsEventConnectionCountThreshold.clearValue|global/read-write - serviceTlsEventConnectionCountThreshold.setPercent|global/read-write - serviceTlsEventConnectionCountThreshold.setValue|global/read-write - serviceWebTransportEnabled|global/read-write - serviceWebTransportPlainTextListenPort|global/read-write - serviceWebTransportTlsListenPort|global/read-write - serviceWebTransportWebUrlSuffix|global/read-write - tlsBlockVersion11Enabled|global/read-write - tlsCipherSuiteManagementList|global/read-write - tlsCipherSuiteMsgBackboneList|global/read-write - tlsCipherSuiteSecureShellList|global/read-write - tlsCrimeExploitProtectionEnabled|global/read-write - tlsServerCertContent|global/read-write - tlsServerCertPassword|global/read-write - tlsStandardDomainCertificateAuthoritiesEnabled|global/read-write - tlsTicketLifetime|global/read-write - webManagerAllowUnencryptedWizardsEnabled|global/read-write - webManagerCustomization|vpn/read-write - webManagerRedirectHttpEnabled|global/read-write - webManagerRedirectHttpOverrideTlsPort|global/read-write - - - - This has been available since 2.13. - operationId: updateBroker - parameters: - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Broker' - description: The Broker object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/BrokerResponse' - description: "The Broker object's attributes after being updated, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Broker object. - tags: - - all - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /about: - get: - description: |- - Get an About object. - - This provides metadata about the SEMP API, such as the version of the API supported by the broker. - - - - A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation. - - This has been available since 2.13. - operationId: getAbout - parameters: - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/AboutResponse' - description: "The About object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get an About object. - tags: - - all - - about - x-accepts: application/json - /about/api: - get: - description: |- - Get an API Description object. - - The API Description object provides metadata about the SEMP API. - - - - A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation. - - This has been available since 2.2. - operationId: getAboutApi - parameters: - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/AboutApiResponse' - description: "The API Description object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get an API Description object. - tags: - - all - - about - x-accepts: application/json - /about/user: - get: - description: |- - Get a User object. - - Session and access level information about the user accessing the SEMP API. - - - - A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation. - - This has been available since 2.2. - operationId: getAboutUser - parameters: - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/AboutUserResponse' - description: "The User object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a User object. - tags: - - all - - about - x-accepts: application/json - /about/user/msgVpns: - get: - description: |- - Get a list of User Message VPN objects. - - This provides information about the Message VPN access level for the username used to access the SEMP API. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation. - - This has been available since 2.2. - operationId: getAboutUserMsgVpns - parameters: - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/AboutUserMsgVpnsResponse' - description: "The list of User Message VPN objects' attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of User Message VPN objects. - tags: - - all - - about - x-accepts: application/json - /about/user/msgVpns/{msgVpnName}: - get: - description: |- - Get a User Message VPN object. - - This provides information about the Message VPN access level for the username used to access the SEMP API. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation. - - This has been available since 2.2. - operationId: getAboutUserMsgVpn - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/AboutUserMsgVpnResponse' - description: "The User Message VPN object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a User Message VPN object. - tags: - - all - - about - x-accepts: application/json - /certAuthorities: - get: - deprecated: true - description: |- - Get a list of Certificate Authority objects. - - Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - certAuthorityName|x||x| - certContent|||x| - crlDayList|||x| - crlTimeList|||x| - crlUrl|||x| - ocspNonResponderCertEnabled|||x| - ocspOverrideUrl|||x| - ocspTimeout|||x| - revocationCheckEnabled|||x| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - operationId: getCertAuthorities - parameters: - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CertAuthoritiesResponse' - description: "The list of Certificate Authority objects' attributes, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Certificate Authority objects. - tags: - - all - - certAuthority - x-accepts: application/json - post: - deprecated: true - description: |- - Create a Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - certAuthorityName|x|x|||x| - certContent|||||x| - crlDayList|||||x| - crlTimeList|||||x| - crlUrl|||||x| - ocspNonResponderCertEnabled|||||x| - ocspOverrideUrl|||||x| - ocspTimeout|||||x| - revocationCheckEnabled|||||x| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - CertAuthority|crlDayList|crlTimeList| - CertAuthority|crlTimeList|crlDayList| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - operationId: createCertAuthority - parameters: - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CertAuthority' - description: The Certificate Authority object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CertAuthorityResponse' - description: "The Certificate Authority object's attributes after being\ - \ created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Certificate Authority object. - tags: - - all - - certAuthority - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /certAuthorities/{certAuthorityName}: - delete: - deprecated: true - description: |- - Delete a Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - operationId: deleteCertAuthority - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Certificate Authority object. - tags: - - all - - certAuthority - x-accepts: application/json - get: - deprecated: true - description: |- - Get a Certificate Authority object. - - Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - certAuthorityName|x||x| - certContent|||x| - crlDayList|||x| - crlTimeList|||x| - crlUrl|||x| - ocspNonResponderCertEnabled|||x| - ocspOverrideUrl|||x| - ocspTimeout|||x| - revocationCheckEnabled|||x| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - operationId: getCertAuthority - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CertAuthorityResponse' - description: "The Certificate Authority object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Certificate Authority object. - tags: - - all - - certAuthority - x-accepts: application/json - patch: - deprecated: true - description: |- - Update a Certificate Authority object. Any attribute missing from the request will be left unchanged. - - Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - certAuthorityName|x|x|||x| - certContent|||||x| - crlDayList|||||x| - crlTimeList|||||x| - crlUrl||||x|x| - ocspNonResponderCertEnabled|||||x| - ocspOverrideUrl|||||x| - ocspTimeout|||||x| - revocationCheckEnabled|||||x| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - CertAuthority|crlDayList|crlTimeList| - CertAuthority|crlTimeList|crlDayList| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - operationId: updateCertAuthority - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CertAuthority' - description: The Certificate Authority object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CertAuthorityResponse' - description: "The Certificate Authority object's attributes after being\ - \ updated, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Certificate Authority object. - tags: - - all - - certAuthority - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - deprecated: true - description: |- - Replace a Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - certAuthorityName|x||x|||x| - certContent||||||x| - crlDayList||||||x| - crlTimeList||||||x| - crlUrl|||||x|x| - ocspNonResponderCertEnabled||||||x| - ocspOverrideUrl||||||x| - ocspTimeout||||||x| - revocationCheckEnabled||||||x| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - CertAuthority|crlDayList|crlTimeList| - CertAuthority|crlTimeList|crlDayList| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - operationId: replaceCertAuthority - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CertAuthority' - description: The Certificate Authority object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CertAuthorityResponse' - description: "The Certificate Authority object's attributes after being\ - \ replaced, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Certificate Authority object. - tags: - - all - - certAuthority - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames: - get: - deprecated: true - description: |- - Get a list of OCSP Responder Trusted Common Name objects. - - When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - certAuthorityName|x||x| - ocspTlsTrustedCommonName|x||x| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been deprecated since 2.19. Replaced by clientCertAuthorities. - operationId: getCertAuthorityOcspTlsTrustedCommonNames - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CertAuthorityOcspTlsTrustedCommonNamesResponse' - description: "The list of OCSP Responder Trusted Common Name objects' attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of OCSP Responder Trusted Common Name objects. - tags: - - all - - certAuthority - x-accepts: application/json - post: - deprecated: true - description: |- - Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - certAuthorityName|x||x||x| - ocspTlsTrustedCommonName|x|x|||x| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been deprecated since 2.19. Replaced by clientCertAuthorities. - operationId: createCertAuthorityOcspTlsTrustedCommonName - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CertAuthorityOcspTlsTrustedCommonName' - description: The OCSP Responder Trusted Common Name object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CertAuthorityOcspTlsTrustedCommonNameResponse' - description: "The OCSP Responder Trusted Common Name object's attributes\ - \ after being created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create an OCSP Responder Trusted Common Name object. - tags: - - all - - certAuthority - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}: - delete: - deprecated: true - description: |- - Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been deprecated since 2.19. Replaced by clientCertAuthorities. - operationId: deleteCertAuthorityOcspTlsTrustedCommonName - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: The expected Trusted Common Name of the OCSP responder remote - certificate. - in: path - name: ocspTlsTrustedCommonName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete an OCSP Responder Trusted Common Name object. - tags: - - all - - certAuthority - x-accepts: application/json - get: - deprecated: true - description: |- - Get an OCSP Responder Trusted Common Name object. - - When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - certAuthorityName|x||x| - ocspTlsTrustedCommonName|x||x| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been deprecated since 2.19. Replaced by clientCertAuthorities. - operationId: getCertAuthorityOcspTlsTrustedCommonName - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: The expected Trusted Common Name of the OCSP responder remote - certificate. - in: path - name: ocspTlsTrustedCommonName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CertAuthorityOcspTlsTrustedCommonNameResponse' - description: "The OCSP Responder Trusted Common Name object's attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get an OCSP Responder Trusted Common Name object. - tags: - - all - - certAuthority - x-accepts: application/json - /clientCertAuthorities: - get: - description: |- - Get a list of Client Certificate Authority objects. - - Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - certAuthorityName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.19. - operationId: getClientCertAuthorities - parameters: - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientCertAuthoritiesResponse' - description: "The list of Client Certificate Authority objects' attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Client Certificate Authority objects. - tags: - - all - - clientCertAuthority - x-accepts: application/json - post: - description: |- - Create a Client Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - certAuthorityName|x|x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - ClientCertAuthority|crlDayList|crlTimeList| - ClientCertAuthority|crlTimeList|crlDayList| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.19. - operationId: createClientCertAuthority - parameters: - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ClientCertAuthority' - description: The Client Certificate Authority object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientCertAuthorityResponse' - description: "The Client Certificate Authority object's attributes after\ - \ being created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Client Certificate Authority object. - tags: - - all - - clientCertAuthority - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /clientCertAuthorities/{certAuthorityName}: - delete: - description: |- - Delete a Client Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.19. - operationId: deleteClientCertAuthority - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Client Certificate Authority object. - tags: - - all - - clientCertAuthority - x-accepts: application/json - get: - description: |- - Get a Client Certificate Authority object. - - Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - certAuthorityName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.19. - operationId: getClientCertAuthority - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientCertAuthorityResponse' - description: "The Client Certificate Authority object's attributes, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Client Certificate Authority object. - tags: - - all - - clientCertAuthority - x-accepts: application/json - patch: - description: |- - Update a Client Certificate Authority object. Any attribute missing from the request will be left unchanged. - - Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - certAuthorityName|x|x|||| - crlUrl||||x|| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - ClientCertAuthority|crlDayList|crlTimeList| - ClientCertAuthority|crlTimeList|crlDayList| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.19. - operationId: updateClientCertAuthority - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ClientCertAuthority' - description: The Client Certificate Authority object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientCertAuthorityResponse' - description: "The Client Certificate Authority object's attributes after\ - \ being updated, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Client Certificate Authority object. - tags: - - all - - clientCertAuthority - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Client Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - certAuthorityName|x||x|||| - crlUrl|||||x|| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - ClientCertAuthority|crlDayList|crlTimeList| - ClientCertAuthority|crlTimeList|crlDayList| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.19. - operationId: replaceClientCertAuthority - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ClientCertAuthority' - description: The Client Certificate Authority object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientCertAuthorityResponse' - description: "The Client Certificate Authority object's attributes after\ - \ being replaced, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Client Certificate Authority object. - tags: - - all - - clientCertAuthority - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames: - get: - description: |- - Get a list of OCSP Responder Trusted Common Name objects. - - When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - certAuthorityName|x||| - ocspTlsTrustedCommonName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.19. - operationId: getClientCertAuthorityOcspTlsTrustedCommonNames - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientCertAuthorityOcspTlsTrustedCommonNamesResponse' - description: "The list of OCSP Responder Trusted Common Name objects' attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of OCSP Responder Trusted Common Name objects. - tags: - - all - - clientCertAuthority - x-accepts: application/json - post: - description: |- - Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - certAuthorityName|x||x||| - ocspTlsTrustedCommonName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.19. - operationId: createClientCertAuthorityOcspTlsTrustedCommonName - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ClientCertAuthorityOcspTlsTrustedCommonName' - description: The OCSP Responder Trusted Common Name object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientCertAuthorityOcspTlsTrustedCommonNameResponse' - description: "The OCSP Responder Trusted Common Name object's attributes\ - \ after being created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create an OCSP Responder Trusted Common Name object. - tags: - - all - - clientCertAuthority - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}: - delete: - description: |- - Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.19. - operationId: deleteClientCertAuthorityOcspTlsTrustedCommonName - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: The expected Trusted Common Name of the OCSP responder remote - certificate. - in: path - name: ocspTlsTrustedCommonName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete an OCSP Responder Trusted Common Name object. - tags: - - all - - clientCertAuthority - x-accepts: application/json - get: - description: |- - Get an OCSP Responder Trusted Common Name object. - - When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - certAuthorityName|x||| - ocspTlsTrustedCommonName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.19. - operationId: getClientCertAuthorityOcspTlsTrustedCommonName - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: The expected Trusted Common Name of the OCSP responder remote - certificate. - in: path - name: ocspTlsTrustedCommonName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ClientCertAuthorityOcspTlsTrustedCommonNameResponse' - description: "The OCSP Responder Trusted Common Name object's attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get an OCSP Responder Trusted Common Name object. - tags: - - all - - clientCertAuthority - x-accepts: application/json - /dmrClusters: - get: - description: |- - Get a list of Cluster objects. - - A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authenticationBasicPassword||x||x - authenticationClientCertContent||x||x - authenticationClientCertPassword||x|| - dmrClusterName|x||| - tlsServerCertEnforceTrustedCommonNameEnabled|||x| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getDmrClusters - parameters: - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClustersResponse' - description: "The list of Cluster objects' attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Cluster objects. - tags: - - all - - dmrCluster - x-accepts: application/json - post: - description: |- - Create a Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - authenticationBasicPassword||||x||x - authenticationClientCertContent||||x||x - authenticationClientCertPassword||||x|| - dmrClusterName|x|x|||| - nodeName|||x||| - tlsServerCertEnforceTrustedCommonNameEnabled|||||x| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: createDmrCluster - parameters: - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DmrCluster' - description: The Cluster object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterResponse' - description: "The Cluster object's attributes after being created, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Cluster object. - tags: - - all - - dmrCluster - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /dmrClusters/{dmrClusterName}: - delete: - description: |- - Delete a Cluster object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: deleteDmrCluster - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Cluster object. - tags: - - all - - dmrCluster - x-accepts: application/json - get: - description: |- - Get a Cluster object. - - A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authenticationBasicPassword||x||x - authenticationClientCertContent||x||x - authenticationClientCertPassword||x|| - dmrClusterName|x||| - tlsServerCertEnforceTrustedCommonNameEnabled|||x| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getDmrCluster - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterResponse' - description: "The Cluster object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Cluster object. - tags: - - all - - dmrCluster - x-accepts: application/json - patch: - description: |- - Update a Cluster object. Any attribute missing from the request will be left unchanged. - - A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - authenticationBasicPassword|||x|x||x - authenticationClientCertContent|||x|x||x - authenticationClientCertPassword|||x|x|| - directOnlyEnabled||x|||| - dmrClusterName|x|x|||| - nodeName||x|||| - tlsServerCertEnforceTrustedCommonNameEnabled|||||x| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: updateDmrCluster - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DmrCluster' - description: The Cluster object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterResponse' - description: "The Cluster object's attributes after being updated, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Cluster object. - tags: - - all - - dmrCluster - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - authenticationBasicPassword||||x|x||x - authenticationClientCertContent||||x|x||x - authenticationClientCertPassword||||x|x|| - directOnlyEnabled||x||||| - dmrClusterName|x||x|||| - nodeName|||x|||| - tlsServerCertEnforceTrustedCommonNameEnabled||||||x| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: replaceDmrCluster - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DmrCluster' - description: The Cluster object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterResponse' - description: "The Cluster object's attributes after being replaced, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Cluster object. - tags: - - all - - dmrCluster - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /dmrClusters/{dmrClusterName}/certMatchingRules: - get: - description: |- - Get a list of Certificate Matching Rule objects. - - A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrClusterName|x||| - ruleName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.28. - operationId: getDmrClusterCertMatchingRules - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRulesResponse' - description: "The list of Certificate Matching Rule objects' attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Certificate Matching Rule objects. - tags: - - all - - dmrCluster - x-accepts: application/json - post: - description: |- - Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - dmrClusterName|x||x||| - ruleName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.28. - operationId: createDmrClusterCertMatchingRule - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRule' - description: The Certificate Matching Rule object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleResponse' - description: "The Certificate Matching Rule object's attributes after being\ - \ created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Certificate Matching Rule object. - tags: - - all - - dmrCluster - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}: - delete: - description: |- - Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.28. - operationId: deleteDmrClusterCertMatchingRule - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Certificate Matching Rule object. - tags: - - all - - dmrCluster - x-accepts: application/json - get: - description: |- - Get a Certificate Matching Rule object. - - A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrClusterName|x||| - ruleName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.28. - operationId: getDmrClusterCertMatchingRule - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleResponse' - description: "The Certificate Matching Rule object's attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Certificate Matching Rule object. - tags: - - all - - dmrCluster - x-accepts: application/json - patch: - description: |- - Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. - - A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - dmrClusterName|x|x|||| - ruleName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.28. - operationId: updateDmrClusterCertMatchingRule - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRule' - description: The Certificate Matching Rule object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleResponse' - description: "The Certificate Matching Rule object's attributes after being\ - \ updated, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Certificate Matching Rule object. - tags: - - all - - dmrCluster - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - dmrClusterName|x||x|||| - ruleName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.28. - operationId: replaceDmrClusterCertMatchingRule - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRule' - description: The Certificate Matching Rule object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleResponse' - description: "The Certificate Matching Rule object's attributes after being\ - \ replaced, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Certificate Matching Rule object. - tags: - - all - - dmrCluster - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters: - get: - description: |- - Get a list of Certificate Matching Rule Attribute Filter objects. - - A Cert Matching Rule Attribute Filter compares a link attribute to a string. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrClusterName|x||| - filterName|x||| - ruleName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.28. - operationId: getDmrClusterCertMatchingRuleAttributeFilters - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleAttributeFiltersResponse' - description: "The list of Certificate Matching Rule Attribute Filter objects'\ - \ attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Certificate Matching Rule Attribute Filter objects. - tags: - - all - - dmrCluster - x-accepts: application/json - post: - description: |- - Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - A Cert Matching Rule Attribute Filter compares a link attribute to a string. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - dmrClusterName|x||x||| - filterName|x|x|||| - ruleName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.28. - operationId: createDmrClusterCertMatchingRuleAttributeFilter - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleAttributeFilter' - description: The Certificate Matching Rule Attribute Filter object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleAttributeFilterResponse' - description: "The Certificate Matching Rule Attribute Filter object's attributes\ - \ after being created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Certificate Matching Rule Attribute Filter object. - tags: - - all - - dmrCluster - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}: - delete: - description: |- - Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - A Cert Matching Rule Attribute Filter compares a link attribute to a string. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.28. - operationId: deleteDmrClusterCertMatchingRuleAttributeFilter - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: The name of the filter. - in: path - name: filterName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Certificate Matching Rule Attribute Filter object. - tags: - - all - - dmrCluster - x-accepts: application/json - get: - description: |- - Get a Certificate Matching Rule Attribute Filter object. - - A Cert Matching Rule Attribute Filter compares a link attribute to a string. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrClusterName|x||| - filterName|x||| - ruleName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.28. - operationId: getDmrClusterCertMatchingRuleAttributeFilter - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: The name of the filter. - in: path - name: filterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleAttributeFilterResponse' - description: "The Certificate Matching Rule Attribute Filter object's attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Certificate Matching Rule Attribute Filter object. - tags: - - all - - dmrCluster - x-accepts: application/json - patch: - description: |- - Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. - - A Cert Matching Rule Attribute Filter compares a link attribute to a string. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - dmrClusterName|x|x|||| - filterName|x|x|||| - ruleName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.28. - operationId: updateDmrClusterCertMatchingRuleAttributeFilter - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: The name of the filter. - in: path - name: filterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleAttributeFilter' - description: The Certificate Matching Rule Attribute Filter object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleAttributeFilterResponse' - description: "The Certificate Matching Rule Attribute Filter object's attributes\ - \ after being updated, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Certificate Matching Rule Attribute Filter object. - tags: - - all - - dmrCluster - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A Cert Matching Rule Attribute Filter compares a link attribute to a string. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - dmrClusterName|x||x|||| - filterName|x||x|||| - ruleName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.28. - operationId: replaceDmrClusterCertMatchingRuleAttributeFilter - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: The name of the filter. - in: path - name: filterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleAttributeFilter' - description: The Certificate Matching Rule Attribute Filter object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleAttributeFilterResponse' - description: "The Certificate Matching Rule Attribute Filter object's attributes\ - \ after being replaced, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Certificate Matching Rule Attribute Filter object. - tags: - - all - - dmrCluster - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions: - get: - description: |- - Get a list of Certificate Matching Rule Condition objects. - - A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrClusterName|x||| - ruleName|x||| - source|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.28. - operationId: getDmrClusterCertMatchingRuleConditions - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleConditionsResponse' - description: "The list of Certificate Matching Rule Condition objects' attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Certificate Matching Rule Condition objects. - tags: - - all - - dmrCluster - x-accepts: application/json - post: - description: |- - Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - dmrClusterName|x||x||| - ruleName|x||x||| - source|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.28. - operationId: createDmrClusterCertMatchingRuleCondition - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleCondition' - description: The Certificate Matching Rule Condition object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleConditionResponse' - description: "The Certificate Matching Rule Condition object's attributes\ - \ after being created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Certificate Matching Rule Condition object. - tags: - - all - - dmrCluster - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source}: - delete: - description: |- - Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.28. - operationId: deleteDmrClusterCertMatchingRuleCondition - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: Certificate field to be compared with the Attribute. - in: path - name: source - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Certificate Matching Rule Condition object. - tags: - - all - - dmrCluster - x-accepts: application/json - get: - description: |- - Get a Certificate Matching Rule Condition object. - - A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrClusterName|x||| - ruleName|x||| - source|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.28. - operationId: getDmrClusterCertMatchingRuleCondition - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: Certificate field to be compared with the Attribute. - in: path - name: source - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleConditionResponse' - description: "The Certificate Matching Rule Condition object's attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Certificate Matching Rule Condition object. - tags: - - all - - dmrCluster - x-accepts: application/json - /dmrClusters/{dmrClusterName}/links: - get: - description: |- - Get a list of Link objects. - - A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authenticationBasicPassword||x||x - dmrClusterName|x||| - remoteNodeName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getDmrClusterLinks - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinksResponse' - description: "The list of Link objects' attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Link objects. - tags: - - all - - dmrCluster - x-accepts: application/json - post: - description: |- - Create a Link object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - authenticationBasicPassword||||x||x - dmrClusterName|x||x||| - remoteNodeName|x|x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: createDmrClusterLink - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLink' - description: The Link object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinkResponse' - description: "The Link object's attributes after being created, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Link object. - tags: - - all - - dmrCluster - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /dmrClusters/{dmrClusterName}/links/{remoteNodeName}: - delete: - description: |- - Delete a Link object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: deleteDmrClusterLink - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the node at the remote end of the Link. - in: path - name: remoteNodeName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Link object. - tags: - - all - - dmrCluster - x-accepts: application/json - get: - description: |- - Get a Link object. - - A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authenticationBasicPassword||x||x - dmrClusterName|x||| - remoteNodeName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getDmrClusterLink - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the node at the remote end of the Link. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinkResponse' - description: "The Link object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Link object. - tags: - - all - - dmrCluster - x-accepts: application/json - patch: - description: |- - Update a Link object. Any attribute missing from the request will be left unchanged. - - A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - authenticationBasicPassword|||x|x||x - authenticationScheme||||x|| - dmrClusterName|x|x|||| - egressFlowWindowSize||||x|| - initiator||||x|| - remoteNodeName|x|x|||| - span||||x|| - transportCompressedEnabled||||x|| - transportTlsEnabled||||x|| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: updateDmrClusterLink - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the node at the remote end of the Link. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLink' - description: The Link object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinkResponse' - description: "The Link object's attributes after being updated, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Link object. - tags: - - all - - dmrCluster - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Link object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - authenticationBasicPassword||||x|x||x - authenticationScheme|||||x|| - dmrClusterName|x||x|||| - egressFlowWindowSize|||||x|| - initiator|||||x|| - remoteNodeName|x||x|||| - span|||||x|| - transportCompressedEnabled|||||x|| - transportTlsEnabled|||||x|| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: replaceDmrClusterLink - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the node at the remote end of the Link. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLink' - description: The Link object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinkResponse' - description: "The Link object's attributes after being replaced, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Link object. - tags: - - all - - dmrCluster - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes: - get: - description: |- - Get a list of Link Attribute objects. - - A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - attributeName|x||| - attributeValue|x||| - dmrClusterName|x||| - remoteNodeName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.28. - operationId: getDmrClusterLinkAttributes - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the node at the remote end of the Link. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinkAttributesResponse' - description: "The list of Link Attribute objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Link Attribute objects. - tags: - - all - - dmrCluster - x-accepts: application/json - post: - description: |- - Create a Link Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - attributeName|x|x|||| - attributeValue|x|x|||| - dmrClusterName|x||x||| - remoteNodeName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.28. - operationId: createDmrClusterLinkAttribute - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the node at the remote end of the Link. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinkAttribute' - description: The Link Attribute object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinkAttributeResponse' - description: "The Link Attribute object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Link Attribute object. - tags: - - all - - dmrCluster - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue}: - delete: - description: |- - Delete a Link Attribute object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.28. - operationId: deleteDmrClusterLinkAttribute - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the node at the remote end of the Link. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: The name of the Attribute. - in: path - name: attributeName - required: true - schema: - type: string - - description: The value of the Attribute. - in: path - name: attributeValue - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Link Attribute object. - tags: - - all - - dmrCluster - x-accepts: application/json - get: - description: |- - Get a Link Attribute object. - - A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - attributeName|x||| - attributeValue|x||| - dmrClusterName|x||| - remoteNodeName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.28. - operationId: getDmrClusterLinkAttribute - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the node at the remote end of the Link. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: The name of the Attribute. - in: path - name: attributeName - required: true - schema: - type: string - - description: The value of the Attribute. - in: path - name: attributeValue - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinkAttributeResponse' - description: "The Link Attribute object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Link Attribute object. - tags: - - all - - dmrCluster - x-accepts: application/json - /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses: - get: - description: |- - Get a list of Remote Address objects. - - Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrClusterName|x||| - remoteAddress|x||| - remoteNodeName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getDmrClusterLinkRemoteAddresses - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the node at the remote end of the Link. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinkRemoteAddressesResponse' - description: "The list of Remote Address objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Remote Address objects. - tags: - - all - - dmrCluster - x-accepts: application/json - post: - description: |- - Create a Remote Address object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - dmrClusterName|x||x||| - remoteAddress|x|x|||| - remoteNodeName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: createDmrClusterLinkRemoteAddress - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the node at the remote end of the Link. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinkRemoteAddress' - description: The Remote Address object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinkRemoteAddressResponse' - description: "The Remote Address object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Remote Address object. - tags: - - all - - dmrCluster - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress}: - delete: - description: |- - Delete a Remote Address object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: deleteDmrClusterLinkRemoteAddress - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the node at the remote end of the Link. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: "The FQDN or IP address (and optional port) of the remote node.\ - \ If a port is not provided, it will vary based on the transport encoding:\ - \ 55555 (plain-text), 55443 (encrypted), or 55003 (compressed)." - in: path - name: remoteAddress - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Remote Address object. - tags: - - all - - dmrCluster - x-accepts: application/json - get: - description: |- - Get a Remote Address object. - - Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrClusterName|x||| - remoteAddress|x||| - remoteNodeName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getDmrClusterLinkRemoteAddress - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the node at the remote end of the Link. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: "The FQDN or IP address (and optional port) of the remote node.\ - \ If a port is not provided, it will vary based on the transport encoding:\ - \ 55555 (plain-text), 55443 (encrypted), or 55003 (compressed)." - in: path - name: remoteAddress - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinkRemoteAddressResponse' - description: "The Remote Address object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Remote Address object. - tags: - - all - - dmrCluster - x-accepts: application/json - /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames: - get: - deprecated: true - description: |- - Get a list of Trusted Common Name objects. - - The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrClusterName|x||x| - remoteNodeName|x||x| - tlsTrustedCommonName|x||x| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - operationId: getDmrClusterLinkTlsTrustedCommonNames - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the node at the remote end of the Link. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinkTlsTrustedCommonNamesResponse' - description: "The list of Trusted Common Name objects' attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Trusted Common Name objects. - tags: - - all - - dmrCluster - x-accepts: application/json - post: - deprecated: true - description: |- - Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - dmrClusterName|x||x||x| - remoteNodeName|x||x||x| - tlsTrustedCommonName|x|x|||x| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - operationId: createDmrClusterLinkTlsTrustedCommonName - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the node at the remote end of the Link. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinkTlsTrustedCommonName' - description: The Trusted Common Name object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinkTlsTrustedCommonNameResponse' - description: "The Trusted Common Name object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Trusted Common Name object. - tags: - - all - - dmrCluster - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName}: - delete: - deprecated: true - description: |- - Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - operationId: deleteDmrClusterLinkTlsTrustedCommonName - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the node at the remote end of the Link. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: The expected trusted common name of the remote certificate. - in: path - name: tlsTrustedCommonName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Trusted Common Name object. - tags: - - all - - dmrCluster - x-accepts: application/json - get: - deprecated: true - description: |- - Get a Trusted Common Name object. - - The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrClusterName|x||x| - remoteNodeName|x||x| - tlsTrustedCommonName|x||x| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - operationId: getDmrClusterLinkTlsTrustedCommonName - parameters: - - description: The name of the Cluster. - in: path - name: dmrClusterName - required: true - schema: - type: string - - description: The name of the node at the remote end of the Link. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: The expected trusted common name of the remote certificate. - in: path - name: tlsTrustedCommonName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DmrClusterLinkTlsTrustedCommonNameResponse' - description: "The Trusted Common Name object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Trusted Common Name object. - tags: - - all - - dmrCluster - x-accepts: application/json - /domainCertAuthorities: - get: - description: |- - Get a list of Domain Certificate Authority objects. - - Certificate Authorities trusted for domain verification. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - certAuthorityName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.19. - operationId: getDomainCertAuthorities - parameters: - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DomainCertAuthoritiesResponse' - description: "The list of Domain Certificate Authority objects' attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Domain Certificate Authority objects. - tags: - - all - - domainCertAuthority - x-accepts: application/json - post: - description: |- - Create a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - Certificate Authorities trusted for domain verification. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - certAuthorityName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.19. - operationId: createDomainCertAuthority - parameters: - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DomainCertAuthority' - description: The Domain Certificate Authority object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DomainCertAuthorityResponse' - description: "The Domain Certificate Authority object's attributes after\ - \ being created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Domain Certificate Authority object. - tags: - - all - - domainCertAuthority - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /domainCertAuthorities/{certAuthorityName}: - delete: - description: |- - Delete a Domain Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - Certificate Authorities trusted for domain verification. - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.19. - operationId: deleteDomainCertAuthority - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Domain Certificate Authority object. - tags: - - all - - domainCertAuthority - x-accepts: application/json - get: - description: |- - Get a Domain Certificate Authority object. - - Certificate Authorities trusted for domain verification. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - certAuthorityName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.19. - operationId: getDomainCertAuthority - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DomainCertAuthorityResponse' - description: "The Domain Certificate Authority object's attributes, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Domain Certificate Authority object. - tags: - - all - - domainCertAuthority - x-accepts: application/json - patch: - description: |- - Update a Domain Certificate Authority object. Any attribute missing from the request will be left unchanged. - - Certificate Authorities trusted for domain verification. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - certAuthorityName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.19. - operationId: updateDomainCertAuthority - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DomainCertAuthority' - description: The Domain Certificate Authority object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DomainCertAuthorityResponse' - description: "The Domain Certificate Authority object's attributes after\ - \ being updated, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Domain Certificate Authority object. - tags: - - all - - domainCertAuthority - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - Certificate Authorities trusted for domain verification. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - certAuthorityName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.19. - operationId: replaceDomainCertAuthority - parameters: - - description: The name of the Certificate Authority. - in: path - name: certAuthorityName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DomainCertAuthority' - description: The Domain Certificate Authority object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DomainCertAuthorityResponse' - description: "The Domain Certificate Authority object's attributes after\ - \ being replaced, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Domain Certificate Authority object. - tags: - - all - - domainCertAuthority - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns: - get: - description: |- - Get a list of Message VPN objects. - - Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authenticationOauthDefaultProviderName|||x| - bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| - distributedCacheManagementEnabled|||x| - msgVpnName|x||| - replicationBridgeAuthenticationBasicPassword||x||x - replicationBridgeAuthenticationClientCertContent||x||x - replicationBridgeAuthenticationClientCertPassword||x|| - replicationEnabledQueueBehavior||x|| - restTlsServerCertEnforceTrustedCommonNameEnabled|||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpns - parameters: - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnsResponse' - description: "The list of Message VPN objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Message VPN objects. - tags: - - all - - msgVpn - x-accepts: application/json - post: - description: |- - Create a Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - authenticationOauthDefaultProviderName|||||x| - bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| - distributedCacheManagementEnabled|||||x| - msgVpnName|x|x|||| - replicationBridgeAuthenticationBasicPassword||||x||x - replicationBridgeAuthenticationClientCertContent||||x||x - replicationBridgeAuthenticationClientCertPassword||||x|| - replicationEnabledQueueBehavior||||x|| - restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - EventThresholdByValue|clearValue|setValue| - EventThresholdByValue|setValue|clearValue| - MsgVpn|authenticationBasicProfileName|authenticationBasicType| - MsgVpn|authorizationProfileName|authorizationType| - MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| - MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| - MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| - MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| - MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| - MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: createMsgVpn - parameters: - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpn' - description: The Message VPN object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnResponse' - description: "The Message VPN object's attributes after being created, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Message VPN object. - tags: - - all - - msgVpn - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}: - delete: - description: |- - Delete a Message VPN object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: deleteMsgVpn - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Message VPN object. - tags: - - all - - msgVpn - x-accepts: application/json - get: - description: |- - Get a Message VPN object. - - Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authenticationOauthDefaultProviderName|||x| - bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| - distributedCacheManagementEnabled|||x| - msgVpnName|x||| - replicationBridgeAuthenticationBasicPassword||x||x - replicationBridgeAuthenticationClientCertContent||x||x - replicationBridgeAuthenticationClientCertPassword||x|| - replicationEnabledQueueBehavior||x|| - restTlsServerCertEnforceTrustedCommonNameEnabled|||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpn - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnResponse' - description: "The Message VPN object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Message VPN object. - tags: - - all - - msgVpn - x-accepts: application/json - patch: - description: |- - Update a Message VPN object. Any attribute missing from the request will be left unchanged. - - Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - authenticationOauthDefaultProviderName|||||x| - bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| - distributedCacheManagementEnabled|||||x| - msgVpnName|x|x|||| - replicationBridgeAuthenticationBasicPassword|||x|||x - replicationBridgeAuthenticationClientCertContent|||x|||x - replicationBridgeAuthenticationClientCertPassword|||x||| - replicationEnabledQueueBehavior|||x||| - restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - EventThresholdByValue|clearValue|setValue| - EventThresholdByValue|setValue|clearValue| - MsgVpn|authenticationBasicProfileName|authenticationBasicType| - MsgVpn|authorizationProfileName|authorizationType| - MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| - MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| - MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| - MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| - MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| - MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. Requests which include the following attributes require greater access scope/level: - - - Attribute|Access Scope/Level - :---|:---: - alias|global/read-write - authenticationBasicEnabled|global/read-write - authenticationBasicProfileName|global/read-write - authenticationBasicRadiusDomain|global/read-write - authenticationBasicType|global/read-write - authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write - authenticationClientCertCertificateMatchingRulesEnabled|global/read-write - authenticationClientCertEnabled|global/read-write - authenticationClientCertMaxChainDepth|global/read-write - authenticationClientCertRevocationCheckMode|global/read-write - authenticationClientCertUsernameSource|global/read-write - authenticationClientCertValidateDateEnabled|global/read-write - authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write - authenticationKerberosEnabled|global/read-write - authenticationOauthEnabled|global/read-write - bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write - bridgingTlsServerCertMaxChainDepth|global/read-write - bridgingTlsServerCertValidateDateEnabled|global/read-write - bridgingTlsServerCertValidateNameEnabled|global/read-write - dmrEnabled|global/read-write - exportSubscriptionsEnabled|global/read-write - maxConnectionCount|global/read-write - maxEgressFlowCount|global/read-write - maxEndpointCount|global/read-write - maxIngressFlowCount|global/read-write - maxMsgSpoolUsage|global/read-write - maxSubscriptionCount|global/read-write - maxTransactedSessionCount|global/read-write - maxTransactionCount|global/read-write - mqttRetainMaxMemory|global/read-write - replicationBridgeAuthenticationBasicClientUsername|global/read-write - replicationBridgeAuthenticationBasicPassword|global/read-write - replicationBridgeAuthenticationClientCertContent|global/read-write - replicationBridgeAuthenticationClientCertPassword|global/read-write - replicationBridgeAuthenticationScheme|global/read-write - replicationBridgeCompressedDataEnabled|global/read-write - replicationBridgeEgressFlowWindowSize|global/read-write - replicationBridgeRetryDelay|global/read-write - replicationBridgeTlsEnabled|global/read-write - replicationBridgeUnidirectionalClientProfileName|global/read-write - replicationEnabled|global/read-write - replicationEnabledQueueBehavior|global/read-write - replicationQueueMaxMsgSpoolUsage|global/read-write - replicationRole|global/read-write - restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write - restTlsServerCertMaxChainDepth|global/read-write - restTlsServerCertValidateDateEnabled|global/read-write - restTlsServerCertValidateNameEnabled|global/read-write - sempOverMsgBusAdminClientEnabled|global/read-write - sempOverMsgBusAdminDistributedCacheEnabled|global/read-write - sempOverMsgBusAdminEnabled|global/read-write - sempOverMsgBusEnabled|global/read-write - sempOverMsgBusShowEnabled|global/read-write - serviceAmqpMaxConnectionCount|global/read-write - serviceAmqpPlainTextListenPort|global/read-write - serviceAmqpTlsListenPort|global/read-write - serviceMqttMaxConnectionCount|global/read-write - serviceMqttPlainTextListenPort|global/read-write - serviceMqttTlsListenPort|global/read-write - serviceMqttTlsWebSocketListenPort|global/read-write - serviceMqttWebSocketListenPort|global/read-write - serviceRestIncomingMaxConnectionCount|global/read-write - serviceRestIncomingPlainTextListenPort|global/read-write - serviceRestIncomingTlsListenPort|global/read-write - serviceRestOutgoingMaxConnectionCount|global/read-write - serviceSmfMaxConnectionCount|global/read-write - serviceWebMaxConnectionCount|global/read-write - - - - This has been available since 2.0. - operationId: updateMsgVpn - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpn' - description: The Message VPN object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnResponse' - description: "The Message VPN object's attributes after being updated, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Message VPN object. - tags: - - all - - msgVpn - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - authenticationOauthDefaultProviderName||||||x| - bridgingTlsServerCertEnforceTrustedCommonNameEnabled||||||x| - distributedCacheManagementEnabled||||||x| - msgVpnName|x||x|||| - replicationBridgeAuthenticationBasicPassword||||x|||x - replicationBridgeAuthenticationClientCertContent||||x|||x - replicationBridgeAuthenticationClientCertPassword||||x||| - replicationEnabledQueueBehavior||||x||| - restTlsServerCertEnforceTrustedCommonNameEnabled||||||x| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - EventThresholdByValue|clearValue|setValue| - EventThresholdByValue|setValue|clearValue| - MsgVpn|authenticationBasicProfileName|authenticationBasicType| - MsgVpn|authorizationProfileName|authorizationType| - MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| - MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| - MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| - MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| - MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| - MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. Requests which include the following attributes require greater access scope/level: - - - Attribute|Access Scope/Level - :---|:---: - alias|global/read-write - authenticationBasicEnabled|global/read-write - authenticationBasicProfileName|global/read-write - authenticationBasicRadiusDomain|global/read-write - authenticationBasicType|global/read-write - authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write - authenticationClientCertCertificateMatchingRulesEnabled|global/read-write - authenticationClientCertEnabled|global/read-write - authenticationClientCertMaxChainDepth|global/read-write - authenticationClientCertRevocationCheckMode|global/read-write - authenticationClientCertUsernameSource|global/read-write - authenticationClientCertValidateDateEnabled|global/read-write - authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write - authenticationKerberosEnabled|global/read-write - authenticationOauthEnabled|global/read-write - bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write - bridgingTlsServerCertMaxChainDepth|global/read-write - bridgingTlsServerCertValidateDateEnabled|global/read-write - bridgingTlsServerCertValidateNameEnabled|global/read-write - dmrEnabled|global/read-write - exportSubscriptionsEnabled|global/read-write - maxConnectionCount|global/read-write - maxEgressFlowCount|global/read-write - maxEndpointCount|global/read-write - maxIngressFlowCount|global/read-write - maxMsgSpoolUsage|global/read-write - maxSubscriptionCount|global/read-write - maxTransactedSessionCount|global/read-write - maxTransactionCount|global/read-write - mqttRetainMaxMemory|global/read-write - replicationBridgeAuthenticationBasicClientUsername|global/read-write - replicationBridgeAuthenticationBasicPassword|global/read-write - replicationBridgeAuthenticationClientCertContent|global/read-write - replicationBridgeAuthenticationClientCertPassword|global/read-write - replicationBridgeAuthenticationScheme|global/read-write - replicationBridgeCompressedDataEnabled|global/read-write - replicationBridgeEgressFlowWindowSize|global/read-write - replicationBridgeRetryDelay|global/read-write - replicationBridgeTlsEnabled|global/read-write - replicationBridgeUnidirectionalClientProfileName|global/read-write - replicationEnabled|global/read-write - replicationEnabledQueueBehavior|global/read-write - replicationQueueMaxMsgSpoolUsage|global/read-write - replicationRole|global/read-write - restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write - restTlsServerCertMaxChainDepth|global/read-write - restTlsServerCertValidateDateEnabled|global/read-write - restTlsServerCertValidateNameEnabled|global/read-write - sempOverMsgBusAdminClientEnabled|global/read-write - sempOverMsgBusAdminDistributedCacheEnabled|global/read-write - sempOverMsgBusAdminEnabled|global/read-write - sempOverMsgBusEnabled|global/read-write - sempOverMsgBusShowEnabled|global/read-write - serviceAmqpMaxConnectionCount|global/read-write - serviceAmqpPlainTextListenPort|global/read-write - serviceAmqpTlsListenPort|global/read-write - serviceMqttMaxConnectionCount|global/read-write - serviceMqttPlainTextListenPort|global/read-write - serviceMqttTlsListenPort|global/read-write - serviceMqttTlsWebSocketListenPort|global/read-write - serviceMqttWebSocketListenPort|global/read-write - serviceRestIncomingMaxConnectionCount|global/read-write - serviceRestIncomingPlainTextListenPort|global/read-write - serviceRestIncomingTlsListenPort|global/read-write - serviceRestOutgoingMaxConnectionCount|global/read-write - serviceSmfMaxConnectionCount|global/read-write - serviceWebMaxConnectionCount|global/read-write - - - - This has been available since 2.0. - operationId: replaceMsgVpn - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpn' - description: The Message VPN object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnResponse' - description: "The Message VPN object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Message VPN object. - tags: - - all - - msgVpn - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/aclProfiles: - get: - description: |- - Get a list of ACL Profile objects. - - An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclProfileName|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnAclProfiles - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfilesResponse' - description: "The list of ACL Profile objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of ACL Profile objects. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - post: - description: |- - Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - aclProfileName|x|x|||| - msgVpnName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: createMsgVpnAclProfile - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfile' - description: The ACL Profile object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileResponse' - description: "The ACL Profile object's attributes after being created, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create an ACL Profile object. - tags: - - all - - msgVpn - - aclProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}: - delete: - description: |- - Delete an ACL Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: deleteMsgVpnAclProfile - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete an ACL Profile object. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - get: - description: |- - Get an ACL Profile object. - - An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclProfileName|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnAclProfile - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileResponse' - description: "The ACL Profile object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get an ACL Profile object. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - patch: - description: |- - Update an ACL Profile object. Any attribute missing from the request will be left unchanged. - - An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - aclProfileName|x|x|||| - msgVpnName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: updateMsgVpnAclProfile - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfile' - description: The ACL Profile object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileResponse' - description: "The ACL Profile object's attributes after being updated, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update an ACL Profile object. - tags: - - all - - msgVpn - - aclProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - aclProfileName|x||x|||| - msgVpnName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: replaceMsgVpnAclProfile - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfile' - description: The ACL Profile object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileResponse' - description: "The ACL Profile object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace an ACL Profile object. - tags: - - all - - msgVpn - - aclProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions: - get: - description: |- - Get a list of Client Connect Exception objects. - - A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclProfileName|x||| - clientConnectExceptionAddress|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnAclProfileClientConnectExceptions - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileClientConnectExceptionsResponse' - description: "The list of Client Connect Exception objects' attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Client Connect Exception objects. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - post: - description: |- - Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - aclProfileName|x||x||| - clientConnectExceptionAddress|x|x|||| - msgVpnName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: createMsgVpnAclProfileClientConnectException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileClientConnectException' - description: The Client Connect Exception object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileClientConnectExceptionResponse' - description: "The Client Connect Exception object's attributes after being\ - \ created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Client Connect Exception object. - tags: - - all - - msgVpn - - aclProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress}: - delete: - description: |- - Delete a Client Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: deleteMsgVpnAclProfileClientConnectException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: The IP address/netmask of the client connect exception in CIDR - form. - in: path - name: clientConnectExceptionAddress - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Client Connect Exception object. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - get: - description: |- - Get a Client Connect Exception object. - - A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclProfileName|x||| - clientConnectExceptionAddress|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnAclProfileClientConnectException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: The IP address/netmask of the client connect exception in CIDR - form. - in: path - name: clientConnectExceptionAddress - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileClientConnectExceptionResponse' - description: "The Client Connect Exception object's attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Client Connect Exception object. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions: - get: - deprecated: true - description: |- - Get a list of Publish Topic Exception objects. - - A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclProfileName|x||x| - msgVpnName|x||x| - publishExceptionTopic|x||x| - topicSyntax|x||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been deprecated since 2.14. Replaced by publishTopicExceptions. - operationId: getMsgVpnAclProfilePublishExceptions - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfilePublishExceptionsResponse' - description: "The list of Publish Topic Exception objects' attributes, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Publish Topic Exception objects. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - post: - deprecated: true - description: |- - Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - aclProfileName|x||x||x| - msgVpnName|x||x||x| - publishExceptionTopic|x|x|||x| - topicSyntax|x|x|||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been deprecated since 2.14. Replaced by publishTopicExceptions. - operationId: createMsgVpnAclProfilePublishException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfilePublishException' - description: The Publish Topic Exception object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfilePublishExceptionResponse' - description: "The Publish Topic Exception object's attributes after being\ - \ created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Publish Topic Exception object. - tags: - - all - - msgVpn - - aclProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic}: - delete: - deprecated: true - description: |- - Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been deprecated since 2.14. Replaced by publishTopicExceptions. - operationId: deleteMsgVpnAclProfilePublishException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: The syntax of the topic for the exception to the default action - taken. - in: path - name: topicSyntax - required: true - schema: - type: string - - description: The topic for the exception to the default action taken. May - include wildcard characters. - in: path - name: publishExceptionTopic - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Publish Topic Exception object. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - get: - deprecated: true - description: |- - Get a Publish Topic Exception object. - - A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclProfileName|x||x| - msgVpnName|x||x| - publishExceptionTopic|x||x| - topicSyntax|x||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been deprecated since 2.14. Replaced by publishTopicExceptions. - operationId: getMsgVpnAclProfilePublishException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: The syntax of the topic for the exception to the default action - taken. - in: path - name: topicSyntax - required: true - schema: - type: string - - description: The topic for the exception to the default action taken. May - include wildcard characters. - in: path - name: publishExceptionTopic - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfilePublishExceptionResponse' - description: "The Publish Topic Exception object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Publish Topic Exception object. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions: - get: - description: |- - Get a list of Publish Topic Exception objects. - - A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclProfileName|x||| - msgVpnName|x||| - publishTopicException|x||| - publishTopicExceptionSyntax|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.14. - operationId: getMsgVpnAclProfilePublishTopicExceptions - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfilePublishTopicExceptionsResponse' - description: "The list of Publish Topic Exception objects' attributes, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Publish Topic Exception objects. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - post: - description: |- - Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - aclProfileName|x||x||| - msgVpnName|x||x||| - publishTopicException|x|x|||| - publishTopicExceptionSyntax|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.14. - operationId: createMsgVpnAclProfilePublishTopicException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfilePublishTopicException' - description: The Publish Topic Exception object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfilePublishTopicExceptionResponse' - description: "The Publish Topic Exception object's attributes after being\ - \ created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Publish Topic Exception object. - tags: - - all - - msgVpn - - aclProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException}: - delete: - description: |- - Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.14. - operationId: deleteMsgVpnAclProfilePublishTopicException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: The syntax of the topic for the exception to the default action - taken. - in: path - name: publishTopicExceptionSyntax - required: true - schema: - type: string - - description: The topic for the exception to the default action taken. May - include wildcard characters. - in: path - name: publishTopicException - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Publish Topic Exception object. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - get: - description: |- - Get a Publish Topic Exception object. - - A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclProfileName|x||| - msgVpnName|x||| - publishTopicException|x||| - publishTopicExceptionSyntax|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.14. - operationId: getMsgVpnAclProfilePublishTopicException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: The syntax of the topic for the exception to the default action - taken. - in: path - name: publishTopicExceptionSyntax - required: true - schema: - type: string - - description: The topic for the exception to the default action taken. May - include wildcard characters. - in: path - name: publishTopicException - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfilePublishTopicExceptionResponse' - description: "The Publish Topic Exception object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Publish Topic Exception object. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions: - get: - deprecated: true - description: |- - Get a list of Subscribe Topic Exception objects. - - A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclProfileName|x||x| - msgVpnName|x||x| - subscribeExceptionTopic|x||x| - topicSyntax|x||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - operationId: getMsgVpnAclProfileSubscribeExceptions - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeExceptionsResponse' - description: "The list of Subscribe Topic Exception objects' attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Subscribe Topic Exception objects. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - post: - deprecated: true - description: |- - Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - aclProfileName|x||x||x| - msgVpnName|x||x||x| - subscribeExceptionTopic|x|x|||x| - topicSyntax|x|x|||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - operationId: createMsgVpnAclProfileSubscribeException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeException' - description: The Subscribe Topic Exception object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeExceptionResponse' - description: "The Subscribe Topic Exception object's attributes after being\ - \ created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Subscribe Topic Exception object. - tags: - - all - - msgVpn - - aclProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic}: - delete: - deprecated: true - description: |- - Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - operationId: deleteMsgVpnAclProfileSubscribeException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: The syntax of the topic for the exception to the default action - taken. - in: path - name: topicSyntax - required: true - schema: - type: string - - description: The topic for the exception to the default action taken. May - include wildcard characters. - in: path - name: subscribeExceptionTopic - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Subscribe Topic Exception object. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - get: - deprecated: true - description: |- - Get a Subscribe Topic Exception object. - - A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclProfileName|x||x| - msgVpnName|x||x| - subscribeExceptionTopic|x||x| - topicSyntax|x||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - operationId: getMsgVpnAclProfileSubscribeException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: The syntax of the topic for the exception to the default action - taken. - in: path - name: topicSyntax - required: true - schema: - type: string - - description: The topic for the exception to the default action taken. May - include wildcard characters. - in: path - name: subscribeExceptionTopic - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeExceptionResponse' - description: "The Subscribe Topic Exception object's attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Subscribe Topic Exception object. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions: - get: - description: |- - Get a list of Subscribe Share Name Exception objects. - - A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclProfileName|x||| - msgVpnName|x||| - subscribeShareNameException|x||| - subscribeShareNameExceptionSyntax|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.14. - operationId: getMsgVpnAclProfileSubscribeShareNameExceptions - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeShareNameExceptionsResponse' - description: "The list of Subscribe Share Name Exception objects' attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Subscribe Share Name Exception objects. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - post: - description: |- - Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - aclProfileName|x||x||| - msgVpnName|x||x||| - subscribeShareNameException|x|x|||| - subscribeShareNameExceptionSyntax|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.14. - operationId: createMsgVpnAclProfileSubscribeShareNameException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeShareNameException' - description: The Subscribe Share Name Exception object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeShareNameExceptionResponse' - description: "The Subscribe Share Name Exception object's attributes after\ - \ being created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Subscribe Share Name Exception object. - tags: - - all - - msgVpn - - aclProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - ? /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException} - : delete: - description: |- - Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.14. - operationId: deleteMsgVpnAclProfileSubscribeShareNameException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: The syntax of the subscribe share name for the exception to the - default action taken. - in: path - name: subscribeShareNameExceptionSyntax - required: true - schema: - type: string - - description: The subscribe share name exception to the default action taken. - May include wildcard characters. - in: path - name: subscribeShareNameException - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Subscribe Share Name Exception object. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - get: - description: |- - Get a Subscribe Share Name Exception object. - - A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclProfileName|x||| - msgVpnName|x||| - subscribeShareNameException|x||| - subscribeShareNameExceptionSyntax|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.14. - operationId: getMsgVpnAclProfileSubscribeShareNameException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: The syntax of the subscribe share name for the exception to the - default action taken. - in: path - name: subscribeShareNameExceptionSyntax - required: true - schema: - type: string - - description: The subscribe share name exception to the default action taken. - May include wildcard characters. - in: path - name: subscribeShareNameException - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeShareNameExceptionResponse' - description: "The Subscribe Share Name Exception object's attributes, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Subscribe Share Name Exception object. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions: - get: - description: |- - Get a list of Subscribe Topic Exception objects. - - A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclProfileName|x||| - msgVpnName|x||| - subscribeTopicException|x||| - subscribeTopicExceptionSyntax|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.14. - operationId: getMsgVpnAclProfileSubscribeTopicExceptions - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeTopicExceptionsResponse' - description: "The list of Subscribe Topic Exception objects' attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Subscribe Topic Exception objects. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - post: - description: |- - Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - aclProfileName|x||x||| - msgVpnName|x||x||| - subscribeTopicException|x|x|||| - subscribeTopicExceptionSyntax|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.14. - operationId: createMsgVpnAclProfileSubscribeTopicException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeTopicException' - description: The Subscribe Topic Exception object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeTopicExceptionResponse' - description: "The Subscribe Topic Exception object's attributes after being\ - \ created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Subscribe Topic Exception object. - tags: - - all - - msgVpn - - aclProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - ? /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException} - : delete: - description: |- - Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.14. - operationId: deleteMsgVpnAclProfileSubscribeTopicException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: The syntax of the topic for the exception to the default action - taken. - in: path - name: subscribeTopicExceptionSyntax - required: true - schema: - type: string - - description: The topic for the exception to the default action taken. May - include wildcard characters. - in: path - name: subscribeTopicException - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Subscribe Topic Exception object. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - get: - description: |- - Get a Subscribe Topic Exception object. - - A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclProfileName|x||| - msgVpnName|x||| - subscribeTopicException|x||| - subscribeTopicExceptionSyntax|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.14. - operationId: getMsgVpnAclProfileSubscribeTopicException - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the ACL Profile. - in: path - name: aclProfileName - required: true - schema: - type: string - - description: The syntax of the topic for the exception to the default action - taken. - in: path - name: subscribeTopicExceptionSyntax - required: true - schema: - type: string - - description: The topic for the exception to the default action taken. May - include wildcard characters. - in: path - name: subscribeTopicException - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeTopicExceptionResponse' - description: "The Subscribe Topic Exception object's attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Subscribe Topic Exception object. - tags: - - all - - msgVpn - - aclProfile - x-accepts: application/json - /msgVpns/{msgVpnName}/authenticationOauthProfiles: - get: - description: |- - Get a list of OAuth Profile objects. - - OAuth profiles specify how to securely authenticate to an OAuth provider. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientSecret||x||x - msgVpnName|x||| - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.25. - operationId: getMsgVpnAuthenticationOauthProfiles - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfilesResponse' - description: "The list of OAuth Profile objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of OAuth Profile objects. - tags: - - all - - msgVpn - - authenticationOauthProfile - x-accepts: application/json - post: - description: |- - Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - OAuth profiles specify how to securely authenticate to an OAuth provider. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - clientSecret||||x||x - msgVpnName|x||x||| - oauthProfileName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.25. - operationId: createMsgVpnAuthenticationOauthProfile - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfile' - description: The OAuth Profile object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileResponse' - description: "The OAuth Profile object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create an OAuth Profile object. - tags: - - all - - msgVpn - - authenticationOauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}: - delete: - description: |- - Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - OAuth profiles specify how to securely authenticate to an OAuth provider. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.25. - operationId: deleteMsgVpnAuthenticationOauthProfile - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete an OAuth Profile object. - tags: - - all - - msgVpn - - authenticationOauthProfile - x-accepts: application/json - get: - description: |- - Get an OAuth Profile object. - - OAuth profiles specify how to securely authenticate to an OAuth provider. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientSecret||x||x - msgVpnName|x||| - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.25. - operationId: getMsgVpnAuthenticationOauthProfile - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileResponse' - description: "The OAuth Profile object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get an OAuth Profile object. - tags: - - all - - msgVpn - - authenticationOauthProfile - x-accepts: application/json - patch: - description: |- - Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. - - OAuth profiles specify how to securely authenticate to an OAuth provider. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - clientSecret|||x|||x - msgVpnName|x|x|||| - oauthProfileName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.25. - operationId: updateMsgVpnAuthenticationOauthProfile - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfile' - description: The OAuth Profile object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileResponse' - description: "The OAuth Profile object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update an OAuth Profile object. - tags: - - all - - msgVpn - - authenticationOauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - OAuth profiles specify how to securely authenticate to an OAuth provider. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - clientSecret||||x|||x - msgVpnName|x||x|||| - oauthProfileName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.25. - operationId: replaceMsgVpnAuthenticationOauthProfile - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfile' - description: The OAuth Profile object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileResponse' - description: "The OAuth Profile object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace an OAuth Profile object. - tags: - - all - - msgVpn - - authenticationOauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims: - get: - description: |- - Get a list of Required Claim objects. - - Additional claims to be verified in the ID token. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientRequiredClaimName|x||| - msgVpnName|x||| - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.25. - operationId: getMsgVpnAuthenticationOauthProfileClientRequiredClaims - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse' - description: "The list of Required Claim objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Required Claim objects. - tags: - - all - - msgVpn - - authenticationOauthProfile - x-accepts: application/json - post: - description: |- - Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - Additional claims to be verified in the ID token. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - clientRequiredClaimName|x|x|||| - clientRequiredClaimValue||x|||| - msgVpnName|x||x||| - oauthProfileName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.25. - operationId: createMsgVpnAuthenticationOauthProfileClientRequiredClaim - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileClientRequiredClaim' - description: The Required Claim object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse' - description: "The Required Claim object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Required Claim object. - tags: - - all - - msgVpn - - authenticationOauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}: - delete: - description: |- - Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - Additional claims to be verified in the ID token. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.25. - operationId: deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the ID token claim to verify. - in: path - name: clientRequiredClaimName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Required Claim object. - tags: - - all - - msgVpn - - authenticationOauthProfile - x-accepts: application/json - get: - description: |- - Get a Required Claim object. - - Additional claims to be verified in the ID token. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientRequiredClaimName|x||| - msgVpnName|x||| - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.25. - operationId: getMsgVpnAuthenticationOauthProfileClientRequiredClaim - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the ID token claim to verify. - in: path - name: clientRequiredClaimName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse' - description: "The Required Claim object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Required Claim object. - tags: - - all - - msgVpn - - authenticationOauthProfile - x-accepts: application/json - /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims: - get: - description: |- - Get a list of Required Claim objects. - - Additional claims to be verified in the access token. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - oauthProfileName|x||| - resourceServerRequiredClaimName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.25. - operationId: getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse' - description: "The list of Required Claim objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Required Claim objects. - tags: - - all - - msgVpn - - authenticationOauthProfile - x-accepts: application/json - post: - description: |- - Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - Additional claims to be verified in the access token. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - oauthProfileName|x||x||| - resourceServerRequiredClaimName|x|x|||| - resourceServerRequiredClaimValue||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.25. - operationId: createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim' - description: The Required Claim object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse' - description: "The Required Claim object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Required Claim object. - tags: - - all - - msgVpn - - authenticationOauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - ? /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} - : delete: - description: |- - Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - Additional claims to be verified in the access token. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.25. - operationId: deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the access token claim to verify. - in: path - name: resourceServerRequiredClaimName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Required Claim object. - tags: - - all - - msgVpn - - authenticationOauthProfile - x-accepts: application/json - get: - description: |- - Get a Required Claim object. - - Additional claims to be verified in the access token. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - oauthProfileName|x||| - resourceServerRequiredClaimName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.25. - operationId: getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the access token claim to verify. - in: path - name: resourceServerRequiredClaimName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse' - description: "The Required Claim object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Required Claim object. - tags: - - all - - msgVpn - - authenticationOauthProfile - x-accepts: application/json - /msgVpns/{msgVpnName}/authenticationOauthProviders: - get: - deprecated: true - description: |- - Get a list of OAuth Provider objects. - - OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - audienceClaimName|||x| - audienceClaimSource|||x| - audienceClaimValue|||x| - audienceValidationEnabled|||x| - authorizationGroupClaimName|||x| - authorizationGroupClaimSource|||x| - authorizationGroupEnabled|||x| - disconnectOnTokenExpirationEnabled|||x| - enabled|||x| - jwksRefreshInterval|||x| - jwksUri|||x| - msgVpnName|x||x| - oauthProviderName|x||x| - tokenIgnoreTimeLimitsEnabled|||x| - tokenIntrospectionParameterName|||x| - tokenIntrospectionPassword||x|x|x - tokenIntrospectionTimeout|||x| - tokenIntrospectionUri|||x| - tokenIntrospectionUsername|||x| - usernameClaimName|||x| - usernameClaimSource|||x| - usernameValidateEnabled|||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - operationId: getMsgVpnAuthenticationOauthProviders - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProvidersResponse' - description: "The list of OAuth Provider objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of OAuth Provider objects. - tags: - - all - - msgVpn - - authenticationOauthProvider - x-accepts: application/json - post: - deprecated: true - description: |- - Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - audienceClaimName|||||x| - audienceClaimSource|||||x| - audienceClaimValue|||||x| - audienceValidationEnabled|||||x| - authorizationGroupClaimName|||||x| - authorizationGroupClaimSource|||||x| - authorizationGroupEnabled|||||x| - disconnectOnTokenExpirationEnabled|||||x| - enabled|||||x| - jwksRefreshInterval|||||x| - jwksUri|||||x| - msgVpnName|x||x||x| - oauthProviderName|x|x|||x| - tokenIgnoreTimeLimitsEnabled|||||x| - tokenIntrospectionParameterName|||||x| - tokenIntrospectionPassword||||x|x|x - tokenIntrospectionTimeout|||||x| - tokenIntrospectionUri|||||x| - tokenIntrospectionUsername|||||x| - usernameClaimName|||||x| - usernameClaimSource|||||x| - usernameValidateEnabled|||||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - operationId: createMsgVpnAuthenticationOauthProvider - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProvider' - description: The OAuth Provider object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProviderResponse' - description: "The OAuth Provider object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create an OAuth Provider object. - tags: - - all - - msgVpn - - authenticationOauthProvider - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}: - delete: - deprecated: true - description: |- - Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - operationId: deleteMsgVpnAuthenticationOauthProvider - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the OAuth Provider. - in: path - name: oauthProviderName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete an OAuth Provider object. - tags: - - all - - msgVpn - - authenticationOauthProvider - x-accepts: application/json - get: - deprecated: true - description: |- - Get an OAuth Provider object. - - OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - audienceClaimName|||x| - audienceClaimSource|||x| - audienceClaimValue|||x| - audienceValidationEnabled|||x| - authorizationGroupClaimName|||x| - authorizationGroupClaimSource|||x| - authorizationGroupEnabled|||x| - disconnectOnTokenExpirationEnabled|||x| - enabled|||x| - jwksRefreshInterval|||x| - jwksUri|||x| - msgVpnName|x||x| - oauthProviderName|x||x| - tokenIgnoreTimeLimitsEnabled|||x| - tokenIntrospectionParameterName|||x| - tokenIntrospectionPassword||x|x|x - tokenIntrospectionTimeout|||x| - tokenIntrospectionUri|||x| - tokenIntrospectionUsername|||x| - usernameClaimName|||x| - usernameClaimSource|||x| - usernameValidateEnabled|||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - operationId: getMsgVpnAuthenticationOauthProvider - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the OAuth Provider. - in: path - name: oauthProviderName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProviderResponse' - description: "The OAuth Provider object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get an OAuth Provider object. - tags: - - all - - msgVpn - - authenticationOauthProvider - x-accepts: application/json - patch: - deprecated: true - description: |- - Update an OAuth Provider object. Any attribute missing from the request will be left unchanged. - - OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - audienceClaimName|||||x| - audienceClaimSource|||||x| - audienceClaimValue|||||x| - audienceValidationEnabled|||||x| - authorizationGroupClaimName|||||x| - authorizationGroupClaimSource|||||x| - authorizationGroupEnabled|||||x| - disconnectOnTokenExpirationEnabled|||||x| - enabled|||||x| - jwksRefreshInterval|||||x| - jwksUri|||||x| - msgVpnName|x|x|||x| - oauthProviderName|x|x|||x| - tokenIgnoreTimeLimitsEnabled|||||x| - tokenIntrospectionParameterName|||||x| - tokenIntrospectionPassword|||x||x|x - tokenIntrospectionTimeout|||||x| - tokenIntrospectionUri|||||x| - tokenIntrospectionUsername|||||x| - usernameClaimName|||||x| - usernameClaimSource|||||x| - usernameValidateEnabled|||||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - operationId: updateMsgVpnAuthenticationOauthProvider - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the OAuth Provider. - in: path - name: oauthProviderName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProvider' - description: The OAuth Provider object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProviderResponse' - description: "The OAuth Provider object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update an OAuth Provider object. - tags: - - all - - msgVpn - - authenticationOauthProvider - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - deprecated: true - description: |- - Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - audienceClaimName||||||x| - audienceClaimSource||||||x| - audienceClaimValue||||||x| - audienceValidationEnabled||||||x| - authorizationGroupClaimName||||||x| - authorizationGroupClaimSource||||||x| - authorizationGroupEnabled||||||x| - disconnectOnTokenExpirationEnabled||||||x| - enabled||||||x| - jwksRefreshInterval||||||x| - jwksUri||||||x| - msgVpnName|x||x|||x| - oauthProviderName|x||x|||x| - tokenIgnoreTimeLimitsEnabled||||||x| - tokenIntrospectionParameterName||||||x| - tokenIntrospectionPassword||||x||x|x - tokenIntrospectionTimeout||||||x| - tokenIntrospectionUri||||||x| - tokenIntrospectionUsername||||||x| - usernameClaimName||||||x| - usernameClaimSource||||||x| - usernameValidateEnabled||||||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - operationId: replaceMsgVpnAuthenticationOauthProvider - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the OAuth Provider. - in: path - name: oauthProviderName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProvider' - description: The OAuth Provider object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProviderResponse' - description: "The OAuth Provider object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace an OAuth Provider object. - tags: - - all - - msgVpn - - authenticationOauthProvider - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/authorizationGroups: - get: - description: |- - Get a list of Authorization Group objects. - - To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authorizationGroupName|x||| - msgVpnName|x||| - orderAfterAuthorizationGroupName||x|| - orderBeforeAuthorizationGroupName||x|| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnAuthorizationGroups - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthorizationGroupsResponse' - description: "The list of Authorization Group objects' attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Authorization Group objects. - tags: - - all - - msgVpn - - authorizationGroup - x-accepts: application/json - post: - description: |- - Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - authorizationGroupName|x|x|||| - msgVpnName|x||x||| - orderAfterAuthorizationGroupName||||x|| - orderBeforeAuthorizationGroupName||||x|| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName - MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: createMsgVpnAuthorizationGroup - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthorizationGroup' - description: The Authorization Group object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthorizationGroupResponse' - description: "The Authorization Group object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create an Authorization Group object. - tags: - - all - - msgVpn - - authorizationGroup - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}: - delete: - description: |- - Delete an Authorization Group object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: deleteMsgVpnAuthorizationGroup - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "The name of the Authorization Group. For LDAP groups, special\ - \ care is needed if the group name contains special characters such as '#',\ - \ '+', ';', '=' as the value of the group name returned from the LDAP server\ - \ might prepend those characters with '\\'. For example a group name called\ - \ 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'." - in: path - name: authorizationGroupName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete an Authorization Group object. - tags: - - all - - msgVpn - - authorizationGroup - x-accepts: application/json - get: - description: |- - Get an Authorization Group object. - - To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authorizationGroupName|x||| - msgVpnName|x||| - orderAfterAuthorizationGroupName||x|| - orderBeforeAuthorizationGroupName||x|| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnAuthorizationGroup - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "The name of the Authorization Group. For LDAP groups, special\ - \ care is needed if the group name contains special characters such as '#',\ - \ '+', ';', '=' as the value of the group name returned from the LDAP server\ - \ might prepend those characters with '\\'. For example a group name called\ - \ 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'." - in: path - name: authorizationGroupName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthorizationGroupResponse' - description: "The Authorization Group object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get an Authorization Group object. - tags: - - all - - msgVpn - - authorizationGroup - x-accepts: application/json - patch: - description: |- - Update an Authorization Group object. Any attribute missing from the request will be left unchanged. - - To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - aclProfileName||||x|| - authorizationGroupName|x|x|||| - clientProfileName||||x|| - msgVpnName|x|x|||| - orderAfterAuthorizationGroupName|||x||| - orderBeforeAuthorizationGroupName|||x||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName - MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: updateMsgVpnAuthorizationGroup - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "The name of the Authorization Group. For LDAP groups, special\ - \ care is needed if the group name contains special characters such as '#',\ - \ '+', ';', '=' as the value of the group name returned from the LDAP server\ - \ might prepend those characters with '\\'. For example a group name called\ - \ 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'." - in: path - name: authorizationGroupName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthorizationGroup' - description: The Authorization Group object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthorizationGroupResponse' - description: "The Authorization Group object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update an Authorization Group object. - tags: - - all - - msgVpn - - authorizationGroup - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - aclProfileName|||||x|| - authorizationGroupName|x||x|||| - clientProfileName|||||x|| - msgVpnName|x||x|||| - orderAfterAuthorizationGroupName||||x||| - orderBeforeAuthorizationGroupName||||x||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName - MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: replaceMsgVpnAuthorizationGroup - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "The name of the Authorization Group. For LDAP groups, special\ - \ care is needed if the group name contains special characters such as '#',\ - \ '+', ';', '=' as the value of the group name returned from the LDAP server\ - \ might prepend those characters with '\\'. For example a group name called\ - \ 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'." - in: path - name: authorizationGroupName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthorizationGroup' - description: The Authorization Group object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnAuthorizationGroupResponse' - description: "The Authorization Group object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace an Authorization Group object. - tags: - - all - - msgVpn - - authorizationGroup - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/bridges: - get: - description: |- - Get a list of Bridge objects. - - Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - bridgeName|x||| - bridgeVirtualRouter|x||| - msgVpnName|x||| - remoteAuthenticationBasicPassword||x||x - remoteAuthenticationClientCertContent||x||x - remoteAuthenticationClientCertPassword||x|| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnBridges - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgesResponse' - description: "The list of Bridge objects' attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Bridge objects. - tags: - - all - - msgVpn - - bridge - x-accepts: application/json - post: - description: |- - Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - bridgeName|x|x|||| - bridgeVirtualRouter|x|x|||| - msgVpnName|x||x||| - remoteAuthenticationBasicPassword||||x||x - remoteAuthenticationClientCertContent||||x||x - remoteAuthenticationClientCertPassword||||x|| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| - MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| - MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: createMsgVpnBridge - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridge' - description: The Bridge object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeResponse' - description: "The Bridge object's attributes after being created, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Bridge object. - tags: - - all - - msgVpn - - bridge - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}: - delete: - description: |- - Delete a Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: deleteMsgVpnBridge - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Bridge object. - tags: - - all - - msgVpn - - bridge - x-accepts: application/json - get: - description: |- - Get a Bridge object. - - Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - bridgeName|x||| - bridgeVirtualRouter|x||| - msgVpnName|x||| - remoteAuthenticationBasicPassword||x||x - remoteAuthenticationClientCertContent||x||x - remoteAuthenticationClientCertPassword||x|| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnBridge - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeResponse' - description: "The Bridge object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Bridge object. - tags: - - all - - msgVpn - - bridge - x-accepts: application/json - patch: - description: |- - Update a Bridge object. Any attribute missing from the request will be left unchanged. - - Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - bridgeName|x|x|||| - bridgeVirtualRouter|x|x|||| - maxTtl||||x|| - msgVpnName|x|x|||| - remoteAuthenticationBasicClientUsername||||x|| - remoteAuthenticationBasicPassword|||x|x||x - remoteAuthenticationClientCertContent|||x|x||x - remoteAuthenticationClientCertPassword|||x|x|| - remoteAuthenticationScheme||||x|| - remoteDeliverToOnePriority||||x|| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| - MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| - MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: updateMsgVpnBridge - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridge' - description: The Bridge object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeResponse' - description: "The Bridge object's attributes after being updated, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Bridge object. - tags: - - all - - msgVpn - - bridge - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - bridgeName|x||x|||| - bridgeVirtualRouter|x||x|||| - maxTtl|||||x|| - msgVpnName|x||x|||| - remoteAuthenticationBasicClientUsername|||||x|| - remoteAuthenticationBasicPassword||||x|x||x - remoteAuthenticationClientCertContent||||x|x||x - remoteAuthenticationClientCertPassword||||x|x|| - remoteAuthenticationScheme|||||x|| - remoteDeliverToOnePriority|||||x|| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| - MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| - MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: replaceMsgVpnBridge - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridge' - description: The Bridge object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeResponse' - description: "The Bridge object's attributes after being replaced, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Bridge object. - tags: - - all - - msgVpn - - bridge - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns: - get: - description: |- - Get a list of Remote Message VPN objects. - - The Remote Message VPN is the Message VPN that the Bridge connects to. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - bridgeName|x||| - bridgeVirtualRouter|x||| - msgVpnName|x||| - password||x||x - remoteMsgVpnInterface|x||| - remoteMsgVpnLocation|x||| - remoteMsgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnBridgeRemoteMsgVpns - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeRemoteMsgVpnsResponse' - description: "The list of Remote Message VPN objects' attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Remote Message VPN objects. - tags: - - all - - msgVpn - - bridge - x-accepts: application/json - post: - description: |- - Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - The Remote Message VPN is the Message VPN that the Bridge connects to. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - bridgeName|x||x||| - bridgeVirtualRouter|x||x||| - msgVpnName|x||x||| - password||||x||x - remoteMsgVpnInterface|x||||| - remoteMsgVpnLocation|x|x|||| - remoteMsgVpnName|x|x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - MsgVpnBridgeRemoteMsgVpn|clientUsername|password| - MsgVpnBridgeRemoteMsgVpn|password|clientUsername| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: createMsgVpnBridgeRemoteMsgVpn - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeRemoteMsgVpn' - description: The Remote Message VPN object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeRemoteMsgVpnResponse' - description: "The Remote Message VPN object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Remote Message VPN object. - tags: - - all - - msgVpn - - bridge - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - ? /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} - : delete: - description: |- - Delete a Remote Message VPN object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - The Remote Message VPN is the Message VPN that the Bridge connects to. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: deleteMsgVpnBridgeRemoteMsgVpn - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: The name of the remote Message VPN. - in: path - name: remoteMsgVpnName - required: true - schema: - type: string - - description: "The location of the remote Message VPN as either an FQDN with\ - \ port, IP address with port, or virtual router name (starting with \"v:\"\ - )." - in: path - name: remoteMsgVpnLocation - required: true - schema: - type: string - - description: "The physical interface on the local Message VPN host for connecting\ - \ to the remote Message VPN. By default, an interface is chosen automatically\ - \ (recommended), but if specified, `remoteMsgVpnLocation` must not be a\ - \ virtual router name." - in: path - name: remoteMsgVpnInterface - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Remote Message VPN object. - tags: - - all - - msgVpn - - bridge - x-accepts: application/json - get: - description: |- - Get a Remote Message VPN object. - - The Remote Message VPN is the Message VPN that the Bridge connects to. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - bridgeName|x||| - bridgeVirtualRouter|x||| - msgVpnName|x||| - password||x||x - remoteMsgVpnInterface|x||| - remoteMsgVpnLocation|x||| - remoteMsgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnBridgeRemoteMsgVpn - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: The name of the remote Message VPN. - in: path - name: remoteMsgVpnName - required: true - schema: - type: string - - description: "The location of the remote Message VPN as either an FQDN with\ - \ port, IP address with port, or virtual router name (starting with \"v:\"\ - )." - in: path - name: remoteMsgVpnLocation - required: true - schema: - type: string - - description: "The physical interface on the local Message VPN host for connecting\ - \ to the remote Message VPN. By default, an interface is chosen automatically\ - \ (recommended), but if specified, `remoteMsgVpnLocation` must not be a\ - \ virtual router name." - in: path - name: remoteMsgVpnInterface - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeRemoteMsgVpnResponse' - description: "The Remote Message VPN object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Remote Message VPN object. - tags: - - all - - msgVpn - - bridge - x-accepts: application/json - patch: - description: |- - Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged. - - The Remote Message VPN is the Message VPN that the Bridge connects to. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - bridgeName|x|x|||| - bridgeVirtualRouter|x|x|||| - clientUsername||||x|| - compressedDataEnabled||||x|| - egressFlowWindowSize||||x|| - msgVpnName|x|x|||| - password|||x|x||x - remoteMsgVpnInterface|x|x|||| - remoteMsgVpnLocation|x|x|||| - remoteMsgVpnName|x|x|||| - tlsEnabled||||x|| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - MsgVpnBridgeRemoteMsgVpn|clientUsername|password| - MsgVpnBridgeRemoteMsgVpn|password|clientUsername| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: updateMsgVpnBridgeRemoteMsgVpn - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: The name of the remote Message VPN. - in: path - name: remoteMsgVpnName - required: true - schema: - type: string - - description: "The location of the remote Message VPN as either an FQDN with\ - \ port, IP address with port, or virtual router name (starting with \"v:\"\ - )." - in: path - name: remoteMsgVpnLocation - required: true - schema: - type: string - - description: "The physical interface on the local Message VPN host for connecting\ - \ to the remote Message VPN. By default, an interface is chosen automatically\ - \ (recommended), but if specified, `remoteMsgVpnLocation` must not be a\ - \ virtual router name." - in: path - name: remoteMsgVpnInterface - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeRemoteMsgVpn' - description: The Remote Message VPN object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeRemoteMsgVpnResponse' - description: "The Remote Message VPN object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Remote Message VPN object. - tags: - - all - - msgVpn - - bridge - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - The Remote Message VPN is the Message VPN that the Bridge connects to. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - bridgeName|x||x|||| - bridgeVirtualRouter|x||x|||| - clientUsername|||||x|| - compressedDataEnabled|||||x|| - egressFlowWindowSize|||||x|| - msgVpnName|x||x|||| - password||||x|x||x - remoteMsgVpnInterface|x||x|||| - remoteMsgVpnLocation|x||x|||| - remoteMsgVpnName|x||x|||| - tlsEnabled|||||x|| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - MsgVpnBridgeRemoteMsgVpn|clientUsername|password| - MsgVpnBridgeRemoteMsgVpn|password|clientUsername| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: replaceMsgVpnBridgeRemoteMsgVpn - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: The name of the remote Message VPN. - in: path - name: remoteMsgVpnName - required: true - schema: - type: string - - description: "The location of the remote Message VPN as either an FQDN with\ - \ port, IP address with port, or virtual router name (starting with \"v:\"\ - )." - in: path - name: remoteMsgVpnLocation - required: true - schema: - type: string - - description: "The physical interface on the local Message VPN host for connecting\ - \ to the remote Message VPN. By default, an interface is chosen automatically\ - \ (recommended), but if specified, `remoteMsgVpnLocation` must not be a\ - \ virtual router name." - in: path - name: remoteMsgVpnInterface - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeRemoteMsgVpn' - description: The Remote Message VPN object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeRemoteMsgVpnResponse' - description: "The Remote Message VPN object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Remote Message VPN object. - tags: - - all - - msgVpn - - bridge - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions: - get: - description: |- - Get a list of Remote Subscription objects. - - A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - bridgeName|x||| - bridgeVirtualRouter|x||| - msgVpnName|x||| - remoteSubscriptionTopic|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnBridgeRemoteSubscriptions - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeRemoteSubscriptionsResponse' - description: "The list of Remote Subscription objects' attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Remote Subscription objects. - tags: - - all - - msgVpn - - bridge - x-accepts: application/json - post: - description: |- - Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - bridgeName|x||x||| - bridgeVirtualRouter|x||x||| - deliverAlwaysEnabled||x|||| - msgVpnName|x||x||| - remoteSubscriptionTopic|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: createMsgVpnBridgeRemoteSubscription - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeRemoteSubscription' - description: The Remote Subscription object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeRemoteSubscriptionResponse' - description: "The Remote Subscription object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Remote Subscription object. - tags: - - all - - msgVpn - - bridge - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic}: - delete: - description: |- - Delete a Remote Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: deleteMsgVpnBridgeRemoteSubscription - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: The topic of the Bridge remote subscription. - in: path - name: remoteSubscriptionTopic - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Remote Subscription object. - tags: - - all - - msgVpn - - bridge - x-accepts: application/json - get: - description: |- - Get a Remote Subscription object. - - A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - bridgeName|x||| - bridgeVirtualRouter|x||| - msgVpnName|x||| - remoteSubscriptionTopic|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnBridgeRemoteSubscription - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: The topic of the Bridge remote subscription. - in: path - name: remoteSubscriptionTopic - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeRemoteSubscriptionResponse' - description: "The Remote Subscription object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Remote Subscription object. - tags: - - all - - msgVpn - - bridge - x-accepts: application/json - /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames: - get: - deprecated: true - description: |- - Get a list of Trusted Common Name objects. - - The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - bridgeName|x||x| - bridgeVirtualRouter|x||x| - msgVpnName|x||x| - tlsTrustedCommonName|x||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - operationId: getMsgVpnBridgeTlsTrustedCommonNames - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeTlsTrustedCommonNamesResponse' - description: "The list of Trusted Common Name objects' attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Trusted Common Name objects. - tags: - - all - - msgVpn - - bridge - x-accepts: application/json - post: - deprecated: true - description: |- - Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - bridgeName|x||x||x| - bridgeVirtualRouter|x||x||x| - msgVpnName|x||x||x| - tlsTrustedCommonName|x|x|||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - operationId: createMsgVpnBridgeTlsTrustedCommonName - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeTlsTrustedCommonName' - description: The Trusted Common Name object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeTlsTrustedCommonNameResponse' - description: "The Trusted Common Name object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Trusted Common Name object. - tags: - - all - - msgVpn - - bridge - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName}: - delete: - deprecated: true - description: |- - Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - operationId: deleteMsgVpnBridgeTlsTrustedCommonName - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: The expected trusted common name of the remote certificate. - in: path - name: tlsTrustedCommonName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Trusted Common Name object. - tags: - - all - - msgVpn - - bridge - x-accepts: application/json - get: - deprecated: true - description: |- - Get a Trusted Common Name object. - - The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - bridgeName|x||x| - bridgeVirtualRouter|x||x| - msgVpnName|x||x| - tlsTrustedCommonName|x||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - operationId: getMsgVpnBridgeTlsTrustedCommonName - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Bridge. - in: path - name: bridgeName - required: true - schema: - type: string - - description: The virtual router of the Bridge. - in: path - name: bridgeVirtualRouter - required: true - schema: - type: string - - description: The expected trusted common name of the remote certificate. - in: path - name: tlsTrustedCommonName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnBridgeTlsTrustedCommonNameResponse' - description: "The Trusted Common Name object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Trusted Common Name object. - tags: - - all - - msgVpn - - bridge - x-accepts: application/json - /msgVpns/{msgVpnName}/certMatchingRules: - get: - description: |- - Get a list of Certificate Matching Rule objects. - - A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - ruleName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.27. - operationId: getMsgVpnCertMatchingRules - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRulesResponse' - description: "The list of Certificate Matching Rule objects' attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Certificate Matching Rule objects. - tags: - - all - - msgVpn - - certMatchingRule - x-accepts: application/json - post: - description: |- - Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - ruleName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.27. - operationId: createMsgVpnCertMatchingRule - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRule' - description: The Certificate Matching Rule object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleResponse' - description: "The Certificate Matching Rule object's attributes after being\ - \ created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Certificate Matching Rule object. - tags: - - all - - msgVpn - - certMatchingRule - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}: - delete: - description: |- - Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.27. - operationId: deleteMsgVpnCertMatchingRule - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Certificate Matching Rule object. - tags: - - all - - msgVpn - - certMatchingRule - x-accepts: application/json - get: - description: |- - Get a Certificate Matching Rule object. - - A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - ruleName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.27. - operationId: getMsgVpnCertMatchingRule - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleResponse' - description: "The Certificate Matching Rule object's attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Certificate Matching Rule object. - tags: - - all - - msgVpn - - certMatchingRule - x-accepts: application/json - patch: - description: |- - Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. - - A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - msgVpnName|x|x|||| - ruleName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.27. - operationId: updateMsgVpnCertMatchingRule - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRule' - description: The Certificate Matching Rule object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleResponse' - description: "The Certificate Matching Rule object's attributes after being\ - \ updated, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Certificate Matching Rule object. - tags: - - all - - msgVpn - - certMatchingRule - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - msgVpnName|x||x|||| - ruleName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.27. - operationId: replaceMsgVpnCertMatchingRule - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRule' - description: The Certificate Matching Rule object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleResponse' - description: "The Certificate Matching Rule object's attributes after being\ - \ replaced, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Certificate Matching Rule object. - tags: - - all - - msgVpn - - certMatchingRule - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters: - get: - description: |- - Get a list of Certificate Matching Rule Attribute Filter objects. - - A Cert Matching Rule Attribute Filter compares a username attribute to a string. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - filterName|x||| - msgVpnName|x||| - ruleName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.28. - operationId: getMsgVpnCertMatchingRuleAttributeFilters - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleAttributeFiltersResponse' - description: "The list of Certificate Matching Rule Attribute Filter objects'\ - \ attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Certificate Matching Rule Attribute Filter objects. - tags: - - all - - msgVpn - - certMatchingRule - x-accepts: application/json - post: - description: |- - Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Cert Matching Rule Attribute Filter compares a username attribute to a string. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - filterName|x|x|||| - msgVpnName|x||x||| - ruleName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.28. - operationId: createMsgVpnCertMatchingRuleAttributeFilter - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleAttributeFilter' - description: The Certificate Matching Rule Attribute Filter object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleAttributeFilterResponse' - description: "The Certificate Matching Rule Attribute Filter object's attributes\ - \ after being created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Certificate Matching Rule Attribute Filter object. - tags: - - all - - msgVpn - - certMatchingRule - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}: - delete: - description: |- - Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Cert Matching Rule Attribute Filter compares a username attribute to a string. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.28. - operationId: deleteMsgVpnCertMatchingRuleAttributeFilter - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: The name of the filter. - in: path - name: filterName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Certificate Matching Rule Attribute Filter object. - tags: - - all - - msgVpn - - certMatchingRule - x-accepts: application/json - get: - description: |- - Get a Certificate Matching Rule Attribute Filter object. - - A Cert Matching Rule Attribute Filter compares a username attribute to a string. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - filterName|x||| - msgVpnName|x||| - ruleName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.28. - operationId: getMsgVpnCertMatchingRuleAttributeFilter - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: The name of the filter. - in: path - name: filterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleAttributeFilterResponse' - description: "The Certificate Matching Rule Attribute Filter object's attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Certificate Matching Rule Attribute Filter object. - tags: - - all - - msgVpn - - certMatchingRule - x-accepts: application/json - patch: - description: |- - Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. - - A Cert Matching Rule Attribute Filter compares a username attribute to a string. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - filterName|x|x|||| - msgVpnName|x|x|||| - ruleName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.28. - operationId: updateMsgVpnCertMatchingRuleAttributeFilter - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: The name of the filter. - in: path - name: filterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleAttributeFilter' - description: The Certificate Matching Rule Attribute Filter object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleAttributeFilterResponse' - description: "The Certificate Matching Rule Attribute Filter object's attributes\ - \ after being updated, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Certificate Matching Rule Attribute Filter object. - tags: - - all - - msgVpn - - certMatchingRule - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A Cert Matching Rule Attribute Filter compares a username attribute to a string. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - filterName|x||x|||| - msgVpnName|x||x|||| - ruleName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.28. - operationId: replaceMsgVpnCertMatchingRuleAttributeFilter - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: The name of the filter. - in: path - name: filterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleAttributeFilter' - description: The Certificate Matching Rule Attribute Filter object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleAttributeFilterResponse' - description: "The Certificate Matching Rule Attribute Filter object's attributes\ - \ after being replaced, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Certificate Matching Rule Attribute Filter object. - tags: - - all - - msgVpn - - certMatchingRule - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions: - get: - description: |- - Get a list of Certificate Matching Rule Condition objects. - - A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - ruleName|x||| - source|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.27. - operationId: getMsgVpnCertMatchingRuleConditions - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleConditionsResponse' - description: "The list of Certificate Matching Rule Condition objects' attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Certificate Matching Rule Condition objects. - tags: - - all - - msgVpn - - certMatchingRule - x-accepts: application/json - post: - description: |- - Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - ruleName|x||x||| - source|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.27. - operationId: createMsgVpnCertMatchingRuleCondition - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleCondition' - description: The Certificate Matching Rule Condition object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleConditionResponse' - description: "The Certificate Matching Rule Condition object's attributes\ - \ after being created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Certificate Matching Rule Condition object. - tags: - - all - - msgVpn - - certMatchingRule - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source}: - delete: - description: |- - Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.27. - operationId: deleteMsgVpnCertMatchingRuleCondition - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: Certificate field to be compared with the Attribute. - in: path - name: source - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Certificate Matching Rule Condition object. - tags: - - all - - msgVpn - - certMatchingRule - x-accepts: application/json - get: - description: |- - Get a Certificate Matching Rule Condition object. - - A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - ruleName|x||| - source|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.27. - operationId: getMsgVpnCertMatchingRuleCondition - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the rule. - in: path - name: ruleName - required: true - schema: - type: string - - description: Certificate field to be compared with the Attribute. - in: path - name: source - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleConditionResponse' - description: "The Certificate Matching Rule Condition object's attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Certificate Matching Rule Condition object. - tags: - - all - - msgVpn - - certMatchingRule - x-accepts: application/json - /msgVpns/{msgVpnName}/clientProfiles: - get: - description: |- - Get a list of Client Profile objects. - - Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - allowCutThroughForwardingEnabled|||x| - apiQueueManagementCopyFromOnCreateName|||x| - apiTopicEndpointManagementCopyFromOnCreateName|||x| - clientProfileName|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnClientProfiles - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientProfilesResponse' - description: "The list of Client Profile objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Client Profile objects. - tags: - - all - - msgVpn - - clientProfile - x-accepts: application/json - post: - description: |- - Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - allowCutThroughForwardingEnabled|||||x| - apiQueueManagementCopyFromOnCreateName|||||x| - apiTopicEndpointManagementCopyFromOnCreateName|||||x| - clientProfileName|x|x|||| - msgVpnName|x||x||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - EventThresholdByPercent|clearPercent|setPercent| - EventThresholdByPercent|setPercent|clearPercent| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: createMsgVpnClientProfile - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientProfile' - description: The Client Profile object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientProfileResponse' - description: "The Client Profile object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Client Profile object. - tags: - - all - - msgVpn - - clientProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}: - delete: - description: |- - Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: deleteMsgVpnClientProfile - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Client Profile. - in: path - name: clientProfileName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Client Profile object. - tags: - - all - - msgVpn - - clientProfile - x-accepts: application/json - get: - description: |- - Get a Client Profile object. - - Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - allowCutThroughForwardingEnabled|||x| - apiQueueManagementCopyFromOnCreateName|||x| - apiTopicEndpointManagementCopyFromOnCreateName|||x| - clientProfileName|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnClientProfile - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Client Profile. - in: path - name: clientProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientProfileResponse' - description: "The Client Profile object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Client Profile object. - tags: - - all - - msgVpn - - clientProfile - x-accepts: application/json - patch: - description: |- - Update a Client Profile object. Any attribute missing from the request will be left unchanged. - - Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - allowCutThroughForwardingEnabled|||||x| - apiQueueManagementCopyFromOnCreateName|||||x| - apiTopicEndpointManagementCopyFromOnCreateName|||||x| - clientProfileName|x|x|||| - msgVpnName|x|x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - EventThresholdByPercent|clearPercent|setPercent| - EventThresholdByPercent|setPercent|clearPercent| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: updateMsgVpnClientProfile - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Client Profile. - in: path - name: clientProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientProfile' - description: The Client Profile object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientProfileResponse' - description: "The Client Profile object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Client Profile object. - tags: - - all - - msgVpn - - clientProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - allowCutThroughForwardingEnabled||||||x| - apiQueueManagementCopyFromOnCreateName||||||x| - apiTopicEndpointManagementCopyFromOnCreateName||||||x| - clientProfileName|x||x|||| - msgVpnName|x||x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - EventThresholdByPercent|clearPercent|setPercent| - EventThresholdByPercent|setPercent|clearPercent| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: replaceMsgVpnClientProfile - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Client Profile. - in: path - name: clientProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientProfile' - description: The Client Profile object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientProfileResponse' - description: "The Client Profile object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Client Profile object. - tags: - - all - - msgVpn - - clientProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/clientUsernames: - get: - description: |- - Get a list of Client Username objects. - - A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientUsername|x||| - msgVpnName|x||| - password||x||x - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnClientUsernames - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientUsernamesResponse' - description: "The list of Client Username objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Client Username objects. - tags: - - all - - msgVpn - - clientUsername - x-accepts: application/json - post: - description: |- - Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - clientUsername|x|x|||| - msgVpnName|x||x||| - password||||x||x - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: createMsgVpnClientUsername - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientUsername' - description: The Client Username object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientUsernameResponse' - description: "The Client Username object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Client Username object. - tags: - - all - - msgVpn - - clientUsername - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}: - delete: - description: |- - Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: deleteMsgVpnClientUsername - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Client Username. - in: path - name: clientUsername - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Client Username object. - tags: - - all - - msgVpn - - clientUsername - x-accepts: application/json - get: - description: |- - Get a Client Username object. - - A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientUsername|x||| - msgVpnName|x||| - password||x||x - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnClientUsername - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Client Username. - in: path - name: clientUsername - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientUsernameResponse' - description: "The Client Username object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Client Username object. - tags: - - all - - msgVpn - - clientUsername - x-accepts: application/json - patch: - description: |- - Update a Client Username object. Any attribute missing from the request will be left unchanged. - - A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - aclProfileName||||x|| - clientProfileName||||x|| - clientUsername|x|x|||| - msgVpnName|x|x|||| - password|||x|||x - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: updateMsgVpnClientUsername - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Client Username. - in: path - name: clientUsername - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientUsername' - description: The Client Username object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientUsernameResponse' - description: "The Client Username object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Client Username object. - tags: - - all - - msgVpn - - clientUsername - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - aclProfileName|||||x|| - clientProfileName|||||x|| - clientUsername|x||x|||| - msgVpnName|x||x|||| - password||||x|||x - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: replaceMsgVpnClientUsername - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Client Username. - in: path - name: clientUsername - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientUsername' - description: The Client Username object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientUsernameResponse' - description: "The Client Username object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Client Username object. - tags: - - all - - msgVpn - - clientUsername - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes: - get: - description: |- - Get a list of Client Username Attribute objects. - - A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - attributeName|x||| - attributeValue|x||| - clientUsername|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.27. - operationId: getMsgVpnClientUsernameAttributes - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Client Username. - in: path - name: clientUsername - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientUsernameAttributesResponse' - description: "The list of Client Username Attribute objects' attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Client Username Attribute objects. - tags: - - all - - msgVpn - - clientUsername - x-accepts: application/json - post: - description: |- - Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - attributeName|x|x|||| - attributeValue|x|x|||| - clientUsername|x||x||| - msgVpnName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.27. - operationId: createMsgVpnClientUsernameAttribute - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Client Username. - in: path - name: clientUsername - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientUsernameAttribute' - description: The Client Username Attribute object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientUsernameAttributeResponse' - description: "The Client Username Attribute object's attributes after being\ - \ created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Client Username Attribute object. - tags: - - all - - msgVpn - - clientUsername - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue}: - delete: - description: |- - Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.27. - operationId: deleteMsgVpnClientUsernameAttribute - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Client Username. - in: path - name: clientUsername - required: true - schema: - type: string - - description: The name of the Attribute. - in: path - name: attributeName - required: true - schema: - type: string - - description: The value of the Attribute. - in: path - name: attributeValue - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Client Username Attribute object. - tags: - - all - - msgVpn - - clientUsername - x-accepts: application/json - get: - description: |- - Get a Client Username Attribute object. - - A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - attributeName|x||| - attributeValue|x||| - clientUsername|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.27. - operationId: getMsgVpnClientUsernameAttribute - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Client Username. - in: path - name: clientUsername - required: true - schema: - type: string - - description: The name of the Attribute. - in: path - name: attributeName - required: true - schema: - type: string - - description: The value of the Attribute. - in: path - name: attributeValue - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnClientUsernameAttributeResponse' - description: "The Client Username Attribute object's attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Client Username Attribute object. - tags: - - all - - msgVpn - - clientUsername - x-accepts: application/json - /msgVpns/{msgVpnName}/distributedCaches: - get: - description: |- - Get a list of Distributed Cache objects. - - A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cacheName|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getMsgVpnDistributedCaches - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCachesResponse' - description: "The list of Distributed Cache objects' attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Distributed Cache objects. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - post: - description: |- - Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - cacheName|x|x|||| - msgVpnName|x||x||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| - MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: createMsgVpnDistributedCache - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCache' - description: The Distributed Cache object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheResponse' - description: "The Distributed Cache object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Distributed Cache object. - tags: - - all - - msgVpn - - distributedCache - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/distributedCaches/{cacheName}: - delete: - description: |- - Delete a Distributed Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: deleteMsgVpnDistributedCache - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Distributed Cache object. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - get: - description: |- - Get a Distributed Cache object. - - A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cacheName|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getMsgVpnDistributedCache - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheResponse' - description: "The Distributed Cache object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Distributed Cache object. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - patch: - description: |- - Update a Distributed Cache object. Any attribute missing from the request will be left unchanged. - - A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - cacheName|x|x|||| - cacheVirtualRouter||x|||| - msgVpnName|x|x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| - MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: updateMsgVpnDistributedCache - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCache' - description: The Distributed Cache object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheResponse' - description: "The Distributed Cache object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Distributed Cache object. - tags: - - all - - msgVpn - - distributedCache - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - cacheName|x||x|||| - cacheVirtualRouter||x||||| - msgVpnName|x||x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| - MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: replaceMsgVpnDistributedCache - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCache' - description: The Distributed Cache object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheResponse' - description: "The Distributed Cache object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Distributed Cache object. - tags: - - all - - msgVpn - - distributedCache - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters: - get: - description: |- - Get a list of Cache Cluster objects. - - A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cacheName|x||| - clusterName|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getMsgVpnDistributedCacheClusters - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClustersResponse' - description: "The list of Cache Cluster objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Cache Cluster objects. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - post: - description: |- - Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - cacheName|x||x||| - clusterName|x|x|||| - msgVpnName|x||x||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThresholdByPercent|clearPercent|setPercent| - EventThresholdByPercent|setPercent|clearPercent| - EventThresholdByValue|clearValue|setValue| - EventThresholdByValue|setValue|clearValue| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: createMsgVpnDistributedCacheCluster - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheCluster' - description: The Cache Cluster object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterResponse' - description: "The Cache Cluster object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Cache Cluster object. - tags: - - all - - msgVpn - - distributedCache - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}: - delete: - description: |- - Delete a Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: deleteMsgVpnDistributedCacheCluster - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Cache Cluster object. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - get: - description: |- - Get a Cache Cluster object. - - A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cacheName|x||| - clusterName|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getMsgVpnDistributedCacheCluster - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterResponse' - description: "The Cache Cluster object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Cache Cluster object. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - patch: - description: |- - Update a Cache Cluster object. Any attribute missing from the request will be left unchanged. - - A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - cacheName|x|x|||| - clusterName|x|x|||| - msgVpnName|x|x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThresholdByPercent|clearPercent|setPercent| - EventThresholdByPercent|setPercent|clearPercent| - EventThresholdByValue|clearValue|setValue| - EventThresholdByValue|setValue|clearValue| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: updateMsgVpnDistributedCacheCluster - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheCluster' - description: The Cache Cluster object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterResponse' - description: "The Cache Cluster object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Cache Cluster object. - tags: - - all - - msgVpn - - distributedCache - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - cacheName|x||x|||| - clusterName|x||x|||| - msgVpnName|x||x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThresholdByPercent|clearPercent|setPercent| - EventThresholdByPercent|setPercent|clearPercent| - EventThresholdByValue|clearValue|setValue| - EventThresholdByValue|setValue|clearValue| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: replaceMsgVpnDistributedCacheCluster - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheCluster' - description: The Cache Cluster object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterResponse' - description: "The Cache Cluster object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Cache Cluster object. - tags: - - all - - msgVpn - - distributedCache - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters: - get: - description: |- - Get a list of Home Cache Cluster objects. - - A Home Cache Cluster is a Cache Cluster that is the "definitive" Cache Cluster for a given topic in the context of the Global Caching feature. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cacheName|x||| - clusterName|x||| - homeClusterName|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse' - description: "The list of Home Cache Cluster objects' attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Home Cache Cluster objects. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - post: - description: |- - Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Home Cache Cluster is a Cache Cluster that is the "definitive" Cache Cluster for a given topic in the context of the Global Caching feature. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - cacheName|x||x||| - clusterName|x||x||| - homeClusterName|x|x|||| - msgVpnName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster' - description: The Home Cache Cluster object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse' - description: "The Home Cache Cluster object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Home Cache Cluster object. - tags: - - all - - msgVpn - - distributedCache - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}: - delete: - description: |- - Delete a Home Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Home Cache Cluster is a Cache Cluster that is the "definitive" Cache Cluster for a given topic in the context of the Global Caching feature. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: The name of the remote Home Cache Cluster. - in: path - name: homeClusterName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Home Cache Cluster object. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - get: - description: |- - Get a Home Cache Cluster object. - - A Home Cache Cluster is a Cache Cluster that is the "definitive" Cache Cluster for a given topic in the context of the Global Caching feature. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cacheName|x||| - clusterName|x||| - homeClusterName|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: The name of the remote Home Cache Cluster. - in: path - name: homeClusterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse' - description: "The Home Cache Cluster object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Home Cache Cluster object. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - ? /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes - : get: - description: |- - Get a list of Topic Prefix objects. - - A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cacheName|x||| - clusterName|x||| - homeClusterName|x||| - msgVpnName|x||| - topicPrefix|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: The name of the remote Home Cache Cluster. - in: path - name: homeClusterName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse' - description: "The list of Topic Prefix objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Topic Prefix objects. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - post: - description: |- - Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - cacheName|x||x||| - clusterName|x||x||| - homeClusterName|x||x||| - msgVpnName|x||x||| - topicPrefix|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: The name of the remote Home Cache Cluster. - in: path - name: homeClusterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix' - description: The Topic Prefix object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse' - description: "The Topic Prefix object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Topic Prefix object. - tags: - - all - - msgVpn - - distributedCache - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - ? /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix} - : delete: - description: |- - Delete a Topic Prefix object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: The name of the remote Home Cache Cluster. - in: path - name: homeClusterName - required: true - schema: - type: string - - description: A topic prefix for global topics available from the remote Home - Cache Cluster. A wildcard (/>) is implied at the end of the prefix. - in: path - name: topicPrefix - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Topic Prefix object. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - get: - description: |- - Get a Topic Prefix object. - - A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cacheName|x||| - clusterName|x||| - homeClusterName|x||| - msgVpnName|x||| - topicPrefix|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: The name of the remote Home Cache Cluster. - in: path - name: homeClusterName - required: true - schema: - type: string - - description: A topic prefix for global topics available from the remote Home - Cache Cluster. A wildcard (/>) is implied at the end of the prefix. - in: path - name: topicPrefix - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse' - description: "The Topic Prefix object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Topic Prefix object. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances: - get: - description: |- - Get a list of Cache Instance objects. - - A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cacheName|x||| - clusterName|x||| - instanceName|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getMsgVpnDistributedCacheClusterInstances - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterInstancesResponse' - description: "The list of Cache Instance objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Cache Instance objects. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - post: - description: |- - Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - cacheName|x||x||| - clusterName|x||x||| - instanceName|x|x|||| - msgVpnName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: createMsgVpnDistributedCacheClusterInstance - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterInstance' - description: The Cache Instance object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterInstanceResponse' - description: "The Cache Instance object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Cache Instance object. - tags: - - all - - msgVpn - - distributedCache - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}: - delete: - description: |- - Delete a Cache Instance object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: deleteMsgVpnDistributedCacheClusterInstance - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: The name of the Cache Instance. - in: path - name: instanceName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Cache Instance object. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - get: - description: |- - Get a Cache Instance object. - - A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cacheName|x||| - clusterName|x||| - instanceName|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getMsgVpnDistributedCacheClusterInstance - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: The name of the Cache Instance. - in: path - name: instanceName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterInstanceResponse' - description: "The Cache Instance object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Cache Instance object. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - patch: - description: |- - Update a Cache Instance object. Any attribute missing from the request will be left unchanged. - - A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - cacheName|x|x|||| - clusterName|x|x|||| - instanceName|x|x|||| - msgVpnName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: updateMsgVpnDistributedCacheClusterInstance - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: The name of the Cache Instance. - in: path - name: instanceName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterInstance' - description: The Cache Instance object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterInstanceResponse' - description: "The Cache Instance object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Cache Instance object. - tags: - - all - - msgVpn - - distributedCache - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - cacheName|x||x|||| - clusterName|x||x|||| - instanceName|x||x|||| - msgVpnName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: replaceMsgVpnDistributedCacheClusterInstance - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: The name of the Cache Instance. - in: path - name: instanceName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterInstance' - description: The Cache Instance object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterInstanceResponse' - description: "The Cache Instance object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Cache Instance object. - tags: - - all - - msgVpn - - distributedCache - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics: - get: - description: |- - Get a list of Topic objects. - - The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cacheName|x||| - clusterName|x||| - msgVpnName|x||| - topic|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getMsgVpnDistributedCacheClusterTopics - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterTopicsResponse' - description: "The list of Topic objects' attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Topic objects. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - post: - description: |- - Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - cacheName|x||x||| - clusterName|x||x||| - msgVpnName|x||x||| - topic|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: createMsgVpnDistributedCacheClusterTopic - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterTopic' - description: The Topic object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterTopicResponse' - description: "The Topic object's attributes after being created, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Topic object. - tags: - - all - - msgVpn - - distributedCache - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic}: - delete: - description: |- - Delete a Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: deleteMsgVpnDistributedCacheClusterTopic - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: The value of the Topic in the form a/b/c. - in: path - name: topic - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Topic object. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - get: - description: |- - Get a Topic object. - - The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cacheName|x||| - clusterName|x||| - msgVpnName|x||| - topic|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getMsgVpnDistributedCacheClusterTopic - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Distributed Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: The name of the Cache Cluster. - in: path - name: clusterName - required: true - schema: - type: string - - description: The value of the Topic in the form a/b/c. - in: path - name: topic - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterTopicResponse' - description: "The Topic object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Topic object. - tags: - - all - - msgVpn - - distributedCache - x-accepts: application/json - /msgVpns/{msgVpnName}/dmrBridges: - get: - description: |- - Get a list of DMR Bridge objects. - - A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - remoteNodeName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getMsgVpnDmrBridges - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDmrBridgesResponse' - description: "The list of DMR Bridge objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of DMR Bridge objects. - tags: - - all - - msgVpn - - dmrBridge - x-accepts: application/json - post: - description: |- - Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - remoteNodeName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: createMsgVpnDmrBridge - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDmrBridge' - description: The DMR Bridge object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDmrBridgeResponse' - description: "The DMR Bridge object's attributes after being created, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a DMR Bridge object. - tags: - - all - - msgVpn - - dmrBridge - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}: - delete: - description: |- - Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: deleteMsgVpnDmrBridge - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the node at the remote end of the DMR Bridge. - in: path - name: remoteNodeName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a DMR Bridge object. - tags: - - all - - msgVpn - - dmrBridge - x-accepts: application/json - get: - description: |- - Get a DMR Bridge object. - - A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - remoteNodeName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getMsgVpnDmrBridge - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the node at the remote end of the DMR Bridge. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDmrBridgeResponse' - description: "The DMR Bridge object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a DMR Bridge object. - tags: - - all - - msgVpn - - dmrBridge - x-accepts: application/json - patch: - description: |- - Update a DMR Bridge object. Any attribute missing from the request will be left unchanged. - - A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - msgVpnName|x|x|||| - remoteNodeName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: updateMsgVpnDmrBridge - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the node at the remote end of the DMR Bridge. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDmrBridge' - description: The DMR Bridge object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDmrBridgeResponse' - description: "The DMR Bridge object's attributes after being updated, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a DMR Bridge object. - tags: - - all - - msgVpn - - dmrBridge - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - msgVpnName|x||x|||| - remoteNodeName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: replaceMsgVpnDmrBridge - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the node at the remote end of the DMR Bridge. - in: path - name: remoteNodeName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDmrBridge' - description: The DMR Bridge object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnDmrBridgeResponse' - description: "The DMR Bridge object's attributes after being replaced, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a DMR Bridge object. - tags: - - all - - msgVpn - - dmrBridge - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/jndiConnectionFactories: - get: - description: |- - Get a list of JNDI Connection Factory objects. - - The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - connectionFactoryName|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.2. - operationId: getMsgVpnJndiConnectionFactories - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiConnectionFactoriesResponse' - description: "The list of JNDI Connection Factory objects' attributes, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of JNDI Connection Factory objects. - tags: - - all - - msgVpn - - jndi - x-accepts: application/json - post: - description: |- - Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - connectionFactoryName|x|x|||| - msgVpnName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.2. - operationId: createMsgVpnJndiConnectionFactory - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiConnectionFactory' - description: The JNDI Connection Factory object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiConnectionFactoryResponse' - description: "The JNDI Connection Factory object's attributes after being\ - \ created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a JNDI Connection Factory object. - tags: - - all - - msgVpn - - jndi - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}: - delete: - description: |- - Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.2. - operationId: deleteMsgVpnJndiConnectionFactory - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the JMS Connection Factory. - in: path - name: connectionFactoryName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a JNDI Connection Factory object. - tags: - - all - - msgVpn - - jndi - x-accepts: application/json - get: - description: |- - Get a JNDI Connection Factory object. - - The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - connectionFactoryName|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.2. - operationId: getMsgVpnJndiConnectionFactory - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the JMS Connection Factory. - in: path - name: connectionFactoryName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiConnectionFactoryResponse' - description: "The JNDI Connection Factory object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a JNDI Connection Factory object. - tags: - - all - - msgVpn - - jndi - x-accepts: application/json - patch: - description: |- - Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged. - - The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - connectionFactoryName|x|x|||| - msgVpnName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.2. - operationId: updateMsgVpnJndiConnectionFactory - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the JMS Connection Factory. - in: path - name: connectionFactoryName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiConnectionFactory' - description: The JNDI Connection Factory object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiConnectionFactoryResponse' - description: "The JNDI Connection Factory object's attributes after being\ - \ updated, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a JNDI Connection Factory object. - tags: - - all - - msgVpn - - jndi - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - connectionFactoryName|x||x|||| - msgVpnName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.2. - operationId: replaceMsgVpnJndiConnectionFactory - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the JMS Connection Factory. - in: path - name: connectionFactoryName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiConnectionFactory' - description: The JNDI Connection Factory object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiConnectionFactoryResponse' - description: "The JNDI Connection Factory object's attributes after being\ - \ replaced, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a JNDI Connection Factory object. - tags: - - all - - msgVpn - - jndi - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/jndiQueues: - get: - description: |- - Get a list of JNDI Queue objects. - - The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - queueName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.2. - operationId: getMsgVpnJndiQueues - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiQueuesResponse' - description: "The list of JNDI Queue objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of JNDI Queue objects. - tags: - - all - - msgVpn - - jndi - x-accepts: application/json - post: - description: |- - Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - queueName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.2. - operationId: createMsgVpnJndiQueue - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiQueue' - description: The JNDI Queue object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiQueueResponse' - description: "The JNDI Queue object's attributes after being created, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a JNDI Queue object. - tags: - - all - - msgVpn - - jndi - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/jndiQueues/{queueName}: - delete: - description: |- - Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.2. - operationId: deleteMsgVpnJndiQueue - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The JNDI name of the JMS Queue. - in: path - name: queueName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a JNDI Queue object. - tags: - - all - - msgVpn - - jndi - x-accepts: application/json - get: - description: |- - Get a JNDI Queue object. - - The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - queueName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.2. - operationId: getMsgVpnJndiQueue - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The JNDI name of the JMS Queue. - in: path - name: queueName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiQueueResponse' - description: "The JNDI Queue object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a JNDI Queue object. - tags: - - all - - msgVpn - - jndi - x-accepts: application/json - patch: - description: |- - Update a JNDI Queue object. Any attribute missing from the request will be left unchanged. - - The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - msgVpnName|x|x|||| - queueName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.2. - operationId: updateMsgVpnJndiQueue - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The JNDI name of the JMS Queue. - in: path - name: queueName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiQueue' - description: The JNDI Queue object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiQueueResponse' - description: "The JNDI Queue object's attributes after being updated, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a JNDI Queue object. - tags: - - all - - msgVpn - - jndi - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - msgVpnName|x||x|||| - queueName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.2. - operationId: replaceMsgVpnJndiQueue - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The JNDI name of the JMS Queue. - in: path - name: queueName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiQueue' - description: The JNDI Queue object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiQueueResponse' - description: "The JNDI Queue object's attributes after being replaced, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a JNDI Queue object. - tags: - - all - - msgVpn - - jndi - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/jndiTopics: - get: - description: |- - Get a list of JNDI Topic objects. - - The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - topicName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.2. - operationId: getMsgVpnJndiTopics - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiTopicsResponse' - description: "The list of JNDI Topic objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of JNDI Topic objects. - tags: - - all - - msgVpn - - jndi - x-accepts: application/json - post: - description: |- - Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - topicName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.2. - operationId: createMsgVpnJndiTopic - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiTopic' - description: The JNDI Topic object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiTopicResponse' - description: "The JNDI Topic object's attributes after being created, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a JNDI Topic object. - tags: - - all - - msgVpn - - jndi - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/jndiTopics/{topicName}: - delete: - description: |- - Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.2. - operationId: deleteMsgVpnJndiTopic - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The JNDI name of the JMS Topic. - in: path - name: topicName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a JNDI Topic object. - tags: - - all - - msgVpn - - jndi - x-accepts: application/json - get: - description: |- - Get a JNDI Topic object. - - The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - topicName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.2. - operationId: getMsgVpnJndiTopic - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The JNDI name of the JMS Topic. - in: path - name: topicName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiTopicResponse' - description: "The JNDI Topic object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a JNDI Topic object. - tags: - - all - - msgVpn - - jndi - x-accepts: application/json - patch: - description: |- - Update a JNDI Topic object. Any attribute missing from the request will be left unchanged. - - The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - msgVpnName|x|x|||| - topicName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.2. - operationId: updateMsgVpnJndiTopic - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The JNDI name of the JMS Topic. - in: path - name: topicName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiTopic' - description: The JNDI Topic object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiTopicResponse' - description: "The JNDI Topic object's attributes after being updated, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a JNDI Topic object. - tags: - - all - - msgVpn - - jndi - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - msgVpnName|x||x|||| - topicName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.2. - operationId: replaceMsgVpnJndiTopic - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The JNDI name of the JMS Topic. - in: path - name: topicName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiTopic' - description: The JNDI Topic object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnJndiTopicResponse' - description: "The JNDI Topic object's attributes after being replaced, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a JNDI Topic object. - tags: - - all - - msgVpn - - jndi - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/mqttRetainCaches: - get: - description: |- - Get a list of MQTT Retain Cache objects. - - Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cacheName|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getMsgVpnMqttRetainCaches - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttRetainCachesResponse' - description: "The list of MQTT Retain Cache objects' attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of MQTT Retain Cache objects. - tags: - - all - - msgVpn - - mqttRetainCache - x-accepts: application/json - post: - description: |- - Create an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - cacheName|x|x|||| - msgVpnName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: createMsgVpnMqttRetainCache - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttRetainCache' - description: The MQTT Retain Cache object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttRetainCacheResponse' - description: "The MQTT Retain Cache object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create an MQTT Retain Cache object. - tags: - - all - - msgVpn - - mqttRetainCache - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}: - delete: - description: |- - Delete an MQTT Retain Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: deleteMsgVpnMqttRetainCache - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the MQTT Retain Cache. - in: path - name: cacheName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete an MQTT Retain Cache object. - tags: - - all - - msgVpn - - mqttRetainCache - x-accepts: application/json - get: - description: |- - Get an MQTT Retain Cache object. - - Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cacheName|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.11. - operationId: getMsgVpnMqttRetainCache - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the MQTT Retain Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttRetainCacheResponse' - description: "The MQTT Retain Cache object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get an MQTT Retain Cache object. - tags: - - all - - msgVpn - - mqttRetainCache - x-accepts: application/json - patch: - description: |- - Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged. - - Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - cacheName|x|x|||| - msgVpnName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: updateMsgVpnMqttRetainCache - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the MQTT Retain Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttRetainCache' - description: The MQTT Retain Cache object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttRetainCacheResponse' - description: "The MQTT Retain Cache object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update an MQTT Retain Cache object. - tags: - - all - - msgVpn - - mqttRetainCache - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - cacheName|x||x|||| - msgVpnName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.11. - operationId: replaceMsgVpnMqttRetainCache - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the MQTT Retain Cache. - in: path - name: cacheName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttRetainCache' - description: The MQTT Retain Cache object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttRetainCacheResponse' - description: "The MQTT Retain Cache object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace an MQTT Retain Cache object. - tags: - - all - - msgVpn - - mqttRetainCache - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/mqttSessions: - get: - description: |- - Get a list of MQTT Session objects. - - An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - mqttSessionClientId|x||| - mqttSessionVirtualRouter|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.1. - operationId: getMsgVpnMqttSessions - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttSessionsResponse' - description: "The list of MQTT Session objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of MQTT Session objects. - tags: - - all - - msgVpn - - mqttSession - x-accepts: application/json - post: - description: |- - Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - mqttSessionClientId|x|x|||| - mqttSessionVirtualRouter|x|x|||| - msgVpnName|x||x||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.1. - operationId: createMsgVpnMqttSession - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttSession' - description: The MQTT Session object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttSessionResponse' - description: "The MQTT Session object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create an MQTT Session object. - tags: - - all - - msgVpn - - mqttSession - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}: - delete: - description: |- - Delete an MQTT Session object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.1. - operationId: deleteMsgVpnMqttSession - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "The Client ID of the MQTT Session, which corresponds to the\ - \ ClientId provided in the MQTT CONNECT packet." - in: path - name: mqttSessionClientId - required: true - schema: - type: string - - description: The virtual router of the MQTT Session. - in: path - name: mqttSessionVirtualRouter - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete an MQTT Session object. - tags: - - all - - msgVpn - - mqttSession - x-accepts: application/json - get: - description: |- - Get an MQTT Session object. - - An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - mqttSessionClientId|x||| - mqttSessionVirtualRouter|x||| - msgVpnName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.1. - operationId: getMsgVpnMqttSession - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "The Client ID of the MQTT Session, which corresponds to the\ - \ ClientId provided in the MQTT CONNECT packet." - in: path - name: mqttSessionClientId - required: true - schema: - type: string - - description: The virtual router of the MQTT Session. - in: path - name: mqttSessionVirtualRouter - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttSessionResponse' - description: "The MQTT Session object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get an MQTT Session object. - tags: - - all - - msgVpn - - mqttSession - x-accepts: application/json - patch: - description: |- - Update an MQTT Session object. Any attribute missing from the request will be left unchanged. - - An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - mqttSessionClientId|x|x|||| - mqttSessionVirtualRouter|x|x|||| - msgVpnName|x|x|||| - owner||||x|| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.1. - operationId: updateMsgVpnMqttSession - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "The Client ID of the MQTT Session, which corresponds to the\ - \ ClientId provided in the MQTT CONNECT packet." - in: path - name: mqttSessionClientId - required: true - schema: - type: string - - description: The virtual router of the MQTT Session. - in: path - name: mqttSessionVirtualRouter - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttSession' - description: The MQTT Session object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttSessionResponse' - description: "The MQTT Session object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update an MQTT Session object. - tags: - - all - - msgVpn - - mqttSession - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - mqttSessionClientId|x||x|||| - mqttSessionVirtualRouter|x||x|||| - msgVpnName|x||x|||| - owner|||||x|| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.1. - operationId: replaceMsgVpnMqttSession - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "The Client ID of the MQTT Session, which corresponds to the\ - \ ClientId provided in the MQTT CONNECT packet." - in: path - name: mqttSessionClientId - required: true - schema: - type: string - - description: The virtual router of the MQTT Session. - in: path - name: mqttSessionVirtualRouter - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttSession' - description: The MQTT Session object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttSessionResponse' - description: "The MQTT Session object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace an MQTT Session object. - tags: - - all - - msgVpn - - mqttSession - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions: - get: - description: |- - Get a list of Subscription objects. - - An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - mqttSessionClientId|x||| - mqttSessionVirtualRouter|x||| - msgVpnName|x||| - subscriptionTopic|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.1. - operationId: getMsgVpnMqttSessionSubscriptions - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "The Client ID of the MQTT Session, which corresponds to the\ - \ ClientId provided in the MQTT CONNECT packet." - in: path - name: mqttSessionClientId - required: true - schema: - type: string - - description: The virtual router of the MQTT Session. - in: path - name: mqttSessionVirtualRouter - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttSessionSubscriptionsResponse' - description: "The list of Subscription objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Subscription objects. - tags: - - all - - msgVpn - - mqttSession - x-accepts: application/json - post: - description: |- - Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - mqttSessionClientId|x||x||| - mqttSessionVirtualRouter|x||x||| - msgVpnName|x||x||| - subscriptionTopic|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.1. - operationId: createMsgVpnMqttSessionSubscription - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "The Client ID of the MQTT Session, which corresponds to the\ - \ ClientId provided in the MQTT CONNECT packet." - in: path - name: mqttSessionClientId - required: true - schema: - type: string - - description: The virtual router of the MQTT Session. - in: path - name: mqttSessionVirtualRouter - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttSessionSubscription' - description: The Subscription object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttSessionSubscriptionResponse' - description: "The Subscription object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Subscription object. - tags: - - all - - msgVpn - - mqttSession - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}: - delete: - description: |- - Delete a Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.1. - operationId: deleteMsgVpnMqttSessionSubscription - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "The Client ID of the MQTT Session, which corresponds to the\ - \ ClientId provided in the MQTT CONNECT packet." - in: path - name: mqttSessionClientId - required: true - schema: - type: string - - description: The virtual router of the MQTT Session. - in: path - name: mqttSessionVirtualRouter - required: true - schema: - type: string - - description: The MQTT subscription topic. - in: path - name: subscriptionTopic - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Subscription object. - tags: - - all - - msgVpn - - mqttSession - x-accepts: application/json - get: - description: |- - Get a Subscription object. - - An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - mqttSessionClientId|x||| - mqttSessionVirtualRouter|x||| - msgVpnName|x||| - subscriptionTopic|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.1. - operationId: getMsgVpnMqttSessionSubscription - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "The Client ID of the MQTT Session, which corresponds to the\ - \ ClientId provided in the MQTT CONNECT packet." - in: path - name: mqttSessionClientId - required: true - schema: - type: string - - description: The virtual router of the MQTT Session. - in: path - name: mqttSessionVirtualRouter - required: true - schema: - type: string - - description: The MQTT subscription topic. - in: path - name: subscriptionTopic - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttSessionSubscriptionResponse' - description: "The Subscription object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Subscription object. - tags: - - all - - msgVpn - - mqttSession - x-accepts: application/json - patch: - description: |- - Update a Subscription object. Any attribute missing from the request will be left unchanged. - - An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - mqttSessionClientId|x|x|||| - mqttSessionVirtualRouter|x|x|||| - msgVpnName|x|x|||| - subscriptionTopic|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.1. - operationId: updateMsgVpnMqttSessionSubscription - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "The Client ID of the MQTT Session, which corresponds to the\ - \ ClientId provided in the MQTT CONNECT packet." - in: path - name: mqttSessionClientId - required: true - schema: - type: string - - description: The virtual router of the MQTT Session. - in: path - name: mqttSessionVirtualRouter - required: true - schema: - type: string - - description: The MQTT subscription topic. - in: path - name: subscriptionTopic - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttSessionSubscription' - description: The Subscription object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttSessionSubscriptionResponse' - description: "The Subscription object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Subscription object. - tags: - - all - - msgVpn - - mqttSession - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - mqttSessionClientId|x||x|||| - mqttSessionVirtualRouter|x||x|||| - msgVpnName|x||x|||| - subscriptionTopic|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.1. - operationId: replaceMsgVpnMqttSessionSubscription - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "The Client ID of the MQTT Session, which corresponds to the\ - \ ClientId provided in the MQTT CONNECT packet." - in: path - name: mqttSessionClientId - required: true - schema: - type: string - - description: The virtual router of the MQTT Session. - in: path - name: mqttSessionVirtualRouter - required: true - schema: - type: string - - description: The MQTT subscription topic. - in: path - name: subscriptionTopic - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttSessionSubscription' - description: The Subscription object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnMqttSessionSubscriptionResponse' - description: "The Subscription object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Subscription object. - tags: - - all - - msgVpn - - mqttSession - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/queueTemplates: - get: - description: |- - Get a list of Queue Template objects. - - A Queue Template provides a mechanism for specifying the initial state for client created queues. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - queueTemplateName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.14. - operationId: getMsgVpnQueueTemplates - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueueTemplatesResponse' - description: "The list of Queue Template objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Queue Template objects. - tags: - - all - - msgVpn - - queueTemplate - x-accepts: application/json - post: - description: |- - Create a Queue Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Queue Template provides a mechanism for specifying the initial state for client created queues. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - queueTemplateName|x|x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.14. - operationId: createMsgVpnQueueTemplate - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueueTemplate' - description: The Queue Template object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueueTemplateResponse' - description: "The Queue Template object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Queue Template object. - tags: - - all - - msgVpn - - queueTemplate - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}: - delete: - description: |- - Delete a Queue Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Queue Template provides a mechanism for specifying the initial state for client created queues. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.14. - operationId: deleteMsgVpnQueueTemplate - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Queue Template. - in: path - name: queueTemplateName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Queue Template object. - tags: - - all - - msgVpn - - queueTemplate - x-accepts: application/json - get: - description: |- - Get a Queue Template object. - - A Queue Template provides a mechanism for specifying the initial state for client created queues. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - queueTemplateName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.14. - operationId: getMsgVpnQueueTemplate - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Queue Template. - in: path - name: queueTemplateName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueueTemplateResponse' - description: "The Queue Template object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Queue Template object. - tags: - - all - - msgVpn - - queueTemplate - x-accepts: application/json - patch: - description: |- - Update a Queue Template object. Any attribute missing from the request will be left unchanged. - - A Queue Template provides a mechanism for specifying the initial state for client created queues. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - msgVpnName|x|x|||| - queueTemplateName|x|x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.14. - operationId: updateMsgVpnQueueTemplate - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Queue Template. - in: path - name: queueTemplateName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueueTemplate' - description: The Queue Template object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueueTemplateResponse' - description: "The Queue Template object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Queue Template object. - tags: - - all - - msgVpn - - queueTemplate - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A Queue Template provides a mechanism for specifying the initial state for client created queues. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - msgVpnName|x||x|||| - queueTemplateName|x||x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.14. - operationId: replaceMsgVpnQueueTemplate - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Queue Template. - in: path - name: queueTemplateName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueueTemplate' - description: The Queue Template object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueueTemplateResponse' - description: "The Queue Template object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Queue Template object. - tags: - - all - - msgVpn - - queueTemplate - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/queues: - get: - description: |- - Get a list of Queue objects. - - A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - queueName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnQueues - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueuesResponse' - description: "The list of Queue objects' attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Queue objects. - tags: - - all - - msgVpn - - queue - x-accepts: application/json - post: - description: |- - Create a Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - queueName|x|x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: createMsgVpnQueue - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueue' - description: The Queue object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueueResponse' - description: "The Queue object's attributes after being created, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Queue object. - tags: - - all - - msgVpn - - queue - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/queues/{queueName}: - delete: - description: |- - Delete a Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: deleteMsgVpnQueue - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Queue. - in: path - name: queueName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Queue object. - tags: - - all - - msgVpn - - queue - x-accepts: application/json - get: - description: |- - Get a Queue object. - - A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - queueName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnQueue - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Queue. - in: path - name: queueName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueueResponse' - description: "The Queue object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Queue object. - tags: - - all - - msgVpn - - queue - x-accepts: application/json - patch: - description: |- - Update a Queue object. Any attribute missing from the request will be left unchanged. - - A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - accessType||||x|| - msgVpnName|x|x|||| - owner||||x|| - permission||||x|| - queueName|x|x|||| - respectMsgPriorityEnabled||||x|| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: updateMsgVpnQueue - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Queue. - in: path - name: queueName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueue' - description: The Queue object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueueResponse' - description: "The Queue object's attributes after being updated, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Queue object. - tags: - - all - - msgVpn - - queue - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - accessType|||||x|| - msgVpnName|x||x|||| - owner|||||x|| - permission|||||x|| - queueName|x||x|||| - respectMsgPriorityEnabled|||||x|| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: replaceMsgVpnQueue - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Queue. - in: path - name: queueName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueue' - description: The Queue object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueueResponse' - description: "The Queue object's attributes after being replaced, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Queue object. - tags: - - all - - msgVpn - - queue - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions: - get: - description: |- - Get a list of Queue Subscription objects. - - One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - queueName|x||| - subscriptionTopic|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnQueueSubscriptions - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Queue. - in: path - name: queueName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueueSubscriptionsResponse' - description: "The list of Queue Subscription objects' attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Queue Subscription objects. - tags: - - all - - msgVpn - - queue - x-accepts: application/json - post: - description: |- - Create a Queue Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - queueName|x||x||| - subscriptionTopic|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: createMsgVpnQueueSubscription - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Queue. - in: path - name: queueName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueueSubscription' - description: The Queue Subscription object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueueSubscriptionResponse' - description: "The Queue Subscription object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Queue Subscription object. - tags: - - all - - msgVpn - - queue - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic}: - delete: - description: |- - Delete a Queue Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: deleteMsgVpnQueueSubscription - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Queue. - in: path - name: queueName - required: true - schema: - type: string - - description: The topic of the Subscription. - in: path - name: subscriptionTopic - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Queue Subscription object. - tags: - - all - - msgVpn - - queue - x-accepts: application/json - get: - description: |- - Get a Queue Subscription object. - - One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - queueName|x||| - subscriptionTopic|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnQueueSubscription - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Queue. - in: path - name: queueName - required: true - schema: - type: string - - description: The topic of the Subscription. - in: path - name: subscriptionTopic - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnQueueSubscriptionResponse' - description: "The Queue Subscription object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Queue Subscription object. - tags: - - all - - msgVpn - - queue - x-accepts: application/json - /msgVpns/{msgVpnName}/replayLogs: - get: - description: |- - Get a list of Replay Log objects. - - When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - replayLogName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.10. - operationId: getMsgVpnReplayLogs - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplayLogsResponse' - description: "The list of Replay Log objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Replay Log objects. - tags: - - all - - msgVpn - - replayLog - x-accepts: application/json - post: - description: |- - Create a Replay Log object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - replayLogName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.10. - operationId: createMsgVpnReplayLog - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplayLog' - description: The Replay Log object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplayLogResponse' - description: "The Replay Log object's attributes after being created, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Replay Log object. - tags: - - all - - msgVpn - - replayLog - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/replayLogs/{replayLogName}: - delete: - description: |- - Delete a Replay Log object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.10. - operationId: deleteMsgVpnReplayLog - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Replay Log. - in: path - name: replayLogName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Replay Log object. - tags: - - all - - msgVpn - - replayLog - x-accepts: application/json - get: - description: |- - Get a Replay Log object. - - When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - replayLogName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.10. - operationId: getMsgVpnReplayLog - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Replay Log. - in: path - name: replayLogName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplayLogResponse' - description: "The Replay Log object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Replay Log object. - tags: - - all - - msgVpn - - replayLog - x-accepts: application/json - patch: - description: |- - Update a Replay Log object. Any attribute missing from the request will be left unchanged. - - When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - msgVpnName|x|x|||| - replayLogName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.10. - operationId: updateMsgVpnReplayLog - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Replay Log. - in: path - name: replayLogName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplayLog' - description: The Replay Log object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplayLogResponse' - description: "The Replay Log object's attributes after being updated, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Replay Log object. - tags: - - all - - msgVpn - - replayLog - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - msgVpnName|x||x|||| - replayLogName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.10. - operationId: replaceMsgVpnReplayLog - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Replay Log. - in: path - name: replayLogName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplayLog' - description: The Replay Log object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplayLogResponse' - description: "The Replay Log object's attributes after being replaced, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Replay Log object. - tags: - - all - - msgVpn - - replayLog - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions: - get: - description: |- - Get a list of Topic Filter Subscription objects. - - One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - replayLogName|x||| - topicFilterSubscription|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.27. - operationId: getMsgVpnReplayLogTopicFilterSubscriptions - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Replay Log. - in: path - name: replayLogName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplayLogTopicFilterSubscriptionsResponse' - description: "The list of Topic Filter Subscription objects' attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Topic Filter Subscription objects. - tags: - - all - - msgVpn - - replayLog - x-accepts: application/json - post: - description: |- - Create a Topic Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - replayLogName|x||x||| - topicFilterSubscription|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.27. - operationId: createMsgVpnReplayLogTopicFilterSubscription - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Replay Log. - in: path - name: replayLogName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplayLogTopicFilterSubscription' - description: The Topic Filter Subscription object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplayLogTopicFilterSubscriptionResponse' - description: "The Topic Filter Subscription object's attributes after being\ - \ created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Topic Filter Subscription object. - tags: - - all - - msgVpn - - replayLog - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription}: - delete: - description: |- - Delete a Topic Filter Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.27. - operationId: deleteMsgVpnReplayLogTopicFilterSubscription - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Replay Log. - in: path - name: replayLogName - required: true - schema: - type: string - - description: The topic of the Subscription. - in: path - name: topicFilterSubscription - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Topic Filter Subscription object. - tags: - - all - - msgVpn - - replayLog - x-accepts: application/json - get: - description: |- - Get a Topic Filter Subscription object. - - One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - replayLogName|x||| - topicFilterSubscription|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.27. - operationId: getMsgVpnReplayLogTopicFilterSubscription - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Replay Log. - in: path - name: replayLogName - required: true - schema: - type: string - - description: The topic of the Subscription. - in: path - name: topicFilterSubscription - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplayLogTopicFilterSubscriptionResponse' - description: "The Topic Filter Subscription object's attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Topic Filter Subscription object. - tags: - - all - - msgVpn - - replayLog - x-accepts: application/json - /msgVpns/{msgVpnName}/replicatedTopics: - get: - description: |- - Get a list of Replicated Topic objects. - - To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - replicatedTopic|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.1. - operationId: getMsgVpnReplicatedTopics - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplicatedTopicsResponse' - description: "The list of Replicated Topic objects' attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Replicated Topic objects. - tags: - - all - - msgVpn - - replicatedTopic - x-accepts: application/json - post: - description: |- - Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - replicatedTopic|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.1. - operationId: createMsgVpnReplicatedTopic - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplicatedTopic' - description: The Replicated Topic object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplicatedTopicResponse' - description: "The Replicated Topic object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Replicated Topic object. - tags: - - all - - msgVpn - - replicatedTopic - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}: - delete: - description: |- - Delete a Replicated Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.1. - operationId: deleteMsgVpnReplicatedTopic - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The topic for applying replication. Published messages matching - this topic will be replicated to the standby site. - in: path - name: replicatedTopic - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Replicated Topic object. - tags: - - all - - msgVpn - - replicatedTopic - x-accepts: application/json - get: - description: |- - Get a Replicated Topic object. - - To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - replicatedTopic|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.1. - operationId: getMsgVpnReplicatedTopic - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The topic for applying replication. Published messages matching - this topic will be replicated to the standby site. - in: path - name: replicatedTopic - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplicatedTopicResponse' - description: "The Replicated Topic object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Replicated Topic object. - tags: - - all - - msgVpn - - replicatedTopic - x-accepts: application/json - patch: - description: |- - Update a Replicated Topic object. Any attribute missing from the request will be left unchanged. - - To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - msgVpnName|x|x|||| - replicatedTopic|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.1. - operationId: updateMsgVpnReplicatedTopic - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The topic for applying replication. Published messages matching - this topic will be replicated to the standby site. - in: path - name: replicatedTopic - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplicatedTopic' - description: The Replicated Topic object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplicatedTopicResponse' - description: "The Replicated Topic object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Replicated Topic object. - tags: - - all - - msgVpn - - replicatedTopic - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - msgVpnName|x||x|||| - replicatedTopic|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.1. - operationId: replaceMsgVpnReplicatedTopic - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The topic for applying replication. Published messages matching - this topic will be replicated to the standby site. - in: path - name: replicatedTopic - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplicatedTopic' - description: The Replicated Topic object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnReplicatedTopicResponse' - description: "The Replicated Topic object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Replicated Topic object. - tags: - - all - - msgVpn - - replicatedTopic - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/restDeliveryPoints: - get: - description: |- - Get a list of REST Delivery Point objects. - - A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - restDeliveryPointName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnRestDeliveryPoints - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointsResponse' - description: "The list of REST Delivery Point objects' attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of REST Delivery Point objects. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - post: - description: |- - Create a REST Delivery Point object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - restDeliveryPointName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: createMsgVpnRestDeliveryPoint - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPoint' - description: The REST Delivery Point object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointResponse' - description: "The REST Delivery Point object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a REST Delivery Point object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}: - delete: - description: |- - Delete a REST Delivery Point object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: deleteMsgVpnRestDeliveryPoint - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a REST Delivery Point object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - get: - description: |- - Get a REST Delivery Point object. - - A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - restDeliveryPointName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnRestDeliveryPoint - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointResponse' - description: "The REST Delivery Point object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a REST Delivery Point object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - patch: - description: |- - Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged. - - A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - clientProfileName||||x|| - msgVpnName|x|x|||| - restDeliveryPointName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: updateMsgVpnRestDeliveryPoint - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPoint' - description: The REST Delivery Point object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointResponse' - description: "The REST Delivery Point object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a REST Delivery Point object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - clientProfileName|||||x|| - msgVpnName|x||x|||| - restDeliveryPointName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: replaceMsgVpnRestDeliveryPoint - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPoint' - description: The REST Delivery Point object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointResponse' - description: "The REST Delivery Point object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a REST Delivery Point object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings: - get: - description: |- - Get a list of Queue Binding objects. - - A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - queueBindingName|x||| - restDeliveryPointName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnRestDeliveryPointQueueBindings - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingsResponse' - description: "The list of Queue Binding objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Queue Binding objects. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - post: - description: |- - Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - queueBindingName|x|x|||| - restDeliveryPointName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: createMsgVpnRestDeliveryPointQueueBinding - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBinding' - description: The Queue Binding object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingResponse' - description: "The Queue Binding object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Queue Binding object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}: - delete: - description: |- - Delete a Queue Binding object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: deleteMsgVpnRestDeliveryPointQueueBinding - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of a queue in the Message VPN. - in: path - name: queueBindingName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Queue Binding object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - get: - description: |- - Get a Queue Binding object. - - A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - queueBindingName|x||| - restDeliveryPointName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnRestDeliveryPointQueueBinding - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of a queue in the Message VPN. - in: path - name: queueBindingName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingResponse' - description: "The Queue Binding object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Queue Binding object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - patch: - description: |- - Update a Queue Binding object. Any attribute missing from the request will be left unchanged. - - A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - msgVpnName|x|x|||| - queueBindingName|x|x|||| - restDeliveryPointName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: updateMsgVpnRestDeliveryPointQueueBinding - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of a queue in the Message VPN. - in: path - name: queueBindingName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBinding' - description: The Queue Binding object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingResponse' - description: "The Queue Binding object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Queue Binding object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - msgVpnName|x||x|||| - queueBindingName|x||x|||| - restDeliveryPointName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: replaceMsgVpnRestDeliveryPointQueueBinding - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of a queue in the Message VPN. - in: path - name: queueBindingName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBinding' - description: The Queue Binding object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingResponse' - description: "The Queue Binding object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Queue Binding object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders: - get: - description: |- - Get a list of Request Header objects. - - A request header to be added to the HTTP request. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - headerName|x||| - msgVpnName|x||| - queueBindingName|x||| - restDeliveryPointName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.23. - operationId: getMsgVpnRestDeliveryPointQueueBindingRequestHeaders - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of a queue in the Message VPN. - in: path - name: queueBindingName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse' - description: "The list of Request Header objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Request Header objects. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - post: - description: |- - Create a Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A request header to be added to the HTTP request. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - headerName|x|x|||| - msgVpnName|x||x||| - queueBindingName|x||x||| - restDeliveryPointName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.23. - operationId: createMsgVpnRestDeliveryPointQueueBindingRequestHeader - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of a queue in the Message VPN. - in: path - name: queueBindingName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingRequestHeader' - description: The Request Header object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse' - description: "The Request Header object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Request Header object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}: - delete: - description: |- - Delete a Request Header object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A request header to be added to the HTTP request. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.23. - operationId: deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of a queue in the Message VPN. - in: path - name: queueBindingName - required: true - schema: - type: string - - description: The name of the HTTP request header. - in: path - name: headerName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Request Header object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - get: - description: |- - Get a Request Header object. - - A request header to be added to the HTTP request. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - headerName|x||| - msgVpnName|x||| - queueBindingName|x||| - restDeliveryPointName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.23. - operationId: getMsgVpnRestDeliveryPointQueueBindingRequestHeader - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of a queue in the Message VPN. - in: path - name: queueBindingName - required: true - schema: - type: string - - description: The name of the HTTP request header. - in: path - name: headerName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse' - description: "The Request Header object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Request Header object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - patch: - description: |- - Update a Request Header object. Any attribute missing from the request will be left unchanged. - - A request header to be added to the HTTP request. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - headerName|x|x|||| - msgVpnName|x|x|||| - queueBindingName|x|x|||| - restDeliveryPointName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.23. - operationId: updateMsgVpnRestDeliveryPointQueueBindingRequestHeader - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of a queue in the Message VPN. - in: path - name: queueBindingName - required: true - schema: - type: string - - description: The name of the HTTP request header. - in: path - name: headerName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingRequestHeader' - description: The Request Header object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse' - description: "The Request Header object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Request Header object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A request header to be added to the HTTP request. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - headerName|x||x|||| - msgVpnName|x||x|||| - queueBindingName|x||x|||| - restDeliveryPointName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.23. - operationId: replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of a queue in the Message VPN. - in: path - name: queueBindingName - required: true - schema: - type: string - - description: The name of the HTTP request header. - in: path - name: headerName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingRequestHeader' - description: The Request Header object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse' - description: "The Request Header object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Request Header object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers: - get: - description: |- - Get a list of REST Consumer objects. - - REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authenticationAwsSecretAccessKey||x||x - authenticationClientCertContent||x||x - authenticationClientCertPassword||x|| - authenticationHttpBasicPassword||x||x - authenticationHttpHeaderValue||x||x - authenticationOauthClientSecret||x||x - authenticationOauthJwtSecretKey||x||x - msgVpnName|x||| - restConsumerName|x||| - restDeliveryPointName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnRestDeliveryPointRestConsumers - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumersResponse' - description: "The list of REST Consumer objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of REST Consumer objects. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - post: - description: |- - Create a REST Consumer object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - authenticationAwsSecretAccessKey||||x||x - authenticationClientCertContent||||x||x - authenticationClientCertPassword||||x|| - authenticationHttpBasicPassword||||x||x - authenticationHttpHeaderValue||||x||x - authenticationOauthClientSecret||||x||x - authenticationOauthJwtSecretKey||||x||x - msgVpnName|x||x||| - restConsumerName|x|x|||| - restDeliveryPointName|x||x||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| - MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| - MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| - MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| - MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: createMsgVpnRestDeliveryPointRestConsumer - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumer' - description: The REST Consumer object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerResponse' - description: "The REST Consumer object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a REST Consumer object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}: - delete: - description: |- - Delete a REST Consumer object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: deleteMsgVpnRestDeliveryPointRestConsumer - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of the REST Consumer. - in: path - name: restConsumerName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a REST Consumer object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - get: - description: |- - Get a REST Consumer object. - - REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authenticationAwsSecretAccessKey||x||x - authenticationClientCertContent||x||x - authenticationClientCertPassword||x|| - authenticationHttpBasicPassword||x||x - authenticationHttpHeaderValue||x||x - authenticationOauthClientSecret||x||x - authenticationOauthJwtSecretKey||x||x - msgVpnName|x||| - restConsumerName|x||| - restDeliveryPointName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnRestDeliveryPointRestConsumer - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of the REST Consumer. - in: path - name: restConsumerName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerResponse' - description: "The REST Consumer object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a REST Consumer object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - patch: - description: |- - Update a REST Consumer object. Any attribute missing from the request will be left unchanged. - - REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - authenticationAwsSecretAccessKey|||x|||x - authenticationClientCertContent|||x|x||x - authenticationClientCertPassword|||x|x|| - authenticationHttpBasicPassword|||x|x||x - authenticationHttpBasicUsername||||x|| - authenticationHttpHeaderValue|||x|||x - authenticationOauthClientId||||x|| - authenticationOauthClientScope||||x|| - authenticationOauthClientSecret|||x|x||x - authenticationOauthClientTokenEndpoint||||x|| - authenticationOauthJwtSecretKey|||x|x||x - authenticationOauthJwtTokenEndpoint||||x|| - authenticationScheme||||x|| - msgVpnName|x|x|||| - outgoingConnectionCount||||x|| - remoteHost||||x|| - remotePort||||x|| - restConsumerName|x|x|||| - restDeliveryPointName|x|x|||| - tlsCipherSuiteList||||x|| - tlsEnabled||||x|| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| - MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| - MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| - MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| - MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: updateMsgVpnRestDeliveryPointRestConsumer - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of the REST Consumer. - in: path - name: restConsumerName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumer' - description: The REST Consumer object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerResponse' - description: "The REST Consumer object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a REST Consumer object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - authenticationAwsSecretAccessKey||||x|||x - authenticationClientCertContent||||x|x||x - authenticationClientCertPassword||||x|x|| - authenticationHttpBasicPassword||||x|x||x - authenticationHttpBasicUsername|||||x|| - authenticationHttpHeaderValue||||x|||x - authenticationOauthClientId|||||x|| - authenticationOauthClientScope|||||x|| - authenticationOauthClientSecret||||x|x||x - authenticationOauthClientTokenEndpoint|||||x|| - authenticationOauthJwtSecretKey||||x|x||x - authenticationOauthJwtTokenEndpoint|||||x|| - authenticationScheme|||||x|| - msgVpnName|x||x|||| - outgoingConnectionCount|||||x|| - remoteHost|||||x|| - remotePort|||||x|| - restConsumerName|x||x|||| - restDeliveryPointName|x||x|||| - tlsCipherSuiteList|||||x|| - tlsEnabled|||||x|| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| - MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| - MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| - MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| - MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: replaceMsgVpnRestDeliveryPointRestConsumer - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of the REST Consumer. - in: path - name: restConsumerName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumer' - description: The REST Consumer object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerResponse' - description: "The REST Consumer object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a REST Consumer object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims: - get: - description: |- - Get a list of Claim objects. - - A Claim is added to the JWT sent to the OAuth token request endpoint. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - oauthJwtClaimName|x||| - restConsumerName|x||| - restDeliveryPointName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.21. - operationId: getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of the REST Consumer. - in: path - name: restConsumerName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse' - description: "The list of Claim objects' attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Claim objects. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - post: - description: |- - Create a Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Claim is added to the JWT sent to the OAuth token request endpoint. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - oauthJwtClaimName|x|x|||| - oauthJwtClaimValue||x|||| - restConsumerName|x||x||| - restDeliveryPointName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.21. - operationId: createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of the REST Consumer. - in: path - name: restConsumerName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim' - description: The Claim object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse' - description: "The Claim object's attributes after being created, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Claim object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - ? /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName} - : delete: - description: |- - Delete a Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Claim is added to the JWT sent to the OAuth token request endpoint. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.21. - operationId: deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of the REST Consumer. - in: path - name: restConsumerName - required: true - schema: - type: string - - description: "The name of the additional claim. Cannot be \"exp\", \"iat\"\ - , or \"jti\"." - in: path - name: oauthJwtClaimName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Claim object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - get: - description: |- - Get a Claim object. - - A Claim is added to the JWT sent to the OAuth token request endpoint. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - oauthJwtClaimName|x||| - restConsumerName|x||| - restDeliveryPointName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.21. - operationId: getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of the REST Consumer. - in: path - name: restConsumerName - required: true - schema: - type: string - - description: "The name of the additional claim. Cannot be \"exp\", \"iat\"\ - , or \"jti\"." - in: path - name: oauthJwtClaimName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse' - description: "The Claim object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Claim object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames: - get: - deprecated: true - description: |- - Get a list of Trusted Common Name objects. - - The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||x| - restConsumerName|x||x| - restDeliveryPointName|x||x| - tlsTrustedCommonName|x||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - operationId: getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of the REST Consumer. - in: path - name: restConsumerName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse' - description: "The list of Trusted Common Name objects' attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Trusted Common Name objects. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - post: - deprecated: true - description: |- - Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||x| - restConsumerName|x||x||x| - restDeliveryPointName|x||x||x| - tlsTrustedCommonName|x|x|||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - operationId: createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of the REST Consumer. - in: path - name: restConsumerName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName' - description: The Trusted Common Name object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse' - description: "The Trusted Common Name object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Trusted Common Name object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - ? /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName} - : delete: - deprecated: true - description: |- - Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - operationId: deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of the REST Consumer. - in: path - name: restConsumerName - required: true - schema: - type: string - - description: The expected trusted common name of the remote certificate. - in: path - name: tlsTrustedCommonName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Trusted Common Name object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - get: - deprecated: true - description: |- - Get a Trusted Common Name object. - - The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||x| - restConsumerName|x||x| - restDeliveryPointName|x||x| - tlsTrustedCommonName|x||x| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - operationId: getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the REST Delivery Point. - in: path - name: restDeliveryPointName - required: true - schema: - type: string - - description: The name of the REST Consumer. - in: path - name: restConsumerName - required: true - schema: - type: string - - description: The expected trusted common name of the remote certificate. - in: path - name: tlsTrustedCommonName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse' - description: "The Trusted Common Name object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Trusted Common Name object. - tags: - - all - - msgVpn - - restDeliveryPoint - x-accepts: application/json - /msgVpns/{msgVpnName}/sequencedTopics: - get: - description: |- - Get a list of Sequenced Topic objects. - - A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - sequencedTopic|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnSequencedTopics - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnSequencedTopicsResponse' - description: "The list of Sequenced Topic objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Sequenced Topic objects. - tags: - - all - - msgVpn - x-accepts: application/json - post: - description: |- - Create a Sequenced Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - sequencedTopic|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: createMsgVpnSequencedTopic - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnSequencedTopic' - description: The Sequenced Topic object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnSequencedTopicResponse' - description: "The Sequenced Topic object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Sequenced Topic object. - tags: - - all - - msgVpn - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic}: - delete: - description: |- - Delete a Sequenced Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.0. - operationId: deleteMsgVpnSequencedTopic - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Topic for applying sequence numbers. - in: path - name: sequencedTopic - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Sequenced Topic object. - tags: - - all - - msgVpn - x-accepts: application/json - get: - description: |- - Get a Sequenced Topic object. - - A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - sequencedTopic|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.0. - operationId: getMsgVpnSequencedTopic - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Topic for applying sequence numbers. - in: path - name: sequencedTopic - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnSequencedTopicResponse' - description: "The Sequenced Topic object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Sequenced Topic object. - tags: - - all - - msgVpn - x-accepts: application/json - /msgVpns/{msgVpnName}/topicEndpointTemplates: - get: - description: |- - Get a list of Topic Endpoint Template objects. - - A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - topicEndpointTemplateName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.14. - operationId: getMsgVpnTopicEndpointTemplates - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnTopicEndpointTemplatesResponse' - description: "The list of Topic Endpoint Template objects' attributes, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Topic Endpoint Template objects. - tags: - - all - - msgVpn - - topicEndpointTemplate - x-accepts: application/json - post: - description: |- - Create a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - topicEndpointTemplateName|x|x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.14. - operationId: createMsgVpnTopicEndpointTemplate - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnTopicEndpointTemplate' - description: The Topic Endpoint Template object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnTopicEndpointTemplateResponse' - description: "The Topic Endpoint Template object's attributes after being\ - \ created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Topic Endpoint Template object. - tags: - - all - - msgVpn - - topicEndpointTemplate - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}: - delete: - description: |- - Delete a Topic Endpoint Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.14. - operationId: deleteMsgVpnTopicEndpointTemplate - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Topic Endpoint Template. - in: path - name: topicEndpointTemplateName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Topic Endpoint Template object. - tags: - - all - - msgVpn - - topicEndpointTemplate - x-accepts: application/json - get: - description: |- - Get a Topic Endpoint Template object. - - A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - topicEndpointTemplateName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.14. - operationId: getMsgVpnTopicEndpointTemplate - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Topic Endpoint Template. - in: path - name: topicEndpointTemplateName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnTopicEndpointTemplateResponse' - description: "The Topic Endpoint Template object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Topic Endpoint Template object. - tags: - - all - - msgVpn - - topicEndpointTemplate - x-accepts: application/json - patch: - description: |- - Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged. - - A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - msgVpnName|x|x|||| - topicEndpointTemplateName|x|x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.14. - operationId: updateMsgVpnTopicEndpointTemplate - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Topic Endpoint Template. - in: path - name: topicEndpointTemplateName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnTopicEndpointTemplate' - description: The Topic Endpoint Template object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnTopicEndpointTemplateResponse' - description: "The Topic Endpoint Template object's attributes after being\ - \ updated, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Topic Endpoint Template object. - tags: - - all - - msgVpn - - topicEndpointTemplate - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - msgVpnName|x||x|||| - topicEndpointTemplateName|x||x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.14. - operationId: replaceMsgVpnTopicEndpointTemplate - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Topic Endpoint Template. - in: path - name: topicEndpointTemplateName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnTopicEndpointTemplate' - description: The Topic Endpoint Template object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnTopicEndpointTemplateResponse' - description: "The Topic Endpoint Template object's attributes after being\ - \ replaced, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Topic Endpoint Template object. - tags: - - all - - msgVpn - - topicEndpointTemplate - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/topicEndpoints: - get: - description: |- - Get a list of Topic Endpoint objects. - - A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - topicEndpointName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.1. - operationId: getMsgVpnTopicEndpoints - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnTopicEndpointsResponse' - description: "The list of Topic Endpoint objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Topic Endpoint objects. - tags: - - all - - msgVpn - - topicEndpoint - x-accepts: application/json - post: - description: |- - Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x||x||| - topicEndpointName|x|x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.1. - operationId: createMsgVpnTopicEndpoint - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnTopicEndpoint' - description: The Topic Endpoint object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnTopicEndpointResponse' - description: "The Topic Endpoint object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Topic Endpoint object. - tags: - - all - - msgVpn - - topicEndpoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}: - delete: - description: |- - Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. - - A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.1. - operationId: deleteMsgVpnTopicEndpoint - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Topic Endpoint. - in: path - name: topicEndpointName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Topic Endpoint object. - tags: - - all - - msgVpn - - topicEndpoint - x-accepts: application/json - get: - description: |- - Get a Topic Endpoint object. - - A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - topicEndpointName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. - - This has been available since 2.1. - operationId: getMsgVpnTopicEndpoint - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Topic Endpoint. - in: path - name: topicEndpointName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnTopicEndpointResponse' - description: "The Topic Endpoint object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Topic Endpoint object. - tags: - - all - - msgVpn - - topicEndpoint - x-accepts: application/json - patch: - description: |- - Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged. - - A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - accessType||||x|| - msgVpnName|x|x|||| - owner||||x|| - permission||||x|| - respectMsgPriorityEnabled||||x|| - topicEndpointName|x|x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.1. - operationId: updateMsgVpnTopicEndpoint - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Topic Endpoint. - in: path - name: topicEndpointName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnTopicEndpoint' - description: The Topic Endpoint object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnTopicEndpointResponse' - description: "The Topic Endpoint object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Topic Endpoint object. - tags: - - all - - msgVpn - - topicEndpoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - accessType|||||x|| - msgVpnName|x||x|||| - owner|||||x|| - permission|||||x|| - respectMsgPriorityEnabled|||||x|| - topicEndpointName|x||x|||| - - - - The following attributes in the request may only be provided in certain combinations with other attributes: - - - Class|Attribute|Requires|Conflicts - :---|:---|:---|:--- - EventThreshold|clearPercent|setPercent|clearValue, setValue - EventThreshold|clearValue|setValue|clearPercent, setPercent - EventThreshold|setPercent|clearPercent|clearValue, setValue - EventThreshold|setValue|clearValue|clearPercent, setPercent - - - - A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation. - - This has been available since 2.1. - operationId: replaceMsgVpnTopicEndpoint - parameters: - - description: The name of the Message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: The name of the Topic Endpoint. - in: path - name: topicEndpointName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnTopicEndpoint' - description: The Topic Endpoint object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MsgVpnTopicEndpointResponse' - description: "The Topic Endpoint object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Topic Endpoint object. - tags: - - all - - msgVpn - - topicEndpoint - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /oauthProfiles: - get: - description: |- - Get a list of OAuth Profile objects. - - OAuth profiles specify how to securely authenticate to an OAuth provider. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientSecret||x||x - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.24. - operationId: getOauthProfiles - parameters: - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfilesResponse' - description: "The list of OAuth Profile objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of OAuth Profile objects. - tags: - - all - - oauthProfile - x-accepts: application/json - post: - description: |- - Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - OAuth profiles specify how to securely authenticate to an OAuth provider. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - clientSecret||||x||x - oauthProfileName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.24. - operationId: createOauthProfile - parameters: - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfile' - description: The OAuth Profile object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileResponse' - description: "The OAuth Profile object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create an OAuth Profile object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /oauthProfiles/{oauthProfileName}: - delete: - description: |- - Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - OAuth profiles specify how to securely authenticate to an OAuth provider. - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.24. - operationId: deleteOauthProfile - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete an OAuth Profile object. - tags: - - all - - oauthProfile - x-accepts: application/json - get: - description: |- - Get an OAuth Profile object. - - OAuth profiles specify how to securely authenticate to an OAuth provider. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientSecret||x||x - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.24. - operationId: getOauthProfile - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileResponse' - description: "The OAuth Profile object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get an OAuth Profile object. - tags: - - all - - oauthProfile - x-accepts: application/json - patch: - description: |- - Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. - - OAuth profiles specify how to securely authenticate to an OAuth provider. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - clientSecret|||x|||x - oauthProfileName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. Requests which include the following attributes require greater access scope/level: - - - Attribute|Access Scope/Level - :---|:---: - accessLevelGroupsClaimName|global/admin - clientId|global/admin - clientRedirectUri|global/admin - clientRequiredType|global/admin - clientScope|global/admin - clientSecret|global/admin - clientValidateTypeEnabled|global/admin - defaultGlobalAccessLevel|global/admin - displayName|global/admin - enabled|global/admin - endpointAuthorization|global/admin - endpointDiscovery|global/admin - endpointDiscoveryRefreshInterval|global/admin - endpointIntrospection|global/admin - endpointIntrospectionTimeout|global/admin - endpointJwks|global/admin - endpointJwksRefreshInterval|global/admin - endpointToken|global/admin - endpointTokenTimeout|global/admin - endpointUserinfo|global/admin - endpointUserinfoTimeout|global/admin - interactiveEnabled|global/admin - interactivePromptForExpiredSession|global/admin - interactivePromptForNewSession|global/admin - issuer|global/admin - oauthRole|global/admin - resourceServerParseAccessTokenEnabled|global/admin - resourceServerRequiredAudience|global/admin - resourceServerRequiredIssuer|global/admin - resourceServerRequiredScope|global/admin - resourceServerRequiredType|global/admin - resourceServerValidateAudienceEnabled|global/admin - resourceServerValidateIssuerEnabled|global/admin - resourceServerValidateScopeEnabled|global/admin - resourceServerValidateTypeEnabled|global/admin - sempEnabled|global/admin - usernameClaimName|global/admin - - - - This has been available since 2.24. - operationId: updateOauthProfile - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfile' - description: The OAuth Profile object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileResponse' - description: "The OAuth Profile object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update an OAuth Profile object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - OAuth profiles specify how to securely authenticate to an OAuth provider. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - clientSecret||||x|||x - oauthProfileName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. Requests which include the following attributes require greater access scope/level: - - - Attribute|Access Scope/Level - :---|:---: - accessLevelGroupsClaimName|global/admin - clientId|global/admin - clientRedirectUri|global/admin - clientRequiredType|global/admin - clientScope|global/admin - clientSecret|global/admin - clientValidateTypeEnabled|global/admin - defaultGlobalAccessLevel|global/admin - displayName|global/admin - enabled|global/admin - endpointAuthorization|global/admin - endpointDiscovery|global/admin - endpointDiscoveryRefreshInterval|global/admin - endpointIntrospection|global/admin - endpointIntrospectionTimeout|global/admin - endpointJwks|global/admin - endpointJwksRefreshInterval|global/admin - endpointToken|global/admin - endpointTokenTimeout|global/admin - endpointUserinfo|global/admin - endpointUserinfoTimeout|global/admin - interactiveEnabled|global/admin - interactivePromptForExpiredSession|global/admin - interactivePromptForNewSession|global/admin - issuer|global/admin - oauthRole|global/admin - resourceServerParseAccessTokenEnabled|global/admin - resourceServerRequiredAudience|global/admin - resourceServerRequiredIssuer|global/admin - resourceServerRequiredScope|global/admin - resourceServerRequiredType|global/admin - resourceServerValidateAudienceEnabled|global/admin - resourceServerValidateIssuerEnabled|global/admin - resourceServerValidateScopeEnabled|global/admin - resourceServerValidateTypeEnabled|global/admin - sempEnabled|global/admin - usernameClaimName|global/admin - - - - This has been available since 2.24. - operationId: replaceOauthProfile - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfile' - description: The OAuth Profile object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileResponse' - description: "The OAuth Profile object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace an OAuth Profile object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /oauthProfiles/{oauthProfileName}/accessLevelGroups: - get: - description: |- - Get a list of Group Access Level objects. - - The name of a group as it exists on the OAuth server being used to authenticate SEMP users. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - groupName|x||| - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.24. - operationId: getOauthProfileAccessLevelGroups - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupsResponse' - description: "The list of Group Access Level objects' attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Group Access Level objects. - tags: - - all - - oauthProfile - x-accepts: application/json - post: - description: |- - Create a Group Access Level object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - The name of a group as it exists on the OAuth server being used to authenticate SEMP users. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - groupName|x|x|||| - oauthProfileName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. Requests which include the following attributes require greater access scope/level: - - - Attribute|Access Scope/Level - :---|:---: - globalAccessLevel|global/admin - - - - This has been available since 2.24. - operationId: createOauthProfileAccessLevelGroup - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileAccessLevelGroup' - description: The Group Access Level object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupResponse' - description: "The Group Access Level object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Group Access Level object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}: - delete: - description: |- - Delete a Group Access Level object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - The name of a group as it exists on the OAuth server being used to authenticate SEMP users. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.24. - operationId: deleteOauthProfileAccessLevelGroup - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the group. - in: path - name: groupName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Group Access Level object. - tags: - - all - - oauthProfile - x-accepts: application/json - get: - description: |- - Get a Group Access Level object. - - The name of a group as it exists on the OAuth server being used to authenticate SEMP users. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - groupName|x||| - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.24. - operationId: getOauthProfileAccessLevelGroup - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the group. - in: path - name: groupName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupResponse' - description: "The Group Access Level object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Group Access Level object. - tags: - - all - - oauthProfile - x-accepts: application/json - patch: - description: |- - Update a Group Access Level object. Any attribute missing from the request will be left unchanged. - - The name of a group as it exists on the OAuth server being used to authenticate SEMP users. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - groupName|x|x|||| - oauthProfileName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. Requests which include the following attributes require greater access scope/level: - - - Attribute|Access Scope/Level - :---|:---: - globalAccessLevel|global/admin - - - - This has been available since 2.24. - operationId: updateOauthProfileAccessLevelGroup - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the group. - in: path - name: groupName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileAccessLevelGroup' - description: The Group Access Level object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupResponse' - description: "The Group Access Level object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Group Access Level object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Group Access Level object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - The name of a group as it exists on the OAuth server being used to authenticate SEMP users. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - groupName|x||x|||| - oauthProfileName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. Requests which include the following attributes require greater access scope/level: - - - Attribute|Access Scope/Level - :---|:---: - globalAccessLevel|global/admin - - - - This has been available since 2.24. - operationId: replaceOauthProfileAccessLevelGroup - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the group. - in: path - name: groupName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileAccessLevelGroup' - description: The Group Access Level object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupResponse' - description: "The Group Access Level object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Group Access Level object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions: - get: - description: |- - Get a list of Message VPN Access-Level Exception objects. - - Message VPN access-level exceptions for members of this group. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - groupName|x||| - msgVpnName|x||| - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.24. - operationId: getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the group. - in: path - name: groupName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse' - description: "The list of Message VPN Access-Level Exception objects' attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Message VPN Access-Level Exception objects. - tags: - - all - - oauthProfile - x-accepts: application/json - post: - description: |- - Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - Message VPN access-level exceptions for members of this group. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - groupName|x||x||| - msgVpnName|x|x|||| - oauthProfileName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.24. - operationId: createOauthProfileAccessLevelGroupMsgVpnAccessLevelException - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the group. - in: path - name: groupName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupMsgVpnAccessLevelException' - description: The Message VPN Access-Level Exception object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse' - description: "The Message VPN Access-Level Exception object's attributes\ - \ after being created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Message VPN Access-Level Exception object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName}: - delete: - description: |- - Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - Message VPN access-level exceptions for members of this group. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.24. - operationId: deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the group. - in: path - name: groupName - required: true - schema: - type: string - - description: The name of the message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Message VPN Access-Level Exception object. - tags: - - all - - oauthProfile - x-accepts: application/json - get: - description: |- - Get a Message VPN Access-Level Exception object. - - Message VPN access-level exceptions for members of this group. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - groupName|x||| - msgVpnName|x||| - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.24. - operationId: getOauthProfileAccessLevelGroupMsgVpnAccessLevelException - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the group. - in: path - name: groupName - required: true - schema: - type: string - - description: The name of the message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse' - description: "The Message VPN Access-Level Exception object's attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Message VPN Access-Level Exception object. - tags: - - all - - oauthProfile - x-accepts: application/json - patch: - description: |- - Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. - - Message VPN access-level exceptions for members of this group. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - groupName|x|x|||| - msgVpnName|x|x|||| - oauthProfileName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.24. - operationId: updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the group. - in: path - name: groupName - required: true - schema: - type: string - - description: The name of the message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupMsgVpnAccessLevelException' - description: The Message VPN Access-Level Exception object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse' - description: "The Message VPN Access-Level Exception object's attributes\ - \ after being updated, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Message VPN Access-Level Exception object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - Message VPN access-level exceptions for members of this group. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - groupName|x||x|||| - msgVpnName|x||x|||| - oauthProfileName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.24. - operationId: replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the group. - in: path - name: groupName - required: true - schema: - type: string - - description: The name of the message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupMsgVpnAccessLevelException' - description: The Message VPN Access-Level Exception object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse' - description: "The Message VPN Access-Level Exception object's attributes\ - \ after being replaced, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Message VPN Access-Level Exception object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /oauthProfiles/{oauthProfileName}/clientAllowedHosts: - get: - description: |- - Get a list of Allowed Host Value objects. - - A valid hostname for this broker in OAuth redirects. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - allowedHost|x||| - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.24. - operationId: getOauthProfileClientAllowedHosts - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileClientAllowedHostsResponse' - description: "The list of Allowed Host Value objects' attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Allowed Host Value objects. - tags: - - all - - oauthProfile - x-accepts: application/json - post: - description: |- - Create an Allowed Host Value object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - A valid hostname for this broker in OAuth redirects. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - allowedHost|x|x|||| - oauthProfileName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.24. - operationId: createOauthProfileClientAllowedHost - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileClientAllowedHost' - description: The Allowed Host Value object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileClientAllowedHostResponse' - description: "The Allowed Host Value object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create an Allowed Host Value object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost}: - delete: - description: |- - Delete an Allowed Host Value object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - A valid hostname for this broker in OAuth redirects. - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.24. - operationId: deleteOauthProfileClientAllowedHost - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: An allowed value for the Host header. - in: path - name: allowedHost - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete an Allowed Host Value object. - tags: - - all - - oauthProfile - x-accepts: application/json - get: - description: |- - Get an Allowed Host Value object. - - A valid hostname for this broker in OAuth redirects. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - allowedHost|x||| - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.24. - operationId: getOauthProfileClientAllowedHost - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: An allowed value for the Host header. - in: path - name: allowedHost - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileClientAllowedHostResponse' - description: "The Allowed Host Value object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get an Allowed Host Value object. - tags: - - all - - oauthProfile - x-accepts: application/json - /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters: - get: - description: |- - Get a list of Authorization Parameter objects. - - Additional parameters to be passed to the OAuth authorization endpoint. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authorizationParameterName|x||| - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.24. - operationId: getOauthProfileClientAuthorizationParameters - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileClientAuthorizationParametersResponse' - description: "The list of Authorization Parameter objects' attributes, and\ - \ the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Authorization Parameter objects. - tags: - - all - - oauthProfile - x-accepts: application/json - post: - description: |- - Create an Authorization Parameter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - Additional parameters to be passed to the OAuth authorization endpoint. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - authorizationParameterName|x|x|||| - oauthProfileName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.24. - operationId: createOauthProfileClientAuthorizationParameter - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileClientAuthorizationParameter' - description: The Authorization Parameter object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileClientAuthorizationParameterResponse' - description: "The Authorization Parameter object's attributes after being\ - \ created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create an Authorization Parameter object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName}: - delete: - description: |- - Delete an Authorization Parameter object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - Additional parameters to be passed to the OAuth authorization endpoint. - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.24. - operationId: deleteOauthProfileClientAuthorizationParameter - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the authorization parameter. - in: path - name: authorizationParameterName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete an Authorization Parameter object. - tags: - - all - - oauthProfile - x-accepts: application/json - get: - description: |- - Get an Authorization Parameter object. - - Additional parameters to be passed to the OAuth authorization endpoint. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authorizationParameterName|x||| - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.24. - operationId: getOauthProfileClientAuthorizationParameter - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the authorization parameter. - in: path - name: authorizationParameterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileClientAuthorizationParameterResponse' - description: "The Authorization Parameter object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get an Authorization Parameter object. - tags: - - all - - oauthProfile - x-accepts: application/json - patch: - description: |- - Update an Authorization Parameter object. Any attribute missing from the request will be left unchanged. - - Additional parameters to be passed to the OAuth authorization endpoint. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - authorizationParameterName|x|x|||| - oauthProfileName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.24. - operationId: updateOauthProfileClientAuthorizationParameter - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the authorization parameter. - in: path - name: authorizationParameterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileClientAuthorizationParameter' - description: The Authorization Parameter object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileClientAuthorizationParameterResponse' - description: "The Authorization Parameter object's attributes after being\ - \ updated, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update an Authorization Parameter object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace an Authorization Parameter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - Additional parameters to be passed to the OAuth authorization endpoint. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - authorizationParameterName|x||x|||| - oauthProfileName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.24. - operationId: replaceOauthProfileClientAuthorizationParameter - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the authorization parameter. - in: path - name: authorizationParameterName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileClientAuthorizationParameter' - description: The Authorization Parameter object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileClientAuthorizationParameterResponse' - description: "The Authorization Parameter object's attributes after being\ - \ replaced, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace an Authorization Parameter object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /oauthProfiles/{oauthProfileName}/clientRequiredClaims: - get: - description: |- - Get a list of Required Claim objects. - - Additional claims to be verified in the ID token. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientRequiredClaimName|x||| - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.24. - operationId: getOauthProfileClientRequiredClaims - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileClientRequiredClaimsResponse' - description: "The list of Required Claim objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Required Claim objects. - tags: - - all - - oauthProfile - x-accepts: application/json - post: - description: |- - Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - Additional claims to be verified in the ID token. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - clientRequiredClaimName|x|x|||| - clientRequiredClaimValue||x|||| - oauthProfileName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.24. - operationId: createOauthProfileClientRequiredClaim - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileClientRequiredClaim' - description: The Required Claim object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileClientRequiredClaimResponse' - description: "The Required Claim object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Required Claim object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}: - delete: - description: |- - Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - Additional claims to be verified in the ID token. - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.24. - operationId: deleteOauthProfileClientRequiredClaim - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the ID token claim to verify. - in: path - name: clientRequiredClaimName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Required Claim object. - tags: - - all - - oauthProfile - x-accepts: application/json - get: - description: |- - Get a Required Claim object. - - Additional claims to be verified in the ID token. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientRequiredClaimName|x||| - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.24. - operationId: getOauthProfileClientRequiredClaim - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the ID token claim to verify. - in: path - name: clientRequiredClaimName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileClientRequiredClaimResponse' - description: "The Required Claim object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Required Claim object. - tags: - - all - - oauthProfile - x-accepts: application/json - /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions: - get: - description: |- - Get a list of Message VPN Access-Level Exception objects. - - Default message VPN access-level exceptions. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.24. - operationId: getOauthProfileDefaultMsgVpnAccessLevelExceptions - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse' - description: "The list of Message VPN Access-Level Exception objects' attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Message VPN Access-Level Exception objects. - tags: - - all - - oauthProfile - x-accepts: application/json - post: - description: |- - Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - Default message VPN access-level exceptions. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - msgVpnName|x|x|||| - oauthProfileName|x||x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.24. - operationId: createOauthProfileDefaultMsgVpnAccessLevelException - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileDefaultMsgVpnAccessLevelException' - description: The Message VPN Access-Level Exception object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse' - description: "The Message VPN Access-Level Exception object's attributes\ - \ after being created, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Message VPN Access-Level Exception object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName}: - delete: - description: |- - Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - Default message VPN access-level exceptions. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.24. - operationId: deleteOauthProfileDefaultMsgVpnAccessLevelException - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Message VPN Access-Level Exception object. - tags: - - all - - oauthProfile - x-accepts: application/json - get: - description: |- - Get a Message VPN Access-Level Exception object. - - Default message VPN access-level exceptions. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgVpnName|x||| - oauthProfileName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.24. - operationId: getOauthProfileDefaultMsgVpnAccessLevelException - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse' - description: "The Message VPN Access-Level Exception object's attributes,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Message VPN Access-Level Exception object. - tags: - - all - - oauthProfile - x-accepts: application/json - patch: - description: |- - Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. - - Default message VPN access-level exceptions. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - msgVpnName|x|x|||| - oauthProfileName|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.24. - operationId: updateOauthProfileDefaultMsgVpnAccessLevelException - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileDefaultMsgVpnAccessLevelException' - description: The Message VPN Access-Level Exception object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse' - description: "The Message VPN Access-Level Exception object's attributes\ - \ after being updated, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Message VPN Access-Level Exception object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - Default message VPN access-level exceptions. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - msgVpnName|x||x|||| - oauthProfileName|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.24. - operationId: replaceOauthProfileDefaultMsgVpnAccessLevelException - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the message VPN. - in: path - name: msgVpnName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileDefaultMsgVpnAccessLevelException' - description: The Message VPN Access-Level Exception object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse' - description: "The Message VPN Access-Level Exception object's attributes\ - \ after being replaced, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Message VPN Access-Level Exception object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims: - get: - description: |- - Get a list of Required Claim objects. - - Additional claims to be verified in the access token. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - oauthProfileName|x||| - resourceServerRequiredClaimName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.24. - operationId: getOauthProfileResourceServerRequiredClaims - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileResourceServerRequiredClaimsResponse' - description: "The list of Required Claim objects' attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Required Claim objects. - tags: - - all - - oauthProfile - x-accepts: application/json - post: - description: |- - Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - Additional claims to be verified in the access token. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - oauthProfileName|x||x||| - resourceServerRequiredClaimName|x|x|||| - resourceServerRequiredClaimValue||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.24. - operationId: createOauthProfileResourceServerRequiredClaim - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileResourceServerRequiredClaim' - description: The Required Claim object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileResourceServerRequiredClaimResponse' - description: "The Required Claim object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Required Claim object. - tags: - - all - - oauthProfile - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}: - delete: - description: |- - Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - Additional claims to be verified in the access token. - - A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation. - - This has been available since 2.24. - operationId: deleteOauthProfileResourceServerRequiredClaim - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the access token claim to verify. - in: path - name: resourceServerRequiredClaimName - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Required Claim object. - tags: - - all - - oauthProfile - x-accepts: application/json - get: - description: |- - Get a Required Claim object. - - Additional claims to be verified in the access token. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - oauthProfileName|x||| - resourceServerRequiredClaimName|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.24. - operationId: getOauthProfileResourceServerRequiredClaim - parameters: - - description: The name of the OAuth profile. - in: path - name: oauthProfileName - required: true - schema: - type: string - - description: The name of the access token claim to verify. - in: path - name: resourceServerRequiredClaimName - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/OauthProfileResourceServerRequiredClaimResponse' - description: "The Required Claim object's attributes, and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Required Claim object. - tags: - - all - - oauthProfile - x-accepts: application/json - /systemInformation: - get: - deprecated: true - description: |- - Get a System Information object. - - The System Information object provides metadata about the SEMP API. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - platform|||x| - sempVersion|||x| - - - - A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation. - - This has been deprecated since 2.2. /systemInformation was replaced by /about/api. - operationId: getSystemInformation - parameters: - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SystemInformationResponse' - description: "The System Information object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a System Information object. - tags: - - all - - systemInformation - x-accepts: application/json - /virtualHostnames: - get: - description: |- - Get a list of Virtual Hostname objects. - - A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. - - Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. - - This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - virtualHostname|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.17. - operationId: getVirtualHostnames - parameters: - - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: Include in the response only objects where certain conditions - are true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/VirtualHostnamesResponse' - description: "The list of Virtual Hostname objects' attributes, and the\ - \ request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a list of Virtual Hostname objects. - tags: - - all - - virtualHostname - x-accepts: application/json - post: - description: |- - Create a Virtual Hostname object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. - - A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. - - Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. - - This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. - - - Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---:|:---:|:---: - virtualHostname|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.17. - operationId: createVirtualHostname - parameters: - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VirtualHostname' - description: The Virtual Hostname object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/VirtualHostnameResponse' - description: "The Virtual Hostname object's attributes after being created,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Create a Virtual Hostname object. - tags: - - all - - virtualHostname - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - /virtualHostnames/{virtualHostname}: - delete: - description: |- - Delete a Virtual Hostname object. The deletion of instances of this object are synchronized to HA mates via config-sync. - - A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. - - Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. - - This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.17. - operationId: deleteVirtualHostname - parameters: - - description: The virtual hostname. - in: path - name: virtualHostname - required: true - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The request metadata. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Delete a Virtual Hostname object. - tags: - - all - - virtualHostname - x-accepts: application/json - get: - description: |- - Get a Virtual Hostname object. - - A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. - - Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. - - This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. - - - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - virtualHostname|x||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. - - This has been available since 2.17. - operationId: getVirtualHostname - parameters: - - description: The virtual hostname. - in: path - name: virtualHostname - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/VirtualHostnameResponse' - description: "The Virtual Hostname object's attributes, and the request\ - \ metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Get a Virtual Hostname object. - tags: - - all - - virtualHostname - x-accepts: application/json - patch: - description: |- - Update a Virtual Hostname object. Any attribute missing from the request will be left unchanged. - - A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. - - Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. - - This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. - - - Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:--- - virtualHostname|x|x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.17. - operationId: updateVirtualHostname - parameters: - - description: The virtual hostname. - in: path - name: virtualHostname - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VirtualHostname' - description: The Virtual Hostname object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/VirtualHostnameResponse' - description: "The Virtual Hostname object's attributes after being updated,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Update a Virtual Hostname object. - tags: - - all - - virtualHostname - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json - put: - description: |- - Replace a Virtual Hostname object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. - - A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. - - Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. - - This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. - - - Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque - :---|:---|:---|:---|:---|:---|:---|:--- - virtualHostname|x||x|||| - - - - A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation. - - This has been available since 2.17. - operationId: replaceVirtualHostname - parameters: - - description: The virtual hostname. - in: path - name: virtualHostname - required: true - schema: - type: string - - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VirtualHostname' - description: The Virtual Hostname object's attributes. - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/VirtualHostnameResponse' - description: "The Virtual Hostname object's attributes after being replaced,\ - \ and the request metadata." - default: - content: - application/json: - schema: - $ref: '#/components/schemas/SempMetaOnlyResponse' - description: The error response. - security: - - basicAuth: [] - summary: Replace a Virtual Hostname object. - tags: - - all - - virtualHostname - x-codegen-request-body-name: body - x-content-type: application/json - x-accepts: application/json -components: - parameters: - countQuery: - description: Limit the count of objects in the response. See the documentation - for the `count` parameter. - in: query - name: count - schema: - default: 10 - minimum: 1 - type: integer - cursorQuery: - description: "The cursor, or position, for the next page of objects. See the\ - \ documentation for the `cursor` parameter." - in: query - name: cursor - schema: - type: string - opaquePasswordQuery: - description: "Accept opaque attributes in the request or return opaque attributes\ - \ in the response, encrypted with the specified password. See the documentation\ - \ for the `opaquePassword` parameter." - in: query - name: opaquePassword - schema: - type: string - selectQuery: - description: "Include in the response only selected attributes of the object,\ - \ or exclude from the response selected attributes of the object. See the\ - \ documentation for the `select` parameter." - explode: false - in: query - name: select - schema: - items: - type: string - type: array - style: form - whereQuery: - description: Include in the response only objects where certain conditions are - true. See the the documentation for the `where` parameter. - explode: false - in: query - name: where - schema: - items: - type: string - type: array - style: form - schemas: - About: - type: object - AboutApi: - example: - sempVersion: sempVersion - platform: platform - properties: - platform: - description: The platform running the SEMP API. - type: string - sempVersion: - description: The version of the SEMP API. - type: string - type: object - AboutApiLinks: - example: - uri: uri - properties: - uri: - description: The URI of this API Description object. - type: string - type: object - AboutApiResponse: - example: - data: - sempVersion: sempVersion - platform: platform - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/AboutApi' - links: - $ref: '#/components/schemas/AboutApiLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - AboutLinks: - example: - apiUri: apiUri - userUri: userUri - uri: uri - properties: - apiUri: - description: The URI of this About's API Description object. Available since - 2.2. - type: string - uri: - description: The URI of this About object. - type: string - userUri: - description: The URI of this About's User object. Available since 2.2. - type: string - type: object - AboutResponse: - example: - data: "{}" - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - apiUri: apiUri - userUri: userUri - uri: uri - properties: - data: - type: object - links: - $ref: '#/components/schemas/AboutLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - AboutUser: - example: - sessionCurrentTime: 6 - sessionIdleExpiryTime: 5 - sessionHardExpiryTime: 1 - sessionCreateTime: 0 - sessionId: sessionId - globalAccessLevel: admin - sessionActive: true - username: username - properties: - globalAccessLevel: - description: | - The global access level of the User. The allowed values and their meaning are: - - 
-            "admin" - Full administrative access.
-            "none" - No access.
-            "read-only" - Read only access.
-            "read-write" - Read and write access.
-
- enum: - - admin - - none - - read-only - - read-write - type: string - sessionActive: - description: Indicates whether a session is active for this request. Available - since 2.24. - type: boolean - sessionCreateTime: - description: The timestamp of when the session was created. This attribute - may not be returned in a GET. This value represents the number of seconds - since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21. - format: int32 - type: integer - sessionCurrentTime: - description: The current server timestamp. This is provided as a reference - point for the other timestamps provided. This attribute may not be returned - in a GET. This value represents the number of seconds since 1970-01-01 - 00:00:00 UTC (Unix time). Available since 2.21. - format: int32 - type: integer - sessionHardExpiryTime: - description: "The hard expiry time for the session. After this time the\ - \ session will be invalid, regardless of activity. This attribute may\ - \ not be returned in a GET. This value represents the number of seconds\ - \ since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21." - format: int32 - type: integer - sessionId: - description: An identifier for the session to differentiate this session - from other sessions for the same user. This value is not guaranteed to - be unique between active sessions for different users. This attribute - may not be returned in a GET. Available since 2.21. - type: string - sessionIdleExpiryTime: - description: The session idle expiry time. After this time the session will - be invalid if there has been no activity. This attribute may not be returned - in a GET. This value represents the number of seconds since 1970-01-01 - 00:00:00 UTC (Unix time). Available since 2.21. - format: int32 - type: integer - username: - description: The username of the User. Available since 2.21. - type: string - type: object - AboutUserLinks: - example: - msgVpnsUri: msgVpnsUri - uri: uri - properties: - msgVpnsUri: - description: The URI of this User's collection of User Message VPN objects. - type: string - uri: - description: The URI of this User object. - type: string - type: object - AboutUserMsgVpn: - example: - accessLevel: none - msgVpnName: msgVpnName - properties: - accessLevel: - description: | - The Message VPN access level of the User. The allowed values and their meaning are: - - 
-            "none" - No access.
-            "read-only" - Read only access.
-            "read-write" - Read and write access.
-
- enum: - - none - - read-only - - read-write - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - type: object - AboutUserMsgVpnLinks: - example: - uri: uri - properties: - uri: - description: The URI of this User Message VPN object. - type: string - type: object - AboutUserMsgVpnResponse: - example: - data: - accessLevel: none - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/AboutUserMsgVpn' - links: - $ref: '#/components/schemas/AboutUserMsgVpnLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - AboutUserMsgVpnsResponse: - example: - data: - - accessLevel: none - msgVpnName: msgVpnName - - accessLevel: none - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/AboutUserMsgVpn' - type: array - links: - items: - $ref: '#/components/schemas/AboutUserMsgVpnLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - AboutUserResponse: - example: - data: - sessionCurrentTime: 6 - sessionIdleExpiryTime: 5 - sessionHardExpiryTime: 1 - sessionCreateTime: 0 - sessionId: sessionId - globalAccessLevel: admin - sessionActive: true - username: username - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - msgVpnsUri: msgVpnsUri - uri: uri - properties: - data: - $ref: '#/components/schemas/AboutUser' - links: - $ref: '#/components/schemas/AboutUserLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - Broker: - example: - serviceSempPlainTextEnabled: true - guaranteedMsgingEventDeliveredUnackedThreshold: - clearPercent: 1 - setPercent: 6 - guaranteedMsgingEventTransactedSessionResourceCountThreshold: - clearPercent: 1 - setPercent: 6 - serviceSmfEnabled: true - guaranteedMsgingEventMsgSpoolFileCountThreshold: - clearPercent: 1 - setPercent: 6 - tlsCipherSuiteManagementList: tlsCipherSuiteManagementList - serviceMsgBackboneEnabled: true - guaranteedMsgingDefragmentationThresholdEnabled: true - serviceSmfCompressionListenPort: 1 - guaranteedMsgingEventTransactionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceSmfPlainTextListenPort: 2 - serviceWebTransportWebUrlSuffix: serviceWebTransportWebUrlSuffix - serviceSempCorsAllowAnyHostEnabled: true - serviceSmfTlsListenPort: 6 - guaranteedMsgingDefragmentationScheduleEnabled: true - serviceMateLinkListenPort: 6 - serviceSempLegacyTimeoutEnabled: true - configSyncClientProfileTcpInitialCongestionWindow: 6 - serviceWebTransportPlainTextListenPort: 5 - serviceWebTransportTlsListenPort: 6 - webManagerRedirectHttpOverrideTlsPort: 3 - tlsTicketLifetime: 3 - serviceSmfRoutingControlListenPort: 6 - tlsServerCertPassword: tlsServerCertPassword - configSyncAuthenticationClientCertMaxChainDepth: 0 - authClientCertRevocationCheckMode: none - serviceRestIncomingEnabled: true - serviceSempSessionIdleTimeout: 6 - configSyncSynchronizeUsernameEnabled: true - serviceWebTransportEnabled: true - webManagerRedirectHttpEnabled: true - tlsCipherSuiteSecureShellList: tlsCipherSuiteSecureShellList - guaranteedMsgingDefragmentationThresholdFragmentationPercentage: 9 - serviceAmqpEnabled: true - guaranteedMsgingEventDiskUsageThreshold: - clearPercent: 1 - setPercent: 6 - configSyncClientProfileTcpKeepaliveInterval: 5 - serviceSempTlsEnabled: true - oauthProfileDefault: oauthProfileDefault - serviceEventConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceRedundancyFirstListenPort: 8 - guaranteedMsgingDefragmentationScheduleTimeList: guaranteedMsgingDefragmentationScheduleTimeList - guaranteedMsgingEventEgressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - guaranteedMsgingEventMsgCountThreshold: - clearPercent: 1 - setPercent: 6 - serviceHealthCheckListenPort: 9 - serviceRestEventOutgoingConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - guaranteedMsgingEventEndpointCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceHealthCheckEnabled: true - serviceMateLinkEnabled: true - configSyncClientProfileTcpMaxWindow: 2 - serviceSmfEventConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - guaranteedMsgingDefragmentationThresholdMinInterval: 3 - configSyncTlsEnabled: true - serviceRestOutgoingEnabled: true - configSyncClientProfileTcpMss: 7 - guaranteedMsgingMaxCacheUsage: 7 - serviceAmqpTlsListenPort: 9 - serviceSempTlsListenPort: 6 - tlsServerCertContent: tlsServerCertContent - serviceSempSessionMaxLifetime: 3 - tlsCipherSuiteMsgBackboneList: tlsCipherSuiteMsgBackboneList - guaranteedMsgingDefragmentationScheduleDayList: guaranteedMsgingDefragmentationScheduleDayList - guaranteedMsgingTransactionReplicationCompatibilityMode: legacy - guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout: 4 - guaranteedMsgingEventIngressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout: 5 - guaranteedMsgingMaxMsgSpoolUsage: 1 - configSyncEnabled: true - configSyncAuthenticationClientCertValidateDateEnabled: true - guaranteedMsgingDefragmentationThresholdUsagePercentage: 2 - serviceRedundancyEnabled: true - serviceMqttEnabled: true - serviceTlsEventConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - tlsBlockVersion11Enabled: true - tlsCrimeExploitProtectionEnabled: true - configSyncClientProfileTcpKeepaliveCount: 1 - webManagerAllowUnencryptedWizardsEnabled: true - serviceSempPlainTextListenPort: 9 - configSyncClientProfileTcpKeepaliveIdle: 5 - guaranteedMsgingEnabled: true - guaranteedMsgingEventTransactedSessionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - webManagerCustomization: webManagerCustomization - tlsStandardDomainCertificateAuthoritiesEnabled: true - guaranteedMsgingEventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - guaranteedMsgingEventCacheUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - properties: - authClientCertRevocationCheckMode: - description: | - The client certificate revocation checking mode used when a client authenticates with a client certificate. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"none"`. The allowed values and their meaning are: - - 
-            "none" - Do not perform any certificate revocation checking.
-            "ocsp" - Use the Open Certificate Status Protcol (OCSP) for certificate revocation checking.
-            "crl" - Use Certificate Revocation Lists (CRL) for certificate revocation checking.
-            "ocsp-crl" - Use OCSP first, but if OCSP fails to return an unambiguous result, then check via CRL.
-
- enum: - - none - - ocsp - - crl - - ocsp-crl - type: string - configSyncAuthenticationClientCertMaxChainDepth: - description: The maximum depth for a client certificate chain. The depth - of a chain is defined as the number of signing CA certificates that are - present in the chain back to a trusted self-signed root CA certificate. - The default value is `3`. Available since 2.22. - format: int64 - type: integer - configSyncAuthenticationClientCertValidateDateEnabled: - description: Enable or disable validation of the "Not Before" and "Not After" - validity dates in the authentication certificate(s). The default value - is `true`. Available since 2.22. - type: boolean - configSyncClientProfileTcpInitialCongestionWindow: - description: "The TCP initial congestion window size for Config Sync clients,\ - \ in multiples of the TCP Maximum Segment Size (MSS). Changing the value\ - \ from its default of 2 results in non-compliance with RFC 2581. Contact\ - \ support before changing this value. The default value is `2`. Available\ - \ since 2.22." - format: int64 - type: integer - configSyncClientProfileTcpKeepaliveCount: - description: The number of TCP keepalive retransmissions to a client using - the Client Profile before declaring that it is not available. The default - value is `5`. Available since 2.22. - format: int64 - type: integer - configSyncClientProfileTcpKeepaliveIdle: - description: "The amount of time a client connection using the Client Profile\ - \ must remain idle before TCP begins sending keepalive probes, in seconds.\ - \ The default value is `3`. Available since 2.22." - format: int64 - type: integer - configSyncClientProfileTcpKeepaliveInterval: - description: "The amount of time between TCP keepalive retransmissions to\ - \ a client using the Client Profile when no acknowledgement is received,\ - \ in seconds. The default value is `1`. Available since 2.22." - format: int64 - type: integer - configSyncClientProfileTcpMaxWindow: - description: "The TCP maximum window size for clients using the Client Profile,\ - \ in kilobytes. Changes are applied to all existing connections. The default\ - \ value is `256`. Available since 2.22." - format: int64 - type: integer - configSyncClientProfileTcpMss: - description: "The TCP maximum segment size for clients using the Client\ - \ Profile, in bytes. Changes are applied to all existing connections.\ - \ The default value is `1460`. Available since 2.22." - format: int64 - type: integer - configSyncEnabled: - description: Enable or disable configuration synchronization for High Availability - or Disaster Recovery. The default value is `false`. Available since 2.22. - type: boolean - configSyncSynchronizeUsernameEnabled: - description: "Enable or disable the synchronizing of usernames within High\ - \ Availability groups. The transition from not synchronizing to synchronizing\ - \ will cause the High Availability mate to fall out of sync. Recommendation:\ - \ leave this as enabled. Changes to this attribute are synchronized to\ - \ HA mates via config-sync. The default value is `true`. Available since\ - \ 2.22." - type: boolean - configSyncTlsEnabled: - description: Enable or disable the use of TLS encryption of the configuration - synchronization communications between brokers in High Availability groups - and/or Disaster Recovery sites. The default value is `false`. Available - since 2.22. - type: boolean - guaranteedMsgingDefragmentationScheduleDayList: - description: "The days of the week to schedule defragmentation runs, specified\ - \ as \"daily\" or as a comma-separated list of days. Days must be specified\ - \ as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri, or \"Sat\", with\ - \ no spaces, and in sorted order from Sunday to Saturday. Please note\ - \ \"Sun,Mon,Tue,Wed,Thu,Fri,Sat\" is not allowed, use \"daily\" instead.\ - \ Changes to this attribute are synchronized to HA mates via config-sync.\ - \ The default value is `\"daily\"`. Available since 2.25." - type: string - guaranteedMsgingDefragmentationScheduleEnabled: - description: Enable or disable schedule-based defragmentation of Guaranteed - Messaging spool files. Changes to this attribute are synchronized to HA - mates via config-sync. The default value is `false`. Available since 2.25. - type: boolean - guaranteedMsgingDefragmentationScheduleTimeList: - description: "The times of the day to schedule defragmentation runs, specified\ - \ as \"hourly\" or as a comma-separated list of 24-hour times in the form\ - \ hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be\ - \ in sorted order from 0:00 to 23:59. Changes to this attribute are synchronized\ - \ to HA mates via config-sync. The default value is `\"0:00\"`. Available\ - \ since 2.25." - type: string - guaranteedMsgingDefragmentationThresholdEnabled: - description: Enable or disable threshold-based defragmentation of Guaranteed - Messaging spool files. Changes to this attribute are synchronized to HA - mates via config-sync. The default value is `false`. Available since 2.25. - type: boolean - guaranteedMsgingDefragmentationThresholdFragmentationPercentage: - description: Percentage of spool fragmentation needed to trigger defragmentation - run. The minimum value allowed is 30%. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `50`. Available since - 2.25. - format: int64 - type: integer - guaranteedMsgingDefragmentationThresholdMinInterval: - description: Minimum interval of time (in minutes) between defragmentation - runs triggered by thresholds. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `15`. Available since - 2.25. - format: int64 - type: integer - guaranteedMsgingDefragmentationThresholdUsagePercentage: - description: Percentage of spool usage needed to trigger defragmentation - run. The minimum value allowed is 30%. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `50`. Available since - 2.25. - format: int64 - type: integer - guaranteedMsgingEnabled: - description: Enable or disable Guaranteed Messaging. The default value is - `false`. Available since 2.18. - type: boolean - guaranteedMsgingEventCacheUsageThreshold: - $ref: '#/components/schemas/EventThreshold' - guaranteedMsgingEventDeliveredUnackedThreshold: - $ref: '#/components/schemas/EventThresholdByPercent' - guaranteedMsgingEventDiskUsageThreshold: - $ref: '#/components/schemas/EventThresholdByPercent' - guaranteedMsgingEventEgressFlowCountThreshold: - $ref: '#/components/schemas/EventThreshold' - guaranteedMsgingEventEndpointCountThreshold: - $ref: '#/components/schemas/EventThreshold' - guaranteedMsgingEventIngressFlowCountThreshold: - $ref: '#/components/schemas/EventThreshold' - guaranteedMsgingEventMsgCountThreshold: - $ref: '#/components/schemas/EventThresholdByPercent' - guaranteedMsgingEventMsgSpoolFileCountThreshold: - $ref: '#/components/schemas/EventThresholdByPercent' - guaranteedMsgingEventMsgSpoolUsageThreshold: - $ref: '#/components/schemas/EventThreshold' - guaranteedMsgingEventTransactedSessionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - guaranteedMsgingEventTransactedSessionResourceCountThreshold: - $ref: '#/components/schemas/EventThresholdByPercent' - guaranteedMsgingEventTransactionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - guaranteedMsgingMaxCacheUsage: - description: Guaranteed messaging cache usage limit. Expressed as a maximum - percentage of the NAB's egress queueing. resources that the guaranteed - message cache is allowed to use. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `10`. Available since - 2.18. - format: int32 - type: integer - guaranteedMsgingMaxMsgSpoolUsage: - description: "The maximum total message spool usage allowed across all VPNs\ - \ on this broker, in megabytes. Recommendation: the maximum value should\ - \ be less than 90% of the disk space allocated for the guaranteed message\ - \ spool. Changes to this attribute are synchronized to HA mates via config-sync.\ - \ The default value is `1500`. Available since 2.18." - format: int64 - type: integer - guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout: - description: "The maximum time, in milliseconds, that can be tolerated for\ - \ remote acknowledgement of synchronization messages before which the\ - \ remote system will be considered out of sync. The default value is `10000`.\ - \ Available since 2.18." - format: int64 - type: integer - guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout: - description: "The maximum time, in milliseconds, that can be tolerated for\ - \ remote disk writes before which the remote system will be considered\ - \ out of sync. The default value is `10000`. Available since 2.18." - format: int64 - type: integer - guaranteedMsgingTransactionReplicationCompatibilityMode: - description: |- - The replication compatibility mode for the router. The default value is `"legacy"`. The allowed values and their meaning are:"legacy" - All transactions originated by clients are replicated to the standby site without using transactions."transacted" - All transactions originated by clients are replicated to the standby site using transactions. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"legacy"`. The allowed values and their meaning are: - - 
-            "legacy" - All transactions originated by clients are replicated to the standby site without using transactions.
-            "transacted" - All transactions originated by clients are replicated to the standby site using transactions.
-
- Available since 2.18. - enum: - - legacy - - transacted - type: string - oauthProfileDefault: - description: The default OAuth profile for OAuth authenticated SEMP requests. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `""`. Available since 2.24. - type: string - serviceAmqpEnabled: - description: "Enable or disable the AMQP service. When disabled new AMQP\ - \ Clients may not connect through the global or per-VPN AMQP listen-ports,\ - \ and all currently connected AMQP Clients are immediately disconnected.\ - \ Changes to this attribute are synchronized to HA mates via config-sync.\ - \ The default value is `false`. Available since 2.17." - type: boolean - serviceAmqpTlsListenPort: - description: TCP port number that AMQP clients can use to connect to the - broker using raw TCP over TLS. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `0`. Available since - 2.17. - format: int64 - type: integer - serviceEventConnectionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - serviceHealthCheckEnabled: - description: Enable or disable the health-check service. Changes to this - attribute are synchronized to HA mates via config-sync. The default value - is `false`. Available since 2.17. - type: boolean - serviceHealthCheckListenPort: - description: The port number for the health-check service. The port must - be unique across the message backbone. The health-check service must be - disabled to change the port. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `5550`. Available since - 2.17. - format: int64 - type: integer - serviceMateLinkEnabled: - description: Enable or disable the mate-link service. The default value - is `true`. Available since 2.17. - type: boolean - serviceMateLinkListenPort: - description: The port number for the mate-link service. The port must be - unique across the message backbone. The mate-link service must be disabled - to change the port. The default value is `8741`. Available since 2.17. - format: int64 - type: integer - serviceMqttEnabled: - description: "Enable or disable the MQTT service. When disabled new MQTT\ - \ Clients may not connect through the per-VPN MQTT listen-ports, and all\ - \ currently connected MQTT Clients are immediately disconnected. Changes\ - \ to this attribute are synchronized to HA mates via config-sync. The\ - \ default value is `false`. Available since 2.17." - type: boolean - serviceMsgBackboneEnabled: - description: "Enable or disable the msg-backbone service. When disabled\ - \ new Clients may not connect through global or per-VPN listen-ports,\ - \ and all currently connected Clients are immediately disconnected. The\ - \ default value is `true`. Available since 2.17." - type: boolean - serviceRedundancyEnabled: - description: Enable or disable the redundancy service. The default value - is `true`. Available since 2.17. - type: boolean - serviceRedundancyFirstListenPort: - description: The first listen-port used for the redundancy service. Redundancy - uses this port and the subsequent 2 ports. These port must be unique across - the message backbone. The redundancy service must be disabled to change - this port. The default value is `8300`. Available since 2.17. - format: int64 - type: integer - serviceRestEventOutgoingConnectionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - serviceRestIncomingEnabled: - description: Enable or disable the REST service incoming connections on - the router. Changes to this attribute are synchronized to HA mates via - config-sync. The default value is `false`. Available since 2.17. - type: boolean - serviceRestOutgoingEnabled: - description: Enable or disable the REST service outgoing connections on - the router. Changes to this attribute are synchronized to HA mates via - config-sync. The default value is `false`. Available since 2.17. - type: boolean - serviceSempCorsAllowAnyHostEnabled: - description: Enable or disable cross origin resource requests for the SEMP - service. Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `true`. Available since 2.24. - type: boolean - serviceSempLegacyTimeoutEnabled: - description: "Enable or disable extended SEMP timeouts for paged GETs. When\ - \ a request times out, it returns the current page of content, even if\ - \ the page is not full. When enabled, the timeout is 60 seconds. When\ - \ disabled, the timeout is 5 seconds. The recommended setting is disabled\ - \ (no legacy-timeout). This parameter is intended as a temporary workaround\ - \ to be used until SEMP clients can handle short pages. This setting\ - \ will be removed in a future release. Changes to this attribute are synchronized\ - \ to HA mates via config-sync. The default value is `false`. Available\ - \ since 2.18." - type: boolean - serviceSempPlainTextEnabled: - description: Enable or disable plain-text SEMP service. Changes to this - attribute are synchronized to HA mates via config-sync. The default value - is `true`. Available since 2.17. - type: boolean - serviceSempPlainTextListenPort: - description: The TCP port for plain-text SEMP client connections. Changes - to this attribute are synchronized to HA mates via config-sync. The default - value is `80`. Available since 2.17. - format: int64 - type: integer - serviceSempSessionIdleTimeout: - description: "The session idle timeout, in minutes. Sessions will be invalidated\ - \ if there is no activity in this period of time. Changes to this attribute\ - \ are synchronized to HA mates via config-sync. The default value is `15`.\ - \ Available since 2.21." - format: int32 - type: integer - serviceSempSessionMaxLifetime: - description: "The maximum lifetime of a session, in minutes. Sessions will\ - \ be invalidated after this period of time, regardless of activity. Changes\ - \ to this attribute are synchronized to HA mates via config-sync. The\ - \ default value is `43200`. Available since 2.21." - format: int32 - type: integer - serviceSempTlsEnabled: - description: Enable or disable TLS SEMP service. Changes to this attribute - are synchronized to HA mates via config-sync. The default value is `true`. - Available since 2.17. - type: boolean - serviceSempTlsListenPort: - description: The TCP port for TLS SEMP client connections. Changes to this - attribute are synchronized to HA mates via config-sync. The default value - is `1943`. Available since 2.17. - format: int64 - type: integer - serviceSmfCompressionListenPort: - description: TCP port number that SMF clients can use to connect to the - broker using raw compression TCP. The default value is `55003`. Available - since 2.17. - format: int64 - type: integer - serviceSmfEnabled: - description: "Enable or disable the SMF service. When disabled new SMF Clients\ - \ may not connect through the global listen-ports, and all currently connected\ - \ SMF Clients are immediately disconnected. The default value is `true`.\ - \ Available since 2.17." - type: boolean - serviceSmfEventConnectionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - serviceSmfPlainTextListenPort: - description: TCP port number that SMF clients can use to connect to the - broker using raw TCP. The default value is `55555`. Available since 2.17. - format: int64 - type: integer - serviceSmfRoutingControlListenPort: - description: TCP port number that SMF clients can use to connect to the - broker using raw routing control TCP. The default value is `55556`. Available - since 2.17. - format: int64 - type: integer - serviceSmfTlsListenPort: - description: TCP port number that SMF clients can use to connect to the - broker using raw TCP over TLS. The default value is `55443`. Available - since 2.17. - format: int64 - type: integer - serviceTlsEventConnectionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - serviceWebTransportEnabled: - description: "Enable or disable the web-transport service. When disabled\ - \ new web-transport Clients may not connect through the global listen-ports,\ - \ and all currently connected web-transport Clients are immediately disconnected.\ - \ Changes to this attribute are synchronized to HA mates via config-sync.\ - \ The default value is `false`. Available since 2.17." - type: boolean - serviceWebTransportPlainTextListenPort: - description: The TCP port for plain-text WEB client connections. Changes - to this attribute are synchronized to HA mates via config-sync. The default - value is `8008`. Available since 2.17. - format: int64 - type: integer - serviceWebTransportTlsListenPort: - description: The TCP port for TLS WEB client connections. Changes to this - attribute are synchronized to HA mates via config-sync. The default value - is `1443`. Available since 2.17. - format: int64 - type: integer - serviceWebTransportWebUrlSuffix: - description: Used to specify the Web URL suffix that will be used by Web - clients when communicating with the broker. The default value is `""`. - Available since 2.17. - type: string - tlsBlockVersion11Enabled: - description: "Enable or disable the blocking of TLS version 1.1 connections.\ - \ When blocked, all existing incoming and outgoing TLS 1.1 connections\ - \ with Clients, SEMP users, and LDAP servers remain connected while new\ - \ connections are blocked. Note that support for TLS 1.1 will eventually\ - \ be discontinued, at which time TLS 1.1 connections will be blocked regardless\ - \ of this setting. Changes to this attribute are synchronized to HA mates\ - \ via config-sync. The default value is `false`." - type: boolean - tlsCipherSuiteManagementList: - description: "The colon-separated list of cipher suites used for TLS management\ - \ connections (e.g. SEMP, LDAP). The value \"default\" implies all supported\ - \ suites ordered from most secure to least secure. Changes to this attribute\ - \ are synchronized to HA mates via config-sync. The default value is `\"\ - default\"`." - type: string - tlsCipherSuiteMsgBackboneList: - description: The colon-separated list of cipher suites used for TLS data - connections (e.g. client pub/sub). The value "default" implies all supported - suites ordered from most secure to least secure. Changes to this attribute - are synchronized to HA mates via config-sync. The default value is `"default"`. - type: string - tlsCipherSuiteSecureShellList: - description: "The colon-separated list of cipher suites used for TLS secure\ - \ shell connections (e.g. SSH, SFTP, SCP). The value \"default\" implies\ - \ all supported suites ordered from most secure to least secure. Changes\ - \ to this attribute are synchronized to HA mates via config-sync. The\ - \ default value is `\"default\"`." - type: string - tlsCrimeExploitProtectionEnabled: - description: "Enable or disable protection against the CRIME exploit. When\ - \ enabled, TLS+compressed messaging performance is degraded. This protection\ - \ should only be disabled if sufficient ACL and authentication features\ - \ are being employed such that a potential attacker does not have sufficient\ - \ access to trigger the exploit. Changes to this attribute are synchronized\ - \ to HA mates via config-sync. The default value is `true`." - type: boolean - tlsServerCertContent: - description: "The PEM formatted content for the server certificate used\ - \ for TLS connections. It must consist of a private key and between one\ - \ and three certificates comprising the certificate trust chain. This\ - \ attribute is absent from a GET and not updated when absent in a PUT,\ - \ subject to the exceptions in note 4. Changing this attribute requires\ - \ an HTTPS connection. The default value is `\"\"`." - type: string - x-requires-https: true - tlsServerCertPassword: - description: "The password for the server certificate used for TLS connections.\ - \ This attribute is absent from a GET and not updated when absent in a\ - \ PUT, subject to the exceptions in note 4. Changing this attribute requires\ - \ an HTTPS connection. The default value is `\"\"`." - type: string - x-requires-https: true - tlsStandardDomainCertificateAuthoritiesEnabled: - description: Enable or disable the standard domain certificate authority - list. The default value is `true`. Available since 2.19. - type: boolean - tlsTicketLifetime: - description: "The TLS ticket lifetime in seconds. When a client connects\ - \ with TLS, a session with a session ticket is created using the TLS ticket\ - \ lifetime which determines how long the client has to resume the session.\ - \ Changes to this attribute are synchronized to HA mates via config-sync.\ - \ The default value is `86400`." - format: int32 - type: integer - webManagerAllowUnencryptedWizardsEnabled: - description: "Enable or disable the use of unencrypted wizards in the Web-based\ - \ Manager UI. This setting should be left at its default on all production\ - \ systems or other systems that need to be secure. Enabling this option\ - \ will permit the broker to forward plain-text data to other brokers,\ - \ making important information or credentials available for snooping.\ - \ Changes to this attribute are synchronized to HA mates via config-sync.\ - \ The default value is `false`. Available since 2.28." - type: boolean - webManagerCustomization: - description: Reserved for internal use by Solace. Changes to this attribute - are synchronized to HA mates via config-sync. The default value is `""`. - Available since 2.25. - type: string - webManagerRedirectHttpEnabled: - description: Enable or disable redirection of HTTP requests for the broker - manager to HTTPS. Changes to this attribute are synchronized to HA mates - via config-sync. The default value is `true`. Available since 2.24. - type: boolean - webManagerRedirectHttpOverrideTlsPort: - description: The HTTPS port that HTTP requests will be redirected towards - in a HTTP 301 redirect response. Zero is a special value that means use - the value specified for the SEMP TLS port value. Changes to this attribute - are synchronized to HA mates via config-sync. The default value is `0`. - Available since 2.24. - format: int32 - type: integer - type: object - BrokerLinks: - example: - virtualHostnamesUri: virtualHostnamesUri - oauthProfilesUri: oauthProfilesUri - certAuthoritiesUri: certAuthoritiesUri - systemInformationUri: systemInformationUri - aboutUri: aboutUri - msgVpnsUri: msgVpnsUri - domainCertAuthoritiesUri: domainCertAuthoritiesUri - clientCertAuthoritiesUri: clientCertAuthoritiesUri - uri: uri - dmrClustersUri: dmrClustersUri - properties: - aboutUri: - description: The URI of this Broker's About object. - type: string - certAuthoritiesUri: - description: The URI of this Broker's collection of Certificate Authority - objects. Deprecated since 2.19. Replaced by clientCertAuthorities and - domainCertAuthorities. - type: string - clientCertAuthoritiesUri: - description: The URI of this Broker's collection of Client Certificate Authority - objects. Available since 2.19. - type: string - dmrClustersUri: - description: The URI of this Broker's collection of Cluster objects. Available - since 2.11. - type: string - domainCertAuthoritiesUri: - description: The URI of this Broker's collection of Domain Certificate Authority - objects. Available since 2.19. - type: string - msgVpnsUri: - description: The URI of this Broker's collection of Message VPN objects. - Available since 2.0. - type: string - oauthProfilesUri: - description: The URI of this Broker's collection of OAuth Profile objects. - Available since 2.24. - type: string - systemInformationUri: - description: The URI of this Broker's System Information object. Deprecated - since 2.2. /systemInformation was replaced by /about/api. - type: string - uri: - description: The URI of this Broker object. - type: string - virtualHostnamesUri: - description: The URI of this Broker's collection of Virtual Hostname objects. - Available since 2.17. - type: string - type: object - BrokerResponse: - example: - data: - serviceSempPlainTextEnabled: true - guaranteedMsgingEventDeliveredUnackedThreshold: - clearPercent: 1 - setPercent: 6 - guaranteedMsgingEventTransactedSessionResourceCountThreshold: - clearPercent: 1 - setPercent: 6 - serviceSmfEnabled: true - guaranteedMsgingEventMsgSpoolFileCountThreshold: - clearPercent: 1 - setPercent: 6 - tlsCipherSuiteManagementList: tlsCipherSuiteManagementList - serviceMsgBackboneEnabled: true - guaranteedMsgingDefragmentationThresholdEnabled: true - serviceSmfCompressionListenPort: 1 - guaranteedMsgingEventTransactionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceSmfPlainTextListenPort: 2 - serviceWebTransportWebUrlSuffix: serviceWebTransportWebUrlSuffix - serviceSempCorsAllowAnyHostEnabled: true - serviceSmfTlsListenPort: 6 - guaranteedMsgingDefragmentationScheduleEnabled: true - serviceMateLinkListenPort: 6 - serviceSempLegacyTimeoutEnabled: true - configSyncClientProfileTcpInitialCongestionWindow: 6 - serviceWebTransportPlainTextListenPort: 5 - serviceWebTransportTlsListenPort: 6 - webManagerRedirectHttpOverrideTlsPort: 3 - tlsTicketLifetime: 3 - serviceSmfRoutingControlListenPort: 6 - tlsServerCertPassword: tlsServerCertPassword - configSyncAuthenticationClientCertMaxChainDepth: 0 - authClientCertRevocationCheckMode: none - serviceRestIncomingEnabled: true - serviceSempSessionIdleTimeout: 6 - configSyncSynchronizeUsernameEnabled: true - serviceWebTransportEnabled: true - webManagerRedirectHttpEnabled: true - tlsCipherSuiteSecureShellList: tlsCipherSuiteSecureShellList - guaranteedMsgingDefragmentationThresholdFragmentationPercentage: 9 - serviceAmqpEnabled: true - guaranteedMsgingEventDiskUsageThreshold: - clearPercent: 1 - setPercent: 6 - configSyncClientProfileTcpKeepaliveInterval: 5 - serviceSempTlsEnabled: true - oauthProfileDefault: oauthProfileDefault - serviceEventConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceRedundancyFirstListenPort: 8 - guaranteedMsgingDefragmentationScheduleTimeList: guaranteedMsgingDefragmentationScheduleTimeList - guaranteedMsgingEventEgressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - guaranteedMsgingEventMsgCountThreshold: - clearPercent: 1 - setPercent: 6 - serviceHealthCheckListenPort: 9 - serviceRestEventOutgoingConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - guaranteedMsgingEventEndpointCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceHealthCheckEnabled: true - serviceMateLinkEnabled: true - configSyncClientProfileTcpMaxWindow: 2 - serviceSmfEventConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - guaranteedMsgingDefragmentationThresholdMinInterval: 3 - configSyncTlsEnabled: true - serviceRestOutgoingEnabled: true - configSyncClientProfileTcpMss: 7 - guaranteedMsgingMaxCacheUsage: 7 - serviceAmqpTlsListenPort: 9 - serviceSempTlsListenPort: 6 - tlsServerCertContent: tlsServerCertContent - serviceSempSessionMaxLifetime: 3 - tlsCipherSuiteMsgBackboneList: tlsCipherSuiteMsgBackboneList - guaranteedMsgingDefragmentationScheduleDayList: guaranteedMsgingDefragmentationScheduleDayList - guaranteedMsgingTransactionReplicationCompatibilityMode: legacy - guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout: 4 - guaranteedMsgingEventIngressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout: 5 - guaranteedMsgingMaxMsgSpoolUsage: 1 - configSyncEnabled: true - configSyncAuthenticationClientCertValidateDateEnabled: true - guaranteedMsgingDefragmentationThresholdUsagePercentage: 2 - serviceRedundancyEnabled: true - serviceMqttEnabled: true - serviceTlsEventConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - tlsBlockVersion11Enabled: true - tlsCrimeExploitProtectionEnabled: true - configSyncClientProfileTcpKeepaliveCount: 1 - webManagerAllowUnencryptedWizardsEnabled: true - serviceSempPlainTextListenPort: 9 - configSyncClientProfileTcpKeepaliveIdle: 5 - guaranteedMsgingEnabled: true - guaranteedMsgingEventTransactedSessionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - webManagerCustomization: webManagerCustomization - tlsStandardDomainCertificateAuthoritiesEnabled: true - guaranteedMsgingEventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - guaranteedMsgingEventCacheUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - virtualHostnamesUri: virtualHostnamesUri - oauthProfilesUri: oauthProfilesUri - certAuthoritiesUri: certAuthoritiesUri - systemInformationUri: systemInformationUri - aboutUri: aboutUri - msgVpnsUri: msgVpnsUri - domainCertAuthoritiesUri: domainCertAuthoritiesUri - clientCertAuthoritiesUri: clientCertAuthoritiesUri - uri: uri - dmrClustersUri: dmrClustersUri - properties: - data: - $ref: '#/components/schemas/Broker' - links: - $ref: '#/components/schemas/BrokerLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - CertAuthoritiesResponse: - example: - data: - - crlTimeList: crlTimeList - ocspOverrideUrl: ocspOverrideUrl - certAuthorityName: certAuthorityName - ocspNonResponderCertEnabled: true - revocationCheckEnabled: true - crlDayList: crlDayList - certContent: certContent - ocspTimeout: 0 - crlUrl: crlUrl - - crlTimeList: crlTimeList - ocspOverrideUrl: ocspOverrideUrl - certAuthorityName: certAuthorityName - ocspNonResponderCertEnabled: true - revocationCheckEnabled: true - crlDayList: crlDayList - certContent: certContent - ocspTimeout: 0 - crlUrl: crlUrl - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - ocspTlsTrustedCommonNamesUri: ocspTlsTrustedCommonNamesUri - uri: uri - - ocspTlsTrustedCommonNamesUri: ocspTlsTrustedCommonNamesUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/CertAuthority' - type: array - links: - items: - $ref: '#/components/schemas/CertAuthorityLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - CertAuthority: - example: - crlTimeList: crlTimeList - ocspOverrideUrl: ocspOverrideUrl - certAuthorityName: certAuthorityName - ocspNonResponderCertEnabled: true - revocationCheckEnabled: true - crlDayList: crlDayList - certContent: certContent - ocspTimeout: 0 - crlUrl: crlUrl - properties: - certAuthorityName: - description: The name of the Certificate Authority. Deprecated since 2.19. - Replaced by clientCertAuthorities and domainCertAuthorities. - type: string - certContent: - description: The PEM formatted content for the trusted root certificate - of a Certificate Authority. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `""`. Deprecated since - 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. - type: string - crlDayList: - description: "The scheduled CRL refresh day(s), specified as \"daily\" or\ - \ a comma-separated list of days. Days must be specified as \"Sun\", \"\ - Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", or \"Sat\", with no spaces,\ - \ and in sorted order from Sunday to Saturday. Changes to this attribute\ - \ are synchronized to HA mates via config-sync. The default value is `\"\ - daily\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities\ - \ and domainCertAuthorities." - type: string - crlTimeList: - description: "The scheduled CRL refresh time(s), specified as \"hourly\"\ - \ or a comma-separated list of 24-hour times in the form hh:mm, or h:mm.\ - \ There must be no spaces, and times must be in sorted order from 0:00\ - \ to 23:59. Changes to this attribute are synchronized to HA mates via\ - \ config-sync. The default value is `\"3:00\"`. Deprecated since 2.19.\ - \ certAuthorities replaced by clientCertAuthorities and domainCertAuthorities." - type: string - crlUrl: - description: The URL for the CRL source. This is a required attribute for - CRL to be operational and the URL must be complete with http:// included. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `""`. Deprecated since 2.19. certAuthorities replaced - by clientCertAuthorities and domainCertAuthorities. - type: string - ocspNonResponderCertEnabled: - description: Enable or disable allowing a non-responder certificate to sign - an OCSP response. Typically used with an OCSP override URL in cases where - a single certificate is used to sign client certificates and OCSP responses. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `false`. Deprecated since 2.19. certAuthorities replaced - by clientCertAuthorities and domainCertAuthorities. - type: boolean - ocspOverrideUrl: - description: The OCSP responder URL to use for overriding the one supplied - in the client certificate. The URL must be complete with http:// included. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `""`. Deprecated since 2.19. certAuthorities replaced - by clientCertAuthorities and domainCertAuthorities. - type: string - ocspTimeout: - description: The timeout in seconds to receive a response from the OCSP - responder after sending a request or making the initial connection attempt. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `5`. Deprecated since 2.19. certAuthorities replaced - by clientCertAuthorities and domainCertAuthorities. - format: int64 - type: integer - revocationCheckEnabled: - description: Enable or disable Certificate Authority revocation checking. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `false`. Deprecated since 2.19. certAuthorities replaced - by clientCertAuthorities and domainCertAuthorities. - type: boolean - type: object - CertAuthorityLinks: - example: - ocspTlsTrustedCommonNamesUri: ocspTlsTrustedCommonNamesUri - uri: uri - properties: - ocspTlsTrustedCommonNamesUri: - description: The URI of this Certificate Authority's collection of OCSP - Responder Trusted Common Name objects. Deprecated since 2.19. Replaced - by clientCertAuthorities. - type: string - uri: - description: The URI of this Certificate Authority object. - type: string - type: object - CertAuthorityOcspTlsTrustedCommonName: - example: - certAuthorityName: certAuthorityName - ocspTlsTrustedCommonName: ocspTlsTrustedCommonName - properties: - certAuthorityName: - description: The name of the Certificate Authority. Deprecated since 2.19. - Replaced by clientCertAuthorities. - type: string - ocspTlsTrustedCommonName: - description: The expected Trusted Common Name of the OCSP responder remote - certificate. Deprecated since 2.19. Replaced by clientCertAuthorities. - type: string - type: object - CertAuthorityOcspTlsTrustedCommonNameLinks: - example: - uri: uri - properties: - uri: - description: The URI of this OCSP Responder Trusted Common Name object. - type: string - type: object - CertAuthorityOcspTlsTrustedCommonNameResponse: - example: - data: - certAuthorityName: certAuthorityName - ocspTlsTrustedCommonName: ocspTlsTrustedCommonName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/CertAuthorityOcspTlsTrustedCommonName' - links: - $ref: '#/components/schemas/CertAuthorityOcspTlsTrustedCommonNameLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - CertAuthorityOcspTlsTrustedCommonNamesResponse: - example: - data: - - certAuthorityName: certAuthorityName - ocspTlsTrustedCommonName: ocspTlsTrustedCommonName - - certAuthorityName: certAuthorityName - ocspTlsTrustedCommonName: ocspTlsTrustedCommonName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/CertAuthorityOcspTlsTrustedCommonName' - type: array - links: - items: - $ref: '#/components/schemas/CertAuthorityOcspTlsTrustedCommonNameLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - CertAuthorityResponse: - example: - data: - crlTimeList: crlTimeList - ocspOverrideUrl: ocspOverrideUrl - certAuthorityName: certAuthorityName - ocspNonResponderCertEnabled: true - revocationCheckEnabled: true - crlDayList: crlDayList - certContent: certContent - ocspTimeout: 0 - crlUrl: crlUrl - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - ocspTlsTrustedCommonNamesUri: ocspTlsTrustedCommonNamesUri - uri: uri - properties: - data: - $ref: '#/components/schemas/CertAuthority' - links: - $ref: '#/components/schemas/CertAuthorityLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - ClientCertAuthoritiesResponse: - example: - data: - - crlTimeList: crlTimeList - ocspOverrideUrl: ocspOverrideUrl - certAuthorityName: certAuthorityName - ocspNonResponderCertEnabled: true - revocationCheckEnabled: true - crlDayList: crlDayList - certContent: certContent - ocspTimeout: 0 - crlUrl: crlUrl - - crlTimeList: crlTimeList - ocspOverrideUrl: ocspOverrideUrl - certAuthorityName: certAuthorityName - ocspNonResponderCertEnabled: true - revocationCheckEnabled: true - crlDayList: crlDayList - certContent: certContent - ocspTimeout: 0 - crlUrl: crlUrl - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - ocspTlsTrustedCommonNamesUri: ocspTlsTrustedCommonNamesUri - uri: uri - - ocspTlsTrustedCommonNamesUri: ocspTlsTrustedCommonNamesUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/ClientCertAuthority' - type: array - links: - items: - $ref: '#/components/schemas/ClientCertAuthorityLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - ClientCertAuthority: - example: - crlTimeList: crlTimeList - ocspOverrideUrl: ocspOverrideUrl - certAuthorityName: certAuthorityName - ocspNonResponderCertEnabled: true - revocationCheckEnabled: true - crlDayList: crlDayList - certContent: certContent - ocspTimeout: 0 - crlUrl: crlUrl - properties: - certAuthorityName: - description: The name of the Certificate Authority. - type: string - certContent: - description: The PEM formatted content for the trusted root certificate - of a client Certificate Authority. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `""`. - type: string - crlDayList: - description: "The scheduled CRL refresh day(s), specified as \"daily\" or\ - \ a comma-separated list of days. Days must be specified as \"Sun\", \"\ - Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", or \"Sat\", with no spaces,\ - \ and in sorted order from Sunday to Saturday. The empty-string (\"\"\ - ) can also be specified, indicating no schedule is configured (\"crlTimeList\"\ - \ must also be configured to the empty-string). Changes to this attribute\ - \ are synchronized to HA mates via config-sync. The default value is `\"\ - daily\"`." - type: string - crlTimeList: - description: "The scheduled CRL refresh time(s), specified as \"hourly\"\ - \ or a comma-separated list of 24-hour times in the form hh:mm, or h:mm.\ - \ There must be no spaces, and times (up to 4) must be in sorted order\ - \ from 0:00 to 23:59. The empty-string (\"\") can also be specified, indicating\ - \ no schedule is configured (\"crlDayList\" must also be configured to\ - \ the empty-string). Changes to this attribute are synchronized to HA\ - \ mates via config-sync. The default value is `\"3:00\"`." - type: string - crlUrl: - description: The URL for the CRL source. This is a required attribute for - CRL to be operational and the URL must be complete with http:// included. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `""`. - type: string - ocspNonResponderCertEnabled: - description: Enable or disable allowing a non-responder certificate to sign - an OCSP response. Typically used with an OCSP override URL in cases where - a single certificate is used to sign client certificates and OCSP responses. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `false`. - type: boolean - ocspOverrideUrl: - description: The OCSP responder URL to use for overriding the one supplied - in the client certificate. The URL must be complete with http:// included. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `""`. - type: string - ocspTimeout: - description: The timeout in seconds to receive a response from the OCSP - responder after sending a request or making the initial connection attempt. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `5`. - format: int64 - type: integer - revocationCheckEnabled: - description: Enable or disable Certificate Authority revocation checking. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `false`. - type: boolean - type: object - ClientCertAuthorityLinks: - example: - ocspTlsTrustedCommonNamesUri: ocspTlsTrustedCommonNamesUri - uri: uri - properties: - ocspTlsTrustedCommonNamesUri: - description: The URI of this Client Certificate Authority's collection of - OCSP Responder Trusted Common Name objects. - type: string - uri: - description: The URI of this Client Certificate Authority object. - type: string - type: object - ClientCertAuthorityOcspTlsTrustedCommonName: - example: - certAuthorityName: certAuthorityName - ocspTlsTrustedCommonName: ocspTlsTrustedCommonName - properties: - certAuthorityName: - description: The name of the Certificate Authority. - type: string - ocspTlsTrustedCommonName: - description: The expected Trusted Common Name of the OCSP responder remote - certificate. - type: string - type: object - ClientCertAuthorityOcspTlsTrustedCommonNameLinks: - example: - uri: uri - properties: - uri: - description: The URI of this OCSP Responder Trusted Common Name object. - type: string - type: object - ClientCertAuthorityOcspTlsTrustedCommonNameResponse: - example: - data: - certAuthorityName: certAuthorityName - ocspTlsTrustedCommonName: ocspTlsTrustedCommonName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/ClientCertAuthorityOcspTlsTrustedCommonName' - links: - $ref: '#/components/schemas/ClientCertAuthorityOcspTlsTrustedCommonNameLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - ClientCertAuthorityOcspTlsTrustedCommonNamesResponse: - example: - data: - - certAuthorityName: certAuthorityName - ocspTlsTrustedCommonName: ocspTlsTrustedCommonName - - certAuthorityName: certAuthorityName - ocspTlsTrustedCommonName: ocspTlsTrustedCommonName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/ClientCertAuthorityOcspTlsTrustedCommonName' - type: array - links: - items: - $ref: '#/components/schemas/ClientCertAuthorityOcspTlsTrustedCommonNameLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - ClientCertAuthorityResponse: - example: - data: - crlTimeList: crlTimeList - ocspOverrideUrl: ocspOverrideUrl - certAuthorityName: certAuthorityName - ocspNonResponderCertEnabled: true - revocationCheckEnabled: true - crlDayList: crlDayList - certContent: certContent - ocspTimeout: 0 - crlUrl: crlUrl - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - ocspTlsTrustedCommonNamesUri: ocspTlsTrustedCommonNamesUri - uri: uri - properties: - data: - $ref: '#/components/schemas/ClientCertAuthority' - links: - $ref: '#/components/schemas/ClientCertAuthorityLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DmrCluster: - example: - nodeName: nodeName - directOnlyEnabled: true - authenticationBasicPassword: authenticationBasicPassword - enabled: true - authenticationClientCertPassword: authenticationClientCertPassword - tlsServerCertValidateNameEnabled: true - tlsServerCertMaxChainDepth: 0 - authenticationClientCertEnabled: true - dmrClusterName: dmrClusterName - tlsServerCertValidateDateEnabled: true - authenticationBasicEnabled: true - authenticationClientCertContent: authenticationClientCertContent - authenticationBasicType: internal - tlsServerCertEnforceTrustedCommonNameEnabled: true - properties: - authenticationBasicEnabled: - description: Enable or disable basic authentication for Cluster Links. Changes - to this attribute are synchronized to HA mates via config-sync. The default - value is `true`. - type: boolean - authenticationBasicPassword: - description: "The password used to authenticate incoming Cluster Links when\ - \ using basic internal authentication. The same password is also used\ - \ by outgoing Cluster Links if a per-Link password is not configured.\ - \ This attribute is absent from a GET and not updated when absent in a\ - \ PUT, subject to the exceptions in note 4. Changes to this attribute\ - \ are synchronized to HA mates via config-sync. The default value is `\"\ - \"`." - type: string - authenticationBasicType: - description: | - The type of basic authentication to use for Cluster Links. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"internal"`. The allowed values and their meaning are: - - 
-            "internal" - Use locally configured password.
-            "none" - No authentication.
-
- enum: - - internal - - none - type: string - authenticationClientCertContent: - description: "The PEM formatted content for the client certificate used\ - \ to login to the remote node. It must consist of a private key and between\ - \ one and three certificates comprising the certificate trust chain. This\ - \ attribute is absent from a GET and not updated when absent in a PUT,\ - \ subject to the exceptions in note 4. Changing this attribute requires\ - \ an HTTPS connection. The default value is `\"\"`." - type: string - x-requires-https: true - authenticationClientCertEnabled: - description: Enable or disable client certificate authentication for Cluster - Links. Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `true`. - type: boolean - authenticationClientCertPassword: - description: "The password for the client certificate. This attribute is\ - \ absent from a GET and not updated when absent in a PUT, subject to the\ - \ exceptions in note 4. Changing this attribute requires an HTTPS connection.\ - \ The default value is `\"\"`." - type: string - x-requires-https: true - directOnlyEnabled: - description: Enable or disable direct messaging only. Guaranteed messages - will not be transmitted through the cluster. The default value is `false`. - type: boolean - dmrClusterName: - description: The name of the Cluster. - type: string - enabled: - description: Enable or disable the Cluster. Changes to this attribute are - synchronized to HA mates via config-sync. The default value is `false`. - type: boolean - nodeName: - description: "The name of this node in the Cluster. This is the name that\ - \ this broker (or redundant group of brokers) is know by to other nodes\ - \ in the Cluster. The name is chosen automatically to be either this broker's\ - \ Router Name or Mate Router Name, depending on which Active Standby Role\ - \ (primary or backup) this broker plays in its redundancy group." - type: string - tlsServerCertEnforceTrustedCommonNameEnabled: - description: "Enable or disable the enforcing of the common name provided\ - \ by the remote broker against the list of trusted common names configured\ - \ for the Link. If enabled, the certificate's common name must match one\ - \ of the trusted common names for the Link to be accepted. Common Name\ - \ validation is not performed if Server Certificate Name Validation is\ - \ enabled, even if Common Name validation is enabled. Changes to this\ - \ attribute are synchronized to HA mates via config-sync. The default\ - \ value is `false`. Deprecated since 2.18. Common Name validation has\ - \ been replaced by Server Certificate Name validation." - type: boolean - tlsServerCertMaxChainDepth: - description: The maximum allowed depth of a certificate chain. The depth - of a chain is defined as the number of signing CA certificates that are - present in the chain back to a trusted self-signed root CA certificate. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `3`. - format: int64 - type: integer - tlsServerCertValidateDateEnabled: - description: "Enable or disable the validation of the \"Not Before\" and\ - \ \"Not After\" validity dates in the certificate. When disabled, the\ - \ certificate is accepted even if the certificate is not valid based on\ - \ these dates. Changes to this attribute are synchronized to HA mates\ - \ via config-sync. The default value is `true`." - type: boolean - tlsServerCertValidateNameEnabled: - description: "Enable or disable the standard TLS authentication mechanism\ - \ of verifying the name used to connect to the bridge. If enabled, the\ - \ name used to connect to the bridge is checked against the names specified\ - \ in the certificate returned by the remote router. Legacy Common Name\ - \ validation is not performed if Server Certificate Name Validation is\ - \ enabled, even if Common Name validation is also enabled. Changes to\ - \ this attribute are synchronized to HA mates via config-sync. The default\ - \ value is `true`. Available since 2.18." - type: boolean - type: object - DmrClusterCertMatchingRule: - example: - dmrClusterName: dmrClusterName - ruleName: ruleName - enabled: true - properties: - dmrClusterName: - description: The name of the Cluster. - type: string - enabled: - description: Enable or disable a certificate matching rule. Changes to this - attribute are synchronized to HA mates via config-sync. The default value - is `false`. - type: boolean - ruleName: - description: The name of the rule. - type: string - type: object - DmrClusterCertMatchingRuleAttributeFilter: - example: - attributeValue: attributeValue - dmrClusterName: dmrClusterName - filterName: filterName - ruleName: ruleName - attributeName: attributeName - properties: - attributeName: - description: Link Attribute to be tested. Changes to this attribute are - synchronized to HA mates via config-sync. The default value is `""`. - type: string - attributeValue: - description: Expected attribute value. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `""`. - type: string - dmrClusterName: - description: The name of the Cluster. - type: string - filterName: - description: The name of the filter. - type: string - ruleName: - description: The name of the rule. - type: string - type: object - DmrClusterCertMatchingRuleAttributeFilterLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Certificate Matching Rule Attribute Filter - object. - type: string - type: object - DmrClusterCertMatchingRuleAttributeFilterResponse: - example: - data: - attributeValue: attributeValue - dmrClusterName: dmrClusterName - filterName: filterName - ruleName: ruleName - attributeName: attributeName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleAttributeFilter' - links: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleAttributeFilterLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DmrClusterCertMatchingRuleAttributeFiltersResponse: - example: - data: - - attributeValue: attributeValue - dmrClusterName: dmrClusterName - filterName: filterName - ruleName: ruleName - attributeName: attributeName - - attributeValue: attributeValue - dmrClusterName: dmrClusterName - filterName: filterName - ruleName: ruleName - attributeName: attributeName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleAttributeFilter' - type: array - links: - items: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleAttributeFilterLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DmrClusterCertMatchingRuleCondition: - example: - expression: expression - dmrClusterName: dmrClusterName - ruleName: ruleName - attribute: attribute - source: certificate-thumbprint - properties: - attribute: - description: "Link Attribute to be compared with certificate content. Either\ - \ an attribute or an expression must be provided on creation, but not\ - \ both. The default value is `\"\"`." - type: string - dmrClusterName: - description: The name of the Cluster. - type: string - expression: - description: "Glob expression to be matched with certificate content. Either\ - \ an expression or an attribute must be provided on creation, but not\ - \ both. The default value is `\"\"`." - type: string - ruleName: - description: The name of the rule. - type: string - source: - description: | - Certificate field to be compared with the Attribute. The allowed values and their meaning are: - - 
-            "certificate-thumbprint" - The attribute is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate.
-            "common-name" - The attribute is extracted from the certificate's first instance of the Common Name attribute in the Subject DN.
-            "common-name-last" - The attribute is extracted from the certificate's last instance of the Common Name attribute in the Subject DN.
-            "subject-alternate-name-msupn" - The attribute is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature.
-            "uid" - The attribute is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN.
-            "uid-last" - The attribute is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN.
-            "org-unit" - The attribute is extracted from the certificate's first instance of the Org Unit attribute in the Subject DN.
-            "org-unit-last" - The attribute is extracted from the certificate's last instance of the Org Unit attribute in the Subject DN.
-            "issuer" - The attribute is extracted from the certificate's Issuer DN.
-            "subject" - The attribute is extracted from the certificate's Subject DN.
-            "serial-number" - The attribute is extracted from the certificate's Serial Number.
-            "dns-name" - The attribute is extracted from the certificate's Subject Alt Name DNSName.
-            "ip-address" - The attribute is extracted from the certificate's Subject Alt Name IPAddress.
-
- enum: - - certificate-thumbprint - - common-name - - common-name-last - - subject-alternate-name-msupn - - uid - - uid-last - - org-unit - - org-unit-last - - issuer - - subject - - serial-number - - dns-name - - ip-address - type: string - type: object - DmrClusterCertMatchingRuleConditionLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Certificate Matching Rule Condition object. - type: string - type: object - DmrClusterCertMatchingRuleConditionResponse: - example: - data: - expression: expression - dmrClusterName: dmrClusterName - ruleName: ruleName - attribute: attribute - source: certificate-thumbprint - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleCondition' - links: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleConditionLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DmrClusterCertMatchingRuleConditionsResponse: - example: - data: - - expression: expression - dmrClusterName: dmrClusterName - ruleName: ruleName - attribute: attribute - source: certificate-thumbprint - - expression: expression - dmrClusterName: dmrClusterName - ruleName: ruleName - attribute: attribute - source: certificate-thumbprint - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleCondition' - type: array - links: - items: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleConditionLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DmrClusterCertMatchingRuleLinks: - example: - attributeFiltersUri: attributeFiltersUri - conditionsUri: conditionsUri - uri: uri - properties: - attributeFiltersUri: - description: The URI of this Certificate Matching Rule's collection of Certificate - Matching Rule Attribute Filter objects. - type: string - conditionsUri: - description: The URI of this Certificate Matching Rule's collection of Certificate - Matching Rule Condition objects. - type: string - uri: - description: The URI of this Certificate Matching Rule object. - type: string - type: object - DmrClusterCertMatchingRuleResponse: - example: - data: - dmrClusterName: dmrClusterName - ruleName: ruleName - enabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - attributeFiltersUri: attributeFiltersUri - conditionsUri: conditionsUri - uri: uri - properties: - data: - $ref: '#/components/schemas/DmrClusterCertMatchingRule' - links: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DmrClusterCertMatchingRulesResponse: - example: - data: - - dmrClusterName: dmrClusterName - ruleName: ruleName - enabled: true - - dmrClusterName: dmrClusterName - ruleName: ruleName - enabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - attributeFiltersUri: attributeFiltersUri - conditionsUri: conditionsUri - uri: uri - - attributeFiltersUri: attributeFiltersUri - conditionsUri: conditionsUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/DmrClusterCertMatchingRule' - type: array - links: - items: - $ref: '#/components/schemas/DmrClusterCertMatchingRuleLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DmrClusterLink: - example: - transportCompressedEnabled: true - remoteNodeName: remoteNodeName - clientProfileQueueDirect2MaxDepth: 5 - clientProfileQueueDirect1MaxDepth: 1 - clientProfileQueueDirect3MinMsgBurst: 9 - initiator: lexical - queueMaxDeliveredUnackedMsgsPerFlow: 1 - clientProfileQueueDirect3MaxDepth: 7 - queueMaxRedeliveryCount: 5 - transportTlsEnabled: true - enabled: true - queueDeadMsgQueue: queueDeadMsgQueue - authenticationScheme: basic - clientProfileQueueControl1MaxDepth: 0 - clientProfileQueueDirect2MinMsgBurst: 2 - queueEventSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - clientProfileQueueControl1MinMsgBurst: 6 - queueMaxMsgSpoolUsage: 4 - clientProfileTcpKeepaliveInterval: 1 - egressFlowWindowSize: 7 - clientProfileTcpCongestionWindowSize: 4 - clientProfileQueueDirect1MinMsgBurst: 5 - queueRespectTtlEnabled: true - clientProfileTcpMaxWindowSize: 6 - authenticationBasicPassword: authenticationBasicPassword - clientProfileTcpKeepaliveCount: 7 - queueMaxTtl: 9 - clientProfileTcpKeepaliveIdleTime: 1 - queueRejectMsgToSenderOnDiscardBehavior: always - dmrClusterName: dmrClusterName - clientProfileTcpMaxSegmentSize: 1 - clientProfileQueueGuaranteed1MaxDepth: 3 - clientProfileQueueGuaranteed1MinMsgBurst: 2 - span: internal - properties: - authenticationBasicPassword: - description: "The password used to authenticate with the remote node when\ - \ using basic internal authentication. If this per-Link password is not\ - \ configured, the Cluster's password is used instead. This attribute is\ - \ absent from a GET and not updated when absent in a PUT, subject to the\ - \ exceptions in note 4. Changes to this attribute are synchronized to\ - \ HA mates via config-sync. The default value is `\"\"`." - type: string - authenticationScheme: - description: | - The authentication scheme to be used by the Link which initiates connections to the remote node. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"basic"`. The allowed values and their meaning are: - - 
-            "basic" - Basic Authentication Scheme (via username and password).
-            "client-certificate" - Client Certificate Authentication Scheme (via certificate file or content).
-
- enum: - - basic - - client-certificate - type: string - clientProfileQueueControl1MaxDepth: - description: "The maximum depth of the \"Control 1\" (C-1) priority queue,\ - \ in work units. Each work unit is 2048 bytes of message data. Changes\ - \ to this attribute are synchronized to HA mates via config-sync. The\ - \ default value is `20000`." - format: int32 - type: integer - clientProfileQueueControl1MinMsgBurst: - description: "The number of messages that are always allowed entry into\ - \ the \"Control 1\" (C-1) priority queue, regardless of the `clientProfileQueueControl1MaxDepth`\ - \ value. Changes to this attribute are synchronized to HA mates via config-sync.\ - \ The default value is `4`." - format: int32 - type: integer - clientProfileQueueDirect1MaxDepth: - description: "The maximum depth of the \"Direct 1\" (D-1) priority queue,\ - \ in work units. Each work unit is 2048 bytes of message data. Changes\ - \ to this attribute are synchronized to HA mates via config-sync. The\ - \ default value is `20000`." - format: int32 - type: integer - clientProfileQueueDirect1MinMsgBurst: - description: "The number of messages that are always allowed entry into\ - \ the \"Direct 1\" (D-1) priority queue, regardless of the `clientProfileQueueDirect1MaxDepth`\ - \ value. Changes to this attribute are synchronized to HA mates via config-sync.\ - \ The default value is `4`." - format: int32 - type: integer - clientProfileQueueDirect2MaxDepth: - description: "The maximum depth of the \"Direct 2\" (D-2) priority queue,\ - \ in work units. Each work unit is 2048 bytes of message data. Changes\ - \ to this attribute are synchronized to HA mates via config-sync. The\ - \ default value is `20000`." - format: int32 - type: integer - clientProfileQueueDirect2MinMsgBurst: - description: "The number of messages that are always allowed entry into\ - \ the \"Direct 2\" (D-2) priority queue, regardless of the `clientProfileQueueDirect2MaxDepth`\ - \ value. Changes to this attribute are synchronized to HA mates via config-sync.\ - \ The default value is `4`." - format: int32 - type: integer - clientProfileQueueDirect3MaxDepth: - description: "The maximum depth of the \"Direct 3\" (D-3) priority queue,\ - \ in work units. Each work unit is 2048 bytes of message data. Changes\ - \ to this attribute are synchronized to HA mates via config-sync. The\ - \ default value is `20000`." - format: int32 - type: integer - clientProfileQueueDirect3MinMsgBurst: - description: "The number of messages that are always allowed entry into\ - \ the \"Direct 3\" (D-3) priority queue, regardless of the `clientProfileQueueDirect3MaxDepth`\ - \ value. Changes to this attribute are synchronized to HA mates via config-sync.\ - \ The default value is `4`." - format: int32 - type: integer - clientProfileQueueGuaranteed1MaxDepth: - description: "The maximum depth of the \"Guaranteed 1\" (G-1) priority queue,\ - \ in work units. Each work unit is 2048 bytes of message data. Changes\ - \ to this attribute are synchronized to HA mates via config-sync. The\ - \ default value is `20000`." - format: int32 - type: integer - clientProfileQueueGuaranteed1MinMsgBurst: - description: "The number of messages that are always allowed entry into\ - \ the \"Guaranteed 1\" (G-3) priority queue, regardless of the `clientProfileQueueGuaranteed1MaxDepth`\ - \ value. Changes to this attribute are synchronized to HA mates via config-sync.\ - \ The default value is `255`." - format: int32 - type: integer - clientProfileTcpCongestionWindowSize: - description: "The TCP initial congestion window size, in multiples of the\ - \ TCP Maximum Segment Size (MSS). Changing the value from its default\ - \ of 2 results in non-compliance with RFC 2581. Contact support before\ - \ changing this value. Changes to this attribute are synchronized to HA\ - \ mates via config-sync. The default value is `2`." - format: int64 - type: integer - clientProfileTcpKeepaliveCount: - description: The number of TCP keepalive retransmissions to be carried out - before declaring that the remote end is not available. Changes to this - attribute are synchronized to HA mates via config-sync. The default value - is `5`. - format: int64 - type: integer - clientProfileTcpKeepaliveIdleTime: - description: "The amount of time a connection must remain idle before TCP\ - \ begins sending keepalive probes, in seconds. Changes to this attribute\ - \ are synchronized to HA mates via config-sync. The default value is `3`." - format: int64 - type: integer - clientProfileTcpKeepaliveInterval: - description: "The amount of time between TCP keepalive retransmissions when\ - \ no acknowledgement is received, in seconds. Changes to this attribute\ - \ are synchronized to HA mates via config-sync. The default value is `1`." - format: int64 - type: integer - clientProfileTcpMaxSegmentSize: - description: "The TCP maximum segment size, in bytes. Changes are applied\ - \ to all existing connections. Changes to this attribute are synchronized\ - \ to HA mates via config-sync. The default value is `1460`." - format: int64 - type: integer - clientProfileTcpMaxWindowSize: - description: "The TCP maximum window size, in kilobytes. Changes are applied\ - \ to all existing connections. Changes to this attribute are synchronized\ - \ to HA mates via config-sync. The default value is `256`." - format: int64 - type: integer - dmrClusterName: - description: The name of the Cluster. - type: string - egressFlowWindowSize: - description: The number of outstanding guaranteed messages that can be sent - over the Link before acknowledgement is received by the sender. Changes - to this attribute are synchronized to HA mates via config-sync. The default - value is `255`. - format: int64 - type: integer - enabled: - description: "Enable or disable the Link. When disabled, subscription sets\ - \ of this and the remote node are not kept up-to-date, and messages are\ - \ not exchanged with the remote node. Published guaranteed messages will\ - \ be queued up for future delivery based on current subscription sets.\ - \ Changes to this attribute are synchronized to HA mates via config-sync.\ - \ The default value is `false`." - type: boolean - initiator: - description: | - The initiator of the Link's TCP connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"lexical"`. The allowed values and their meaning are: - - 
-            "lexical" - The "higher" node-name initiates.
-            "local" - The local node initiates.
-            "remote" - The remote node initiates.
-
- enum: - - lexical - - local - - remote - type: string - queueDeadMsgQueue: - description: The name of the Dead Message Queue (DMQ) used by the Queue - for discarded messages. Changes to this attribute are synchronized to - HA mates via config-sync. The default value is `"#DEAD_MSG_QUEUE"`. - type: string - queueEventSpoolUsageThreshold: - $ref: '#/components/schemas/EventThreshold' - queueMaxDeliveredUnackedMsgsPerFlow: - description: The maximum number of messages delivered but not acknowledged - per flow for the Queue. Changes to this attribute are synchronized to - HA mates via config-sync. The default value is `1000000`. - format: int64 - type: integer - queueMaxMsgSpoolUsage: - description: "The maximum message spool usage by the Queue (quota), in megabytes\ - \ (MB). Changes to this attribute are synchronized to HA mates via config-sync.\ - \ The default value is `800000`." - format: int64 - type: integer - queueMaxRedeliveryCount: - description: The maximum number of times the Queue will attempt redelivery - of a message prior to it being discarded or moved to the DMQ. A value - of 0 means to retry forever. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `0`. - format: int64 - type: integer - queueMaxTtl: - description: "The maximum time in seconds a message can stay in the Queue\ - \ when `queueRespectTtlEnabled` is `true`. A message expires when the\ - \ lesser of the sender assigned time-to-live (TTL) in the message and\ - \ the `queueMaxTtl` configured for the Queue, is exceeded. A value of\ - \ 0 disables expiry. Changes to this attribute are synchronized to HA\ - \ mates via config-sync. The default value is `0`." - format: int64 - type: integer - queueRejectMsgToSenderOnDiscardBehavior: - description: | - Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"always"`. The allowed values and their meaning are: - - 
-            "always" - Always return a negative acknowledgment (NACK) to the sending client on message discard.
-            "when-queue-enabled" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled.
-            "never" - Never return a negative acknowledgment (NACK) to the sending client on message discard.
-
- enum: - - always - - when-queue-enabled - - never - type: string - queueRespectTtlEnabled: - description: "Enable or disable the respecting of the time-to-live (TTL)\ - \ for messages in the Queue. When enabled, expired messages are discarded\ - \ or moved to the DMQ. Changes to this attribute are synchronized to HA\ - \ mates via config-sync. The default value is `false`." - type: boolean - remoteNodeName: - description: The name of the node at the remote end of the Link. - type: string - span: - description: | - The span of the Link, either internal or external. Internal Links connect nodes within the same Cluster. External Links connect nodes within different Clusters. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"external"`. The allowed values and their meaning are: - - 
-            "internal" - Link to same cluster.
-            "external" - Link to other cluster.
-
- enum: - - internal - - external - type: string - transportCompressedEnabled: - description: Enable or disable compression on the Link. Changes to this - attribute are synchronized to HA mates via config-sync. The default value - is `false`. - type: boolean - transportTlsEnabled: - description: Enable or disable encryption (TLS) on the Link. Changes to - this attribute are synchronized to HA mates via config-sync. The default - value is `false`. - type: boolean - type: object - DmrClusterLinkAttribute: - example: - remoteNodeName: remoteNodeName - attributeValue: attributeValue - dmrClusterName: dmrClusterName - attributeName: attributeName - properties: - attributeName: - description: The name of the Attribute. - type: string - attributeValue: - description: The value of the Attribute. - type: string - dmrClusterName: - description: The name of the Cluster. - type: string - remoteNodeName: - description: The name of the node at the remote end of the Link. - type: string - type: object - DmrClusterLinkAttributeLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Link Attribute object. - type: string - type: object - DmrClusterLinkAttributeResponse: - example: - data: - remoteNodeName: remoteNodeName - attributeValue: attributeValue - dmrClusterName: dmrClusterName - attributeName: attributeName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/DmrClusterLinkAttribute' - links: - $ref: '#/components/schemas/DmrClusterLinkAttributeLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DmrClusterLinkAttributesResponse: - example: - data: - - remoteNodeName: remoteNodeName - attributeValue: attributeValue - dmrClusterName: dmrClusterName - attributeName: attributeName - - remoteNodeName: remoteNodeName - attributeValue: attributeValue - dmrClusterName: dmrClusterName - attributeName: attributeName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/DmrClusterLinkAttribute' - type: array - links: - items: - $ref: '#/components/schemas/DmrClusterLinkAttributeLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DmrClusterLinkLinks: - example: - remoteAddressesUri: remoteAddressesUri - attributesUri: attributesUri - uri: uri - tlsTrustedCommonNamesUri: tlsTrustedCommonNamesUri - properties: - attributesUri: - description: The URI of this Link's collection of Link Attribute objects. - Available since 2.28. - type: string - remoteAddressesUri: - description: The URI of this Link's collection of Remote Address objects. - type: string - tlsTrustedCommonNamesUri: - description: The URI of this Link's collection of Trusted Common Name objects. - Deprecated since 2.18. Common Name validation has been replaced by Server - Certificate Name validation. - type: string - uri: - description: The URI of this Link object. - type: string - type: object - DmrClusterLinkRemoteAddress: - example: - remoteNodeName: remoteNodeName - dmrClusterName: dmrClusterName - remoteAddress: remoteAddress - properties: - dmrClusterName: - description: The name of the Cluster. - type: string - remoteAddress: - description: "The FQDN or IP address (and optional port) of the remote node.\ - \ If a port is not provided, it will vary based on the transport encoding:\ - \ 55555 (plain-text), 55443 (encrypted), or 55003 (compressed)." - type: string - remoteNodeName: - description: The name of the node at the remote end of the Link. - type: string - type: object - DmrClusterLinkRemoteAddressLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Remote Address object. - type: string - type: object - DmrClusterLinkRemoteAddressResponse: - example: - data: - remoteNodeName: remoteNodeName - dmrClusterName: dmrClusterName - remoteAddress: remoteAddress - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/DmrClusterLinkRemoteAddress' - links: - $ref: '#/components/schemas/DmrClusterLinkRemoteAddressLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DmrClusterLinkRemoteAddressesResponse: - example: - data: - - remoteNodeName: remoteNodeName - dmrClusterName: dmrClusterName - remoteAddress: remoteAddress - - remoteNodeName: remoteNodeName - dmrClusterName: dmrClusterName - remoteAddress: remoteAddress - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/DmrClusterLinkRemoteAddress' - type: array - links: - items: - $ref: '#/components/schemas/DmrClusterLinkRemoteAddressLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DmrClusterLinkResponse: - example: - data: - transportCompressedEnabled: true - remoteNodeName: remoteNodeName - clientProfileQueueDirect2MaxDepth: 5 - clientProfileQueueDirect1MaxDepth: 1 - clientProfileQueueDirect3MinMsgBurst: 9 - initiator: lexical - queueMaxDeliveredUnackedMsgsPerFlow: 1 - clientProfileQueueDirect3MaxDepth: 7 - queueMaxRedeliveryCount: 5 - transportTlsEnabled: true - enabled: true - queueDeadMsgQueue: queueDeadMsgQueue - authenticationScheme: basic - clientProfileQueueControl1MaxDepth: 0 - clientProfileQueueDirect2MinMsgBurst: 2 - queueEventSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - clientProfileQueueControl1MinMsgBurst: 6 - queueMaxMsgSpoolUsage: 4 - clientProfileTcpKeepaliveInterval: 1 - egressFlowWindowSize: 7 - clientProfileTcpCongestionWindowSize: 4 - clientProfileQueueDirect1MinMsgBurst: 5 - queueRespectTtlEnabled: true - clientProfileTcpMaxWindowSize: 6 - authenticationBasicPassword: authenticationBasicPassword - clientProfileTcpKeepaliveCount: 7 - queueMaxTtl: 9 - clientProfileTcpKeepaliveIdleTime: 1 - queueRejectMsgToSenderOnDiscardBehavior: always - dmrClusterName: dmrClusterName - clientProfileTcpMaxSegmentSize: 1 - clientProfileQueueGuaranteed1MaxDepth: 3 - clientProfileQueueGuaranteed1MinMsgBurst: 2 - span: internal - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - remoteAddressesUri: remoteAddressesUri - attributesUri: attributesUri - uri: uri - tlsTrustedCommonNamesUri: tlsTrustedCommonNamesUri - properties: - data: - $ref: '#/components/schemas/DmrClusterLink' - links: - $ref: '#/components/schemas/DmrClusterLinkLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DmrClusterLinkTlsTrustedCommonName: - example: - remoteNodeName: remoteNodeName - dmrClusterName: dmrClusterName - tlsTrustedCommonName: tlsTrustedCommonName - properties: - dmrClusterName: - description: The name of the Cluster. Deprecated since 2.18. Common Name - validation has been replaced by Server Certificate Name validation. - type: string - remoteNodeName: - description: The name of the node at the remote end of the Link. Deprecated - since 2.18. Common Name validation has been replaced by Server Certificate - Name validation. - type: string - tlsTrustedCommonName: - description: The expected trusted common name of the remote certificate. - Deprecated since 2.18. Common Name validation has been replaced by Server - Certificate Name validation. - type: string - type: object - DmrClusterLinkTlsTrustedCommonNameLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Trusted Common Name object. - type: string - type: object - DmrClusterLinkTlsTrustedCommonNameResponse: - example: - data: - remoteNodeName: remoteNodeName - dmrClusterName: dmrClusterName - tlsTrustedCommonName: tlsTrustedCommonName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/DmrClusterLinkTlsTrustedCommonName' - links: - $ref: '#/components/schemas/DmrClusterLinkTlsTrustedCommonNameLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DmrClusterLinkTlsTrustedCommonNamesResponse: - example: - data: - - remoteNodeName: remoteNodeName - dmrClusterName: dmrClusterName - tlsTrustedCommonName: tlsTrustedCommonName - - remoteNodeName: remoteNodeName - dmrClusterName: dmrClusterName - tlsTrustedCommonName: tlsTrustedCommonName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/DmrClusterLinkTlsTrustedCommonName' - type: array - links: - items: - $ref: '#/components/schemas/DmrClusterLinkTlsTrustedCommonNameLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DmrClusterLinks: - example: - certMatchingRulesUri: certMatchingRulesUri - linksUri: linksUri - uri: uri - properties: - certMatchingRulesUri: - description: The URI of this Cluster's collection of Certificate Matching - Rule objects. Available since 2.28. - type: string - linksUri: - description: The URI of this Cluster's collection of Link objects. - type: string - uri: - description: The URI of this Cluster object. - type: string - type: object - DmrClusterLinksResponse: - example: - data: - - transportCompressedEnabled: true - remoteNodeName: remoteNodeName - clientProfileQueueDirect2MaxDepth: 5 - clientProfileQueueDirect1MaxDepth: 1 - clientProfileQueueDirect3MinMsgBurst: 9 - initiator: lexical - queueMaxDeliveredUnackedMsgsPerFlow: 1 - clientProfileQueueDirect3MaxDepth: 7 - queueMaxRedeliveryCount: 5 - transportTlsEnabled: true - enabled: true - queueDeadMsgQueue: queueDeadMsgQueue - authenticationScheme: basic - clientProfileQueueControl1MaxDepth: 0 - clientProfileQueueDirect2MinMsgBurst: 2 - queueEventSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - clientProfileQueueControl1MinMsgBurst: 6 - queueMaxMsgSpoolUsage: 4 - clientProfileTcpKeepaliveInterval: 1 - egressFlowWindowSize: 7 - clientProfileTcpCongestionWindowSize: 4 - clientProfileQueueDirect1MinMsgBurst: 5 - queueRespectTtlEnabled: true - clientProfileTcpMaxWindowSize: 6 - authenticationBasicPassword: authenticationBasicPassword - clientProfileTcpKeepaliveCount: 7 - queueMaxTtl: 9 - clientProfileTcpKeepaliveIdleTime: 1 - queueRejectMsgToSenderOnDiscardBehavior: always - dmrClusterName: dmrClusterName - clientProfileTcpMaxSegmentSize: 1 - clientProfileQueueGuaranteed1MaxDepth: 3 - clientProfileQueueGuaranteed1MinMsgBurst: 2 - span: internal - - transportCompressedEnabled: true - remoteNodeName: remoteNodeName - clientProfileQueueDirect2MaxDepth: 5 - clientProfileQueueDirect1MaxDepth: 1 - clientProfileQueueDirect3MinMsgBurst: 9 - initiator: lexical - queueMaxDeliveredUnackedMsgsPerFlow: 1 - clientProfileQueueDirect3MaxDepth: 7 - queueMaxRedeliveryCount: 5 - transportTlsEnabled: true - enabled: true - queueDeadMsgQueue: queueDeadMsgQueue - authenticationScheme: basic - clientProfileQueueControl1MaxDepth: 0 - clientProfileQueueDirect2MinMsgBurst: 2 - queueEventSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - clientProfileQueueControl1MinMsgBurst: 6 - queueMaxMsgSpoolUsage: 4 - clientProfileTcpKeepaliveInterval: 1 - egressFlowWindowSize: 7 - clientProfileTcpCongestionWindowSize: 4 - clientProfileQueueDirect1MinMsgBurst: 5 - queueRespectTtlEnabled: true - clientProfileTcpMaxWindowSize: 6 - authenticationBasicPassword: authenticationBasicPassword - clientProfileTcpKeepaliveCount: 7 - queueMaxTtl: 9 - clientProfileTcpKeepaliveIdleTime: 1 - queueRejectMsgToSenderOnDiscardBehavior: always - dmrClusterName: dmrClusterName - clientProfileTcpMaxSegmentSize: 1 - clientProfileQueueGuaranteed1MaxDepth: 3 - clientProfileQueueGuaranteed1MinMsgBurst: 2 - span: internal - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - remoteAddressesUri: remoteAddressesUri - attributesUri: attributesUri - uri: uri - tlsTrustedCommonNamesUri: tlsTrustedCommonNamesUri - - remoteAddressesUri: remoteAddressesUri - attributesUri: attributesUri - uri: uri - tlsTrustedCommonNamesUri: tlsTrustedCommonNamesUri - properties: - data: - items: - $ref: '#/components/schemas/DmrClusterLink' - type: array - links: - items: - $ref: '#/components/schemas/DmrClusterLinkLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DmrClusterResponse: - example: - data: - nodeName: nodeName - directOnlyEnabled: true - authenticationBasicPassword: authenticationBasicPassword - enabled: true - authenticationClientCertPassword: authenticationClientCertPassword - tlsServerCertValidateNameEnabled: true - tlsServerCertMaxChainDepth: 0 - authenticationClientCertEnabled: true - dmrClusterName: dmrClusterName - tlsServerCertValidateDateEnabled: true - authenticationBasicEnabled: true - authenticationClientCertContent: authenticationClientCertContent - authenticationBasicType: internal - tlsServerCertEnforceTrustedCommonNameEnabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - certMatchingRulesUri: certMatchingRulesUri - linksUri: linksUri - uri: uri - properties: - data: - $ref: '#/components/schemas/DmrCluster' - links: - $ref: '#/components/schemas/DmrClusterLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DmrClustersResponse: - example: - data: - - nodeName: nodeName - directOnlyEnabled: true - authenticationBasicPassword: authenticationBasicPassword - enabled: true - authenticationClientCertPassword: authenticationClientCertPassword - tlsServerCertValidateNameEnabled: true - tlsServerCertMaxChainDepth: 0 - authenticationClientCertEnabled: true - dmrClusterName: dmrClusterName - tlsServerCertValidateDateEnabled: true - authenticationBasicEnabled: true - authenticationClientCertContent: authenticationClientCertContent - authenticationBasicType: internal - tlsServerCertEnforceTrustedCommonNameEnabled: true - - nodeName: nodeName - directOnlyEnabled: true - authenticationBasicPassword: authenticationBasicPassword - enabled: true - authenticationClientCertPassword: authenticationClientCertPassword - tlsServerCertValidateNameEnabled: true - tlsServerCertMaxChainDepth: 0 - authenticationClientCertEnabled: true - dmrClusterName: dmrClusterName - tlsServerCertValidateDateEnabled: true - authenticationBasicEnabled: true - authenticationClientCertContent: authenticationClientCertContent - authenticationBasicType: internal - tlsServerCertEnforceTrustedCommonNameEnabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - certMatchingRulesUri: certMatchingRulesUri - linksUri: linksUri - uri: uri - - certMatchingRulesUri: certMatchingRulesUri - linksUri: linksUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/DmrCluster' - type: array - links: - items: - $ref: '#/components/schemas/DmrClusterLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DomainCertAuthoritiesResponse: - example: - data: - - certAuthorityName: certAuthorityName - certContent: certContent - - certAuthorityName: certAuthorityName - certContent: certContent - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/DomainCertAuthority' - type: array - links: - items: - $ref: '#/components/schemas/DomainCertAuthorityLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - DomainCertAuthority: - example: - certAuthorityName: certAuthorityName - certContent: certContent - properties: - certAuthorityName: - description: The name of the Certificate Authority. - type: string - certContent: - description: The PEM formatted content for the trusted root certificate - of a domain Certificate Authority. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `""`. - type: string - type: object - DomainCertAuthorityLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Domain Certificate Authority object. - type: string - type: object - DomainCertAuthorityResponse: - example: - data: - certAuthorityName: certAuthorityName - certContent: certContent - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/DomainCertAuthority' - links: - $ref: '#/components/schemas/DomainCertAuthorityLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - EventThreshold: - example: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - properties: - clearPercent: - description: The clear threshold for the value of this counter as a percentage - of its maximum value. Falling below this value will trigger a corresponding - event. This attribute may not be returned in a GET. - format: int64 - type: integer - clearValue: - description: The clear threshold for the absolute value of this counter. - Falling below this value will trigger a corresponding event. This attribute - may not be returned in a GET. - format: int64 - type: integer - setPercent: - description: The set threshold for the value of this counter as a percentage - of its maximum value. Exceeding this value will trigger a corresponding - event. This attribute may not be returned in a GET. - format: int64 - type: integer - setValue: - description: The set threshold for the absolute value of this counter. Exceeding - this value will trigger a corresponding event. This attribute may not - be returned in a GET. - format: int64 - type: integer - type: object - EventThresholdByPercent: - example: - clearPercent: 1 - setPercent: 6 - properties: - clearPercent: - description: The clear threshold for the value of this counter as a percentage - of its maximum value. Falling below this value will trigger a corresponding - event. - format: int64 - type: integer - setPercent: - description: The set threshold for the value of this counter as a percentage - of its maximum value. Exceeding this value will trigger a corresponding - event. - format: int64 - type: integer - type: object - EventThresholdByValue: - example: - setValue: 5 - clearValue: 1 - properties: - clearValue: - description: The clear threshold for the absolute value of this counter - or rate. Falling below this value will trigger a corresponding event. - format: int64 - type: integer - setValue: - description: The set threshold for the absolute value of this counter or - rate. Exceeding this value will trigger a corresponding event. - format: int64 - type: integer - type: object - MsgVpn: - example: - serviceMqttMaxConnectionCount: 6 - authorizationProfileName: authorizationProfileName - replicationBridgeAuthenticationClientCertPassword: replicationBridgeAuthenticationClientCertPassword - replicationBridgeEgressFlowWindowSize: 6 - restTlsServerCertMaxChainDepth: 4 - serviceRestIncomingPlainTextEnabled: true - replicationEnabled: true - eventServiceWebConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - bridgingTlsServerCertValidateDateEnabled: true - authorizationType: ldap - replicationAckPropagationIntervalMsgCount: 1 - bridgingTlsServerCertMaxChainDepth: 6 - replicationBridgeCompressedDataEnabled: true - serviceAmqpPlainTextEnabled: true - bridgingTlsServerCertEnforceTrustedCommonNameEnabled: true - restTlsServerCertValidateDateEnabled: true - eventTransactedSessionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - authenticationKerberosEnabled: true - authorizationLdapGroupMembershipAttributeName: authorizationLdapGroupMembershipAttributeName - serviceRestIncomingPlainTextListenPort: 1 - authenticationClientCertUsernameSource: certificate-thumbprint - replicationBridgeAuthenticationClientCertContent: replicationBridgeAuthenticationClientCertContent - eventSubscriptionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceMqttPlainTextListenPort: 8 - authenticationClientCertMaxChainDepth: 0 - serviceMqttWebSocketEnabled: true - authorizationLdapTrimClientUsernameDomainEnabled: true - serviceRestIncomingAuthorizationHeaderHandling: drop - authenticationClientCertEnabled: true - restTlsServerCertEnforceTrustedCommonNameEnabled: true - replicationRejectMsgWhenSyncIneligibleEnabled: true - eventPublishTopicFormatSmfEnabled: true - authenticationBasicProfileName: authenticationBasicProfileName - enabled: true - replicationBridgeAuthenticationScheme: basic - serviceRestIncomingAuthenticationClientCertRequest: always - replicationBridgeUnidirectionalClientProfileName: replicationBridgeUnidirectionalClientProfileName - serviceRestIncomingMaxConnectionCount: 6 - sempOverMsgBusEnabled: true - maxTransactionCount: 1 - serviceAmqpTlsListenPort: 9 - serviceMqttTlsListenPort: 9 - eventServiceAmqpConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceRestMode: gateway - serviceRestIncomingTlsEnabled: true - authenticationKerberosAllowApiProvidedUsernameEnabled: true - sempOverMsgBusAdminDistributedCacheEnabled: true - maxSubscriptionCount: 4 - authenticationOauthEnabled: true - authenticationBasicType: internal - serviceWebMaxConnectionCount: 5 - serviceAmqpMaxConnectionCount: 5 - maxEgressFlowCount: 7 - serviceMqttWebSocketListenPort: 3 - serviceSmfPlainTextEnabled: true - maxEndpointCount: 9 - serviceWebTlsEnabled: true - serviceMqttTlsWebSocketEnabled: true - exportSubscriptionsEnabled: true - authenticationClientCertCertificateMatchingRulesEnabled: true - eventIngressMsgRateThreshold: - setValue: 5 - clearValue: 1 - eventPublishSubscriptionMode: "off" - serviceMqttTlsEnabled: true - eventConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceSmfTlsEnabled: true - eventLargeMsgThreshold: 5 - serviceRestIncomingTlsListenPort: 2 - replicationQueueRejectMsgToSenderOnDiscardEnabled: true - eventTransactionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - eventPublishMsgVpnEnabled: true - sempOverMsgBusShowEnabled: true - serviceWebPlainTextEnabled: true - dmrEnabled: true - msgVpnName: msgVpnName - eventEndpointCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - sempOverMsgBusAdminEnabled: true - eventEgressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - eventServiceRestIncomingConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - eventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceSmfMaxConnectionCount: 6 - jndiEnabled: true - restTlsServerCertValidateNameEnabled: true - serviceMqttPlainTextEnabled: true - eventPublishClientEnabled: true - replicationQueueMaxMsgSpoolUsage: 1 - eventServiceMqttConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - sempOverMsgBusAdminClientEnabled: true - tlsAllowDowngradeToPlainTextEnabled: true - maxConnectionCount: 2 - serviceWebAuthenticationClientCertRequest: always - serviceRestOutgoingMaxConnectionCount: 6 - replicationBridgeTlsEnabled: true - authenticationClientCertRevocationCheckMode: allow-all - authenticationClientCertAllowApiProvidedUsernameEnabled: true - eventServiceSmfConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceAmqpPlainTextListenPort: 9 - authenticationClientCertValidateDateEnabled: true - serviceAmqpTlsEnabled: true - eventEgressMsgRateThreshold: - setValue: 5 - clearValue: 1 - replicationTransactionMode: sync - replicationRole: active - authenticationBasicRadiusDomain: authenticationBasicRadiusDomain - replicationEnabledQueueBehavior: fail-on-existing-queue - replicationBridgeRetryDelay: 7 - eventLogTag: eventLogTag - distributedCacheManagementEnabled: true - alias: alias - authenticationOauthDefaultProfileName: authenticationOauthDefaultProfileName - serviceMqttTlsWebSocketListenPort: 6 - replicationBridgeAuthenticationBasicClientUsername: replicationBridgeAuthenticationBasicClientUsername - bridgingTlsServerCertValidateNameEnabled: true - replicationBridgeAuthenticationBasicPassword: replicationBridgeAuthenticationBasicPassword - maxIngressFlowCount: 3 - serviceMqttAuthenticationClientCertRequest: always - maxTransactedSessionCount: 7 - mqttRetainMaxMemory: 1 - eventPublishTopicFormatMqttEnabled: true - authenticationBasicEnabled: true - maxMsgSpoolUsage: 2 - authenticationOauthDefaultProviderName: authenticationOauthDefaultProviderName - eventIngressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - properties: - alias: - description: |- - The name of another Message VPN which this Message VPN is an alias for. When this Message VPN is enabled, the alias has no effect. When this Message VPN is disabled, Clients (but not Bridges and routing Links) logging into this Message VPN are automatically logged in to the other Message VPN, and authentication and authorization take place in the context of the other Message VPN. - - Aliases may form a non-circular chain, cascading one to the next. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. Available since 2.14. - type: string - authenticationBasicEnabled: - description: "Enable or disable basic authentication for clients connecting\ - \ to the Message VPN. Basic authentication is authentication that involves\ - \ the use of a username and password to prove identity. If a user provides\ - \ credentials for a different authentication scheme, this setting is not\ - \ applicable. Changes to this attribute are synchronized to HA mates and\ - \ replication sites via config-sync. The default value is `true`." - type: boolean - authenticationBasicProfileName: - description: The name of the RADIUS or LDAP Profile to use for basic authentication. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `"default"`. - type: string - authenticationBasicRadiusDomain: - description: The RADIUS domain to use for basic authentication. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `""`. - type: string - authenticationBasicType: - description: | - The type of basic authentication to use for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"radius"`. The allowed values and their meaning are: - - 
-            "internal" - Internal database. Authentication is against Client Usernames.
-            "ldap" - LDAP authentication. An LDAP profile name must be provided.
-            "radius" - RADIUS authentication. A RADIUS profile name must be provided.
-            "none" - No authentication. Anonymous login allowed.
-
- enum: - - internal - - ldap - - radius - - none - type: string - authenticationClientCertAllowApiProvidedUsernameEnabled: - description: "Enable or disable allowing a client to specify a Client Username\ - \ via the API connect method. When disabled, the certificate CN (Common\ - \ Name) is always used. Changes to this attribute are synchronized to\ - \ HA mates and replication sites via config-sync. The default value is\ - \ `false`." - type: boolean - authenticationClientCertCertificateMatchingRulesEnabled: - description: "Enable or disable certificate matching rules. When disabled,\ - \ any valid certificate is accepted. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `false`. Available since 2.27." - type: boolean - authenticationClientCertEnabled: - description: Enable or disable client certificate authentication in the - Message VPN. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default value is `false`. - type: boolean - authenticationClientCertMaxChainDepth: - description: The maximum depth for a client certificate chain. The depth - of a chain is defined as the number of signing CA certificates that are - present in the chain back to a trusted self-signed root CA certificate. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `3`. - format: int64 - type: integer - authenticationClientCertRevocationCheckMode: - description: |- - The desired behavior for client certificate revocation checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"allow-valid"`. The allowed values and their meaning are: - - 
-            "allow-all" - Allow the client to authenticate, the result of client certificate revocation check is ignored.
-            "allow-unknown" - Allow the client to authenticate even if the revocation status of his certificate cannot be determined.
-            "allow-valid" - Allow the client to authenticate only when the revocation check returned an explicit positive response.
-
- Available since 2.6. - enum: - - allow-all - - allow-unknown - - allow-valid - type: string - authenticationClientCertUsernameSource: - description: |- - The field from the client certificate to use as the client username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"common-name"`. The allowed values and their meaning are: - - 
-            "certificate-thumbprint" - The username is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate.
-            "common-name" - The username is extracted from the certificate's first instance of the Common Name attribute in the Subject DN.
-            "common-name-last" - The username is extracted from the certificate's last instance of the Common Name attribute in the Subject DN.
-            "subject-alternate-name-msupn" - The username is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature.
-            "uid" - The username is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN.
-            "uid-last" - The username is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN.
-
- Available since 2.6. - enum: - - certificate-thumbprint - - common-name - - common-name-last - - subject-alternate-name-msupn - - uid - - uid-last - type: string - authenticationClientCertValidateDateEnabled: - description: Enable or disable validation of the "Not Before" and "Not After" - validity dates in the client certificate. Changes to this attribute are - synchronized to HA mates and replication sites via config-sync. The default - value is `true`. - type: boolean - authenticationKerberosAllowApiProvidedUsernameEnabled: - description: "Enable or disable allowing a client to specify a Client Username\ - \ via the API connect method. When disabled, the Kerberos Principal name\ - \ is always used. Changes to this attribute are synchronized to HA mates\ - \ and replication sites via config-sync. The default value is `false`." - type: boolean - authenticationKerberosEnabled: - description: Enable or disable Kerberos authentication in the Message VPN. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `false`. - type: boolean - authenticationOauthDefaultProfileName: - description: The name of the profile to use when the client does not supply - a profile name. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `""`. Available - since 2.25. - type: string - authenticationOauthDefaultProviderName: - description: The name of the provider to use when the client does not supply - a provider name. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `""`. Deprecated - since 2.25. authenticationOauthDefaultProviderName and authenticationOauthProviders - replaced by authenticationOauthDefaultProfileName and authenticationOauthProfiles. - type: string - authenticationOauthEnabled: - description: Enable or disable OAuth authentication. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `false`. Available since 2.13. - type: boolean - authorizationLdapGroupMembershipAttributeName: - description: The name of the attribute that is retrieved from the LDAP server - as part of the LDAP search when authorizing a client connecting to the - Message VPN. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default value is `"memberOf"`. - type: string - authorizationLdapTrimClientUsernameDomainEnabled: - description: "Enable or disable client-username domain trimming for LDAP\ - \ lookups of client connections. When enabled, the value of $CLIENT_USERNAME\ - \ (when used for searching) will be truncated at the first occurance of\ - \ the @ character. For example, if the client-username is in the form\ - \ of an email address, then the domain portion will be removed. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `false`. Available since 2.13." - type: boolean - authorizationProfileName: - description: The name of the LDAP Profile to use for client authorization. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `""`. - type: string - authorizationType: - description: | - The type of authorization to use for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"internal"`. The allowed values and their meaning are: - - 
-            "ldap" - LDAP authorization.
-            "internal" - Internal authorization.
-
- enum: - - ldap - - internal - type: string - bridgingTlsServerCertEnforceTrustedCommonNameEnabled: - description: "Enable or disable validation of the Common Name (CN) in the\ - \ server certificate from the remote broker. If enabled, the Common Name\ - \ is checked against the list of Trusted Common Names configured for the\ - \ Bridge. Common Name validation is not performed if Server Certificate\ - \ Name Validation is enabled, even if Common Name validation is enabled.\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `false`. Deprecated since\ - \ 2.18. Common Name validation has been replaced by Server Certificate\ - \ Name validation." - type: boolean - bridgingTlsServerCertMaxChainDepth: - description: The maximum depth for a server certificate chain. The depth - of a chain is defined as the number of signing CA certificates that are - present in the chain back to a trusted self-signed root CA certificate. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `3`. - format: int64 - type: integer - bridgingTlsServerCertValidateDateEnabled: - description: "Enable or disable validation of the \"Not Before\" and \"\ - Not After\" validity dates in the server certificate. When disabled, a\ - \ certificate will be accepted even if the certificate is not valid based\ - \ on these dates. Changes to this attribute are synchronized to HA mates\ - \ and replication sites via config-sync. The default value is `true`." - type: boolean - bridgingTlsServerCertValidateNameEnabled: - description: "Enable or disable the standard TLS authentication mechanism\ - \ of verifying the name used to connect to the bridge. If enabled, the\ - \ name used to connect to the bridge is checked against the names specified\ - \ in the certificate returned by the remote router. Legacy Common Name\ - \ validation is not performed if Server Certificate Name Validation is\ - \ enabled, even if Common Name validation is also enabled. Changes to\ - \ this attribute are synchronized to HA mates and replication sites via\ - \ config-sync. The default value is `true`. Available since 2.18." - type: boolean - distributedCacheManagementEnabled: - description: Enable or disable managing of cache instances over the message - bus. The default value is `true`. Deprecated since 2.28. Distributed cache - mangement is now redundancy aware and thus no longer requires administrative - intervention for operational state. - type: boolean - dmrEnabled: - description: Enable or disable Dynamic Message Routing (DMR) for the Message - VPN. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `false`. Available since 2.11. - type: boolean - enabled: - description: Enable or disable the Message VPN. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `false`. - type: boolean - eventConnectionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventEgressFlowCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventEgressMsgRateThreshold: - $ref: '#/components/schemas/EventThresholdByValue' - eventEndpointCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventIngressFlowCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventIngressMsgRateThreshold: - $ref: '#/components/schemas/EventThresholdByValue' - eventLargeMsgThreshold: - description: "The threshold, in kilobytes, after which a message is considered\ - \ to be large for the Message VPN. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `1024`." - format: int64 - type: integer - eventLogTag: - description: A prefix applied to all published Events in the Message VPN. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `""`. - type: string - eventMsgSpoolUsageThreshold: - $ref: '#/components/schemas/EventThreshold' - eventPublishClientEnabled: - description: Enable or disable Client level Event message publishing. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `false`. - type: boolean - eventPublishMsgVpnEnabled: - description: Enable or disable Message VPN level Event message publishing. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `false`. - type: boolean - eventPublishSubscriptionMode: - description: | - Subscription level Event message publishing mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"off"`. The allowed values and their meaning are: - - 
-            "off" - Disable client level event message publishing.
-            "on-with-format-v1" - Enable client level event message publishing with format v1.
-            "on-with-no-unsubscribe-events-on-disconnect-format-v1" - As "on-with-format-v1", but unsubscribe events are not generated when a client disconnects. Unsubscribe events are still raised when a client explicitly unsubscribes from its subscriptions.
-            "on-with-format-v2" - Enable client level event message publishing with format v2.
-            "on-with-no-unsubscribe-events-on-disconnect-format-v2" - As "on-with-format-v2", but unsubscribe events are not generated when a client disconnects. Unsubscribe events are still raised when a client explicitly unsubscribes from its subscriptions.
-
- enum: - - "off" - - on-with-format-v1 - - on-with-no-unsubscribe-events-on-disconnect-format-v1 - - on-with-format-v2 - - on-with-no-unsubscribe-events-on-disconnect-format-v2 - type: string - eventPublishTopicFormatMqttEnabled: - description: Enable or disable Event publish topics in MQTT format. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `false`. - type: boolean - eventPublishTopicFormatSmfEnabled: - description: Enable or disable Event publish topics in SMF format. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `true`. - type: boolean - eventServiceAmqpConnectionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventServiceMqttConnectionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventServiceRestIncomingConnectionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventServiceSmfConnectionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventServiceWebConnectionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventSubscriptionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventTransactedSessionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventTransactionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - exportSubscriptionsEnabled: - description: Enable or disable the export of subscriptions in the Message - VPN to other routers in the network over Neighbor links. Changes to this - attribute are synchronized to HA mates and replication sites via config-sync. - The default value is `false`. - type: boolean - jndiEnabled: - description: Enable or disable JNDI access for clients in the Message VPN. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `false`. Available since 2.2. - type: boolean - maxConnectionCount: - description: The maximum number of client connections to the Message VPN. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default is the maximum value supported by the - platform. - format: int64 - type: integer - maxEgressFlowCount: - description: The maximum number of transmit flows that can be created in - the Message VPN. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `1000`. - format: int64 - type: integer - maxEndpointCount: - description: The maximum number of Queues and Topic Endpoints that can be - created in the Message VPN. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `1000`. - format: int64 - type: integer - maxIngressFlowCount: - description: The maximum number of receive flows that can be created in - the Message VPN. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `1000`. - format: int64 - type: integer - maxMsgSpoolUsage: - description: "The maximum message spool usage by the Message VPN, in megabytes.\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `0`." - format: int64 - type: integer - maxSubscriptionCount: - description: "The maximum number of local client subscriptions that can\ - \ be added to the Message VPN. This limit is not enforced when a subscription\ - \ is added using a management interface, such as CLI or SEMP. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default varies by platform." - format: int64 - type: integer - maxTransactedSessionCount: - description: The maximum number of transacted sessions that can be created - in the Message VPN. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default varies by platform. - format: int64 - type: integer - maxTransactionCount: - description: The maximum number of transactions that can be created in the - Message VPN. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default varies by platform. - format: int64 - type: integer - mqttRetainMaxMemory: - description: "The maximum total memory usage of the MQTT Retain feature\ - \ for this Message VPN, in MB. If the maximum memory is reached, any arriving\ - \ retain messages that require more memory are discarded. A value of -1\ - \ indicates that the memory is bounded only by the global max memory limit.\ - \ A value of 0 prevents MQTT Retain from becoming operational. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `-1`. Available since 2.11." - format: int32 - type: integer - msgVpnName: - description: The name of the Message VPN. - type: string - replicationAckPropagationIntervalMsgCount: - description: "The acknowledgement (ACK) propagation interval for the replication\ - \ Bridge, in number of replicated messages. Changes to this attribute\ - \ are synchronized to HA mates and replication sites via config-sync.\ - \ The default value is `20`." - format: int64 - type: integer - replicationBridgeAuthenticationBasicClientUsername: - description: The Client Username the replication Bridge uses to login to - the remote Message VPN. Changes to this attribute are synchronized to - HA mates via config-sync. The default value is `""`. - type: string - replicationBridgeAuthenticationBasicPassword: - description: "The password for the Client Username. This attribute is absent\ - \ from a GET and not updated when absent in a PUT, subject to the exceptions\ - \ in note 4. Changes to this attribute are synchronized to HA mates via\ - \ config-sync. The default value is `\"\"`." - type: string - replicationBridgeAuthenticationClientCertContent: - description: "The PEM formatted content for the client certificate used\ - \ by this bridge to login to the Remote Message VPN. It must consist of\ - \ a private key and between one and three certificates comprising the\ - \ certificate trust chain. This attribute is absent from a GET and not\ - \ updated when absent in a PUT, subject to the exceptions in note 4. Changing\ - \ this attribute requires an HTTPS connection. The default value is `\"\ - \"`. Available since 2.9." - type: string - x-requires-https: true - replicationBridgeAuthenticationClientCertPassword: - description: "The password for the client certificate. This attribute is\ - \ absent from a GET and not updated when absent in a PUT, subject to the\ - \ exceptions in note 4. Changing this attribute requires an HTTPS connection.\ - \ The default value is `\"\"`. Available since 2.9." - type: string - x-requires-https: true - replicationBridgeAuthenticationScheme: - description: | - The authentication scheme for the replication Bridge in the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"basic"`. The allowed values and their meaning are: - - 
-            "basic" - Basic Authentication Scheme (via username and password).
-            "client-certificate" - Client Certificate Authentication Scheme (via certificate file or content).
-
- enum: - - basic - - client-certificate - type: string - replicationBridgeCompressedDataEnabled: - description: Enable or disable use of compression for the replication Bridge. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `false`. - type: boolean - replicationBridgeEgressFlowWindowSize: - description: "The size of the window used for guaranteed messages published\ - \ to the replication Bridge, in messages. Changes to this attribute are\ - \ synchronized to HA mates via config-sync. The default value is `255`." - format: int64 - type: integer - replicationBridgeRetryDelay: - description: The number of seconds that must pass before retrying the replication - Bridge connection. Changes to this attribute are synchronized to HA mates - via config-sync. The default value is `3`. - format: int64 - type: integer - replicationBridgeTlsEnabled: - description: Enable or disable use of encryption (TLS) for the replication - Bridge connection. Changes to this attribute are synchronized to HA mates - via config-sync. The default value is `false`. - type: boolean - replicationBridgeUnidirectionalClientProfileName: - description: The Client Profile for the unidirectional replication Bridge - in the Message VPN. It is used only for the TCP parameters. Changes to - this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `"#client-profile"`. - type: string - replicationEnabled: - description: Enable or disable replication for the Message VPN. Changes - to this attribute are synchronized to HA mates via config-sync. The default - value is `false`. - type: boolean - replicationEnabledQueueBehavior: - description: | - The behavior to take when enabling replication for the Message VPN, depending on the existence of the replication Queue. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"fail-on-existing-queue"`. The allowed values and their meaning are: - - 
-            "fail-on-existing-queue" - The data replication queue must not already exist.
-            "force-use-existing-queue" - The data replication queue must already exist. Any data messages on the Queue will be forwarded to interested applications. IMPORTANT: Before using this mode be certain that the messages are not stale or otherwise unsuitable to be forwarded. This mode can only be specified when the existing queue is configured the same as is currently specified under replication configuration otherwise the enabling of replication will fail.
-            "force-recreate-queue" - The data replication queue must already exist. Any data messages on the Queue will be discarded. IMPORTANT: Before using this mode be certain that the messages on the existing data replication queue are not needed by interested applications.
-
- enum: - - fail-on-existing-queue - - force-use-existing-queue - - force-recreate-queue - type: string - replicationQueueMaxMsgSpoolUsage: - description: "The maximum message spool usage by the replication Bridge\ - \ local Queue (quota), in megabytes. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `60000`." - format: int64 - type: integer - replicationQueueRejectMsgToSenderOnDiscardEnabled: - description: Enable or disable whether messages discarded on the replication - Bridge local Queue are rejected back to the sender. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `true`. - type: boolean - replicationRejectMsgWhenSyncIneligibleEnabled: - description: Enable or disable whether guaranteed messages published to - synchronously replicated Topics are rejected back to the sender when synchronous - replication becomes ineligible. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. - type: boolean - replicationRole: - description: | - The replication role for the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"standby"`. The allowed values and their meaning are: - - 
-            "active" - Assume the Active role in replication for the Message VPN.
-            "standby" - Assume the Standby role in replication for the Message VPN.
-
- enum: - - active - - standby - type: string - replicationTransactionMode: - description: | - The transaction replication mode for all transactions within the Message VPN. Changing this value during operation will not affect existing transactions; it is only used upon starting a transaction. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"async"`. The allowed values and their meaning are: - - 
-            "sync" - Messages are acknowledged when replicated (spooled remotely).
-            "async" - Messages are acknowledged when pending replication (spooled locally).
-
- enum: - - sync - - async - type: string - restTlsServerCertEnforceTrustedCommonNameEnabled: - description: "Enable or disable validation of the Common Name (CN) in the\ - \ server certificate from the remote REST Consumer. If enabled, the Common\ - \ Name is checked against the list of Trusted Common Names configured\ - \ for the REST Consumer. Common Name validation is not performed if Server\ - \ Certificate Name Validation is enabled, even if Common Name validation\ - \ is enabled. Changes to this attribute are synchronized to HA mates and\ - \ replication sites via config-sync. The default value is `false`. Deprecated\ - \ since 2.17. Common Name validation has been replaced by Server Certificate\ - \ Name validation." - type: boolean - restTlsServerCertMaxChainDepth: - description: The maximum depth for a REST Consumer server certificate chain. - The depth of a chain is defined as the number of signing CA certificates - that are present in the chain back to a trusted self-signed root CA certificate. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `3`. - format: int64 - type: integer - restTlsServerCertValidateDateEnabled: - description: Enable or disable validation of the "Not Before" and "Not After" - validity dates in the REST Consumer server certificate. Changes to this - attribute are synchronized to HA mates and replication sites via config-sync. - The default value is `true`. - type: boolean - restTlsServerCertValidateNameEnabled: - description: "Enable or disable the standard TLS authentication mechanism\ - \ of verifying the name used to connect to the remote REST Consumer. If\ - \ enabled, the name used to connect to the remote REST Consumer is checked\ - \ against the names specified in the certificate returned by the remote\ - \ router. Legacy Common Name validation is not performed if Server Certificate\ - \ Name Validation is enabled, even if Common Name validation is also enabled.\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `true`. Available since\ - \ 2.17." - type: boolean - sempOverMsgBusAdminClientEnabled: - description: Enable or disable "admin client" SEMP over the message bus - commands for the current Message VPN. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. - type: boolean - sempOverMsgBusAdminDistributedCacheEnabled: - description: Enable or disable "admin distributed-cache" SEMP over the message - bus commands for the current Message VPN. Changes to this attribute are - synchronized to HA mates and replication sites via config-sync. The default - value is `false`. - type: boolean - sempOverMsgBusAdminEnabled: - description: Enable or disable "admin" SEMP over the message bus commands - for the current Message VPN. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. - type: boolean - sempOverMsgBusEnabled: - description: Enable or disable SEMP over the message bus for the current - Message VPN. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default value is `true`. - type: boolean - sempOverMsgBusShowEnabled: - description: Enable or disable "show" SEMP over the message bus commands - for the current Message VPN. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. - type: boolean - serviceAmqpMaxConnectionCount: - description: The maximum number of AMQP client connections that can be simultaneously - connected to the Message VPN. This value may be higher than supported - by the platform. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default is the maximum value - supported by the platform. Available since 2.7. - format: int64 - type: integer - serviceAmqpPlainTextEnabled: - description: Enable or disable the plain-text AMQP service in the Message - VPN. Disabling causes clients connected to the corresponding listen-port - to be disconnected. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `false`. Available - since 2.7. - type: boolean - serviceAmqpPlainTextListenPort: - description: The port number for plain-text AMQP clients that connect to - the Message VPN. The port must be unique across the message backbone. - A value of 0 means that the listen-port is unassigned and cannot be enabled. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `0`. Available since 2.7. - format: int64 - type: integer - serviceAmqpTlsEnabled: - description: Enable or disable the use of encryption (TLS) for the AMQP - service in the Message VPN. Disabling causes clients currently connected - over TLS to be disconnected. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. Available since 2.7. - type: boolean - serviceAmqpTlsListenPort: - description: The port number for AMQP clients that connect to the Message - VPN over TLS. The port must be unique across the message backbone. A value - of 0 means that the listen-port is unassigned and cannot be enabled. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `0`. Available since 2.7. - format: int64 - type: integer - serviceMqttAuthenticationClientCertRequest: - description: |- - Determines when to request a client certificate from an incoming MQTT client connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"when-enabled-in-message-vpn"`. The allowed values and their meaning are: - - 
-            "always" - Always ask for a client certificate regardless of the "message-vpn > authentication > client-certificate > shutdown" configuration.
-            "never" - Never ask for a client certificate regardless of the "message-vpn > authentication > client-certificate > shutdown" configuration.
-            "when-enabled-in-message-vpn" - Only ask for a client-certificate if client certificate authentication is enabled under "message-vpn >  authentication > client-certificate > shutdown".
-
- Available since 2.21. - enum: - - always - - never - - when-enabled-in-message-vpn - type: string - serviceMqttMaxConnectionCount: - description: The maximum number of MQTT client connections that can be simultaneously - connected to the Message VPN. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default is the - maximum value supported by the platform. Available since 2.1. - format: int64 - type: integer - serviceMqttPlainTextEnabled: - description: Enable or disable the plain-text MQTT service in the Message - VPN. Disabling causes clients currently connected to be disconnected. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `false`. Available since 2.1. - type: boolean - serviceMqttPlainTextListenPort: - description: The port number for plain-text MQTT clients that connect to - the Message VPN. The port must be unique across the message backbone. - A value of 0 means that the listen-port is unassigned and cannot be enabled. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `0`. Available since 2.1. - format: int64 - type: integer - serviceMqttTlsEnabled: - description: Enable or disable the use of encryption (TLS) for the MQTT - service in the Message VPN. Disabling causes clients currently connected - over TLS to be disconnected. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. Available since 2.1. - type: boolean - serviceMqttTlsListenPort: - description: The port number for MQTT clients that connect to the Message - VPN over TLS. The port must be unique across the message backbone. A value - of 0 means that the listen-port is unassigned and cannot be enabled. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `0`. Available since 2.1. - format: int64 - type: integer - serviceMqttTlsWebSocketEnabled: - description: Enable or disable the use of encrypted WebSocket (WebSocket - over TLS) for the MQTT service in the Message VPN. Disabling causes clients - currently connected by encrypted WebSocket to be disconnected. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `false`. Available since 2.1. - type: boolean - serviceMqttTlsWebSocketListenPort: - description: The port number for MQTT clients that connect to the Message - VPN using WebSocket over TLS. The port must be unique across the message - backbone. A value of 0 means that the listen-port is unassigned and cannot - be enabled. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default value is `0`. Available - since 2.1. - format: int64 - type: integer - serviceMqttWebSocketEnabled: - description: Enable or disable the use of WebSocket for the MQTT service - in the Message VPN. Disabling causes clients currently connected by WebSocket - to be disconnected. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `false`. Available - since 2.1. - type: boolean - serviceMqttWebSocketListenPort: - description: The port number for plain-text MQTT clients that connect to - the Message VPN using WebSocket. The port must be unique across the message - backbone. A value of 0 means that the listen-port is unassigned and cannot - be enabled. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default value is `0`. Available - since 2.1. - format: int64 - type: integer - serviceRestIncomingAuthenticationClientCertRequest: - description: |- - Determines when to request a client certificate from an incoming REST Producer connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"when-enabled-in-message-vpn"`. The allowed values and their meaning are: - - 
-            "always" - Always ask for a client certificate regardless of the "message-vpn > authentication > client-certificate > shutdown" configuration.
-            "never" - Never ask for a client certificate regardless of the "message-vpn > authentication > client-certificate > shutdown" configuration.
-            "when-enabled-in-message-vpn" - Only ask for a client-certificate if client certificate authentication is enabled under "message-vpn >  authentication > client-certificate > shutdown".
-
- Available since 2.21. - enum: - - always - - never - - when-enabled-in-message-vpn - type: string - serviceRestIncomingAuthorizationHeaderHandling: - description: |- - The handling of Authorization headers for incoming REST connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"drop"`. The allowed values and their meaning are: - - 
-            "drop" - Do not attach the Authorization header to the message as a user property. This configuration is most secure.
-            "forward" - Forward the Authorization header, attaching it to the message as a user property in the same way as other headers. For best security, use the drop setting.
-            "legacy" - If the Authorization header was used for authentication to the broker, do not attach it to the message. If the Authorization header was not used for authentication to the broker, attach it to the message as a user property in the same way as other headers. For best security, use the drop setting.
-
- Available since 2.19. - enum: - - drop - - forward - - legacy - type: string - serviceRestIncomingMaxConnectionCount: - description: The maximum number of REST incoming client connections that - can be simultaneously connected to the Message VPN. This value may be - higher than supported by the platform. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default is the - maximum value supported by the platform. - format: int64 - type: integer - serviceRestIncomingPlainTextEnabled: - description: Enable or disable the plain-text REST service for incoming - clients in the Message VPN. Disabling causes clients currently connected - to be disconnected. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `false`. - type: boolean - serviceRestIncomingPlainTextListenPort: - description: The port number for incoming plain-text REST clients that connect - to the Message VPN. The port must be unique across the message backbone. - A value of 0 means that the listen-port is unassigned and cannot be enabled. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `0`. - format: int64 - type: integer - serviceRestIncomingTlsEnabled: - description: Enable or disable the use of encryption (TLS) for the REST - service for incoming clients in the Message VPN. Disabling causes clients - currently connected over TLS to be disconnected. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `false`. - type: boolean - serviceRestIncomingTlsListenPort: - description: The port number for incoming REST clients that connect to the - Message VPN over TLS. The port must be unique across the message backbone. - A value of 0 means that the listen-port is unassigned and cannot be enabled. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `0`. - format: int64 - type: integer - serviceRestMode: - description: |- - The REST service mode for incoming REST clients that connect to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"messaging"`. The allowed values and their meaning are: - - 
-            "gateway" - Act as a message gateway through which REST messages are propagated.
-            "messaging" - Act as a message broker on which REST messages are queued.
-
- Available since 2.6. - enum: - - gateway - - messaging - type: string - serviceRestOutgoingMaxConnectionCount: - description: The maximum number of REST Consumer (outgoing) client connections - that can be simultaneously connected to the Message VPN. Changes to this - attribute are synchronized to HA mates and replication sites via config-sync. - The default varies by platform. - format: int64 - type: integer - serviceSmfMaxConnectionCount: - description: The maximum number of SMF client connections that can be simultaneously - connected to the Message VPN. This value may be higher than supported - by the platform. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default varies by platform. - format: int64 - type: integer - serviceSmfPlainTextEnabled: - description: Enable or disable the plain-text SMF service in the Message - VPN. Disabling causes clients currently connected to be disconnected. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `true`. - type: boolean - serviceSmfTlsEnabled: - description: Enable or disable the use of encryption (TLS) for the SMF service - in the Message VPN. Disabling causes clients currently connected over - TLS to be disconnected. Changes to this attribute are synchronized to - HA mates and replication sites via config-sync. The default value is `true`. - type: boolean - serviceWebAuthenticationClientCertRequest: - description: |- - Determines when to request a client certificate from a Web Transport client connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"when-enabled-in-message-vpn"`. The allowed values and their meaning are: - - 
-            "always" - Always ask for a client certificate regardless of the "message-vpn > authentication > client-certificate > shutdown" configuration.
-            "never" - Never ask for a client certificate regardless of the "message-vpn > authentication > client-certificate > shutdown" configuration.
-            "when-enabled-in-message-vpn" - Only ask for a client-certificate if client certificate authentication is enabled under "message-vpn >  authentication > client-certificate > shutdown".
-
- Available since 2.21. - enum: - - always - - never - - when-enabled-in-message-vpn - type: string - serviceWebMaxConnectionCount: - description: The maximum number of Web Transport client connections that - can be simultaneously connected to the Message VPN. This value may be - higher than supported by the platform. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default is the - maximum value supported by the platform. - format: int64 - type: integer - serviceWebPlainTextEnabled: - description: Enable or disable the plain-text Web Transport service in the - Message VPN. Disabling causes clients currently connected to be disconnected. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `true`. - type: boolean - serviceWebTlsEnabled: - description: Enable or disable the use of TLS for the Web Transport service - in the Message VPN. Disabling causes clients currently connected over - TLS to be disconnected. Changes to this attribute are synchronized to - HA mates and replication sites via config-sync. The default value is `true`. - type: boolean - tlsAllowDowngradeToPlainTextEnabled: - description: Enable or disable the allowing of TLS SMF clients to downgrade - their connections to plain-text connections. Changing this will not affect - existing connections. Changes to this attribute are synchronized to HA - mates and replication sites via config-sync. The default value is `false`. - type: boolean - type: object - MsgVpnAclProfile: - example: - clientConnectDefaultAction: allow - publishTopicDefaultAction: allow - subscribeTopicDefaultAction: allow - msgVpnName: msgVpnName - aclProfileName: aclProfileName - subscribeShareNameDefaultAction: allow - properties: - aclProfileName: - description: The name of the ACL Profile. - type: string - clientConnectDefaultAction: - description: | - The default action to take when a client using the ACL Profile connects to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"disallow"`. The allowed values and their meaning are: - - 
-            "allow" - Allow client connection unless an exception is found for it.
-            "disallow" - Disallow client connection unless an exception is found for it.
-
- enum: - - allow - - disallow - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - publishTopicDefaultAction: - description: | - The default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"disallow"`. The allowed values and their meaning are: - - 
-            "allow" - Allow topic unless an exception is found for it.
-            "disallow" - Disallow topic unless an exception is found for it.
-
- enum: - - allow - - disallow - type: string - subscribeShareNameDefaultAction: - description: |- - The default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"allow"`. The allowed values and their meaning are: - - 
-            "allow" - Allow topic unless an exception is found for it.
-            "disallow" - Disallow topic unless an exception is found for it.
-
- Available since 2.14. - enum: - - allow - - disallow - type: string - subscribeTopicDefaultAction: - description: | - The default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"disallow"`. The allowed values and their meaning are: - - 
-            "allow" - Allow topic unless an exception is found for it.
-            "disallow" - Disallow topic unless an exception is found for it.
-
- enum: - - allow - - disallow - type: string - type: object - MsgVpnAclProfileClientConnectException: - example: - clientConnectExceptionAddress: clientConnectExceptionAddress - msgVpnName: msgVpnName - aclProfileName: aclProfileName - properties: - aclProfileName: - description: The name of the ACL Profile. - type: string - clientConnectExceptionAddress: - description: The IP address/netmask of the client connect exception in CIDR - form. - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - type: object - MsgVpnAclProfileClientConnectExceptionLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Client Connect Exception object. - type: string - type: object - MsgVpnAclProfileClientConnectExceptionResponse: - example: - data: - clientConnectExceptionAddress: clientConnectExceptionAddress - msgVpnName: msgVpnName - aclProfileName: aclProfileName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnAclProfileClientConnectException' - links: - $ref: '#/components/schemas/MsgVpnAclProfileClientConnectExceptionLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAclProfileClientConnectExceptionsResponse: - example: - data: - - clientConnectExceptionAddress: clientConnectExceptionAddress - msgVpnName: msgVpnName - aclProfileName: aclProfileName - - clientConnectExceptionAddress: clientConnectExceptionAddress - msgVpnName: msgVpnName - aclProfileName: aclProfileName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnAclProfileClientConnectException' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnAclProfileClientConnectExceptionLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAclProfileLinks: - example: - clientConnectExceptionsUri: clientConnectExceptionsUri - subscribeTopicExceptionsUri: subscribeTopicExceptionsUri - subscribeShareNameExceptionsUri: subscribeShareNameExceptionsUri - publishExceptionsUri: publishExceptionsUri - uri: uri - publishTopicExceptionsUri: publishTopicExceptionsUri - subscribeExceptionsUri: subscribeExceptionsUri - properties: - clientConnectExceptionsUri: - description: The URI of this ACL Profile's collection of Client Connect - Exception objects. - type: string - publishExceptionsUri: - description: The URI of this ACL Profile's collection of Publish Topic Exception - objects. Deprecated since 2.14. Replaced by publishTopicExceptions. - type: string - publishTopicExceptionsUri: - description: The URI of this ACL Profile's collection of Publish Topic Exception - objects. Available since 2.14. - type: string - subscribeExceptionsUri: - description: The URI of this ACL Profile's collection of Subscribe Topic - Exception objects. Deprecated since 2.14. Replaced by subscribeTopicExceptions. - type: string - subscribeShareNameExceptionsUri: - description: The URI of this ACL Profile's collection of Subscribe Share - Name Exception objects. Available since 2.14. - type: string - subscribeTopicExceptionsUri: - description: The URI of this ACL Profile's collection of Subscribe Topic - Exception objects. Available since 2.14. - type: string - uri: - description: The URI of this ACL Profile object. - type: string - type: object - MsgVpnAclProfilePublishException: - example: - publishExceptionTopic: publishExceptionTopic - msgVpnName: msgVpnName - aclProfileName: aclProfileName - topicSyntax: smf - properties: - aclProfileName: - description: The name of the ACL Profile. Deprecated since 2.14. Replaced - by publishTopicExceptions. - type: string - msgVpnName: - description: The name of the Message VPN. Deprecated since 2.14. Replaced - by publishTopicExceptions. - type: string - publishExceptionTopic: - description: The topic for the exception to the default action taken. May - include wildcard characters. Deprecated since 2.14. Replaced by publishTopicExceptions. - type: string - topicSyntax: - description: |- - The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are: - - 
-            "smf" - Topic uses SMF syntax.
-            "mqtt" - Topic uses MQTT syntax.
-
- Deprecated since 2.14. Replaced by publishTopicExceptions. - enum: - - smf - - mqtt - type: string - type: object - MsgVpnAclProfilePublishExceptionLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Publish Topic Exception object. - type: string - type: object - MsgVpnAclProfilePublishExceptionResponse: - example: - data: - publishExceptionTopic: publishExceptionTopic - msgVpnName: msgVpnName - aclProfileName: aclProfileName - topicSyntax: smf - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnAclProfilePublishException' - links: - $ref: '#/components/schemas/MsgVpnAclProfilePublishExceptionLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAclProfilePublishExceptionsResponse: - example: - data: - - publishExceptionTopic: publishExceptionTopic - msgVpnName: msgVpnName - aclProfileName: aclProfileName - topicSyntax: smf - - publishExceptionTopic: publishExceptionTopic - msgVpnName: msgVpnName - aclProfileName: aclProfileName - topicSyntax: smf - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnAclProfilePublishException' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnAclProfilePublishExceptionLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAclProfilePublishTopicException: - example: - publishTopicExceptionSyntax: smf - msgVpnName: msgVpnName - aclProfileName: aclProfileName - publishTopicException: publishTopicException - properties: - aclProfileName: - description: The name of the ACL Profile. - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - publishTopicException: - description: The topic for the exception to the default action taken. May - include wildcard characters. - type: string - publishTopicExceptionSyntax: - description: | - The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are: - - 
-            "smf" - Topic uses SMF syntax.
-            "mqtt" - Topic uses MQTT syntax.
-
- enum: - - smf - - mqtt - type: string - type: object - MsgVpnAclProfilePublishTopicExceptionLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Publish Topic Exception object. - type: string - type: object - MsgVpnAclProfilePublishTopicExceptionResponse: - example: - data: - publishTopicExceptionSyntax: smf - msgVpnName: msgVpnName - aclProfileName: aclProfileName - publishTopicException: publishTopicException - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnAclProfilePublishTopicException' - links: - $ref: '#/components/schemas/MsgVpnAclProfilePublishTopicExceptionLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAclProfilePublishTopicExceptionsResponse: - example: - data: - - publishTopicExceptionSyntax: smf - msgVpnName: msgVpnName - aclProfileName: aclProfileName - publishTopicException: publishTopicException - - publishTopicExceptionSyntax: smf - msgVpnName: msgVpnName - aclProfileName: aclProfileName - publishTopicException: publishTopicException - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnAclProfilePublishTopicException' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnAclProfilePublishTopicExceptionLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAclProfileResponse: - example: - data: - clientConnectDefaultAction: allow - publishTopicDefaultAction: allow - subscribeTopicDefaultAction: allow - msgVpnName: msgVpnName - aclProfileName: aclProfileName - subscribeShareNameDefaultAction: allow - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - clientConnectExceptionsUri: clientConnectExceptionsUri - subscribeTopicExceptionsUri: subscribeTopicExceptionsUri - subscribeShareNameExceptionsUri: subscribeShareNameExceptionsUri - publishExceptionsUri: publishExceptionsUri - uri: uri - publishTopicExceptionsUri: publishTopicExceptionsUri - subscribeExceptionsUri: subscribeExceptionsUri - properties: - data: - $ref: '#/components/schemas/MsgVpnAclProfile' - links: - $ref: '#/components/schemas/MsgVpnAclProfileLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAclProfileSubscribeException: - example: - msgVpnName: msgVpnName - subscribeExceptionTopic: subscribeExceptionTopic - aclProfileName: aclProfileName - topicSyntax: smf - properties: - aclProfileName: - description: The name of the ACL Profile. Deprecated since 2.14. Replaced - by subscribeTopicExceptions. - type: string - msgVpnName: - description: The name of the Message VPN. Deprecated since 2.14. Replaced - by subscribeTopicExceptions. - type: string - subscribeExceptionTopic: - description: The topic for the exception to the default action taken. May - include wildcard characters. Deprecated since 2.14. Replaced by subscribeTopicExceptions. - type: string - topicSyntax: - description: |- - The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are: - - 
-            "smf" - Topic uses SMF syntax.
-            "mqtt" - Topic uses MQTT syntax.
-
- Deprecated since 2.14. Replaced by subscribeTopicExceptions. - enum: - - smf - - mqtt - type: string - type: object - MsgVpnAclProfileSubscribeExceptionLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Subscribe Topic Exception object. - type: string - type: object - MsgVpnAclProfileSubscribeExceptionResponse: - example: - data: - msgVpnName: msgVpnName - subscribeExceptionTopic: subscribeExceptionTopic - aclProfileName: aclProfileName - topicSyntax: smf - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeException' - links: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeExceptionLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAclProfileSubscribeExceptionsResponse: - example: - data: - - msgVpnName: msgVpnName - subscribeExceptionTopic: subscribeExceptionTopic - aclProfileName: aclProfileName - topicSyntax: smf - - msgVpnName: msgVpnName - subscribeExceptionTopic: subscribeExceptionTopic - aclProfileName: aclProfileName - topicSyntax: smf - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeException' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeExceptionLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAclProfileSubscribeShareNameException: - example: - subscribeShareNameExceptionSyntax: smf - msgVpnName: msgVpnName - subscribeShareNameException: subscribeShareNameException - aclProfileName: aclProfileName - properties: - aclProfileName: - description: The name of the ACL Profile. - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - subscribeShareNameException: - description: The subscribe share name exception to the default action taken. - May include wildcard characters. - type: string - subscribeShareNameExceptionSyntax: - description: | - The syntax of the subscribe share name for the exception to the default action taken. The allowed values and their meaning are: - - 
-            "smf" - Topic uses SMF syntax.
-            "mqtt" - Topic uses MQTT syntax.
-
- enum: - - smf - - mqtt - type: string - type: object - MsgVpnAclProfileSubscribeShareNameExceptionLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Subscribe Share Name Exception object. - type: string - type: object - MsgVpnAclProfileSubscribeShareNameExceptionResponse: - example: - data: - subscribeShareNameExceptionSyntax: smf - msgVpnName: msgVpnName - subscribeShareNameException: subscribeShareNameException - aclProfileName: aclProfileName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeShareNameException' - links: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeShareNameExceptionLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAclProfileSubscribeShareNameExceptionsResponse: - example: - data: - - subscribeShareNameExceptionSyntax: smf - msgVpnName: msgVpnName - subscribeShareNameException: subscribeShareNameException - aclProfileName: aclProfileName - - subscribeShareNameExceptionSyntax: smf - msgVpnName: msgVpnName - subscribeShareNameException: subscribeShareNameException - aclProfileName: aclProfileName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeShareNameException' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeShareNameExceptionLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAclProfileSubscribeTopicException: - example: - subscribeTopicException: subscribeTopicException - subscribeTopicExceptionSyntax: smf - msgVpnName: msgVpnName - aclProfileName: aclProfileName - properties: - aclProfileName: - description: The name of the ACL Profile. - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - subscribeTopicException: - description: The topic for the exception to the default action taken. May - include wildcard characters. - type: string - subscribeTopicExceptionSyntax: - description: | - The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are: - - 
-            "smf" - Topic uses SMF syntax.
-            "mqtt" - Topic uses MQTT syntax.
-
- enum: - - smf - - mqtt - type: string - type: object - MsgVpnAclProfileSubscribeTopicExceptionLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Subscribe Topic Exception object. - type: string - type: object - MsgVpnAclProfileSubscribeTopicExceptionResponse: - example: - data: - subscribeTopicException: subscribeTopicException - subscribeTopicExceptionSyntax: smf - msgVpnName: msgVpnName - aclProfileName: aclProfileName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeTopicException' - links: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeTopicExceptionLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAclProfileSubscribeTopicExceptionsResponse: - example: - data: - - subscribeTopicException: subscribeTopicException - subscribeTopicExceptionSyntax: smf - msgVpnName: msgVpnName - aclProfileName: aclProfileName - - subscribeTopicException: subscribeTopicException - subscribeTopicExceptionSyntax: smf - msgVpnName: msgVpnName - aclProfileName: aclProfileName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeTopicException' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnAclProfileSubscribeTopicExceptionLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAclProfilesResponse: - example: - data: - - clientConnectDefaultAction: allow - publishTopicDefaultAction: allow - subscribeTopicDefaultAction: allow - msgVpnName: msgVpnName - aclProfileName: aclProfileName - subscribeShareNameDefaultAction: allow - - clientConnectDefaultAction: allow - publishTopicDefaultAction: allow - subscribeTopicDefaultAction: allow - msgVpnName: msgVpnName - aclProfileName: aclProfileName - subscribeShareNameDefaultAction: allow - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - clientConnectExceptionsUri: clientConnectExceptionsUri - subscribeTopicExceptionsUri: subscribeTopicExceptionsUri - subscribeShareNameExceptionsUri: subscribeShareNameExceptionsUri - publishExceptionsUri: publishExceptionsUri - uri: uri - publishTopicExceptionsUri: publishTopicExceptionsUri - subscribeExceptionsUri: subscribeExceptionsUri - - clientConnectExceptionsUri: clientConnectExceptionsUri - subscribeTopicExceptionsUri: subscribeTopicExceptionsUri - subscribeShareNameExceptionsUri: subscribeShareNameExceptionsUri - publishExceptionsUri: publishExceptionsUri - uri: uri - publishTopicExceptionsUri: publishTopicExceptionsUri - subscribeExceptionsUri: subscribeExceptionsUri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnAclProfile' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnAclProfileLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAuthenticationOauthProfile: - example: - resourceServerValidateIssuerEnabled: true - endpointUserinfoTimeout: 5 - resourceServerRequiredType: resourceServerRequiredType - enabled: true - issuer: issuer - endpointDiscoveryRefreshInterval: 0 - endpointIntrospectionTimeout: 6 - resourceServerRequiredScope: resourceServerRequiredScope - resourceServerValidateScopeEnabled: true - endpointJwksRefreshInterval: 1 - resourceServerRequiredIssuer: resourceServerRequiredIssuer - authorizationGroupsClaimName: authorizationGroupsClaimName - disconnectOnTokenExpirationEnabled: true - mqttUsernameValidateEnabled: true - clientSecret: clientSecret - msgVpnName: msgVpnName - usernameClaimName: usernameClaimName - endpointUserinfo: endpointUserinfo - resourceServerRequiredAudience: resourceServerRequiredAudience - clientValidateTypeEnabled: true - clientId: clientId - oauthRole: client - resourceServerParseAccessTokenEnabled: true - resourceServerValidateTypeEnabled: true - endpointJwks: endpointJwks - resourceServerValidateAudienceEnabled: true - clientRequiredType: clientRequiredType - oauthProfileName: oauthProfileName - endpointDiscovery: endpointDiscovery - endpointIntrospection: endpointIntrospection - properties: - authorizationGroupsClaimName: - description: "The name of the groups claim. If non-empty, the specified\ - \ claim will be used to determine groups for authorization. If empty,\ - \ the authorizationType attribute of the Message VPN will be used to determine\ - \ authorization. Changes to this attribute are synchronized to HA mates\ - \ and replication sites via config-sync. The default value is `\"groups\"\ - `." - type: string - clientId: - description: The OAuth client id. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `""`. - type: string - clientRequiredType: - description: The required value for the TYP field in the ID token header. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `"JWT"`. - type: string - clientSecret: - description: "The OAuth client secret. This attribute is absent from a GET\ - \ and not updated when absent in a PUT, subject to the exceptions in note\ - \ 4. Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `\"\"`." - type: string - clientValidateTypeEnabled: - description: Enable or disable verification of the TYP field in the ID token - header. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `true`. - type: boolean - disconnectOnTokenExpirationEnabled: - description: "Enable or disable the disconnection of clients when their\ - \ tokens expire. Changing this value does not affect existing clients,\ - \ only new client connections. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `true`." - type: boolean - enabled: - description: Enable or disable the OAuth profile. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `false`. - type: boolean - endpointDiscovery: - description: The OpenID Connect discovery endpoint or OAuth Authorization - Server Metadata endpoint. Changes to this attribute are synchronized to - HA mates and replication sites via config-sync. The default value is `""`. - type: string - endpointDiscoveryRefreshInterval: - description: The number of seconds between discovery endpoint requests. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `86400`. - format: int32 - type: integer - endpointIntrospection: - description: The OAuth introspection endpoint. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `""`. - type: string - endpointIntrospectionTimeout: - description: The maximum time in seconds a token introspection request is - allowed to take. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `1`. - format: int32 - type: integer - endpointJwks: - description: The OAuth JWKS endpoint. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `""`. - type: string - endpointJwksRefreshInterval: - description: The number of seconds between JWKS endpoint requests. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `86400`. - format: int32 - type: integer - endpointUserinfo: - description: The OpenID Connect Userinfo endpoint. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `""`. - type: string - endpointUserinfoTimeout: - description: The maximum time in seconds a userinfo request is allowed to - take. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `1`. - format: int32 - type: integer - issuer: - description: The Issuer Identifier for the OAuth provider. Changes to this - attribute are synchronized to HA mates and replication sites via config-sync. - The default value is `""`. - type: string - mqttUsernameValidateEnabled: - description: "Enable or disable whether the API provided MQTT client username\ - \ will be validated against the username calculated from the token(s).\ - \ When enabled, connection attempts by MQTT clients are rejected if they\ - \ differ. Note that this value only applies to MQTT clients; SMF client\ - \ usernames will not be validated. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `false`." - type: boolean - msgVpnName: - description: The name of the Message VPN. - type: string - oauthProfileName: - description: The name of the OAuth profile. - type: string - oauthRole: - description: | - The OAuth role of the broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"client"`. The allowed values and their meaning are: - - 
-            "client" - The broker is in the OAuth client role.
-            "resource-server" - The broker is in the OAuth resource server role.
-
- enum: - - client - - resource-server - type: string - resourceServerParseAccessTokenEnabled: - description: Enable or disable parsing of the access token as a JWT. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `true`. - type: boolean - resourceServerRequiredAudience: - description: The required audience value. Changes to this attribute are - synchronized to HA mates and replication sites via config-sync. The default - value is `""`. - type: string - resourceServerRequiredIssuer: - description: The required issuer value. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `""`. - type: string - resourceServerRequiredScope: - description: A space-separated list of scopes that must be present in the - scope claim. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default value is `""`. - type: string - resourceServerRequiredType: - description: The required TYP value. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `"at+jwt"`. - type: string - resourceServerValidateAudienceEnabled: - description: Enable or disable verification of the audience claim in the - access token or introspection response. Changes to this attribute are - synchronized to HA mates and replication sites via config-sync. The default - value is `true`. - type: boolean - resourceServerValidateIssuerEnabled: - description: Enable or disable verification of the issuer claim in the access - token or introspection response. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `true`. - type: boolean - resourceServerValidateScopeEnabled: - description: Enable or disable verification of the scope claim in the access - token or introspection response. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `true`. - type: boolean - resourceServerValidateTypeEnabled: - description: Enable or disable verification of the TYP field in the access - token header. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default value is `true`. - type: boolean - usernameClaimName: - description: The name of the username claim. Changes to this attribute are - synchronized to HA mates and replication sites via config-sync. The default - value is `"sub"`. - type: string - type: object - MsgVpnAuthenticationOauthProfileClientRequiredClaim: - example: - clientRequiredClaimValue: clientRequiredClaimValue - oauthProfileName: oauthProfileName - clientRequiredClaimName: clientRequiredClaimName - msgVpnName: msgVpnName - properties: - clientRequiredClaimName: - description: The name of the ID token claim to verify. - type: string - clientRequiredClaimValue: - description: The required claim value. - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - oauthProfileName: - description: The name of the OAuth profile. - type: string - type: object - MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Required Claim object. - type: string - type: object - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse: - example: - data: - clientRequiredClaimValue: clientRequiredClaimValue - oauthProfileName: oauthProfileName - clientRequiredClaimName: clientRequiredClaimName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileClientRequiredClaim' - links: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse: - example: - data: - - clientRequiredClaimValue: clientRequiredClaimValue - oauthProfileName: oauthProfileName - clientRequiredClaimName: clientRequiredClaimName - msgVpnName: msgVpnName - - clientRequiredClaimValue: clientRequiredClaimValue - oauthProfileName: oauthProfileName - clientRequiredClaimName: clientRequiredClaimName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileClientRequiredClaim' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAuthenticationOauthProfileLinks: - example: - resourceServerRequiredClaimsUri: resourceServerRequiredClaimsUri - clientRequiredClaimsUri: clientRequiredClaimsUri - uri: uri - properties: - clientRequiredClaimsUri: - description: The URI of this OAuth Profile's collection of Required Claim - objects. - type: string - resourceServerRequiredClaimsUri: - description: The URI of this OAuth Profile's collection of Required Claim - objects. - type: string - uri: - description: The URI of this OAuth Profile object. - type: string - type: object - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim: - example: - resourceServerRequiredClaimValue: resourceServerRequiredClaimValue - resourceServerRequiredClaimName: resourceServerRequiredClaimName - oauthProfileName: oauthProfileName - msgVpnName: msgVpnName - properties: - msgVpnName: - description: The name of the Message VPN. - type: string - oauthProfileName: - description: The name of the OAuth profile. - type: string - resourceServerRequiredClaimName: - description: The name of the access token claim to verify. - type: string - resourceServerRequiredClaimValue: - description: The required claim value. - type: string - type: object - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Required Claim object. - type: string - type: object - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse: - example: - data: - resourceServerRequiredClaimValue: resourceServerRequiredClaimValue - resourceServerRequiredClaimName: resourceServerRequiredClaimName - oauthProfileName: oauthProfileName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim' - links: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse: - example: - data: - - resourceServerRequiredClaimValue: resourceServerRequiredClaimValue - resourceServerRequiredClaimName: resourceServerRequiredClaimName - oauthProfileName: oauthProfileName - msgVpnName: msgVpnName - - resourceServerRequiredClaimValue: resourceServerRequiredClaimValue - resourceServerRequiredClaimName: resourceServerRequiredClaimName - oauthProfileName: oauthProfileName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAuthenticationOauthProfileResponse: - example: - data: - resourceServerValidateIssuerEnabled: true - endpointUserinfoTimeout: 5 - resourceServerRequiredType: resourceServerRequiredType - enabled: true - issuer: issuer - endpointDiscoveryRefreshInterval: 0 - endpointIntrospectionTimeout: 6 - resourceServerRequiredScope: resourceServerRequiredScope - resourceServerValidateScopeEnabled: true - endpointJwksRefreshInterval: 1 - resourceServerRequiredIssuer: resourceServerRequiredIssuer - authorizationGroupsClaimName: authorizationGroupsClaimName - disconnectOnTokenExpirationEnabled: true - mqttUsernameValidateEnabled: true - clientSecret: clientSecret - msgVpnName: msgVpnName - usernameClaimName: usernameClaimName - endpointUserinfo: endpointUserinfo - resourceServerRequiredAudience: resourceServerRequiredAudience - clientValidateTypeEnabled: true - clientId: clientId - oauthRole: client - resourceServerParseAccessTokenEnabled: true - resourceServerValidateTypeEnabled: true - endpointJwks: endpointJwks - resourceServerValidateAudienceEnabled: true - clientRequiredType: clientRequiredType - oauthProfileName: oauthProfileName - endpointDiscovery: endpointDiscovery - endpointIntrospection: endpointIntrospection - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - resourceServerRequiredClaimsUri: resourceServerRequiredClaimsUri - clientRequiredClaimsUri: clientRequiredClaimsUri - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfile' - links: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAuthenticationOauthProfilesResponse: - example: - data: - - resourceServerValidateIssuerEnabled: true - endpointUserinfoTimeout: 5 - resourceServerRequiredType: resourceServerRequiredType - enabled: true - issuer: issuer - endpointDiscoveryRefreshInterval: 0 - endpointIntrospectionTimeout: 6 - resourceServerRequiredScope: resourceServerRequiredScope - resourceServerValidateScopeEnabled: true - endpointJwksRefreshInterval: 1 - resourceServerRequiredIssuer: resourceServerRequiredIssuer - authorizationGroupsClaimName: authorizationGroupsClaimName - disconnectOnTokenExpirationEnabled: true - mqttUsernameValidateEnabled: true - clientSecret: clientSecret - msgVpnName: msgVpnName - usernameClaimName: usernameClaimName - endpointUserinfo: endpointUserinfo - resourceServerRequiredAudience: resourceServerRequiredAudience - clientValidateTypeEnabled: true - clientId: clientId - oauthRole: client - resourceServerParseAccessTokenEnabled: true - resourceServerValidateTypeEnabled: true - endpointJwks: endpointJwks - resourceServerValidateAudienceEnabled: true - clientRequiredType: clientRequiredType - oauthProfileName: oauthProfileName - endpointDiscovery: endpointDiscovery - endpointIntrospection: endpointIntrospection - - resourceServerValidateIssuerEnabled: true - endpointUserinfoTimeout: 5 - resourceServerRequiredType: resourceServerRequiredType - enabled: true - issuer: issuer - endpointDiscoveryRefreshInterval: 0 - endpointIntrospectionTimeout: 6 - resourceServerRequiredScope: resourceServerRequiredScope - resourceServerValidateScopeEnabled: true - endpointJwksRefreshInterval: 1 - resourceServerRequiredIssuer: resourceServerRequiredIssuer - authorizationGroupsClaimName: authorizationGroupsClaimName - disconnectOnTokenExpirationEnabled: true - mqttUsernameValidateEnabled: true - clientSecret: clientSecret - msgVpnName: msgVpnName - usernameClaimName: usernameClaimName - endpointUserinfo: endpointUserinfo - resourceServerRequiredAudience: resourceServerRequiredAudience - clientValidateTypeEnabled: true - clientId: clientId - oauthRole: client - resourceServerParseAccessTokenEnabled: true - resourceServerValidateTypeEnabled: true - endpointJwks: endpointJwks - resourceServerValidateAudienceEnabled: true - clientRequiredType: clientRequiredType - oauthProfileName: oauthProfileName - endpointDiscovery: endpointDiscovery - endpointIntrospection: endpointIntrospection - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - resourceServerRequiredClaimsUri: resourceServerRequiredClaimsUri - clientRequiredClaimsUri: clientRequiredClaimsUri - uri: uri - - resourceServerRequiredClaimsUri: resourceServerRequiredClaimsUri - clientRequiredClaimsUri: clientRequiredClaimsUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfile' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProfileLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAuthenticationOauthProvider: - example: - audienceValidationEnabled: true - audienceClaimValue: audienceClaimValue - usernameValidateEnabled: true - oauthProviderName: oauthProviderName - tokenIntrospectionPassword: tokenIntrospectionPassword - jwksUri: jwksUri - tokenIntrospectionTimeout: 6 - tokenIntrospectionUsername: tokenIntrospectionUsername - enabled: true - authorizationGroupClaimSource: access-token - usernameClaimSource: access-token - jwksRefreshInterval: 0 - authorizationGroupEnabled: true - tokenIgnoreTimeLimitsEnabled: true - audienceClaimSource: access-token - authorizationGroupClaimName: authorizationGroupClaimName - tokenIntrospectionUri: tokenIntrospectionUri - disconnectOnTokenExpirationEnabled: true - msgVpnName: msgVpnName - usernameClaimName: usernameClaimName - audienceClaimName: audienceClaimName - tokenIntrospectionParameterName: tokenIntrospectionParameterName - properties: - audienceClaimName: - description: "The audience claim name, indicating which part of the object\ - \ to use for determining the audience. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `\"aud\"`. Deprecated since 2.25. authenticationOauthProviders replaced\ - \ by authenticationOauthProfiles." - type: string - audienceClaimSource: - description: |- - The audience claim source, indicating where to search for the audience value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"id-token"`. The allowed values and their meaning are: - - 
-            "access-token" - The OAuth v2 access_token.
-            "id-token" - The OpenID Connect id_token.
-            "introspection" - The result of introspecting the OAuth v2 access_token.
-
- Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - enum: - - access-token - - id-token - - introspection - type: string - audienceClaimValue: - description: The required audience value for a token to be considered valid. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `""`. Deprecated since 2.25. - authenticationOauthProviders replaced by authenticationOauthProfiles. - type: string - audienceValidationEnabled: - description: Enable or disable audience validation. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `false`. Deprecated since 2.25. authenticationOauthProviders - replaced by authenticationOauthProfiles. - type: boolean - authorizationGroupClaimName: - description: "The authorization group claim name, indicating which part\ - \ of the object to use for determining the authorization group. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `\"scope\"`. Deprecated since\ - \ 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles." - type: string - authorizationGroupClaimSource: - description: |- - The authorization group claim source, indicating where to search for the authorization group name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"id-token"`. The allowed values and their meaning are: - - 
-            "access-token" - The OAuth v2 access_token.
-            "id-token" - The OpenID Connect id_token.
-            "introspection" - The result of introspecting the OAuth v2 access_token.
-
- Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - enum: - - access-token - - id-token - - introspection - type: string - authorizationGroupEnabled: - description: "Enable or disable OAuth based authorization. When enabled,\ - \ the configured authorization type for OAuth clients is overridden. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `false`. Deprecated since 2.25.\ - \ authenticationOauthProviders replaced by authenticationOauthProfiles." - type: boolean - disconnectOnTokenExpirationEnabled: - description: "Enable or disable the disconnection of clients when their\ - \ tokens expire. Changing this value does not affect existing clients,\ - \ only new client connections. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `true`. Deprecated since 2.25. authenticationOauthProviders replaced\ - \ by authenticationOauthProfiles." - type: boolean - enabled: - description: Enable or disable OAuth Provider client authentication. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders - replaced by authenticationOauthProfiles. - type: boolean - jwksRefreshInterval: - description: The number of seconds between forced JWKS public key refreshing. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `86400`. Deprecated since - 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - format: int32 - type: integer - jwksUri: - description: The URI where the OAuth provider publishes its JWKS public - keys. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `""`. Deprecated since 2.25. - authenticationOauthProviders replaced by authenticationOauthProfiles. - type: string - msgVpnName: - description: The name of the Message VPN. Deprecated since 2.25. Replaced - by authenticationOauthProfiles. - type: string - oauthProviderName: - description: The name of the OAuth Provider. Deprecated since 2.25. Replaced - by authenticationOauthProfiles. - type: string - tokenIgnoreTimeLimitsEnabled: - description: Enable or disable whether to ignore time limits and accept - tokens that are not yet valid or are no longer valid. Changes to this - attribute are synchronized to HA mates and replication sites via config-sync. - The default value is `false`. Deprecated since 2.25. authenticationOauthProviders - replaced by authenticationOauthProfiles. - type: boolean - tokenIntrospectionParameterName: - description: The parameter name used to identify the token during access - token introspection. A standards compliant OAuth introspection server - expects "token". Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `"token"`. - Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - type: string - tokenIntrospectionPassword: - description: "The password to use when logging into the token introspection\ - \ URI. This attribute is absent from a GET and not updated when absent\ - \ in a PUT, subject to the exceptions in note 4. Changes to this attribute\ - \ are synchronized to HA mates and replication sites via config-sync.\ - \ The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders\ - \ replaced by authenticationOauthProfiles." - type: string - tokenIntrospectionTimeout: - description: The maximum time in seconds a token introspection is allowed - to take. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `1`. Deprecated since 2.25. - authenticationOauthProviders replaced by authenticationOauthProfiles. - format: int32 - type: integer - tokenIntrospectionUri: - description: The token introspection URI of the OAuth authentication server. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `""`. Deprecated since 2.25. - authenticationOauthProviders replaced by authenticationOauthProfiles. - type: string - tokenIntrospectionUsername: - description: The username to use when logging into the token introspection - URI. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `""`. Deprecated since 2.25. - authenticationOauthProviders replaced by authenticationOauthProfiles. - type: string - usernameClaimName: - description: "The username claim name, indicating which part of the object\ - \ to use for determining the username. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `\"sub\"`. Deprecated since 2.25. authenticationOauthProviders replaced\ - \ by authenticationOauthProfiles." - type: string - usernameClaimSource: - description: |- - The username claim source, indicating where to search for the username value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"id-token"`. The allowed values and their meaning are: - - 
-            "access-token" - The OAuth v2 access_token.
-            "id-token" - The OpenID Connect id_token.
-            "introspection" - The result of introspecting the OAuth v2 access_token.
-
- Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - enum: - - access-token - - id-token - - introspection - type: string - usernameValidateEnabled: - description: Enable or disable whether the API provided username will be - validated against the username calculated from the token(s); the connection - attempt is rejected if they differ. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. Deprecated since 2.25. authenticationOauthProviders replaced - by authenticationOauthProfiles. - type: boolean - type: object - MsgVpnAuthenticationOauthProviderLinks: - example: - uri: uri - properties: - uri: - description: The URI of this OAuth Provider object. - type: string - type: object - MsgVpnAuthenticationOauthProviderResponse: - example: - data: - audienceValidationEnabled: true - audienceClaimValue: audienceClaimValue - usernameValidateEnabled: true - oauthProviderName: oauthProviderName - tokenIntrospectionPassword: tokenIntrospectionPassword - jwksUri: jwksUri - tokenIntrospectionTimeout: 6 - tokenIntrospectionUsername: tokenIntrospectionUsername - enabled: true - authorizationGroupClaimSource: access-token - usernameClaimSource: access-token - jwksRefreshInterval: 0 - authorizationGroupEnabled: true - tokenIgnoreTimeLimitsEnabled: true - audienceClaimSource: access-token - authorizationGroupClaimName: authorizationGroupClaimName - tokenIntrospectionUri: tokenIntrospectionUri - disconnectOnTokenExpirationEnabled: true - msgVpnName: msgVpnName - usernameClaimName: usernameClaimName - audienceClaimName: audienceClaimName - tokenIntrospectionParameterName: tokenIntrospectionParameterName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProvider' - links: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProviderLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAuthenticationOauthProvidersResponse: - example: - data: - - audienceValidationEnabled: true - audienceClaimValue: audienceClaimValue - usernameValidateEnabled: true - oauthProviderName: oauthProviderName - tokenIntrospectionPassword: tokenIntrospectionPassword - jwksUri: jwksUri - tokenIntrospectionTimeout: 6 - tokenIntrospectionUsername: tokenIntrospectionUsername - enabled: true - authorizationGroupClaimSource: access-token - usernameClaimSource: access-token - jwksRefreshInterval: 0 - authorizationGroupEnabled: true - tokenIgnoreTimeLimitsEnabled: true - audienceClaimSource: access-token - authorizationGroupClaimName: authorizationGroupClaimName - tokenIntrospectionUri: tokenIntrospectionUri - disconnectOnTokenExpirationEnabled: true - msgVpnName: msgVpnName - usernameClaimName: usernameClaimName - audienceClaimName: audienceClaimName - tokenIntrospectionParameterName: tokenIntrospectionParameterName - - audienceValidationEnabled: true - audienceClaimValue: audienceClaimValue - usernameValidateEnabled: true - oauthProviderName: oauthProviderName - tokenIntrospectionPassword: tokenIntrospectionPassword - jwksUri: jwksUri - tokenIntrospectionTimeout: 6 - tokenIntrospectionUsername: tokenIntrospectionUsername - enabled: true - authorizationGroupClaimSource: access-token - usernameClaimSource: access-token - jwksRefreshInterval: 0 - authorizationGroupEnabled: true - tokenIgnoreTimeLimitsEnabled: true - audienceClaimSource: access-token - authorizationGroupClaimName: authorizationGroupClaimName - tokenIntrospectionUri: tokenIntrospectionUri - disconnectOnTokenExpirationEnabled: true - msgVpnName: msgVpnName - usernameClaimName: usernameClaimName - audienceClaimName: audienceClaimName - tokenIntrospectionParameterName: tokenIntrospectionParameterName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProvider' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnAuthenticationOauthProviderLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAuthorizationGroup: - example: - orderBeforeAuthorizationGroupName: orderBeforeAuthorizationGroupName - authorizationGroupName: authorizationGroupName - clientProfileName: clientProfileName - msgVpnName: msgVpnName - aclProfileName: aclProfileName - enabled: true - orderAfterAuthorizationGroupName: orderAfterAuthorizationGroupName - properties: - aclProfileName: - description: The ACL Profile of the Authorization Group. Changes to this - attribute are synchronized to HA mates and replication sites via config-sync. - The default value is `"default"`. - type: string - authorizationGroupName: - description: "The name of the Authorization Group. For LDAP groups, special\ - \ care is needed if the group name contains special characters such as\ - \ '#', '+', ';', '=' as the value of the group name returned from the\ - \ LDAP server might prepend those characters with '\\'. For example a\ - \ group name called 'test#,lab,com' will be returned from the LDAP server\ - \ as 'test\\#,lab,com'." - type: string - clientProfileName: - description: The Client Profile of the Authorization Group. Changes to this - attribute are synchronized to HA mates and replication sites via config-sync. - The default value is `"default"`. - type: string - enabled: - description: Enable or disable the Authorization Group in the Message VPN. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `false`. - type: boolean - msgVpnName: - description: The name of the Message VPN. - type: string - orderAfterAuthorizationGroupName: - description: "Lower the priority to be less than this group. This attribute\ - \ is absent from a GET and not updated when absent in a PUT, subject to\ - \ the exceptions in note 4. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default is not\ - \ applicable." - type: string - orderBeforeAuthorizationGroupName: - description: "Raise the priority to be greater than this group. This attribute\ - \ is absent from a GET and not updated when absent in a PUT, subject to\ - \ the exceptions in note 4. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default is not\ - \ applicable." - type: string - type: object - MsgVpnAuthorizationGroupLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Authorization Group object. - type: string - type: object - MsgVpnAuthorizationGroupResponse: - example: - data: - orderBeforeAuthorizationGroupName: orderBeforeAuthorizationGroupName - authorizationGroupName: authorizationGroupName - clientProfileName: clientProfileName - msgVpnName: msgVpnName - aclProfileName: aclProfileName - enabled: true - orderAfterAuthorizationGroupName: orderAfterAuthorizationGroupName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnAuthorizationGroup' - links: - $ref: '#/components/schemas/MsgVpnAuthorizationGroupLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnAuthorizationGroupsResponse: - example: - data: - - orderBeforeAuthorizationGroupName: orderBeforeAuthorizationGroupName - authorizationGroupName: authorizationGroupName - clientProfileName: clientProfileName - msgVpnName: msgVpnName - aclProfileName: aclProfileName - enabled: true - orderAfterAuthorizationGroupName: orderAfterAuthorizationGroupName - - orderBeforeAuthorizationGroupName: orderBeforeAuthorizationGroupName - authorizationGroupName: authorizationGroupName - clientProfileName: clientProfileName - msgVpnName: msgVpnName - aclProfileName: aclProfileName - enabled: true - orderAfterAuthorizationGroupName: orderAfterAuthorizationGroupName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnAuthorizationGroup' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnAuthorizationGroupLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnBridge: - example: - remoteAuthenticationBasicClientUsername: remoteAuthenticationBasicClientUsername - remoteAuthenticationClientCertPassword: remoteAuthenticationClientCertPassword - maxTtl: 0 - remoteDeliverToOnePriority: p1 - bridgeName: bridgeName - enabled: true - remoteAuthenticationBasicPassword: remoteAuthenticationBasicPassword - bridgeVirtualRouter: primary - remoteAuthenticationClientCertContent: remoteAuthenticationClientCertContent - remoteConnectionRetryCount: 6 - remoteConnectionRetryDelay: 1 - tlsCipherSuiteList: tlsCipherSuiteList - msgVpnName: msgVpnName - remoteAuthenticationScheme: basic - properties: - bridgeName: - description: The name of the Bridge. - type: string - bridgeVirtualRouter: - description: | - The virtual router of the Bridge. The allowed values and their meaning are: - - 
-            "primary" - The Bridge is used for the primary virtual router.
-            "backup" - The Bridge is used for the backup virtual router.
-            "auto" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role.
-
- enum: - - primary - - backup - - auto - type: string - enabled: - description: Enable or disable the Bridge. Changes to this attribute are - synchronized to HA mates and replication sites via config-sync. The default - value is `false`. - type: boolean - maxTtl: - description: The maximum time-to-live (TTL) in hops. Messages are discarded - if their TTL exceeds this value. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `8`. - format: int64 - type: integer - msgVpnName: - description: The name of the Message VPN. - type: string - remoteAuthenticationBasicClientUsername: - description: The Client Username the Bridge uses to login to the remote - Message VPN. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default value is `""`. - type: string - remoteAuthenticationBasicPassword: - description: "The password for the Client Username. This attribute is absent\ - \ from a GET and not updated when absent in a PUT, subject to the exceptions\ - \ in note 4. Changes to this attribute are synchronized to HA mates and\ - \ replication sites via config-sync. The default value is `\"\"`." - type: string - remoteAuthenticationClientCertContent: - description: "The PEM formatted content for the client certificate used\ - \ by the Bridge to login to the remote Message VPN. It must consist of\ - \ a private key and between one and three certificates comprising the\ - \ certificate trust chain. This attribute is absent from a GET and not\ - \ updated when absent in a PUT, subject to the exceptions in note 4. Changing\ - \ this attribute requires an HTTPS connection. The default value is `\"\ - \"`. Available since 2.9." - type: string - x-requires-https: true - remoteAuthenticationClientCertPassword: - description: "The password for the client certificate. This attribute is\ - \ absent from a GET and not updated when absent in a PUT, subject to the\ - \ exceptions in note 4. Changing this attribute requires an HTTPS connection.\ - \ The default value is `\"\"`. Available since 2.9." - type: string - x-requires-https: true - remoteAuthenticationScheme: - description: | - The authentication scheme for the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"basic"`. The allowed values and their meaning are: - - 
-            "basic" - Basic Authentication Scheme (via username and password).
-            "client-certificate" - Client Certificate Authentication Scheme (via certificate file or content).
-
- enum: - - basic - - client-certificate - type: string - remoteConnectionRetryCount: - description: The maximum number of retry attempts to establish a connection - to the remote Message VPN. A value of 0 means to retry forever. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `0`. - format: int64 - type: integer - remoteConnectionRetryDelay: - description: The number of seconds the broker waits for the bridge connection - to be established before attempting a new connection. Changes to this - attribute are synchronized to HA mates and replication sites via config-sync. - The default value is `3`. - format: int64 - type: integer - remoteDeliverToOnePriority: - description: | - The priority for deliver-to-one (DTO) messages transmitted from the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"p1"`. The allowed values and their meaning are: - - 
-            "p1" - The 1st or highest priority.
-            "p2" - The 2nd highest priority.
-            "p3" - The 3rd highest priority.
-            "p4" - The 4th highest priority.
-            "da" - Ignore priority and deliver always.
-
- enum: - - p1 - - p2 - - p3 - - p4 - - da - type: string - tlsCipherSuiteList: - description: The colon-separated list of cipher suites supported for TLS - connections to the remote Message VPN. The value "default" implies all - supported suites ordered from most secure to least secure. Changes to - this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `"default"`. - type: string - type: object - MsgVpnBridgeLinks: - example: - remoteMsgVpnsUri: remoteMsgVpnsUri - uri: uri - remoteSubscriptionsUri: remoteSubscriptionsUri - tlsTrustedCommonNamesUri: tlsTrustedCommonNamesUri - properties: - remoteMsgVpnsUri: - description: The URI of this Bridge's collection of Remote Message VPN objects. - type: string - remoteSubscriptionsUri: - description: The URI of this Bridge's collection of Remote Subscription - objects. - type: string - tlsTrustedCommonNamesUri: - description: The URI of this Bridge's collection of Trusted Common Name - objects. Deprecated since 2.18. Common Name validation has been replaced - by Server Certificate Name validation. - type: string - uri: - description: The URI of this Bridge object. - type: string - type: object - MsgVpnBridgeRemoteMsgVpn: - example: - egressFlowWindowSize: 6 - remoteMsgVpnLocation: remoteMsgVpnLocation - bridgeName: bridgeName - compressedDataEnabled: true - enabled: true - remoteMsgVpnName: remoteMsgVpnName - bridgeVirtualRouter: primary - password: password - remoteMsgVpnInterface: remoteMsgVpnInterface - tlsEnabled: true - clientUsername: clientUsername - connectOrder: 0 - queueBinding: queueBinding - msgVpnName: msgVpnName - unidirectionalClientProfile: unidirectionalClientProfile - properties: - bridgeName: - description: The name of the Bridge. - type: string - bridgeVirtualRouter: - description: | - The virtual router of the Bridge. The allowed values and their meaning are: - - 
-            "primary" - The Bridge is used for the primary virtual router.
-            "backup" - The Bridge is used for the backup virtual router.
-            "auto" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role.
-
- enum: - - primary - - backup - - auto - type: string - clientUsername: - description: The Client Username the Bridge uses to login to the remote - Message VPN. This per remote Message VPN value overrides the value provided - for the Bridge overall. Changes to this attribute are synchronized to - HA mates and replication sites via config-sync. The default value is `""`. - type: string - compressedDataEnabled: - description: Enable or disable data compression for the remote Message VPN - connection. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default value is `false`. - type: boolean - connectOrder: - description: "The preference given to incoming connections from remote Message\ - \ VPN hosts, from 1 (highest priority) to 4 (lowest priority). Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `4`." - format: int32 - type: integer - egressFlowWindowSize: - description: The number of outstanding guaranteed messages that can be transmitted - over the remote Message VPN connection before an acknowledgement is received. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `255`. - format: int64 - type: integer - enabled: - description: Enable or disable the remote Message VPN. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `false`. - type: boolean - msgVpnName: - description: The name of the Message VPN. - type: string - password: - description: "The password for the Client Username. This attribute is absent\ - \ from a GET and not updated when absent in a PUT, subject to the exceptions\ - \ in note 4. Changes to this attribute are synchronized to HA mates and\ - \ replication sites via config-sync. The default value is `\"\"`." - type: string - queueBinding: - description: The queue binding of the Bridge in the remote Message VPN. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `""`. - type: string - remoteMsgVpnInterface: - description: "The physical interface on the local Message VPN host for connecting\ - \ to the remote Message VPN. By default, an interface is chosen automatically\ - \ (recommended), but if specified, `remoteMsgVpnLocation` must not be\ - \ a virtual router name." - type: string - remoteMsgVpnLocation: - description: "The location of the remote Message VPN as either an FQDN with\ - \ port, IP address with port, or virtual router name (starting with \"\ - v:\")." - type: string - remoteMsgVpnName: - description: The name of the remote Message VPN. - type: string - tlsEnabled: - description: Enable or disable encryption (TLS) for the remote Message VPN - connection. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default value is `false`. - type: boolean - unidirectionalClientProfile: - description: "The Client Profile for the unidirectional Bridge of the remote\ - \ Message VPN. The Client Profile must exist in the local Message VPN,\ - \ and it is used only for the TCP parameters. Note that the default client\ - \ profile has a TCP maximum window size of 2MB. Changes to this attribute\ - \ are synchronized to HA mates and replication sites via config-sync.\ - \ The default value is `\"#client-profile\"`." - type: string - type: object - MsgVpnBridgeRemoteMsgVpnLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Remote Message VPN object. - type: string - type: object - MsgVpnBridgeRemoteMsgVpnResponse: - example: - data: - egressFlowWindowSize: 6 - remoteMsgVpnLocation: remoteMsgVpnLocation - bridgeName: bridgeName - compressedDataEnabled: true - enabled: true - remoteMsgVpnName: remoteMsgVpnName - bridgeVirtualRouter: primary - password: password - remoteMsgVpnInterface: remoteMsgVpnInterface - tlsEnabled: true - clientUsername: clientUsername - connectOrder: 0 - queueBinding: queueBinding - msgVpnName: msgVpnName - unidirectionalClientProfile: unidirectionalClientProfile - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnBridgeRemoteMsgVpn' - links: - $ref: '#/components/schemas/MsgVpnBridgeRemoteMsgVpnLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnBridgeRemoteMsgVpnsResponse: - example: - data: - - egressFlowWindowSize: 6 - remoteMsgVpnLocation: remoteMsgVpnLocation - bridgeName: bridgeName - compressedDataEnabled: true - enabled: true - remoteMsgVpnName: remoteMsgVpnName - bridgeVirtualRouter: primary - password: password - remoteMsgVpnInterface: remoteMsgVpnInterface - tlsEnabled: true - clientUsername: clientUsername - connectOrder: 0 - queueBinding: queueBinding - msgVpnName: msgVpnName - unidirectionalClientProfile: unidirectionalClientProfile - - egressFlowWindowSize: 6 - remoteMsgVpnLocation: remoteMsgVpnLocation - bridgeName: bridgeName - compressedDataEnabled: true - enabled: true - remoteMsgVpnName: remoteMsgVpnName - bridgeVirtualRouter: primary - password: password - remoteMsgVpnInterface: remoteMsgVpnInterface - tlsEnabled: true - clientUsername: clientUsername - connectOrder: 0 - queueBinding: queueBinding - msgVpnName: msgVpnName - unidirectionalClientProfile: unidirectionalClientProfile - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnBridgeRemoteMsgVpn' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnBridgeRemoteMsgVpnLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnBridgeRemoteSubscription: - example: - bridgeVirtualRouter: primary - deliverAlwaysEnabled: true - remoteSubscriptionTopic: remoteSubscriptionTopic - msgVpnName: msgVpnName - bridgeName: bridgeName - properties: - bridgeName: - description: The name of the Bridge. - type: string - bridgeVirtualRouter: - description: | - The virtual router of the Bridge. The allowed values and their meaning are: - - 
-            "primary" - The Bridge is used for the primary virtual router.
-            "backup" - The Bridge is used for the backup virtual router.
-            "auto" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role.
-
- enum: - - primary - - backup - - auto - type: string - deliverAlwaysEnabled: - description: Enable or disable deliver-always for the Bridge remote subscription - topic instead of a deliver-to-one remote priority. A given topic for the - Bridge may be deliver-to-one or deliver-always but not both. - type: boolean - msgVpnName: - description: The name of the Message VPN. - type: string - remoteSubscriptionTopic: - description: The topic of the Bridge remote subscription. - type: string - type: object - MsgVpnBridgeRemoteSubscriptionLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Remote Subscription object. - type: string - type: object - MsgVpnBridgeRemoteSubscriptionResponse: - example: - data: - bridgeVirtualRouter: primary - deliverAlwaysEnabled: true - remoteSubscriptionTopic: remoteSubscriptionTopic - msgVpnName: msgVpnName - bridgeName: bridgeName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnBridgeRemoteSubscription' - links: - $ref: '#/components/schemas/MsgVpnBridgeRemoteSubscriptionLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnBridgeRemoteSubscriptionsResponse: - example: - data: - - bridgeVirtualRouter: primary - deliverAlwaysEnabled: true - remoteSubscriptionTopic: remoteSubscriptionTopic - msgVpnName: msgVpnName - bridgeName: bridgeName - - bridgeVirtualRouter: primary - deliverAlwaysEnabled: true - remoteSubscriptionTopic: remoteSubscriptionTopic - msgVpnName: msgVpnName - bridgeName: bridgeName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnBridgeRemoteSubscription' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnBridgeRemoteSubscriptionLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnBridgeResponse: - example: - data: - remoteAuthenticationBasicClientUsername: remoteAuthenticationBasicClientUsername - remoteAuthenticationClientCertPassword: remoteAuthenticationClientCertPassword - maxTtl: 0 - remoteDeliverToOnePriority: p1 - bridgeName: bridgeName - enabled: true - remoteAuthenticationBasicPassword: remoteAuthenticationBasicPassword - bridgeVirtualRouter: primary - remoteAuthenticationClientCertContent: remoteAuthenticationClientCertContent - remoteConnectionRetryCount: 6 - remoteConnectionRetryDelay: 1 - tlsCipherSuiteList: tlsCipherSuiteList - msgVpnName: msgVpnName - remoteAuthenticationScheme: basic - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - remoteMsgVpnsUri: remoteMsgVpnsUri - uri: uri - remoteSubscriptionsUri: remoteSubscriptionsUri - tlsTrustedCommonNamesUri: tlsTrustedCommonNamesUri - properties: - data: - $ref: '#/components/schemas/MsgVpnBridge' - links: - $ref: '#/components/schemas/MsgVpnBridgeLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnBridgeTlsTrustedCommonName: - example: - bridgeVirtualRouter: primary - msgVpnName: msgVpnName - bridgeName: bridgeName - tlsTrustedCommonName: tlsTrustedCommonName - properties: - bridgeName: - description: The name of the Bridge. Deprecated since 2.18. Common Name - validation has been replaced by Server Certificate Name validation. - type: string - bridgeVirtualRouter: - description: |- - The virtual router of the Bridge. The allowed values and their meaning are: - - 
-            "primary" - The Bridge is used for the primary virtual router.
-            "backup" - The Bridge is used for the backup virtual router.
-            "auto" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role.
-
- Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - enum: - - primary - - backup - - auto - type: string - msgVpnName: - description: The name of the Message VPN. Deprecated since 2.18. Common - Name validation has been replaced by Server Certificate Name validation. - type: string - tlsTrustedCommonName: - description: The expected trusted common name of the remote certificate. - Deprecated since 2.18. Common Name validation has been replaced by Server - Certificate Name validation. - type: string - type: object - MsgVpnBridgeTlsTrustedCommonNameLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Trusted Common Name object. - type: string - type: object - MsgVpnBridgeTlsTrustedCommonNameResponse: - example: - data: - bridgeVirtualRouter: primary - msgVpnName: msgVpnName - bridgeName: bridgeName - tlsTrustedCommonName: tlsTrustedCommonName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnBridgeTlsTrustedCommonName' - links: - $ref: '#/components/schemas/MsgVpnBridgeTlsTrustedCommonNameLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnBridgeTlsTrustedCommonNamesResponse: - example: - data: - - bridgeVirtualRouter: primary - msgVpnName: msgVpnName - bridgeName: bridgeName - tlsTrustedCommonName: tlsTrustedCommonName - - bridgeVirtualRouter: primary - msgVpnName: msgVpnName - bridgeName: bridgeName - tlsTrustedCommonName: tlsTrustedCommonName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnBridgeTlsTrustedCommonName' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnBridgeTlsTrustedCommonNameLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnBridgesResponse: - example: - data: - - remoteAuthenticationBasicClientUsername: remoteAuthenticationBasicClientUsername - remoteAuthenticationClientCertPassword: remoteAuthenticationClientCertPassword - maxTtl: 0 - remoteDeliverToOnePriority: p1 - bridgeName: bridgeName - enabled: true - remoteAuthenticationBasicPassword: remoteAuthenticationBasicPassword - bridgeVirtualRouter: primary - remoteAuthenticationClientCertContent: remoteAuthenticationClientCertContent - remoteConnectionRetryCount: 6 - remoteConnectionRetryDelay: 1 - tlsCipherSuiteList: tlsCipherSuiteList - msgVpnName: msgVpnName - remoteAuthenticationScheme: basic - - remoteAuthenticationBasicClientUsername: remoteAuthenticationBasicClientUsername - remoteAuthenticationClientCertPassword: remoteAuthenticationClientCertPassword - maxTtl: 0 - remoteDeliverToOnePriority: p1 - bridgeName: bridgeName - enabled: true - remoteAuthenticationBasicPassword: remoteAuthenticationBasicPassword - bridgeVirtualRouter: primary - remoteAuthenticationClientCertContent: remoteAuthenticationClientCertContent - remoteConnectionRetryCount: 6 - remoteConnectionRetryDelay: 1 - tlsCipherSuiteList: tlsCipherSuiteList - msgVpnName: msgVpnName - remoteAuthenticationScheme: basic - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - remoteMsgVpnsUri: remoteMsgVpnsUri - uri: uri - remoteSubscriptionsUri: remoteSubscriptionsUri - tlsTrustedCommonNamesUri: tlsTrustedCommonNamesUri - - remoteMsgVpnsUri: remoteMsgVpnsUri - uri: uri - remoteSubscriptionsUri: remoteSubscriptionsUri - tlsTrustedCommonNamesUri: tlsTrustedCommonNamesUri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnBridge' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnBridgeLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnCertMatchingRule: - example: - ruleName: ruleName - msgVpnName: msgVpnName - enabled: true - properties: - enabled: - description: Enable or disable a certificate matching rule. Changes to this - attribute are synchronized to HA mates and replication sites via config-sync. - The default value is `false`. - type: boolean - msgVpnName: - description: The name of the Message VPN. - type: string - ruleName: - description: The name of the rule. - type: string - type: object - MsgVpnCertMatchingRuleAttributeFilter: - example: - attributeValue: attributeValue - filterName: filterName - ruleName: ruleName - attributeName: attributeName - msgVpnName: msgVpnName - properties: - attributeName: - description: Client Username Attribute to be tested. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `""`. - type: string - attributeValue: - description: Expected attribute value. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `""`. - type: string - filterName: - description: The name of the filter. - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - ruleName: - description: The name of the rule. - type: string - type: object - MsgVpnCertMatchingRuleAttributeFilterLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Certificate Matching Rule Attribute Filter - object. - type: string - type: object - MsgVpnCertMatchingRuleAttributeFilterResponse: - example: - data: - attributeValue: attributeValue - filterName: filterName - ruleName: ruleName - attributeName: attributeName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleAttributeFilter' - links: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleAttributeFilterLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnCertMatchingRuleAttributeFiltersResponse: - example: - data: - - attributeValue: attributeValue - filterName: filterName - ruleName: ruleName - attributeName: attributeName - msgVpnName: msgVpnName - - attributeValue: attributeValue - filterName: filterName - ruleName: ruleName - attributeName: attributeName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleAttributeFilter' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleAttributeFilterLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnCertMatchingRuleCondition: - example: - expression: expression - ruleName: ruleName - attribute: attribute - msgVpnName: msgVpnName - source: certificate-thumbprint - properties: - attribute: - description: "Client Username Attribute to be compared with certificate\ - \ content. Either an attribute or an expression must be provided on creation,\ - \ but not both. The default value is `\"\"`." - type: string - expression: - description: "Glob expression to be matched with certificate content. Either\ - \ an expression or an attribute must be provided on creation, but not\ - \ both. The default value is `\"\"`." - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - ruleName: - description: The name of the rule. - type: string - source: - description: | - Certificate field to be compared with the Attribute. The allowed values and their meaning are: - - 
-            "certificate-thumbprint" - The attribute is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate.
-            "common-name" - The attribute is extracted from the certificate's first instance of the Common Name attribute in the Subject DN.
-            "common-name-last" - The attribute is extracted from the certificate's last instance of the Common Name attribute in the Subject DN.
-            "subject-alternate-name-msupn" - The attribute is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature.
-            "uid" - The attribute is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN.
-            "uid-last" - The attribute is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN.
-            "org-unit" - The attribute is extracted from the certificate's first instance of the Org Unit attribute in the Subject DN.
-            "org-unit-last" - The attribute is extracted from the certificate's last instance of the Org Unit attribute in the Subject DN.
-            "issuer" - The attribute is extracted from the certificate's Issuer DN.
-            "subject" - The attribute is extracted from the certificate's Subject DN.
-            "serial-number" - The attribute is extracted from the certificate's Serial Number.
-            "dns-name" - The attribute is extracted from the certificate's Subject Alt Name DNSName.
-            "ip-address" - The attribute is extracted from the certificate's Subject Alt Name IPAddress.
-
- enum: - - certificate-thumbprint - - common-name - - common-name-last - - subject-alternate-name-msupn - - uid - - uid-last - - org-unit - - org-unit-last - - issuer - - subject - - serial-number - - dns-name - - ip-address - type: string - type: object - MsgVpnCertMatchingRuleConditionLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Certificate Matching Rule Condition object. - type: string - type: object - MsgVpnCertMatchingRuleConditionResponse: - example: - data: - expression: expression - ruleName: ruleName - attribute: attribute - msgVpnName: msgVpnName - source: certificate-thumbprint - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleCondition' - links: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleConditionLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnCertMatchingRuleConditionsResponse: - example: - data: - - expression: expression - ruleName: ruleName - attribute: attribute - msgVpnName: msgVpnName - source: certificate-thumbprint - - expression: expression - ruleName: ruleName - attribute: attribute - msgVpnName: msgVpnName - source: certificate-thumbprint - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleCondition' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleConditionLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnCertMatchingRuleLinks: - example: - attributeFiltersUri: attributeFiltersUri - conditionsUri: conditionsUri - uri: uri - properties: - attributeFiltersUri: - description: The URI of this Certificate Matching Rule's collection of Certificate - Matching Rule Attribute Filter objects. Available since 2.28. - type: string - conditionsUri: - description: The URI of this Certificate Matching Rule's collection of Certificate - Matching Rule Condition objects. - type: string - uri: - description: The URI of this Certificate Matching Rule object. - type: string - type: object - MsgVpnCertMatchingRuleResponse: - example: - data: - ruleName: ruleName - msgVpnName: msgVpnName - enabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - attributeFiltersUri: attributeFiltersUri - conditionsUri: conditionsUri - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnCertMatchingRule' - links: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnCertMatchingRulesResponse: - example: - data: - - ruleName: ruleName - msgVpnName: msgVpnName - enabled: true - - ruleName: ruleName - msgVpnName: msgVpnName - enabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - attributeFiltersUri: attributeFiltersUri - conditionsUri: conditionsUri - uri: uri - - attributeFiltersUri: attributeFiltersUri - conditionsUri: conditionsUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnCertMatchingRule' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnCertMatchingRuleLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnClientProfile: - example: - apiTopicEndpointManagementCopyFromOnCreateName: apiTopicEndpointManagementCopyFromOnCreateName - compressionEnabled: true - tcpMaxWindowSize: 6 - allowGuaranteedEndpointCreateDurability: all - clientProfileName: clientProfileName - eventTransactionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - tcpMaxSegmentSize: 2 - queueDirect2MaxDepth: 1 - serviceSmfMinKeepaliveEnabled: true - msgVpnName: msgVpnName - allowSharedSubscriptionsEnabled: true - eventClientProvisionedEndpointSpoolUsageThreshold: - clearPercent: 1 - setPercent: 6 - eventEgressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueDirect3MinMsgBurst: 1 - elidingDelay: 0 - eventServiceWebConnectionCountPerClientUsernameThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueControl1MinMsgBurst: 7 - serviceWebMaxPayload: 9 - serviceMinKeepaliveTimeout: 9 - eventTransactedSessionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - apiQueueManagementCopyFromOnCreateTemplateName: apiQueueManagementCopyFromOnCreateTemplateName - eventSubscriptionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - tlsAllowDowngradeToPlainTextEnabled: true - tcpKeepaliveIdleTime: 6 - maxEndpointCountPerClientUsername: 5 - queueDirect2MinMsgBurst: 6 - queueGuaranteed1MinMsgBurst: 5 - queueDirect1MaxDepth: 1 - eventServiceSmfConnectionCountPerClientUsernameThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - tcpCongestionWindowSize: 6 - eventEndpointCountPerClientUsernameThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueDirect3MaxDepth: 7 - allowBridgeConnectionsEnabled: true - allowTransactedSessionsEnabled: true - serviceSmfMaxConnectionCountPerClientUsername: 9 - allowGuaranteedMsgSendEnabled: true - queueDirect1MinMsgBurst: 1 - queueGuaranteed1MaxDepth: 4 - serviceWebInactiveTimeout: 6 - allowGuaranteedMsgReceiveEnabled: true - tcpKeepaliveCount: 3 - maxTransactionCount: 2 - apiTopicEndpointManagementCopyFromOnCreateTemplateName: apiTopicEndpointManagementCopyFromOnCreateTemplateName - maxSubscriptionCount: 9 - eventConnectionCountPerClientUsernameThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - elidingMaxTopicCount: 6 - maxMsgsPerTransaction: 7 - queueControl1MaxDepth: 4 - tcpKeepaliveInterval: 1 - elidingEnabled: true - maxIngressFlowCount: 2 - replicationAllowClientConnectWhenStandbyEnabled: true - maxEgressFlowCount: 5 - maxTransactedSessionCount: 3 - rejectMsgToSenderOnNoSubscriptionMatchEnabled: true - serviceWebMaxConnectionCountPerClientUsername: 8 - allowGuaranteedEndpointCreateEnabled: true - allowCutThroughForwardingEnabled: true - apiQueueManagementCopyFromOnCreateName: apiQueueManagementCopyFromOnCreateName - maxConnectionCountPerClientUsername: 1 - eventIngressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - properties: - allowBridgeConnectionsEnabled: - description: Enable or disable allowing Bridge clients using the Client - Profile to connect. Changing this setting does not affect existing Bridge - client connections. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `false`. - type: boolean - allowCutThroughForwardingEnabled: - description: Enable or disable allowing clients using the Client Profile - to bind to endpoints with the cut-through forwarding delivery mode. Changing - this value does not affect existing client connections. Changes to this - attribute are synchronized to HA mates and replication sites via config-sync. - The default value is `false`. Deprecated since 2.22. This attribute has - been deprecated. Please visit the Solace Product Lifecycle Policy web - page for details on deprecated features. - type: boolean - allowGuaranteedEndpointCreateDurability: - description: |- - The types of Queues and Topic Endpoints that clients using the client-profile can create. Changing this value does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"all"`. The allowed values and their meaning are: - - 
-            "all" - Client can create any type of endpoint.
-            "durable" - Client can create only durable endpoints.
-            "non-durable" - Client can create only non-durable endpoints.
-
- Available since 2.14. - enum: - - all - - durable - - non-durable - type: string - allowGuaranteedEndpointCreateEnabled: - description: Enable or disable allowing clients using the Client Profile - to create topic endponts or queues. Changing this value does not affect - existing client connections. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. - type: boolean - allowGuaranteedMsgReceiveEnabled: - description: Enable or disable allowing clients using the Client Profile - to receive guaranteed messages. Changing this setting does not affect - existing client connections. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. - type: boolean - allowGuaranteedMsgSendEnabled: - description: Enable or disable allowing clients using the Client Profile - to send guaranteed messages. Changing this setting does not affect existing - client connections. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `false`. - type: boolean - allowSharedSubscriptionsEnabled: - description: Enable or disable allowing shared subscriptions. Changing this - setting does not affect existing subscriptions. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `false`. Available since 2.11. - type: boolean - allowTransactedSessionsEnabled: - description: Enable or disable allowing clients using the Client Profile - to establish transacted sessions. Changing this setting does not affect - existing client connections. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. - type: boolean - apiQueueManagementCopyFromOnCreateName: - description: The name of a queue to copy settings from when a new queue - is created by a client using the Client Profile. The referenced queue - must exist in the Message VPN. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `""`. Deprecated since 2.14. This attribute has been replaced with `apiQueueManagementCopyFromOnCreateTemplateName`. - type: string - apiQueueManagementCopyFromOnCreateTemplateName: - description: "The name of a queue template to copy settings from when a\ - \ new queue is created by a client using the Client Profile. If the referenced\ - \ queue template does not exist, queue creation will fail when it tries\ - \ to resolve this template. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `\"\"`. Available since 2.14." - type: string - apiTopicEndpointManagementCopyFromOnCreateName: - description: The name of a topic endpoint to copy settings from when a new - topic endpoint is created by a client using the Client Profile. The referenced - topic endpoint must exist in the Message VPN. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `""`. Deprecated since 2.14. This attribute has been - replaced with `apiTopicEndpointManagementCopyFromOnCreateTemplateName`. - type: string - apiTopicEndpointManagementCopyFromOnCreateTemplateName: - description: "The name of a topic endpoint template to copy settings from\ - \ when a new topic endpoint is created by a client using the Client Profile.\ - \ If the referenced topic endpoint template does not exist, topic endpoint\ - \ creation will fail when it tries to resolve this template. Changes to\ - \ this attribute are synchronized to HA mates and replication sites via\ - \ config-sync. The default value is `\"\"`. Available since 2.14." - type: string - clientProfileName: - description: The name of the Client Profile. - type: string - compressionEnabled: - description: Enable or disable allowing clients using the Client Profile - to use compression. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `true`. Available - since 2.10. - type: boolean - elidingDelay: - description: "The amount of time to delay the delivery of messages to clients\ - \ using the Client Profile after the initial message has been delivered\ - \ (the eliding delay interval), in milliseconds. A value of 0 means there\ - \ is no delay in delivering messages to clients. Changes to this attribute\ - \ are synchronized to HA mates and replication sites via config-sync.\ - \ The default value is `0`." - format: int64 - type: integer - elidingEnabled: - description: Enable or disable message eliding for clients using the Client - Profile. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `false`. - type: boolean - elidingMaxTopicCount: - description: The maximum number of topics tracked for message eliding per - client connection using the Client Profile. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `256`. - format: int64 - type: integer - eventClientProvisionedEndpointSpoolUsageThreshold: - $ref: '#/components/schemas/EventThresholdByPercent' - eventConnectionCountPerClientUsernameThreshold: - $ref: '#/components/schemas/EventThreshold' - eventEgressFlowCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventEndpointCountPerClientUsernameThreshold: - $ref: '#/components/schemas/EventThreshold' - eventIngressFlowCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventServiceSmfConnectionCountPerClientUsernameThreshold: - $ref: '#/components/schemas/EventThreshold' - eventServiceWebConnectionCountPerClientUsernameThreshold: - $ref: '#/components/schemas/EventThreshold' - eventSubscriptionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventTransactedSessionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventTransactionCountThreshold: - $ref: '#/components/schemas/EventThreshold' - maxConnectionCountPerClientUsername: - description: The maximum number of client connections per Client Username - using the Client Profile. Changes to this attribute are synchronized to - HA mates and replication sites via config-sync. The default is the maximum - value supported by the platform. - format: int64 - type: integer - maxEgressFlowCount: - description: The maximum number of transmit flows that can be created by - one client using the Client Profile. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `1000`. - format: int64 - type: integer - maxEndpointCountPerClientUsername: - description: The maximum number of queues and topic endpoints that can be - created by clients with the same Client Username using the Client Profile. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `1000`. - format: int64 - type: integer - maxIngressFlowCount: - description: The maximum number of receive flows that can be created by - one client using the Client Profile. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `1000`. - format: int64 - type: integer - maxMsgsPerTransaction: - description: The maximum number of publisher and consumer messages combined - that is allowed within a transaction for each client associated with this - client-profile. Exceeding this limit will result in a transaction prepare - or commit failure. Changing this value during operation will not affect - existing sessions. It is only validated at transaction creation time. - Large transactions consume more resources and are more likely to require - retrieving messages from the ADB or from disk to process the transaction - prepare or commit requests. The transaction processing rate may diminish - if a large number of messages must be retrieved from the ADB or from disk. - Care should be taken to not use excessively large transactions needlessly - to avoid exceeding resource limits and to avoid reducing the overall broker - performance. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default value is `256`. Available - since 2.20. - format: int32 - type: integer - maxSubscriptionCount: - description: "The maximum number of subscriptions per client using the Client\ - \ Profile. This limit is not enforced when a client adds a subscription\ - \ to an endpoint, except for MQTT QoS 1 subscriptions. In addition, this\ - \ limit is not enforced when a subscription is added using a management\ - \ interface, such as CLI or SEMP. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default varies\ - \ by platform." - format: int64 - type: integer - maxTransactedSessionCount: - description: The maximum number of transacted sessions that can be created - by one client using the Client Profile. Changes to this attribute are - synchronized to HA mates and replication sites via config-sync. The default - value is `10`. - format: int64 - type: integer - maxTransactionCount: - description: The maximum number of transactions that can be created by one - client using the Client Profile. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default varies - by platform. - format: int64 - type: integer - msgVpnName: - description: The name of the Message VPN. - type: string - queueControl1MaxDepth: - description: "The maximum depth of the \"Control 1\" (C-1) priority queue,\ - \ in work units. Each work unit is 2048 bytes of message data. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `20000`." - format: int32 - type: integer - queueControl1MinMsgBurst: - description: "The number of messages that are always allowed entry into\ - \ the \"Control 1\" (C-1) priority queue, regardless of the `queueControl1MaxDepth`\ - \ value. Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `4`." - format: int32 - type: integer - queueDirect1MaxDepth: - description: "The maximum depth of the \"Direct 1\" (D-1) priority queue,\ - \ in work units. Each work unit is 2048 bytes of message data. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `20000`." - format: int32 - type: integer - queueDirect1MinMsgBurst: - description: "The number of messages that are always allowed entry into\ - \ the \"Direct 1\" (D-1) priority queue, regardless of the `queueDirect1MaxDepth`\ - \ value. Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `4`." - format: int32 - type: integer - queueDirect2MaxDepth: - description: "The maximum depth of the \"Direct 2\" (D-2) priority queue,\ - \ in work units. Each work unit is 2048 bytes of message data. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `20000`." - format: int32 - type: integer - queueDirect2MinMsgBurst: - description: "The number of messages that are always allowed entry into\ - \ the \"Direct 2\" (D-2) priority queue, regardless of the `queueDirect2MaxDepth`\ - \ value. Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `4`." - format: int32 - type: integer - queueDirect3MaxDepth: - description: "The maximum depth of the \"Direct 3\" (D-3) priority queue,\ - \ in work units. Each work unit is 2048 bytes of message data. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `20000`." - format: int32 - type: integer - queueDirect3MinMsgBurst: - description: "The number of messages that are always allowed entry into\ - \ the \"Direct 3\" (D-3) priority queue, regardless of the `queueDirect3MaxDepth`\ - \ value. Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `4`." - format: int32 - type: integer - queueGuaranteed1MaxDepth: - description: "The maximum depth of the \"Guaranteed 1\" (G-1) priority queue,\ - \ in work units. Each work unit is 2048 bytes of message data. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `20000`." - format: int32 - type: integer - queueGuaranteed1MinMsgBurst: - description: "The number of messages that are always allowed entry into\ - \ the \"Guaranteed 1\" (G-3) priority queue, regardless of the `queueGuaranteed1MaxDepth`\ - \ value. Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `255`." - format: int32 - type: integer - rejectMsgToSenderOnNoSubscriptionMatchEnabled: - description: Enable or disable the sending of a negative acknowledgement - (NACK) to a client using the Client Profile when discarding a guaranteed - message due to no matching subscription found. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `false`. Available since 2.2. - type: boolean - replicationAllowClientConnectWhenStandbyEnabled: - description: Enable or disable allowing clients using the Client Profile - to connect to the Message VPN when its replication state is standby. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `false`. - type: boolean - serviceMinKeepaliveTimeout: - description: The minimum client keepalive timeout which will be enforced - for client connections. Changes to this attribute are synchronized to - HA mates and replication sites via config-sync. The default value is `30`. - Available since 2.19. - format: int32 - type: integer - serviceSmfMaxConnectionCountPerClientUsername: - description: The maximum number of SMF client connections per Client Username - using the Client Profile. Changes to this attribute are synchronized to - HA mates and replication sites via config-sync. The default is the maximum - value supported by the platform. - format: int64 - type: integer - serviceSmfMinKeepaliveEnabled: - description: Enable or disable the enforcement of a minimum keepalive timeout - for SMF clients. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `false`. Available - since 2.19. - type: boolean - serviceWebInactiveTimeout: - description: "The timeout for inactive Web Transport client sessions using\ - \ the Client Profile, in seconds. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `30`." - format: int64 - type: integer - serviceWebMaxConnectionCountPerClientUsername: - description: The maximum number of Web Transport client connections per - Client Username using the Client Profile. Changes to this attribute are - synchronized to HA mates and replication sites via config-sync. The default - is the maximum value supported by the platform. - format: int64 - type: integer - serviceWebMaxPayload: - description: "The maximum Web Transport payload size before fragmentation\ - \ occurs for clients using the Client Profile, in bytes. The size of the\ - \ header is not included. Changes to this attribute are synchronized to\ - \ HA mates and replication sites via config-sync. The default value is\ - \ `1000000`." - format: int64 - type: integer - tcpCongestionWindowSize: - description: "The TCP initial congestion window size for clients using the\ - \ Client Profile, in multiples of the TCP Maximum Segment Size (MSS).\ - \ Changing the value from its default of 2 results in non-compliance with\ - \ RFC 2581. Contact support before changing this value. Changes to this\ - \ attribute are synchronized to HA mates and replication sites via config-sync.\ - \ The default value is `2`." - format: int64 - type: integer - tcpKeepaliveCount: - description: The number of TCP keepalive retransmissions to a client using - the Client Profile before declaring that it is not available. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `5`. - format: int64 - type: integer - tcpKeepaliveIdleTime: - description: "The amount of time a client connection using the Client Profile\ - \ must remain idle before TCP begins sending keepalive probes, in seconds.\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `3`." - format: int64 - type: integer - tcpKeepaliveInterval: - description: "The amount of time between TCP keepalive retransmissions to\ - \ a client using the Client Profile when no acknowledgement is received,\ - \ in seconds. Changes to this attribute are synchronized to HA mates and\ - \ replication sites via config-sync. The default value is `1`." - format: int64 - type: integer - tcpMaxSegmentSize: - description: "The TCP maximum segment size for clients using the Client\ - \ Profile, in bytes. Changes are applied to all existing connections.\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `1460`." - format: int64 - type: integer - tcpMaxWindowSize: - description: "The TCP maximum window size for clients using the Client Profile,\ - \ in kilobytes. Changes are applied to all existing connections. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `256`." - format: int64 - type: integer - tlsAllowDowngradeToPlainTextEnabled: - description: Enable or disable allowing a client using the Client Profile - to downgrade an encrypted connection to plain text. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `true`. Available since 2.8. - type: boolean - type: object - MsgVpnClientProfileLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Client Profile object. - type: string - type: object - MsgVpnClientProfileResponse: - example: - data: - apiTopicEndpointManagementCopyFromOnCreateName: apiTopicEndpointManagementCopyFromOnCreateName - compressionEnabled: true - tcpMaxWindowSize: 6 - allowGuaranteedEndpointCreateDurability: all - clientProfileName: clientProfileName - eventTransactionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - tcpMaxSegmentSize: 2 - queueDirect2MaxDepth: 1 - serviceSmfMinKeepaliveEnabled: true - msgVpnName: msgVpnName - allowSharedSubscriptionsEnabled: true - eventClientProvisionedEndpointSpoolUsageThreshold: - clearPercent: 1 - setPercent: 6 - eventEgressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueDirect3MinMsgBurst: 1 - elidingDelay: 0 - eventServiceWebConnectionCountPerClientUsernameThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueControl1MinMsgBurst: 7 - serviceWebMaxPayload: 9 - serviceMinKeepaliveTimeout: 9 - eventTransactedSessionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - apiQueueManagementCopyFromOnCreateTemplateName: apiQueueManagementCopyFromOnCreateTemplateName - eventSubscriptionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - tlsAllowDowngradeToPlainTextEnabled: true - tcpKeepaliveIdleTime: 6 - maxEndpointCountPerClientUsername: 5 - queueDirect2MinMsgBurst: 6 - queueGuaranteed1MinMsgBurst: 5 - queueDirect1MaxDepth: 1 - eventServiceSmfConnectionCountPerClientUsernameThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - tcpCongestionWindowSize: 6 - eventEndpointCountPerClientUsernameThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueDirect3MaxDepth: 7 - allowBridgeConnectionsEnabled: true - allowTransactedSessionsEnabled: true - serviceSmfMaxConnectionCountPerClientUsername: 9 - allowGuaranteedMsgSendEnabled: true - queueDirect1MinMsgBurst: 1 - queueGuaranteed1MaxDepth: 4 - serviceWebInactiveTimeout: 6 - allowGuaranteedMsgReceiveEnabled: true - tcpKeepaliveCount: 3 - maxTransactionCount: 2 - apiTopicEndpointManagementCopyFromOnCreateTemplateName: apiTopicEndpointManagementCopyFromOnCreateTemplateName - maxSubscriptionCount: 9 - eventConnectionCountPerClientUsernameThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - elidingMaxTopicCount: 6 - maxMsgsPerTransaction: 7 - queueControl1MaxDepth: 4 - tcpKeepaliveInterval: 1 - elidingEnabled: true - maxIngressFlowCount: 2 - replicationAllowClientConnectWhenStandbyEnabled: true - maxEgressFlowCount: 5 - maxTransactedSessionCount: 3 - rejectMsgToSenderOnNoSubscriptionMatchEnabled: true - serviceWebMaxConnectionCountPerClientUsername: 8 - allowGuaranteedEndpointCreateEnabled: true - allowCutThroughForwardingEnabled: true - apiQueueManagementCopyFromOnCreateName: apiQueueManagementCopyFromOnCreateName - maxConnectionCountPerClientUsername: 1 - eventIngressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnClientProfile' - links: - $ref: '#/components/schemas/MsgVpnClientProfileLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnClientProfilesResponse: - example: - data: - - apiTopicEndpointManagementCopyFromOnCreateName: apiTopicEndpointManagementCopyFromOnCreateName - compressionEnabled: true - tcpMaxWindowSize: 6 - allowGuaranteedEndpointCreateDurability: all - clientProfileName: clientProfileName - eventTransactionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - tcpMaxSegmentSize: 2 - queueDirect2MaxDepth: 1 - serviceSmfMinKeepaliveEnabled: true - msgVpnName: msgVpnName - allowSharedSubscriptionsEnabled: true - eventClientProvisionedEndpointSpoolUsageThreshold: - clearPercent: 1 - setPercent: 6 - eventEgressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueDirect3MinMsgBurst: 1 - elidingDelay: 0 - eventServiceWebConnectionCountPerClientUsernameThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueControl1MinMsgBurst: 7 - serviceWebMaxPayload: 9 - serviceMinKeepaliveTimeout: 9 - eventTransactedSessionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - apiQueueManagementCopyFromOnCreateTemplateName: apiQueueManagementCopyFromOnCreateTemplateName - eventSubscriptionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - tlsAllowDowngradeToPlainTextEnabled: true - tcpKeepaliveIdleTime: 6 - maxEndpointCountPerClientUsername: 5 - queueDirect2MinMsgBurst: 6 - queueGuaranteed1MinMsgBurst: 5 - queueDirect1MaxDepth: 1 - eventServiceSmfConnectionCountPerClientUsernameThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - tcpCongestionWindowSize: 6 - eventEndpointCountPerClientUsernameThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueDirect3MaxDepth: 7 - allowBridgeConnectionsEnabled: true - allowTransactedSessionsEnabled: true - serviceSmfMaxConnectionCountPerClientUsername: 9 - allowGuaranteedMsgSendEnabled: true - queueDirect1MinMsgBurst: 1 - queueGuaranteed1MaxDepth: 4 - serviceWebInactiveTimeout: 6 - allowGuaranteedMsgReceiveEnabled: true - tcpKeepaliveCount: 3 - maxTransactionCount: 2 - apiTopicEndpointManagementCopyFromOnCreateTemplateName: apiTopicEndpointManagementCopyFromOnCreateTemplateName - maxSubscriptionCount: 9 - eventConnectionCountPerClientUsernameThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - elidingMaxTopicCount: 6 - maxMsgsPerTransaction: 7 - queueControl1MaxDepth: 4 - tcpKeepaliveInterval: 1 - elidingEnabled: true - maxIngressFlowCount: 2 - replicationAllowClientConnectWhenStandbyEnabled: true - maxEgressFlowCount: 5 - maxTransactedSessionCount: 3 - rejectMsgToSenderOnNoSubscriptionMatchEnabled: true - serviceWebMaxConnectionCountPerClientUsername: 8 - allowGuaranteedEndpointCreateEnabled: true - allowCutThroughForwardingEnabled: true - apiQueueManagementCopyFromOnCreateName: apiQueueManagementCopyFromOnCreateName - maxConnectionCountPerClientUsername: 1 - eventIngressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - - apiTopicEndpointManagementCopyFromOnCreateName: apiTopicEndpointManagementCopyFromOnCreateName - compressionEnabled: true - tcpMaxWindowSize: 6 - allowGuaranteedEndpointCreateDurability: all - clientProfileName: clientProfileName - eventTransactionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - tcpMaxSegmentSize: 2 - queueDirect2MaxDepth: 1 - serviceSmfMinKeepaliveEnabled: true - msgVpnName: msgVpnName - allowSharedSubscriptionsEnabled: true - eventClientProvisionedEndpointSpoolUsageThreshold: - clearPercent: 1 - setPercent: 6 - eventEgressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueDirect3MinMsgBurst: 1 - elidingDelay: 0 - eventServiceWebConnectionCountPerClientUsernameThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueControl1MinMsgBurst: 7 - serviceWebMaxPayload: 9 - serviceMinKeepaliveTimeout: 9 - eventTransactedSessionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - apiQueueManagementCopyFromOnCreateTemplateName: apiQueueManagementCopyFromOnCreateTemplateName - eventSubscriptionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - tlsAllowDowngradeToPlainTextEnabled: true - tcpKeepaliveIdleTime: 6 - maxEndpointCountPerClientUsername: 5 - queueDirect2MinMsgBurst: 6 - queueGuaranteed1MinMsgBurst: 5 - queueDirect1MaxDepth: 1 - eventServiceSmfConnectionCountPerClientUsernameThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - tcpCongestionWindowSize: 6 - eventEndpointCountPerClientUsernameThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueDirect3MaxDepth: 7 - allowBridgeConnectionsEnabled: true - allowTransactedSessionsEnabled: true - serviceSmfMaxConnectionCountPerClientUsername: 9 - allowGuaranteedMsgSendEnabled: true - queueDirect1MinMsgBurst: 1 - queueGuaranteed1MaxDepth: 4 - serviceWebInactiveTimeout: 6 - allowGuaranteedMsgReceiveEnabled: true - tcpKeepaliveCount: 3 - maxTransactionCount: 2 - apiTopicEndpointManagementCopyFromOnCreateTemplateName: apiTopicEndpointManagementCopyFromOnCreateTemplateName - maxSubscriptionCount: 9 - eventConnectionCountPerClientUsernameThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - elidingMaxTopicCount: 6 - maxMsgsPerTransaction: 7 - queueControl1MaxDepth: 4 - tcpKeepaliveInterval: 1 - elidingEnabled: true - maxIngressFlowCount: 2 - replicationAllowClientConnectWhenStandbyEnabled: true - maxEgressFlowCount: 5 - maxTransactedSessionCount: 3 - rejectMsgToSenderOnNoSubscriptionMatchEnabled: true - serviceWebMaxConnectionCountPerClientUsername: 8 - allowGuaranteedEndpointCreateEnabled: true - allowCutThroughForwardingEnabled: true - apiQueueManagementCopyFromOnCreateName: apiQueueManagementCopyFromOnCreateName - maxConnectionCountPerClientUsername: 1 - eventIngressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnClientProfile' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnClientProfileLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnClientUsername: - example: - password: password - subscriptionManagerEnabled: true - clientUsername: clientUsername - clientProfileName: clientProfileName - msgVpnName: msgVpnName - guaranteedEndpointPermissionOverrideEnabled: true - aclProfileName: aclProfileName - enabled: true - properties: - aclProfileName: - description: The ACL Profile of the Client Username. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `"default"`. - type: string - clientProfileName: - description: The Client Profile of the Client Username. Changes to this - attribute are synchronized to HA mates and replication sites via config-sync. - The default value is `"default"`. - type: string - clientUsername: - description: The name of the Client Username. - type: string - enabled: - description: "Enable or disable the Client Username. When disabled, all\ - \ clients currently connected as the Client Username are disconnected.\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `false`." - type: boolean - guaranteedEndpointPermissionOverrideEnabled: - description: "Enable or disable guaranteed endpoint permission override\ - \ for the Client Username. When enabled all guaranteed endpoints may be\ - \ accessed, modified or deleted with the same permission as the owner.\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `false`." - type: boolean - msgVpnName: - description: The name of the Message VPN. - type: string - password: - description: "The password for the Client Username. This attribute is absent\ - \ from a GET and not updated when absent in a PUT, subject to the exceptions\ - \ in note 4. Changes to this attribute are synchronized to HA mates and\ - \ replication sites via config-sync. The default value is `\"\"`." - type: string - subscriptionManagerEnabled: - description: Enable or disable the subscription management capability of - the Client Username. This is the ability to manage subscriptions on behalf - of other Client Usernames. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. - type: boolean - type: object - MsgVpnClientUsernameAttribute: - example: - attributeValue: attributeValue - clientUsername: clientUsername - attributeName: attributeName - msgVpnName: msgVpnName - properties: - attributeName: - description: The name of the Attribute. - type: string - attributeValue: - description: The value of the Attribute. - type: string - clientUsername: - description: The name of the Client Username. - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - type: object - MsgVpnClientUsernameAttributeLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Client Username Attribute object. - type: string - type: object - MsgVpnClientUsernameAttributeResponse: - example: - data: - attributeValue: attributeValue - clientUsername: clientUsername - attributeName: attributeName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnClientUsernameAttribute' - links: - $ref: '#/components/schemas/MsgVpnClientUsernameAttributeLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnClientUsernameAttributesResponse: - example: - data: - - attributeValue: attributeValue - clientUsername: clientUsername - attributeName: attributeName - msgVpnName: msgVpnName - - attributeValue: attributeValue - clientUsername: clientUsername - attributeName: attributeName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnClientUsernameAttribute' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnClientUsernameAttributeLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnClientUsernameLinks: - example: - attributesUri: attributesUri - uri: uri - properties: - attributesUri: - description: The URI of this Client Username's collection of Client Username - Attribute objects. Available since 2.27. - type: string - uri: - description: The URI of this Client Username object. - type: string - type: object - MsgVpnClientUsernameResponse: - example: - data: - password: password - subscriptionManagerEnabled: true - clientUsername: clientUsername - clientProfileName: clientProfileName - msgVpnName: msgVpnName - guaranteedEndpointPermissionOverrideEnabled: true - aclProfileName: aclProfileName - enabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - attributesUri: attributesUri - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnClientUsername' - links: - $ref: '#/components/schemas/MsgVpnClientUsernameLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnClientUsernamesResponse: - example: - data: - - password: password - subscriptionManagerEnabled: true - clientUsername: clientUsername - clientProfileName: clientProfileName - msgVpnName: msgVpnName - guaranteedEndpointPermissionOverrideEnabled: true - aclProfileName: aclProfileName - enabled: true - - password: password - subscriptionManagerEnabled: true - clientUsername: clientUsername - clientProfileName: clientProfileName - msgVpnName: msgVpnName - guaranteedEndpointPermissionOverrideEnabled: true - aclProfileName: aclProfileName - enabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - attributesUri: attributesUri - uri: uri - - attributesUri: attributesUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnClientUsername' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnClientUsernameLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnDistributedCache: - example: - cacheName: cacheName - heartbeat: 0 - scheduledDeleteMsgDayList: scheduledDeleteMsgDayList - msgVpnName: msgVpnName - cacheVirtualRouter: auto - scheduledDeleteMsgTimeList: scheduledDeleteMsgTimeList - enabled: true - properties: - cacheName: - description: The name of the Distributed Cache. - type: string - cacheVirtualRouter: - description: |- - The virtual router of the Distributed Cache. The default value is `"auto"`. The allowed values and their meaning are: - - 
-            "auto" - The Distributed Cache is automatically assigned a virtual router at creation, depending on the broker's active-standby role.
-
- Available since 2.28. - enum: - - auto - type: string - enabled: - description: Enable or disable the Distributed Cache. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `false`. - type: boolean - heartbeat: - description: "The heartbeat interval, in seconds, used by the Cache Instances\ - \ to monitor connectivity with the message broker. Changes to this attribute\ - \ are synchronized to HA mates and replication sites via config-sync.\ - \ The default value is `10`." - format: int64 - type: integer - msgVpnName: - description: The name of the Message VPN. - type: string - scheduledDeleteMsgDayList: - description: "The scheduled delete message day(s), specified as \"daily\"\ - \ or a comma-separated list of days. Days must be specified as \"Sun\"\ - , \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", or \"Sat\", with no spaces,\ - \ and in sorted order from Sunday to Saturday. The empty-string (\"\"\ - ) can also be specified, indicating no schedule is configured (\"scheduledDeleteMsgTimeList\"\ - \ must also be configured to the empty-string). Changes to this attribute\ - \ are synchronized to HA mates and replication sites via config-sync.\ - \ The default value is `\"\"`." - type: string - scheduledDeleteMsgTimeList: - description: "The scheduled delete message time(s), specified as \"hourly\"\ - \ or a comma-separated list of 24-hour times in the form hh:mm, or h:mm.\ - \ There must be no spaces, and times (up to 4) must be in sorted order\ - \ from 0:00 to 23:59. The empty-string (\"\") can also be specified, indicating\ - \ no schedule is configured (\"scheduledDeleteMsgDayList\" must also be\ - \ configured to the empty-string). Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `\"\"`." - type: string - type: object - MsgVpnDistributedCacheCluster: - example: - eventRequestQueueDepthThreshold: - clearPercent: 1 - setPercent: 6 - eventResponseRateThreshold: - setValue: 5 - clearValue: 1 - msgLifetime: 7 - eventDataByteRateThreshold: - setValue: 5 - clearValue: 1 - eventDataMsgRateThreshold: - setValue: 5 - clearValue: 1 - maxMemory: 1 - maxMsgsPerTopic: 5 - deliverToOneOverrideEnabled: true - enabled: true - eventRequestRateThreshold: - setValue: 5 - clearValue: 1 - cacheName: cacheName - globalCachingEnabled: true - globalCachingHeartbeat: 0 - clusterName: clusterName - newTopicAdvertisementEnabled: true - eventMaxTopicsThreshold: - clearPercent: 1 - setPercent: 6 - msgVpnName: msgVpnName - eventMaxMemoryThreshold: - clearPercent: 1 - setPercent: 6 - maxTopicCount: 2 - globalCachingTopicLifetime: 6 - maxRequestQueueDepth: 5 - properties: - cacheName: - description: The name of the Distributed Cache. - type: string - clusterName: - description: The name of the Cache Cluster. - type: string - deliverToOneOverrideEnabled: - description: Enable or disable deliver-to-one override for the Cache Cluster. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `true`. - type: boolean - enabled: - description: Enable or disable the Cache Cluster. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `false`. - type: boolean - eventDataByteRateThreshold: - $ref: '#/components/schemas/EventThresholdByValue' - eventDataMsgRateThreshold: - $ref: '#/components/schemas/EventThresholdByValue' - eventMaxMemoryThreshold: - $ref: '#/components/schemas/EventThresholdByPercent' - eventMaxTopicsThreshold: - $ref: '#/components/schemas/EventThresholdByPercent' - eventRequestQueueDepthThreshold: - $ref: '#/components/schemas/EventThresholdByPercent' - eventRequestRateThreshold: - $ref: '#/components/schemas/EventThresholdByValue' - eventResponseRateThreshold: - $ref: '#/components/schemas/EventThresholdByValue' - globalCachingEnabled: - description: "Enable or disable global caching for the Cache Cluster. When\ - \ enabled, the Cache Instances will fetch topics from remote Home Cache\ - \ Clusters when requested, and subscribe to those topics to cache them\ - \ locally. When disabled, the Cache Instances will remove all subscriptions\ - \ and cached messages for topics from remote Home Cache Clusters. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `false`." - type: boolean - globalCachingHeartbeat: - description: "The heartbeat interval, in seconds, used by the Cache Instances\ - \ to monitor connectivity with the remote Home Cache Clusters. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `3`." - format: int64 - type: integer - globalCachingTopicLifetime: - description: "The topic lifetime, in seconds. If no client requests are\ - \ received for a given global topic over the duration of the topic lifetime,\ - \ then the Cache Instance will remove the subscription and cached messages\ - \ for that topic. A value of 0 disables aging. Changes to this attribute\ - \ are synchronized to HA mates and replication sites via config-sync.\ - \ The default value is `3600`." - format: int64 - type: integer - maxMemory: - description: "The maximum memory usage, in megabytes (MB), for each Cache\ - \ Instance in the Cache Cluster. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `2048`." - format: int64 - type: integer - maxMsgsPerTopic: - description: "The maximum number of messages per topic for each Cache Instance\ - \ in the Cache Cluster. When at the maximum, old messages are removed\ - \ as new messages arrive. Changes to this attribute are synchronized to\ - \ HA mates and replication sites via config-sync. The default value is\ - \ `1`." - format: int64 - type: integer - maxRequestQueueDepth: - description: The maximum queue depth for cache requests received by the - Cache Cluster. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `100000`. - format: int64 - type: integer - maxTopicCount: - description: The maximum number of topics for each Cache Instance in the - Cache Cluster. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `2000000`. - format: int64 - type: integer - msgLifetime: - description: "The message lifetime, in seconds. If a message remains cached\ - \ for the duration of its lifetime, the Cache Instance will remove the\ - \ message. A lifetime of 0 results in the message being retained indefinitely.\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `0`." - format: int64 - type: integer - msgVpnName: - description: The name of the Message VPN. - type: string - newTopicAdvertisementEnabled: - description: "Enable or disable the advertising, onto the message bus, of\ - \ new topics learned by each Cache Instance in the Cache Cluster. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `false`." - type: boolean - type: object - MsgVpnDistributedCacheClusterGlobalCachingHomeCluster: - example: - cacheName: cacheName - clusterName: clusterName - msgVpnName: msgVpnName - homeClusterName: homeClusterName - properties: - cacheName: - description: The name of the Distributed Cache. - type: string - clusterName: - description: The name of the Cache Cluster. - type: string - homeClusterName: - description: The name of the remote Home Cache Cluster. - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - type: object - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks: - example: - topicPrefixesUri: topicPrefixesUri - uri: uri - properties: - topicPrefixesUri: - description: The URI of this Home Cache Cluster's collection of Topic Prefix - objects. - type: string - uri: - description: The URI of this Home Cache Cluster object. - type: string - type: object - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse: - example: - data: - cacheName: cacheName - clusterName: clusterName - msgVpnName: msgVpnName - homeClusterName: homeClusterName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - topicPrefixesUri: topicPrefixesUri - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster' - links: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix: - example: - cacheName: cacheName - topicPrefix: topicPrefix - clusterName: clusterName - msgVpnName: msgVpnName - homeClusterName: homeClusterName - properties: - cacheName: - description: The name of the Distributed Cache. - type: string - clusterName: - description: The name of the Cache Cluster. - type: string - homeClusterName: - description: The name of the remote Home Cache Cluster. - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - topicPrefix: - description: A topic prefix for global topics available from the remote - Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. - type: string - type: object - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Topic Prefix object. - type: string - type: object - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse: - example: - data: - cacheName: cacheName - topicPrefix: topicPrefix - clusterName: clusterName - msgVpnName: msgVpnName - homeClusterName: homeClusterName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix' - links: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse: - example: - data: - - cacheName: cacheName - topicPrefix: topicPrefix - clusterName: clusterName - msgVpnName: msgVpnName - homeClusterName: homeClusterName - - cacheName: cacheName - topicPrefix: topicPrefix - clusterName: clusterName - msgVpnName: msgVpnName - homeClusterName: homeClusterName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse: - example: - data: - - cacheName: cacheName - clusterName: clusterName - msgVpnName: msgVpnName - homeClusterName: homeClusterName - - cacheName: cacheName - clusterName: clusterName - msgVpnName: msgVpnName - homeClusterName: homeClusterName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - topicPrefixesUri: topicPrefixesUri - uri: uri - - topicPrefixesUri: topicPrefixesUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnDistributedCacheClusterInstance: - example: - cacheName: cacheName - instanceName: instanceName - stopOnLostMsgEnabled: true - clusterName: clusterName - msgVpnName: msgVpnName - autoStartEnabled: true - enabled: true - properties: - autoStartEnabled: - description: "Enable or disable auto-start for the Cache Instance. When\ - \ enabled, the Cache Instance will automatically attempt to transition\ - \ from the Stopped operational state to Up whenever it restarts or reconnects\ - \ to the message broker. Changes to this attribute are synchronized to\ - \ HA mates and replication sites via config-sync. The default value is\ - \ `false`." - type: boolean - cacheName: - description: The name of the Distributed Cache. - type: string - clusterName: - description: The name of the Cache Cluster. - type: string - enabled: - description: Enable or disable the Cache Instance. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `false`. - type: boolean - instanceName: - description: The name of the Cache Instance. - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - stopOnLostMsgEnabled: - description: "Enable or disable stop-on-lost-message for the Cache Instance.\ - \ When enabled, the Cache Instance will transition to the stopped operational\ - \ state upon losing a message. When stopped, it cannot accept or respond\ - \ to cache requests, but continues to cache messages. Changes to this\ - \ attribute are synchronized to HA mates and replication sites via config-sync.\ - \ The default value is `true`." - type: boolean - type: object - MsgVpnDistributedCacheClusterInstanceLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Cache Instance object. - type: string - type: object - MsgVpnDistributedCacheClusterInstanceResponse: - example: - data: - cacheName: cacheName - instanceName: instanceName - stopOnLostMsgEnabled: true - clusterName: clusterName - msgVpnName: msgVpnName - autoStartEnabled: true - enabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterInstance' - links: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterInstanceLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnDistributedCacheClusterInstancesResponse: - example: - data: - - cacheName: cacheName - instanceName: instanceName - stopOnLostMsgEnabled: true - clusterName: clusterName - msgVpnName: msgVpnName - autoStartEnabled: true - enabled: true - - cacheName: cacheName - instanceName: instanceName - stopOnLostMsgEnabled: true - clusterName: clusterName - msgVpnName: msgVpnName - autoStartEnabled: true - enabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterInstance' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterInstanceLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnDistributedCacheClusterLinks: - example: - globalCachingHomeClustersUri: globalCachingHomeClustersUri - instancesUri: instancesUri - topicsUri: topicsUri - uri: uri - properties: - globalCachingHomeClustersUri: - description: The URI of this Cache Cluster's collection of Home Cache Cluster - objects. - type: string - instancesUri: - description: The URI of this Cache Cluster's collection of Cache Instance - objects. - type: string - topicsUri: - description: The URI of this Cache Cluster's collection of Topic objects. - type: string - uri: - description: The URI of this Cache Cluster object. - type: string - type: object - MsgVpnDistributedCacheClusterResponse: - example: - data: - eventRequestQueueDepthThreshold: - clearPercent: 1 - setPercent: 6 - eventResponseRateThreshold: - setValue: 5 - clearValue: 1 - msgLifetime: 7 - eventDataByteRateThreshold: - setValue: 5 - clearValue: 1 - eventDataMsgRateThreshold: - setValue: 5 - clearValue: 1 - maxMemory: 1 - maxMsgsPerTopic: 5 - deliverToOneOverrideEnabled: true - enabled: true - eventRequestRateThreshold: - setValue: 5 - clearValue: 1 - cacheName: cacheName - globalCachingEnabled: true - globalCachingHeartbeat: 0 - clusterName: clusterName - newTopicAdvertisementEnabled: true - eventMaxTopicsThreshold: - clearPercent: 1 - setPercent: 6 - msgVpnName: msgVpnName - eventMaxMemoryThreshold: - clearPercent: 1 - setPercent: 6 - maxTopicCount: 2 - globalCachingTopicLifetime: 6 - maxRequestQueueDepth: 5 - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - globalCachingHomeClustersUri: globalCachingHomeClustersUri - instancesUri: instancesUri - topicsUri: topicsUri - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnDistributedCacheCluster' - links: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnDistributedCacheClusterTopic: - example: - cacheName: cacheName - clusterName: clusterName - topic: topic - msgVpnName: msgVpnName - properties: - cacheName: - description: The name of the Distributed Cache. - type: string - clusterName: - description: The name of the Cache Cluster. - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - topic: - description: The value of the Topic in the form a/b/c. - type: string - type: object - MsgVpnDistributedCacheClusterTopicLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Topic object. - type: string - type: object - MsgVpnDistributedCacheClusterTopicResponse: - example: - data: - cacheName: cacheName - clusterName: clusterName - topic: topic - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterTopic' - links: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterTopicLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnDistributedCacheClusterTopicsResponse: - example: - data: - - cacheName: cacheName - clusterName: clusterName - topic: topic - msgVpnName: msgVpnName - - cacheName: cacheName - clusterName: clusterName - topic: topic - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterTopic' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterTopicLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnDistributedCacheClustersResponse: - example: - data: - - eventRequestQueueDepthThreshold: - clearPercent: 1 - setPercent: 6 - eventResponseRateThreshold: - setValue: 5 - clearValue: 1 - msgLifetime: 7 - eventDataByteRateThreshold: - setValue: 5 - clearValue: 1 - eventDataMsgRateThreshold: - setValue: 5 - clearValue: 1 - maxMemory: 1 - maxMsgsPerTopic: 5 - deliverToOneOverrideEnabled: true - enabled: true - eventRequestRateThreshold: - setValue: 5 - clearValue: 1 - cacheName: cacheName - globalCachingEnabled: true - globalCachingHeartbeat: 0 - clusterName: clusterName - newTopicAdvertisementEnabled: true - eventMaxTopicsThreshold: - clearPercent: 1 - setPercent: 6 - msgVpnName: msgVpnName - eventMaxMemoryThreshold: - clearPercent: 1 - setPercent: 6 - maxTopicCount: 2 - globalCachingTopicLifetime: 6 - maxRequestQueueDepth: 5 - - eventRequestQueueDepthThreshold: - clearPercent: 1 - setPercent: 6 - eventResponseRateThreshold: - setValue: 5 - clearValue: 1 - msgLifetime: 7 - eventDataByteRateThreshold: - setValue: 5 - clearValue: 1 - eventDataMsgRateThreshold: - setValue: 5 - clearValue: 1 - maxMemory: 1 - maxMsgsPerTopic: 5 - deliverToOneOverrideEnabled: true - enabled: true - eventRequestRateThreshold: - setValue: 5 - clearValue: 1 - cacheName: cacheName - globalCachingEnabled: true - globalCachingHeartbeat: 0 - clusterName: clusterName - newTopicAdvertisementEnabled: true - eventMaxTopicsThreshold: - clearPercent: 1 - setPercent: 6 - msgVpnName: msgVpnName - eventMaxMemoryThreshold: - clearPercent: 1 - setPercent: 6 - maxTopicCount: 2 - globalCachingTopicLifetime: 6 - maxRequestQueueDepth: 5 - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - globalCachingHomeClustersUri: globalCachingHomeClustersUri - instancesUri: instancesUri - topicsUri: topicsUri - uri: uri - - globalCachingHomeClustersUri: globalCachingHomeClustersUri - instancesUri: instancesUri - topicsUri: topicsUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnDistributedCacheCluster' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnDistributedCacheClusterLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnDistributedCacheLinks: - example: - clustersUri: clustersUri - uri: uri - properties: - clustersUri: - description: The URI of this Distributed Cache's collection of Cache Cluster - objects. - type: string - uri: - description: The URI of this Distributed Cache object. - type: string - type: object - MsgVpnDistributedCacheResponse: - example: - data: - cacheName: cacheName - heartbeat: 0 - scheduledDeleteMsgDayList: scheduledDeleteMsgDayList - msgVpnName: msgVpnName - cacheVirtualRouter: auto - scheduledDeleteMsgTimeList: scheduledDeleteMsgTimeList - enabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - clustersUri: clustersUri - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnDistributedCache' - links: - $ref: '#/components/schemas/MsgVpnDistributedCacheLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnDistributedCachesResponse: - example: - data: - - cacheName: cacheName - heartbeat: 0 - scheduledDeleteMsgDayList: scheduledDeleteMsgDayList - msgVpnName: msgVpnName - cacheVirtualRouter: auto - scheduledDeleteMsgTimeList: scheduledDeleteMsgTimeList - enabled: true - - cacheName: cacheName - heartbeat: 0 - scheduledDeleteMsgDayList: scheduledDeleteMsgDayList - msgVpnName: msgVpnName - cacheVirtualRouter: auto - scheduledDeleteMsgTimeList: scheduledDeleteMsgTimeList - enabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - clustersUri: clustersUri - uri: uri - - clustersUri: clustersUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnDistributedCache' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnDistributedCacheLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnDmrBridge: - example: - remoteMsgVpnName: remoteMsgVpnName - remoteNodeName: remoteNodeName - msgVpnName: msgVpnName - properties: - msgVpnName: - description: The name of the Message VPN. - type: string - remoteMsgVpnName: - description: The remote Message VPN of the DMR Bridge. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `""`. - type: string - remoteNodeName: - description: The name of the node at the remote end of the DMR Bridge. - type: string - type: object - MsgVpnDmrBridgeLinks: - example: - uri: uri - properties: - uri: - description: The URI of this DMR Bridge object. - type: string - type: object - MsgVpnDmrBridgeResponse: - example: - data: - remoteMsgVpnName: remoteMsgVpnName - remoteNodeName: remoteNodeName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnDmrBridge' - links: - $ref: '#/components/schemas/MsgVpnDmrBridgeLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnDmrBridgesResponse: - example: - data: - - remoteMsgVpnName: remoteMsgVpnName - remoteNodeName: remoteNodeName - msgVpnName: msgVpnName - - remoteMsgVpnName: remoteMsgVpnName - remoteNodeName: remoteNodeName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnDmrBridge' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnDmrBridgeLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnJndiConnectionFactoriesResponse: - example: - data: - - messagingDefaultDeliveryMode: persistent - connectionFactoryName: connectionFactoryName - guaranteedReceiveAckTimeout: 1 - transportReadTimeout: 7 - transportReconnectRetryCount: 4 - dtoReceiveSubscriberNetworkPriority: 6 - messagingDefaultElidingEligibleEnabled: true - transportDirectTransportEnabled: true - transportReconnectRetryWait: 5 - clientDescription: clientDescription - guaranteedReceiveWindowSize: 2 - dtoReceiveSubscriberLocalPriority: 0 - transportCompressionLevel: 2 - transportConnectRetryPerHostCount: 7 - guaranteedSendAckTimeout: 9 - transportReceiveBufferSize: 1 - msgVpnName: msgVpnName - transportKeepaliveEnabled: true - allowDuplicateClientIdEnabled: true - transportPort: 6 - guaranteedReceiveReconnectRetryCount: 5 - transportConnectRetryCount: 4 - transportConnectTimeout: 1 - dynamicEndpointCreateDurableEnabled: true - clientId: clientId - messagingJmsxUserIdEnabled: true - guaranteedReceiveWindowSizeAckThreshold: 7 - dynamicEndpointRespectTtlEnabled: true - messagingTextInXmlPayloadEnabled: true - guaranteedSendWindowSize: 3 - transportKeepaliveInterval: 1 - transportOptimizeDirectEnabled: true - transportTcpNoDelayEnabled: true - guaranteedReceiveReconnectRetryWait: 5 - transportSendBufferSize: 9 - transportKeepaliveCount: 1 - xaEnabled: true - dtoSendEnabled: true - messagingDefaultDmqEligibleEnabled: true - dtoReceiveOverrideEnabled: true - transportMsgCallbackOnIoThreadEnabled: true - - messagingDefaultDeliveryMode: persistent - connectionFactoryName: connectionFactoryName - guaranteedReceiveAckTimeout: 1 - transportReadTimeout: 7 - transportReconnectRetryCount: 4 - dtoReceiveSubscriberNetworkPriority: 6 - messagingDefaultElidingEligibleEnabled: true - transportDirectTransportEnabled: true - transportReconnectRetryWait: 5 - clientDescription: clientDescription - guaranteedReceiveWindowSize: 2 - dtoReceiveSubscriberLocalPriority: 0 - transportCompressionLevel: 2 - transportConnectRetryPerHostCount: 7 - guaranteedSendAckTimeout: 9 - transportReceiveBufferSize: 1 - msgVpnName: msgVpnName - transportKeepaliveEnabled: true - allowDuplicateClientIdEnabled: true - transportPort: 6 - guaranteedReceiveReconnectRetryCount: 5 - transportConnectRetryCount: 4 - transportConnectTimeout: 1 - dynamicEndpointCreateDurableEnabled: true - clientId: clientId - messagingJmsxUserIdEnabled: true - guaranteedReceiveWindowSizeAckThreshold: 7 - dynamicEndpointRespectTtlEnabled: true - messagingTextInXmlPayloadEnabled: true - guaranteedSendWindowSize: 3 - transportKeepaliveInterval: 1 - transportOptimizeDirectEnabled: true - transportTcpNoDelayEnabled: true - guaranteedReceiveReconnectRetryWait: 5 - transportSendBufferSize: 9 - transportKeepaliveCount: 1 - xaEnabled: true - dtoSendEnabled: true - messagingDefaultDmqEligibleEnabled: true - dtoReceiveOverrideEnabled: true - transportMsgCallbackOnIoThreadEnabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnJndiConnectionFactory' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnJndiConnectionFactoryLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnJndiConnectionFactory: - example: - messagingDefaultDeliveryMode: persistent - connectionFactoryName: connectionFactoryName - guaranteedReceiveAckTimeout: 1 - transportReadTimeout: 7 - transportReconnectRetryCount: 4 - dtoReceiveSubscriberNetworkPriority: 6 - messagingDefaultElidingEligibleEnabled: true - transportDirectTransportEnabled: true - transportReconnectRetryWait: 5 - clientDescription: clientDescription - guaranteedReceiveWindowSize: 2 - dtoReceiveSubscriberLocalPriority: 0 - transportCompressionLevel: 2 - transportConnectRetryPerHostCount: 7 - guaranteedSendAckTimeout: 9 - transportReceiveBufferSize: 1 - msgVpnName: msgVpnName - transportKeepaliveEnabled: true - allowDuplicateClientIdEnabled: true - transportPort: 6 - guaranteedReceiveReconnectRetryCount: 5 - transportConnectRetryCount: 4 - transportConnectTimeout: 1 - dynamicEndpointCreateDurableEnabled: true - clientId: clientId - messagingJmsxUserIdEnabled: true - guaranteedReceiveWindowSizeAckThreshold: 7 - dynamicEndpointRespectTtlEnabled: true - messagingTextInXmlPayloadEnabled: true - guaranteedSendWindowSize: 3 - transportKeepaliveInterval: 1 - transportOptimizeDirectEnabled: true - transportTcpNoDelayEnabled: true - guaranteedReceiveReconnectRetryWait: 5 - transportSendBufferSize: 9 - transportKeepaliveCount: 1 - xaEnabled: true - dtoSendEnabled: true - messagingDefaultDmqEligibleEnabled: true - dtoReceiveOverrideEnabled: true - transportMsgCallbackOnIoThreadEnabled: true - properties: - allowDuplicateClientIdEnabled: - description: Enable or disable whether new JMS connections can use the same - Client identifier (ID) as an existing connection. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `false`. Available since 2.3. - type: boolean - clientDescription: - description: The description of the Client. Changes to this attribute are - synchronized to HA mates and replication sites via config-sync. The default - value is `""`. - type: string - clientId: - description: "The Client identifier (ID). If not specified, a unique value\ - \ for it will be generated. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `\"\"`." - type: string - connectionFactoryName: - description: The name of the JMS Connection Factory. - type: string - dtoReceiveOverrideEnabled: - description: "Enable or disable overriding by the Subscriber (Consumer)\ - \ of the deliver-to-one (DTO) property on messages. When enabled, the\ - \ Subscriber can receive all DTO tagged messages. Changes to this attribute\ - \ are synchronized to HA mates and replication sites via config-sync.\ - \ The default value is `true`." - type: boolean - dtoReceiveSubscriberLocalPriority: - description: The priority for receiving deliver-to-one (DTO) messages by - the Subscriber (Consumer) if the messages are published on the local broker - that the Subscriber is directly connected to. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `1`. - format: int32 - type: integer - dtoReceiveSubscriberNetworkPriority: - description: The priority for receiving deliver-to-one (DTO) messages by - the Subscriber (Consumer) if the messages are published on a remote broker. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `1`. - format: int32 - type: integer - dtoSendEnabled: - description: Enable or disable the deliver-to-one (DTO) property on messages - sent by the Publisher (Producer). Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. - type: boolean - dynamicEndpointCreateDurableEnabled: - description: Enable or disable whether a durable endpoint will be dynamically - created on the broker when the client calls "Session.createDurableSubscriber()" - or "Session.createQueue()". The created endpoint respects the message - time-to-live (TTL) according to the "dynamicEndpointRespectTtlEnabled" - property. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `false`. - type: boolean - dynamicEndpointRespectTtlEnabled: - description: Enable or disable whether dynamically created durable and non-durable - endpoints respect the message time-to-live (TTL) property. Changes to - this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `true`. - type: boolean - guaranteedReceiveAckTimeout: - description: "The timeout for sending the acknowledgement (ACK) for guaranteed\ - \ messages received by the Subscriber (Consumer), in milliseconds. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `1000`." - format: int32 - type: integer - guaranteedReceiveReconnectRetryCount: - description: The maximum number of attempts to reconnect to the host or - list of hosts after the guaranteed messaging connection has been lost. - The value "-1" means to retry forever. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `-1`. Available since 2.14. - format: int32 - type: integer - guaranteedReceiveReconnectRetryWait: - description: "The amount of time to wait before making another attempt to\ - \ connect or reconnect to the host after the guaranteed messaging connection\ - \ has been lost, in milliseconds. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `3000`. Available since 2.14." - format: int32 - type: integer - guaranteedReceiveWindowSize: - description: "The size of the window for guaranteed messages received by\ - \ the Subscriber (Consumer), in messages. Changes to this attribute are\ - \ synchronized to HA mates and replication sites via config-sync. The\ - \ default value is `18`." - format: int32 - type: integer - guaranteedReceiveWindowSizeAckThreshold: - description: The threshold for sending the acknowledgement (ACK) for guaranteed - messages received by the Subscriber (Consumer) as a percentage of `guaranteedReceiveWindowSize`. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `60`. - format: int32 - type: integer - guaranteedSendAckTimeout: - description: "The timeout for receiving the acknowledgement (ACK) for guaranteed\ - \ messages sent by the Publisher (Producer), in milliseconds. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `2000`." - format: int32 - type: integer - guaranteedSendWindowSize: - description: "The size of the window for non-persistent guaranteed messages\ - \ sent by the Publisher (Producer), in messages. For persistent messages\ - \ the window size is fixed at 1. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `255`." - format: int32 - type: integer - messagingDefaultDeliveryMode: - description: | - The default delivery mode for messages sent by the Publisher (Producer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"persistent"`. The allowed values and their meaning are: - - 
-            "persistent" - The broker spools messages (persists in the Message Spool) as part of the send operation.
-            "non-persistent" - The broker does not spool messages (does not persist in the Message Spool) as part of the send operation.
-
- enum: - - persistent - - non-persistent - type: string - messagingDefaultDmqEligibleEnabled: - description: Enable or disable whether messages sent by the Publisher (Producer) - are Dead Message Queue (DMQ) eligible by default. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `false`. - type: boolean - messagingDefaultElidingEligibleEnabled: - description: Enable or disable whether messages sent by the Publisher (Producer) - are Eliding eligible by default. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. - type: boolean - messagingJmsxUserIdEnabled: - description: Enable or disable inclusion (adding or replacing) of the JMSXUserID - property in messages sent by the Publisher (Producer). Changes to this - attribute are synchronized to HA mates and replication sites via config-sync. - The default value is `false`. - type: boolean - messagingTextInXmlPayloadEnabled: - description: "Enable or disable encoding of JMS text messages in Publisher\ - \ (Producer) messages as XML payload. When disabled, JMS text messages\ - \ are encoded as a binary attachment. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `true`." - type: boolean - msgVpnName: - description: The name of the Message VPN. - type: string - transportCompressionLevel: - description: "The ZLIB compression level for the connection to the broker.\ - \ The value \"0\" means no compression, and the value \"-1\" means the\ - \ compression level is specified in the JNDI Properties file. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `-1`." - format: int32 - type: integer - transportConnectRetryCount: - description: "The maximum number of retry attempts to establish an initial\ - \ connection to the host or list of hosts. The value \"0\" means a single\ - \ attempt (no retries), and the value \"-1\" means to retry forever. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `0`." - format: int32 - type: integer - transportConnectRetryPerHostCount: - description: "The maximum number of retry attempts to establish an initial\ - \ connection to each host on the list of hosts. The value \"0\" means\ - \ a single attempt (no retries), and the value \"-1\" means to retry forever.\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `0`." - format: int32 - type: integer - transportConnectTimeout: - description: "The timeout for establishing an initial connection to the\ - \ broker, in milliseconds. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `30000`." - format: int32 - type: integer - transportDirectTransportEnabled: - description: "Enable or disable usage of the Direct Transport mode for sending\ - \ non-persistent messages. When disabled, the Guaranteed Transport mode\ - \ is used. Changes to this attribute are synchronized to HA mates and\ - \ replication sites via config-sync. The default value is `true`." - type: boolean - transportKeepaliveCount: - description: The maximum number of consecutive application-level keepalive - messages sent without the broker response before the connection to the - broker is closed. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `3`. - format: int32 - type: integer - transportKeepaliveEnabled: - description: Enable or disable usage of application-level keepalive messages - to maintain a connection with the broker. Changes to this attribute are - synchronized to HA mates and replication sites via config-sync. The default - value is `true`. - type: boolean - transportKeepaliveInterval: - description: "The interval between application-level keepalive messages,\ - \ in milliseconds. Changes to this attribute are synchronized to HA mates\ - \ and replication sites via config-sync. The default value is `3000`." - format: int32 - type: integer - transportMsgCallbackOnIoThreadEnabled: - description: Enable or disable delivery of asynchronous messages directly - from the I/O thread. Contact support before enabling this property. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `false`. - type: boolean - transportOptimizeDirectEnabled: - description: "Enable or disable optimization for the Direct Transport delivery\ - \ mode. If enabled, the client application is limited to one Publisher\ - \ (Producer) and one non-durable Subscriber (Consumer). Changes to this\ - \ attribute are synchronized to HA mates and replication sites via config-sync.\ - \ The default value is `false`." - type: boolean - transportPort: - description: The connection port number on the broker for SMF clients. The - value "-1" means the port is specified in the JNDI Properties file. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `-1`. - format: int32 - type: integer - transportReadTimeout: - description: "The timeout for reading a reply from the broker, in milliseconds.\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `10000`." - format: int32 - type: integer - transportReceiveBufferSize: - description: "The size of the receive socket buffer, in bytes. It corresponds\ - \ to the SO_RCVBUF socket option. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `65536`." - format: int32 - type: integer - transportReconnectRetryCount: - description: The maximum number of attempts to reconnect to the host or - list of hosts after the connection has been lost. The value "-1" means - to retry forever. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `3`. - format: int32 - type: integer - transportReconnectRetryWait: - description: "The amount of time before making another attempt to connect\ - \ or reconnect to the host after the connection has been lost, in milliseconds.\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `3000`." - format: int32 - type: integer - transportSendBufferSize: - description: "The size of the send socket buffer, in bytes. It corresponds\ - \ to the SO_SNDBUF socket option. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `65536`." - format: int32 - type: integer - transportTcpNoDelayEnabled: - description: "Enable or disable the TCP_NODELAY option. When enabled, Nagle's\ - \ algorithm for TCP/IP congestion control (RFC 896) is disabled. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `true`." - type: boolean - xaEnabled: - description: "Enable or disable this as an XA Connection Factory. When enabled,\ - \ the Connection Factory can be cast to \"XAConnectionFactory\", \"XAQueueConnectionFactory\"\ - \ or \"XATopicConnectionFactory\". Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `false`." - type: boolean - type: object - MsgVpnJndiConnectionFactoryLinks: - example: - uri: uri - properties: - uri: - description: The URI of this JNDI Connection Factory object. - type: string - type: object - MsgVpnJndiConnectionFactoryResponse: - example: - data: - messagingDefaultDeliveryMode: persistent - connectionFactoryName: connectionFactoryName - guaranteedReceiveAckTimeout: 1 - transportReadTimeout: 7 - transportReconnectRetryCount: 4 - dtoReceiveSubscriberNetworkPriority: 6 - messagingDefaultElidingEligibleEnabled: true - transportDirectTransportEnabled: true - transportReconnectRetryWait: 5 - clientDescription: clientDescription - guaranteedReceiveWindowSize: 2 - dtoReceiveSubscriberLocalPriority: 0 - transportCompressionLevel: 2 - transportConnectRetryPerHostCount: 7 - guaranteedSendAckTimeout: 9 - transportReceiveBufferSize: 1 - msgVpnName: msgVpnName - transportKeepaliveEnabled: true - allowDuplicateClientIdEnabled: true - transportPort: 6 - guaranteedReceiveReconnectRetryCount: 5 - transportConnectRetryCount: 4 - transportConnectTimeout: 1 - dynamicEndpointCreateDurableEnabled: true - clientId: clientId - messagingJmsxUserIdEnabled: true - guaranteedReceiveWindowSizeAckThreshold: 7 - dynamicEndpointRespectTtlEnabled: true - messagingTextInXmlPayloadEnabled: true - guaranteedSendWindowSize: 3 - transportKeepaliveInterval: 1 - transportOptimizeDirectEnabled: true - transportTcpNoDelayEnabled: true - guaranteedReceiveReconnectRetryWait: 5 - transportSendBufferSize: 9 - transportKeepaliveCount: 1 - xaEnabled: true - dtoSendEnabled: true - messagingDefaultDmqEligibleEnabled: true - dtoReceiveOverrideEnabled: true - transportMsgCallbackOnIoThreadEnabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnJndiConnectionFactory' - links: - $ref: '#/components/schemas/MsgVpnJndiConnectionFactoryLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnJndiQueue: - example: - queueName: queueName - physicalName: physicalName - msgVpnName: msgVpnName - properties: - msgVpnName: - description: The name of the Message VPN. - type: string - physicalName: - description: The physical name of the JMS Queue. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `""`. - type: string - queueName: - description: The JNDI name of the JMS Queue. - type: string - type: object - MsgVpnJndiQueueLinks: - example: - uri: uri - properties: - uri: - description: The URI of this JNDI Queue object. - type: string - type: object - MsgVpnJndiQueueResponse: - example: - data: - queueName: queueName - physicalName: physicalName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnJndiQueue' - links: - $ref: '#/components/schemas/MsgVpnJndiQueueLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnJndiQueuesResponse: - example: - data: - - queueName: queueName - physicalName: physicalName - msgVpnName: msgVpnName - - queueName: queueName - physicalName: physicalName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnJndiQueue' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnJndiQueueLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnJndiTopic: - example: - physicalName: physicalName - topicName: topicName - msgVpnName: msgVpnName - properties: - msgVpnName: - description: The name of the Message VPN. - type: string - physicalName: - description: The physical name of the JMS Topic. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `""`. - type: string - topicName: - description: The JNDI name of the JMS Topic. - type: string - type: object - MsgVpnJndiTopicLinks: - example: - uri: uri - properties: - uri: - description: The URI of this JNDI Topic object. - type: string - type: object - MsgVpnJndiTopicResponse: - example: - data: - physicalName: physicalName - topicName: topicName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnJndiTopic' - links: - $ref: '#/components/schemas/MsgVpnJndiTopicLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnJndiTopicsResponse: - example: - data: - - physicalName: physicalName - topicName: topicName - msgVpnName: msgVpnName - - physicalName: physicalName - topicName: topicName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnJndiTopic' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnJndiTopicLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnLinks: - example: - authenticationOauthProvidersUri: authenticationOauthProvidersUri - authenticationOauthProfilesUri: authenticationOauthProfilesUri - clientProfilesUri: clientProfilesUri - topicEndpointsUri: topicEndpointsUri - jndiConnectionFactoriesUri: jndiConnectionFactoriesUri - mqttRetainCachesUri: mqttRetainCachesUri - clientUsernamesUri: clientUsernamesUri - bridgesUri: bridgesUri - replicatedTopicsUri: replicatedTopicsUri - topicEndpointTemplatesUri: topicEndpointTemplatesUri - aclProfilesUri: aclProfilesUri - sequencedTopicsUri: sequencedTopicsUri - uri: uri - jndiTopicsUri: jndiTopicsUri - dmrBridgesUri: dmrBridgesUri - replayLogsUri: replayLogsUri - certMatchingRulesUri: certMatchingRulesUri - queueTemplatesUri: queueTemplatesUri - queuesUri: queuesUri - restDeliveryPointsUri: restDeliveryPointsUri - distributedCachesUri: distributedCachesUri - mqttSessionsUri: mqttSessionsUri - authorizationGroupsUri: authorizationGroupsUri - jndiQueuesUri: jndiQueuesUri - properties: - aclProfilesUri: - description: The URI of this Message VPN's collection of ACL Profile objects. - type: string - authenticationOauthProfilesUri: - description: The URI of this Message VPN's collection of OAuth Profile objects. - Available since 2.25. - type: string - authenticationOauthProvidersUri: - description: The URI of this Message VPN's collection of OAuth Provider - objects. Deprecated since 2.25. Replaced by authenticationOauthProfiles. - type: string - authorizationGroupsUri: - description: The URI of this Message VPN's collection of Authorization Group - objects. - type: string - bridgesUri: - description: The URI of this Message VPN's collection of Bridge objects. - type: string - certMatchingRulesUri: - description: The URI of this Message VPN's collection of Certificate Matching - Rule objects. Available since 2.27. - type: string - clientProfilesUri: - description: The URI of this Message VPN's collection of Client Profile - objects. - type: string - clientUsernamesUri: - description: The URI of this Message VPN's collection of Client Username - objects. - type: string - distributedCachesUri: - description: The URI of this Message VPN's collection of Distributed Cache - objects. Available since 2.11. - type: string - dmrBridgesUri: - description: The URI of this Message VPN's collection of DMR Bridge objects. - Available since 2.11. - type: string - jndiConnectionFactoriesUri: - description: The URI of this Message VPN's collection of JNDI Connection - Factory objects. Available since 2.2. - type: string - jndiQueuesUri: - description: The URI of this Message VPN's collection of JNDI Queue objects. - Available since 2.2. - type: string - jndiTopicsUri: - description: The URI of this Message VPN's collection of JNDI Topic objects. - Available since 2.2. - type: string - mqttRetainCachesUri: - description: The URI of this Message VPN's collection of MQTT Retain Cache - objects. Available since 2.11. - type: string - mqttSessionsUri: - description: The URI of this Message VPN's collection of MQTT Session objects. - Available since 2.1. - type: string - queueTemplatesUri: - description: The URI of this Message VPN's collection of Queue Template - objects. Available since 2.14. - type: string - queuesUri: - description: The URI of this Message VPN's collection of Queue objects. - type: string - replayLogsUri: - description: The URI of this Message VPN's collection of Replay Log objects. - Available since 2.10. - type: string - replicatedTopicsUri: - description: The URI of this Message VPN's collection of Replicated Topic - objects. Available since 2.1. - type: string - restDeliveryPointsUri: - description: The URI of this Message VPN's collection of REST Delivery Point - objects. - type: string - sequencedTopicsUri: - description: The URI of this Message VPN's collection of Sequenced Topic - objects. - type: string - topicEndpointTemplatesUri: - description: The URI of this Message VPN's collection of Topic Endpoint - Template objects. Available since 2.14. - type: string - topicEndpointsUri: - description: The URI of this Message VPN's collection of Topic Endpoint - objects. Available since 2.1. - type: string - uri: - description: The URI of this Message VPN object. - type: string - type: object - MsgVpnMqttRetainCache: - example: - cacheName: cacheName - msgLifetime: 0 - msgVpnName: msgVpnName - enabled: true - properties: - cacheName: - description: The name of the MQTT Retain Cache. - type: string - enabled: - description: "Enable or disable this MQTT Retain Cache. When the cache is\ - \ disabled, neither retain messages nor retain requests will be delivered\ - \ by the cache. However, live retain messages will continue to be delivered\ - \ to currently connected MQTT clients. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `false`." - type: boolean - msgLifetime: - description: "The message lifetime, in seconds. If a message remains cached\ - \ for the duration of its lifetime, the cache will remove the message.\ - \ A lifetime of 0 results in the message being retained indefinitely,\ - \ otherwise it must be 3 seconds or more. Changes to this attribute are\ - \ synchronized to HA mates and replication sites via config-sync. The\ - \ default value is `0`." - format: int64 - type: integer - msgVpnName: - description: The name of the Message VPN. - type: string - type: object - MsgVpnMqttRetainCacheLinks: - example: - uri: uri - properties: - uri: - description: The URI of this MQTT Retain Cache object. - type: string - type: object - MsgVpnMqttRetainCacheResponse: - example: - data: - cacheName: cacheName - msgLifetime: 0 - msgVpnName: msgVpnName - enabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnMqttRetainCache' - links: - $ref: '#/components/schemas/MsgVpnMqttRetainCacheLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnMqttRetainCachesResponse: - example: - data: - - cacheName: cacheName - msgLifetime: 0 - msgVpnName: msgVpnName - enabled: true - - cacheName: cacheName - msgLifetime: 0 - msgVpnName: msgVpnName - enabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnMqttRetainCache' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnMqttRetainCacheLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnMqttSession: - example: - owner: owner - queueMaxBindCount: 0 - mqttSessionClientId: mqttSessionClientId - queueRejectLowPriorityMsgEnabled: true - queueRespectTtlEnabled: true - queueMaxDeliveredUnackedMsgsPerFlow: 6 - queueMaxRedeliveryCount: 5 - enabled: true - queueMaxTtl: 2 - queueRejectLowPriorityMsgLimit: 7 - queueDeadMsgQueue: queueDeadMsgQueue - queueEventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueRejectMsgToSenderOnDiscardBehavior: always - queueEventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueMaxMsgSize: 1 - msgVpnName: msgVpnName - queueEventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueMaxMsgSpoolUsage: 5 - mqttSessionVirtualRouter: primary - queueConsumerAckPropagationEnabled: true - properties: - enabled: - description: "Enable or disable the MQTT Session. When disabled, the client\ - \ is disconnected, new messages matching QoS 0 subscriptions are discarded,\ - \ and new messages matching QoS 1 subscriptions are stored for future\ - \ delivery. Changes to this attribute are synchronized to HA mates and\ - \ replication sites via config-sync. The default value is `false`." - type: boolean - mqttSessionClientId: - description: "The Client ID of the MQTT Session, which corresponds to the\ - \ ClientId provided in the MQTT CONNECT packet." - type: string - mqttSessionVirtualRouter: - description: | - The virtual router of the MQTT Session. The allowed values and their meaning are: - - 
-            "primary" - The MQTT Session belongs to the primary virtual router.
-            "backup" - The MQTT Session belongs to the backup virtual router.
-            "auto" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role.
-
- enum: - - primary - - backup - - auto - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - owner: - description: The owner of the MQTT Session. For externally-created sessions - this defaults to the Client Username of the connecting client. For management-created - sessions this defaults to empty. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `""`. - type: string - queueConsumerAckPropagationEnabled: - description: Enable or disable the propagation of consumer acknowledgements - (ACKs) received on the active replication Message VPN to the standby replication - Message VPN. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default value is `true`. Available - since 2.14. - type: boolean - queueDeadMsgQueue: - description: The name of the Dead Message Queue (DMQ) used by the MQTT Session - Queue. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `"#DEAD_MSG_QUEUE"`. Available - since 2.14. - type: string - queueEventBindCountThreshold: - $ref: '#/components/schemas/EventThreshold' - queueEventMsgSpoolUsageThreshold: - $ref: '#/components/schemas/EventThreshold' - queueEventRejectLowPriorityMsgLimitThreshold: - $ref: '#/components/schemas/EventThreshold' - queueMaxBindCount: - description: The maximum number of consumer flows that can bind to the MQTT - Session Queue. Changes to this attribute are synchronized to HA mates - and replication sites via config-sync. The default value is `1000`. Available - since 2.14. - format: int64 - type: integer - queueMaxDeliveredUnackedMsgsPerFlow: - description: The maximum number of messages delivered but not acknowledged - per flow for the MQTT Session Queue. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `10000`. Available since 2.14. - format: int64 - type: integer - queueMaxMsgSize: - description: "The maximum message size allowed in the MQTT Session Queue,\ - \ in bytes (B). Changes to this attribute are synchronized to HA mates\ - \ and replication sites via config-sync. The default value is `10000000`.\ - \ Available since 2.14." - format: int32 - type: integer - queueMaxMsgSpoolUsage: - description: "The maximum message spool usage allowed by the MQTT Session\ - \ Queue, in megabytes (MB). A value of 0 only allows spooling of the last\ - \ message received and disables quota checking. Changes to this attribute\ - \ are synchronized to HA mates and replication sites via config-sync.\ - \ The default value is `5000`. Available since 2.14." - format: int64 - type: integer - queueMaxRedeliveryCount: - description: The maximum number of times the MQTT Session Queue will attempt - redelivery of a message prior to it being discarded or moved to the DMQ. - A value of 0 means to retry forever. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `0`. Available since 2.14. - format: int64 - type: integer - queueMaxTtl: - description: "The maximum time in seconds a message can stay in the MQTT\ - \ Session Queue when `queueRespectTtlEnabled` is `\"true\"`. A message\ - \ expires when the lesser of the sender assigned time-to-live (TTL) in\ - \ the message and the `queueMaxTtl` configured for the MQTT Session Queue,\ - \ is exceeded. A value of 0 disables expiry. Changes to this attribute\ - \ are synchronized to HA mates and replication sites via config-sync.\ - \ The default value is `0`. Available since 2.14." - format: int64 - type: integer - queueRejectLowPriorityMsgEnabled: - description: Enable or disable the checking of low priority messages against - the `queueRejectLowPriorityMsgLimit`. This may only be enabled if `queueRejectMsgToSenderOnDiscardBehavior` - does not have a value of `"never"`. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. Available since 2.14. - type: boolean - queueRejectLowPriorityMsgLimit: - description: The number of messages of any priority in the MQTT Session - Queue above which low priority messages are not admitted but higher priority - messages are allowed. Changes to this attribute are synchronized to HA - mates and replication sites via config-sync. The default value is `0`. - Available since 2.14. - format: int64 - type: integer - queueRejectMsgToSenderOnDiscardBehavior: - description: |- - Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"when-queue-enabled"`. The allowed values and their meaning are: - - 
-            "always" - Always return a negative acknowledgment (NACK) to the sending client on message discard.
-            "when-queue-enabled" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled.
-            "never" - Never return a negative acknowledgment (NACK) to the sending client on message discard.
-
- Available since 2.14. - enum: - - always - - when-queue-enabled - - never - type: string - queueRespectTtlEnabled: - description: "Enable or disable the respecting of the time-to-live (TTL)\ - \ for messages in the MQTT Session Queue. When enabled, expired messages\ - \ are discarded or moved to the DMQ. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `false`. Available since 2.14." - type: boolean - type: object - MsgVpnMqttSessionLinks: - example: - subscriptionsUri: subscriptionsUri - uri: uri - properties: - subscriptionsUri: - description: The URI of this MQTT Session's collection of Subscription objects. - type: string - uri: - description: The URI of this MQTT Session object. - type: string - type: object - MsgVpnMqttSessionResponse: - example: - data: - owner: owner - queueMaxBindCount: 0 - mqttSessionClientId: mqttSessionClientId - queueRejectLowPriorityMsgEnabled: true - queueRespectTtlEnabled: true - queueMaxDeliveredUnackedMsgsPerFlow: 6 - queueMaxRedeliveryCount: 5 - enabled: true - queueMaxTtl: 2 - queueRejectLowPriorityMsgLimit: 7 - queueDeadMsgQueue: queueDeadMsgQueue - queueEventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueRejectMsgToSenderOnDiscardBehavior: always - queueEventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueMaxMsgSize: 1 - msgVpnName: msgVpnName - queueEventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueMaxMsgSpoolUsage: 5 - mqttSessionVirtualRouter: primary - queueConsumerAckPropagationEnabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - subscriptionsUri: subscriptionsUri - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnMqttSession' - links: - $ref: '#/components/schemas/MsgVpnMqttSessionLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnMqttSessionSubscription: - example: - mqttSessionClientId: mqttSessionClientId - subscriptionQos: 0 - msgVpnName: msgVpnName - subscriptionTopic: subscriptionTopic - mqttSessionVirtualRouter: primary - properties: - mqttSessionClientId: - description: "The Client ID of the MQTT Session, which corresponds to the\ - \ ClientId provided in the MQTT CONNECT packet." - type: string - mqttSessionVirtualRouter: - description: | - The virtual router of the MQTT Session. The allowed values and their meaning are: - - 
-            "primary" - The MQTT Session belongs to the primary virtual router.
-            "backup" - The MQTT Session belongs to the backup virtual router.
-            "auto" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role.
-
- enum: - - primary - - backup - - auto - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - subscriptionQos: - description: "The quality of service (QoS) for the subscription as either\ - \ 0 (deliver at most once) or 1 (deliver at least once). QoS 2 is not\ - \ supported, but QoS 2 messages attracted by QoS 0 or QoS 1 subscriptions\ - \ are accepted and delivered accordingly. Changes to this attribute are\ - \ synchronized to HA mates and replication sites via config-sync. The\ - \ default value is `0`." - format: int64 - type: integer - subscriptionTopic: - description: The MQTT subscription topic. - type: string - type: object - MsgVpnMqttSessionSubscriptionLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Subscription object. - type: string - type: object - MsgVpnMqttSessionSubscriptionResponse: - example: - data: - mqttSessionClientId: mqttSessionClientId - subscriptionQos: 0 - msgVpnName: msgVpnName - subscriptionTopic: subscriptionTopic - mqttSessionVirtualRouter: primary - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnMqttSessionSubscription' - links: - $ref: '#/components/schemas/MsgVpnMqttSessionSubscriptionLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnMqttSessionSubscriptionsResponse: - example: - data: - - mqttSessionClientId: mqttSessionClientId - subscriptionQos: 0 - msgVpnName: msgVpnName - subscriptionTopic: subscriptionTopic - mqttSessionVirtualRouter: primary - - mqttSessionClientId: mqttSessionClientId - subscriptionQos: 0 - msgVpnName: msgVpnName - subscriptionTopic: subscriptionTopic - mqttSessionVirtualRouter: primary - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnMqttSessionSubscription' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnMqttSessionSubscriptionLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnMqttSessionsResponse: - example: - data: - - owner: owner - queueMaxBindCount: 0 - mqttSessionClientId: mqttSessionClientId - queueRejectLowPriorityMsgEnabled: true - queueRespectTtlEnabled: true - queueMaxDeliveredUnackedMsgsPerFlow: 6 - queueMaxRedeliveryCount: 5 - enabled: true - queueMaxTtl: 2 - queueRejectLowPriorityMsgLimit: 7 - queueDeadMsgQueue: queueDeadMsgQueue - queueEventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueRejectMsgToSenderOnDiscardBehavior: always - queueEventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueMaxMsgSize: 1 - msgVpnName: msgVpnName - queueEventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueMaxMsgSpoolUsage: 5 - mqttSessionVirtualRouter: primary - queueConsumerAckPropagationEnabled: true - - owner: owner - queueMaxBindCount: 0 - mqttSessionClientId: mqttSessionClientId - queueRejectLowPriorityMsgEnabled: true - queueRespectTtlEnabled: true - queueMaxDeliveredUnackedMsgsPerFlow: 6 - queueMaxRedeliveryCount: 5 - enabled: true - queueMaxTtl: 2 - queueRejectLowPriorityMsgLimit: 7 - queueDeadMsgQueue: queueDeadMsgQueue - queueEventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueRejectMsgToSenderOnDiscardBehavior: always - queueEventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueMaxMsgSize: 1 - msgVpnName: msgVpnName - queueEventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueMaxMsgSpoolUsage: 5 - mqttSessionVirtualRouter: primary - queueConsumerAckPropagationEnabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - subscriptionsUri: subscriptionsUri - uri: uri - - subscriptionsUri: subscriptionsUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnMqttSession' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnMqttSessionLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnQueue: - example: - redeliveryEnabled: true - rejectLowPriorityMsgLimit: 9 - maxMsgSize: 5 - accessType: exclusive - deadMsgQueue: deadMsgQueue - deliveryCountEnabled: true - rejectMsgToSenderOnDiscardBehavior: always - consumerAckPropagationEnabled: true - eventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - respectMsgPriorityEnabled: true - msgVpnName: msgVpnName - maxDeliveredUnackedMsgsPerFlow: 1 - rejectLowPriorityMsgEnabled: true - deliveryDelay: 0 - maxBindCount: 6 - owner: owner - eventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - egressEnabled: true - maxTtl: 7 - respectTtlEnabled: true - permission: no-access - maxRedeliveryCount: 2 - ingressEnabled: true - queueName: queueName - eventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - maxMsgSpoolUsage: 5 - properties: - accessType: - description: | - The access type for delivering messages to consumer flows bound to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"exclusive"`. The allowed values and their meaning are: - - 
-            "exclusive" - Exclusive delivery of messages to the first bound consumer flow.
-            "non-exclusive" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion.
-
- enum: - - exclusive - - non-exclusive - type: string - consumerAckPropagationEnabled: - description: Enable or disable the propagation of consumer acknowledgements - (ACKs) received on the active replication Message VPN to the standby replication - Message VPN. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default value is `true`. - type: boolean - deadMsgQueue: - description: The name of the Dead Message Queue (DMQ) used by the Queue. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `"#DEAD_MSG_QUEUE"`. Available - since 2.2. - type: string - deliveryCountEnabled: - description: Enable or disable the ability for client applications to query - the message delivery count of messages received from the Queue. This is - a controlled availability feature. Please contact support to find out - if this feature is supported for your use case. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `false`. Available since 2.19. - type: boolean - deliveryDelay: - description: "The delay, in seconds, to apply to messages arriving on the\ - \ Queue before the messages are eligible for delivery. Changes to this\ - \ attribute are synchronized to HA mates and replication sites via config-sync.\ - \ The default value is `0`. Available since 2.22." - format: int64 - type: integer - egressEnabled: - description: Enable or disable the transmission of messages from the Queue. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `false`. - type: boolean - eventBindCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventMsgSpoolUsageThreshold: - $ref: '#/components/schemas/EventThreshold' - eventRejectLowPriorityMsgLimitThreshold: - $ref: '#/components/schemas/EventThreshold' - ingressEnabled: - description: Enable or disable the reception of messages to the Queue. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `false`. - type: boolean - maxBindCount: - description: The maximum number of consumer flows that can bind to the Queue. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `1000`. - format: int64 - type: integer - maxDeliveredUnackedMsgsPerFlow: - description: The maximum number of messages delivered but not acknowledged - per flow for the Queue. Changes to this attribute are synchronized to - HA mates and replication sites via config-sync. The default value is `10000`. - format: int64 - type: integer - maxMsgSize: - description: "The maximum message size allowed in the Queue, in bytes (B).\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `10000000`." - format: int32 - type: integer - maxMsgSpoolUsage: - description: "The maximum message spool usage allowed by the Queue, in megabytes\ - \ (MB). A value of 0 only allows spooling of the last message received\ - \ and disables quota checking. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `5000`." - format: int64 - type: integer - maxRedeliveryCount: - description: The maximum number of times the Queue will attempt redelivery - of a message prior to it being discarded or moved to the DMQ. A value - of 0 means to retry forever. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `0`. - format: int64 - type: integer - maxTtl: - description: "The maximum time in seconds a message can stay in the Queue\ - \ when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser\ - \ of the sender assigned time-to-live (TTL) in the message and the `maxTtl`\ - \ configured for the Queue, is exceeded. A value of 0 disables expiry.\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `0`." - format: int64 - type: integer - msgVpnName: - description: The name of the Message VPN. - type: string - owner: - description: The Client Username that owns the Queue and has permission - equivalent to `"delete"`. Changes to this attribute are synchronized to - HA mates and replication sites via config-sync. The default value is `""`. - type: string - permission: - description: | - The permission level for all consumers of the Queue, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"no-access"`. The allowed values and their meaning are: - - 
-            "no-access" - Disallows all access.
-            "read-only" - Read-only access to the messages.
-            "consume" - Consume (read and remove) messages.
-            "modify-topic" - Consume messages or modify the topic/selector.
-            "delete" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.
-
- enum: - - no-access - - read-only - - consume - - modify-topic - - delete - type: string - queueName: - description: The name of the Queue. - type: string - redeliveryEnabled: - description: "Enable or disable message redelivery. When enabled, the number\ - \ of redelivery attempts is controlled by maxRedeliveryCount. When disabled,\ - \ the message will never be delivered from the queue more than once. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `true`. Available since 2.18." - type: boolean - rejectLowPriorityMsgEnabled: - description: Enable or disable the checking of low priority messages against - the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` - does not have a value of `"never"`. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. - type: boolean - rejectLowPriorityMsgLimit: - description: The number of messages of any priority in the Queue above which - low priority messages are not admitted but higher priority messages are - allowed. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `0`. - format: int64 - type: integer - rejectMsgToSenderOnDiscardBehavior: - description: |- - Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"when-queue-enabled"`. The allowed values and their meaning are: - - 
-            "always" - Always return a negative acknowledgment (NACK) to the sending client on message discard.
-            "when-queue-enabled" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled.
-            "never" - Never return a negative acknowledgment (NACK) to the sending client on message discard.
-
- Available since 2.1. - enum: - - always - - when-queue-enabled - - never - type: string - respectMsgPriorityEnabled: - description: "Enable or disable the respecting of message priority. When\ - \ enabled, messages contained in the Queue are delivered in priority order,\ - \ from 9 (highest) to 0 (lowest). MQTT queues do not support enabling\ - \ message priority. Changes to this attribute are synchronized to HA mates\ - \ and replication sites via config-sync. The default value is `false`.\ - \ Available since 2.8." - type: boolean - respectTtlEnabled: - description: "Enable or disable the respecting of the time-to-live (TTL)\ - \ for messages in the Queue. When enabled, expired messages are discarded\ - \ or moved to the DMQ. Changes to this attribute are synchronized to HA\ - \ mates and replication sites via config-sync. The default value is `false`." - type: boolean - type: object - MsgVpnQueueLinks: - example: - subscriptionsUri: subscriptionsUri - uri: uri - properties: - subscriptionsUri: - description: The URI of this Queue's collection of Queue Subscription objects. - type: string - uri: - description: The URI of this Queue object. - type: string - type: object - MsgVpnQueueResponse: - example: - data: - redeliveryEnabled: true - rejectLowPriorityMsgLimit: 9 - maxMsgSize: 5 - accessType: exclusive - deadMsgQueue: deadMsgQueue - deliveryCountEnabled: true - rejectMsgToSenderOnDiscardBehavior: always - consumerAckPropagationEnabled: true - eventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - respectMsgPriorityEnabled: true - msgVpnName: msgVpnName - maxDeliveredUnackedMsgsPerFlow: 1 - rejectLowPriorityMsgEnabled: true - deliveryDelay: 0 - maxBindCount: 6 - owner: owner - eventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - egressEnabled: true - maxTtl: 7 - respectTtlEnabled: true - permission: no-access - maxRedeliveryCount: 2 - ingressEnabled: true - queueName: queueName - eventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - maxMsgSpoolUsage: 5 - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - subscriptionsUri: subscriptionsUri - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnQueue' - links: - $ref: '#/components/schemas/MsgVpnQueueLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnQueueSubscription: - example: - queueName: queueName - msgVpnName: msgVpnName - subscriptionTopic: subscriptionTopic - properties: - msgVpnName: - description: The name of the Message VPN. - type: string - queueName: - description: The name of the Queue. - type: string - subscriptionTopic: - description: The topic of the Subscription. - type: string - type: object - MsgVpnQueueSubscriptionLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Queue Subscription object. - type: string - type: object - MsgVpnQueueSubscriptionResponse: - example: - data: - queueName: queueName - msgVpnName: msgVpnName - subscriptionTopic: subscriptionTopic - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnQueueSubscription' - links: - $ref: '#/components/schemas/MsgVpnQueueSubscriptionLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnQueueSubscriptionsResponse: - example: - data: - - queueName: queueName - msgVpnName: msgVpnName - subscriptionTopic: subscriptionTopic - - queueName: queueName - msgVpnName: msgVpnName - subscriptionTopic: subscriptionTopic - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnQueueSubscription' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnQueueSubscriptionLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnQueueTemplate: - example: - maxBindCount: 6 - eventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - redeliveryEnabled: true - maxTtl: 7 - respectTtlEnabled: true - permission: no-access - rejectLowPriorityMsgLimit: 9 - maxRedeliveryCount: 2 - maxMsgSize: 5 - accessType: exclusive - deadMsgQueue: deadMsgQueue - queueNameFilter: queueNameFilter - rejectMsgToSenderOnDiscardBehavior: always - consumerAckPropagationEnabled: true - eventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueTemplateName: queueTemplateName - respectMsgPriorityEnabled: true - durabilityOverride: none - eventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - maxMsgSpoolUsage: 5 - msgVpnName: msgVpnName - maxDeliveredUnackedMsgsPerFlow: 1 - rejectLowPriorityMsgEnabled: true - deliveryDelay: 0 - properties: - accessType: - description: | - The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"exclusive"`. The allowed values and their meaning are: - - 
-            "exclusive" - Exclusive delivery of messages to the first bound consumer flow.
-            "non-exclusive" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion.
-
- enum: - - exclusive - - non-exclusive - type: string - consumerAckPropagationEnabled: - description: Enable or disable the propagation of consumer acknowledgements - (ACKs) received on the active replication Message VPN to the standby replication - Message VPN. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default value is `true`. - type: boolean - deadMsgQueue: - description: The name of the Dead Message Queue (DMQ). Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `"#DEAD_MSG_QUEUE"`. - type: string - deliveryDelay: - description: "The delay, in seconds, to apply to messages arriving on the\ - \ Queue before the messages are eligible for delivery. This attribute\ - \ does not apply to MQTT queues created from this template, but it may\ - \ apply in future releases. Therefore, to maintain forward compatibility,\ - \ do not set this value on templates that might be used for MQTT queues.\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `0`. Available since 2.22." - format: int64 - type: integer - durabilityOverride: - description: | - Controls the durability of queues created from this template. If non-durable, the created queue will be non-durable, regardless of the specified durability. If none, the created queue will have the requested durability. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"none"`. The allowed values and their meaning are: - - 
-            "none" - The durability of the endpoint will be as requested on create.
-            "non-durable" - The durability of the created queue will be non-durable, regardless of what was requested.
-
- enum: - - none - - non-durable - type: string - eventBindCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventMsgSpoolUsageThreshold: - $ref: '#/components/schemas/EventThreshold' - eventRejectLowPriorityMsgLimitThreshold: - $ref: '#/components/schemas/EventThreshold' - maxBindCount: - description: The maximum number of consumer flows that can bind. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `1000`. - format: int64 - type: integer - maxDeliveredUnackedMsgsPerFlow: - description: The maximum number of messages delivered but not acknowledged - per flow. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `10000`. - format: int64 - type: integer - maxMsgSize: - description: "The maximum message size allowed, in bytes (B). Changes to\ - \ this attribute are synchronized to HA mates and replication sites via\ - \ config-sync. The default value is `10000000`." - format: int32 - type: integer - maxMsgSpoolUsage: - description: "The maximum message spool usage allowed, in megabytes (MB).\ - \ A value of 0 only allows spooling of the last message received and disables\ - \ quota checking. Changes to this attribute are synchronized to HA mates\ - \ and replication sites via config-sync. The default value is `5000`." - format: int64 - type: integer - maxRedeliveryCount: - description: The maximum number of message redelivery attempts that will - occur prior to the message being discarded or moved to the DMQ. A value - of 0 means to retry forever. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `0`. - format: int64 - type: integer - maxTtl: - description: "The maximum time in seconds a message can stay in a Queue\ - \ when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser\ - \ of the sender assigned time-to-live (TTL) in the message and the `maxTtl`\ - \ configured for the Queue, is exceeded. A value of 0 disables expiry.\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `0`." - format: int64 - type: integer - msgVpnName: - description: The name of the Message VPN. - type: string - permission: - description: | - The permission level for all consumers, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"no-access"`. The allowed values and their meaning are: - - 
-            "no-access" - Disallows all access.
-            "read-only" - Read-only access to the messages.
-            "consume" - Consume (read and remove) messages.
-            "modify-topic" - Consume messages or modify the topic/selector.
-            "delete" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.
-
- enum: - - no-access - - read-only - - consume - - modify-topic - - delete - type: string - queueNameFilter: - description: "A wildcardable pattern used to determine which Queues use\ - \ settings from this Template. Two different wildcards are supported:\ - \ * and >. Similar to topic filters or subscription patterns, a > matches\ - \ anything (but only when used at the end), and a * matches zero or more\ - \ characters but never a slash (/). A > is only a wildcard when used at\ - \ the end, after a /. A * is only allowed at the end, after a slash (/).\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `\"\"`." - type: string - queueTemplateName: - description: The name of the Queue Template. - type: string - redeliveryEnabled: - description: "Enable or disable message redelivery. When enabled, the number\ - \ of redelivery attempts is controlled by maxRedeliveryCount. When disabled,\ - \ the message will never be delivered from the queue more than once. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `true`. Available since 2.18." - type: boolean - rejectLowPriorityMsgEnabled: - description: Enable or disable the checking of low priority messages against - the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` - does not have a value of `"never"`. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. - type: boolean - rejectLowPriorityMsgLimit: - description: The number of messages of any priority above which low priority - messages are not admitted but higher priority messages are allowed. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `0`. - format: int64 - type: integer - rejectMsgToSenderOnDiscardBehavior: - description: | - Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs prevent the message from being delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"when-queue-enabled"`. The allowed values and their meaning are: - - 
-            "always" - Always return a negative acknowledgment (NACK) to the sending client on message discard.
-            "when-queue-enabled" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled.
-            "never" - Never return a negative acknowledgment (NACK) to the sending client on message discard.
-
- enum: - - always - - when-queue-enabled - - never - type: string - respectMsgPriorityEnabled: - description: "Enable or disable the respecting of message priority. When\ - \ enabled, messages are delivered in priority order, from 9 (highest)\ - \ to 0 (lowest). Changes to this attribute are synchronized to HA mates\ - \ and replication sites via config-sync. The default value is `false`." - type: boolean - respectTtlEnabled: - description: "Enable or disable the respecting of the time-to-live (TTL)\ - \ for messages. When enabled, expired messages are discarded or moved\ - \ to the DMQ. Changes to this attribute are synchronized to HA mates and\ - \ replication sites via config-sync. The default value is `false`." - type: boolean - type: object - MsgVpnQueueTemplateLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Queue Template object. - type: string - type: object - MsgVpnQueueTemplateResponse: - example: - data: - maxBindCount: 6 - eventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - redeliveryEnabled: true - maxTtl: 7 - respectTtlEnabled: true - permission: no-access - rejectLowPriorityMsgLimit: 9 - maxRedeliveryCount: 2 - maxMsgSize: 5 - accessType: exclusive - deadMsgQueue: deadMsgQueue - queueNameFilter: queueNameFilter - rejectMsgToSenderOnDiscardBehavior: always - consumerAckPropagationEnabled: true - eventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueTemplateName: queueTemplateName - respectMsgPriorityEnabled: true - durabilityOverride: none - eventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - maxMsgSpoolUsage: 5 - msgVpnName: msgVpnName - maxDeliveredUnackedMsgsPerFlow: 1 - rejectLowPriorityMsgEnabled: true - deliveryDelay: 0 - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnQueueTemplate' - links: - $ref: '#/components/schemas/MsgVpnQueueTemplateLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnQueueTemplatesResponse: - example: - data: - - maxBindCount: 6 - eventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - redeliveryEnabled: true - maxTtl: 7 - respectTtlEnabled: true - permission: no-access - rejectLowPriorityMsgLimit: 9 - maxRedeliveryCount: 2 - maxMsgSize: 5 - accessType: exclusive - deadMsgQueue: deadMsgQueue - queueNameFilter: queueNameFilter - rejectMsgToSenderOnDiscardBehavior: always - consumerAckPropagationEnabled: true - eventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueTemplateName: queueTemplateName - respectMsgPriorityEnabled: true - durabilityOverride: none - eventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - maxMsgSpoolUsage: 5 - msgVpnName: msgVpnName - maxDeliveredUnackedMsgsPerFlow: 1 - rejectLowPriorityMsgEnabled: true - deliveryDelay: 0 - - maxBindCount: 6 - eventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - redeliveryEnabled: true - maxTtl: 7 - respectTtlEnabled: true - permission: no-access - rejectLowPriorityMsgLimit: 9 - maxRedeliveryCount: 2 - maxMsgSize: 5 - accessType: exclusive - deadMsgQueue: deadMsgQueue - queueNameFilter: queueNameFilter - rejectMsgToSenderOnDiscardBehavior: always - consumerAckPropagationEnabled: true - eventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - queueTemplateName: queueTemplateName - respectMsgPriorityEnabled: true - durabilityOverride: none - eventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - maxMsgSpoolUsage: 5 - msgVpnName: msgVpnName - maxDeliveredUnackedMsgsPerFlow: 1 - rejectLowPriorityMsgEnabled: true - deliveryDelay: 0 - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnQueueTemplate' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnQueueTemplateLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnQueuesResponse: - example: - data: - - redeliveryEnabled: true - rejectLowPriorityMsgLimit: 9 - maxMsgSize: 5 - accessType: exclusive - deadMsgQueue: deadMsgQueue - deliveryCountEnabled: true - rejectMsgToSenderOnDiscardBehavior: always - consumerAckPropagationEnabled: true - eventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - respectMsgPriorityEnabled: true - msgVpnName: msgVpnName - maxDeliveredUnackedMsgsPerFlow: 1 - rejectLowPriorityMsgEnabled: true - deliveryDelay: 0 - maxBindCount: 6 - owner: owner - eventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - egressEnabled: true - maxTtl: 7 - respectTtlEnabled: true - permission: no-access - maxRedeliveryCount: 2 - ingressEnabled: true - queueName: queueName - eventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - maxMsgSpoolUsage: 5 - - redeliveryEnabled: true - rejectLowPriorityMsgLimit: 9 - maxMsgSize: 5 - accessType: exclusive - deadMsgQueue: deadMsgQueue - deliveryCountEnabled: true - rejectMsgToSenderOnDiscardBehavior: always - consumerAckPropagationEnabled: true - eventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - respectMsgPriorityEnabled: true - msgVpnName: msgVpnName - maxDeliveredUnackedMsgsPerFlow: 1 - rejectLowPriorityMsgEnabled: true - deliveryDelay: 0 - maxBindCount: 6 - owner: owner - eventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - egressEnabled: true - maxTtl: 7 - respectTtlEnabled: true - permission: no-access - maxRedeliveryCount: 2 - ingressEnabled: true - queueName: queueName - eventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - maxMsgSpoolUsage: 5 - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - subscriptionsUri: subscriptionsUri - uri: uri - - subscriptionsUri: subscriptionsUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnQueue' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnQueueLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnReplayLog: - example: - ingressEnabled: true - replayLogName: replayLogName - maxSpoolUsage: 0 - egressEnabled: true - msgVpnName: msgVpnName - topicFilterEnabled: true - properties: - egressEnabled: - description: Enable or disable the transmission of messages from the Replay - Log. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `false`. - type: boolean - ingressEnabled: - description: Enable or disable the reception of messages to the Replay Log. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `false`. - type: boolean - maxSpoolUsage: - description: "The maximum spool usage allowed by the Replay Log, in megabytes\ - \ (MB). If this limit is exceeded, old messages will be trimmed. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `0`." - format: int64 - type: integer - msgVpnName: - description: The name of the Message VPN. - type: string - replayLogName: - description: The name of the Replay Log. - type: string - topicFilterEnabled: - description: Enable or disable topic filtering for the Replay Log. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `false`. Available since 2.27. - type: boolean - type: object - MsgVpnReplayLogLinks: - example: - topicFilterSubscriptionsUri: topicFilterSubscriptionsUri - uri: uri - properties: - topicFilterSubscriptionsUri: - description: The URI of this Replay Log's collection of Topic Filter Subscription - objects. Available since 2.27. - type: string - uri: - description: The URI of this Replay Log object. - type: string - type: object - MsgVpnReplayLogResponse: - example: - data: - ingressEnabled: true - replayLogName: replayLogName - maxSpoolUsage: 0 - egressEnabled: true - msgVpnName: msgVpnName - topicFilterEnabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - topicFilterSubscriptionsUri: topicFilterSubscriptionsUri - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnReplayLog' - links: - $ref: '#/components/schemas/MsgVpnReplayLogLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnReplayLogTopicFilterSubscription: - example: - replayLogName: replayLogName - topicFilterSubscription: topicFilterSubscription - msgVpnName: msgVpnName - properties: - msgVpnName: - description: The name of the Message VPN. - type: string - replayLogName: - description: The name of the Replay Log. - type: string - topicFilterSubscription: - description: The topic of the Subscription. - type: string - type: object - MsgVpnReplayLogTopicFilterSubscriptionLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Topic Filter Subscription object. - type: string - type: object - MsgVpnReplayLogTopicFilterSubscriptionResponse: - example: - data: - replayLogName: replayLogName - topicFilterSubscription: topicFilterSubscription - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnReplayLogTopicFilterSubscription' - links: - $ref: '#/components/schemas/MsgVpnReplayLogTopicFilterSubscriptionLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnReplayLogTopicFilterSubscriptionsResponse: - example: - data: - - replayLogName: replayLogName - topicFilterSubscription: topicFilterSubscription - msgVpnName: msgVpnName - - replayLogName: replayLogName - topicFilterSubscription: topicFilterSubscription - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnReplayLogTopicFilterSubscription' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnReplayLogTopicFilterSubscriptionLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnReplayLogsResponse: - example: - data: - - ingressEnabled: true - replayLogName: replayLogName - maxSpoolUsage: 0 - egressEnabled: true - msgVpnName: msgVpnName - topicFilterEnabled: true - - ingressEnabled: true - replayLogName: replayLogName - maxSpoolUsage: 0 - egressEnabled: true - msgVpnName: msgVpnName - topicFilterEnabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - topicFilterSubscriptionsUri: topicFilterSubscriptionsUri - uri: uri - - topicFilterSubscriptionsUri: topicFilterSubscriptionsUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnReplayLog' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnReplayLogLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnReplicatedTopic: - example: - replicationMode: sync - replicatedTopic: replicatedTopic - msgVpnName: msgVpnName - properties: - msgVpnName: - description: The name of the Message VPN. - type: string - replicatedTopic: - description: The topic for applying replication. Published messages matching - this topic will be replicated to the standby site. - type: string - replicationMode: - description: | - The replication mode for the Replicated Topic. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"async"`. The allowed values and their meaning are: - - 
-            "sync" - Messages are acknowledged when replicated (spooled remotely).
-            "async" - Messages are acknowledged when pending replication (spooled locally).
-
- enum: - - sync - - async - type: string - type: object - MsgVpnReplicatedTopicLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Replicated Topic object. - type: string - type: object - MsgVpnReplicatedTopicResponse: - example: - data: - replicationMode: sync - replicatedTopic: replicatedTopic - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnReplicatedTopic' - links: - $ref: '#/components/schemas/MsgVpnReplicatedTopicLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnReplicatedTopicsResponse: - example: - data: - - replicationMode: sync - replicatedTopic: replicatedTopic - msgVpnName: msgVpnName - - replicationMode: sync - replicatedTopic: replicatedTopic - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnReplicatedTopic' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnReplicatedTopicLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnResponse: - example: - data: - serviceMqttMaxConnectionCount: 6 - authorizationProfileName: authorizationProfileName - replicationBridgeAuthenticationClientCertPassword: replicationBridgeAuthenticationClientCertPassword - replicationBridgeEgressFlowWindowSize: 6 - restTlsServerCertMaxChainDepth: 4 - serviceRestIncomingPlainTextEnabled: true - replicationEnabled: true - eventServiceWebConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - bridgingTlsServerCertValidateDateEnabled: true - authorizationType: ldap - replicationAckPropagationIntervalMsgCount: 1 - bridgingTlsServerCertMaxChainDepth: 6 - replicationBridgeCompressedDataEnabled: true - serviceAmqpPlainTextEnabled: true - bridgingTlsServerCertEnforceTrustedCommonNameEnabled: true - restTlsServerCertValidateDateEnabled: true - eventTransactedSessionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - authenticationKerberosEnabled: true - authorizationLdapGroupMembershipAttributeName: authorizationLdapGroupMembershipAttributeName - serviceRestIncomingPlainTextListenPort: 1 - authenticationClientCertUsernameSource: certificate-thumbprint - replicationBridgeAuthenticationClientCertContent: replicationBridgeAuthenticationClientCertContent - eventSubscriptionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceMqttPlainTextListenPort: 8 - authenticationClientCertMaxChainDepth: 0 - serviceMqttWebSocketEnabled: true - authorizationLdapTrimClientUsernameDomainEnabled: true - serviceRestIncomingAuthorizationHeaderHandling: drop - authenticationClientCertEnabled: true - restTlsServerCertEnforceTrustedCommonNameEnabled: true - replicationRejectMsgWhenSyncIneligibleEnabled: true - eventPublishTopicFormatSmfEnabled: true - authenticationBasicProfileName: authenticationBasicProfileName - enabled: true - replicationBridgeAuthenticationScheme: basic - serviceRestIncomingAuthenticationClientCertRequest: always - replicationBridgeUnidirectionalClientProfileName: replicationBridgeUnidirectionalClientProfileName - serviceRestIncomingMaxConnectionCount: 6 - sempOverMsgBusEnabled: true - maxTransactionCount: 1 - serviceAmqpTlsListenPort: 9 - serviceMqttTlsListenPort: 9 - eventServiceAmqpConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceRestMode: gateway - serviceRestIncomingTlsEnabled: true - authenticationKerberosAllowApiProvidedUsernameEnabled: true - sempOverMsgBusAdminDistributedCacheEnabled: true - maxSubscriptionCount: 4 - authenticationOauthEnabled: true - authenticationBasicType: internal - serviceWebMaxConnectionCount: 5 - serviceAmqpMaxConnectionCount: 5 - maxEgressFlowCount: 7 - serviceMqttWebSocketListenPort: 3 - serviceSmfPlainTextEnabled: true - maxEndpointCount: 9 - serviceWebTlsEnabled: true - serviceMqttTlsWebSocketEnabled: true - exportSubscriptionsEnabled: true - authenticationClientCertCertificateMatchingRulesEnabled: true - eventIngressMsgRateThreshold: - setValue: 5 - clearValue: 1 - eventPublishSubscriptionMode: "off" - serviceMqttTlsEnabled: true - eventConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceSmfTlsEnabled: true - eventLargeMsgThreshold: 5 - serviceRestIncomingTlsListenPort: 2 - replicationQueueRejectMsgToSenderOnDiscardEnabled: true - eventTransactionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - eventPublishMsgVpnEnabled: true - sempOverMsgBusShowEnabled: true - serviceWebPlainTextEnabled: true - dmrEnabled: true - msgVpnName: msgVpnName - eventEndpointCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - sempOverMsgBusAdminEnabled: true - eventEgressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - eventServiceRestIncomingConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - eventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceSmfMaxConnectionCount: 6 - jndiEnabled: true - restTlsServerCertValidateNameEnabled: true - serviceMqttPlainTextEnabled: true - eventPublishClientEnabled: true - replicationQueueMaxMsgSpoolUsage: 1 - eventServiceMqttConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - sempOverMsgBusAdminClientEnabled: true - tlsAllowDowngradeToPlainTextEnabled: true - maxConnectionCount: 2 - serviceWebAuthenticationClientCertRequest: always - serviceRestOutgoingMaxConnectionCount: 6 - replicationBridgeTlsEnabled: true - authenticationClientCertRevocationCheckMode: allow-all - authenticationClientCertAllowApiProvidedUsernameEnabled: true - eventServiceSmfConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceAmqpPlainTextListenPort: 9 - authenticationClientCertValidateDateEnabled: true - serviceAmqpTlsEnabled: true - eventEgressMsgRateThreshold: - setValue: 5 - clearValue: 1 - replicationTransactionMode: sync - replicationRole: active - authenticationBasicRadiusDomain: authenticationBasicRadiusDomain - replicationEnabledQueueBehavior: fail-on-existing-queue - replicationBridgeRetryDelay: 7 - eventLogTag: eventLogTag - distributedCacheManagementEnabled: true - alias: alias - authenticationOauthDefaultProfileName: authenticationOauthDefaultProfileName - serviceMqttTlsWebSocketListenPort: 6 - replicationBridgeAuthenticationBasicClientUsername: replicationBridgeAuthenticationBasicClientUsername - bridgingTlsServerCertValidateNameEnabled: true - replicationBridgeAuthenticationBasicPassword: replicationBridgeAuthenticationBasicPassword - maxIngressFlowCount: 3 - serviceMqttAuthenticationClientCertRequest: always - maxTransactedSessionCount: 7 - mqttRetainMaxMemory: 1 - eventPublishTopicFormatMqttEnabled: true - authenticationBasicEnabled: true - maxMsgSpoolUsage: 2 - authenticationOauthDefaultProviderName: authenticationOauthDefaultProviderName - eventIngressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - authenticationOauthProvidersUri: authenticationOauthProvidersUri - authenticationOauthProfilesUri: authenticationOauthProfilesUri - clientProfilesUri: clientProfilesUri - topicEndpointsUri: topicEndpointsUri - jndiConnectionFactoriesUri: jndiConnectionFactoriesUri - mqttRetainCachesUri: mqttRetainCachesUri - clientUsernamesUri: clientUsernamesUri - bridgesUri: bridgesUri - replicatedTopicsUri: replicatedTopicsUri - topicEndpointTemplatesUri: topicEndpointTemplatesUri - aclProfilesUri: aclProfilesUri - sequencedTopicsUri: sequencedTopicsUri - uri: uri - jndiTopicsUri: jndiTopicsUri - dmrBridgesUri: dmrBridgesUri - replayLogsUri: replayLogsUri - certMatchingRulesUri: certMatchingRulesUri - queueTemplatesUri: queueTemplatesUri - queuesUri: queuesUri - restDeliveryPointsUri: restDeliveryPointsUri - distributedCachesUri: distributedCachesUri - mqttSessionsUri: mqttSessionsUri - authorizationGroupsUri: authorizationGroupsUri - jndiQueuesUri: jndiQueuesUri - properties: - data: - $ref: '#/components/schemas/MsgVpn' - links: - $ref: '#/components/schemas/MsgVpnLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnRestDeliveryPoint: - example: - service: service - vendor: vendor - clientProfileName: clientProfileName - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - enabled: true - properties: - clientProfileName: - description: The Client Profile of the REST Delivery Point. It must exist - in the local Message VPN. Its TCP parameters are used for all REST Consumers - in this RDP. Its queue properties are used by the RDP client. The Client - Profile is used inside the auto-generated Client Username for this RDP. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `"default"`. - type: string - enabled: - description: "Enable or disable the REST Delivery Point. When disabled,\ - \ no connections are initiated or messages delivered to any of the contained\ - \ REST Consumers. Changes to this attribute are synchronized to HA mates\ - \ and replication sites via config-sync. The default value is `false`." - type: boolean - msgVpnName: - description: The name of the Message VPN. - type: string - restDeliveryPointName: - description: The name of the REST Delivery Point. - type: string - service: - description: The name of the service that this REST Delivery Point connects - to. Internally the broker does not use this value; it is informational - only. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `""`. Available since 2.19. - type: string - vendor: - description: The name of the vendor that this REST Delivery Point connects - to. Internally the broker does not use this value; it is informational - only. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `""`. Available since 2.19. - type: string - type: object - MsgVpnRestDeliveryPointLinks: - example: - restConsumersUri: restConsumersUri - queueBindingsUri: queueBindingsUri - uri: uri - properties: - queueBindingsUri: - description: The URI of this REST Delivery Point's collection of Queue Binding - objects. - type: string - restConsumersUri: - description: The URI of this REST Delivery Point's collection of REST Consumer - objects. - type: string - uri: - description: The URI of this REST Delivery Point object. - type: string - type: object - MsgVpnRestDeliveryPointQueueBinding: - example: - requestTargetEvaluation: none - gatewayReplaceTargetAuthorityEnabled: true - queueBindingName: queueBindingName - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - postRequestTarget: postRequestTarget - properties: - gatewayReplaceTargetAuthorityEnabled: - description: "Enable or disable whether the authority for the request-target\ - \ is replaced with that configured for the REST Consumer remote. When\ - \ enabled, the broker sends HTTP requests in absolute-form, with the request-target's\ - \ authority taken from the REST Consumer's remote host and port configuration.\ - \ When disabled, the broker sends HTTP requests whose request-target matches\ - \ that of the original request message, including whether to use absolute-form\ - \ or origin-form. This configuration is applicable only when the Message\ - \ VPN is in REST gateway mode. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `false`. Available since 2.6." - type: boolean - msgVpnName: - description: The name of the Message VPN. - type: string - postRequestTarget: - description: "The request-target string to use when sending requests. It\ - \ identifies the target resource on the far-end REST Consumer upon which\ - \ to apply the request. There are generally two common forms for the request-target.\ - \ The origin-form is most often used in practice and contains the path\ - \ and query components of the target URI. If the path component is empty\ - \ then the client must generally send a \"/\" as the path. When making\ - \ a request to a proxy, most often the absolute-form is required. This\ - \ configuration is only applicable when the Message VPN is in REST messaging\ - \ mode. Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `\"\"`." - type: string - queueBindingName: - description: The name of a queue in the Message VPN. - type: string - requestTargetEvaluation: - description: |- - The type of evaluation to perform on the request target. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"none"`. The allowed values and their meaning are: - - 
-            "none" - Do not evaluate substitution expressions on the request target.
-            "substitution-expressions" - Evaluate substitution expressions on the request target.
-
- Available since 2.23. - enum: - - none - - substitution-expressions - type: string - restDeliveryPointName: - description: The name of the REST Delivery Point. - type: string - type: object - MsgVpnRestDeliveryPointQueueBindingLinks: - example: - requestHeadersUri: requestHeadersUri - uri: uri - properties: - requestHeadersUri: - description: The URI of this Queue Binding's collection of Request Header - objects. Available since 2.23. - type: string - uri: - description: The URI of this Queue Binding object. - type: string - type: object - MsgVpnRestDeliveryPointQueueBindingRequestHeader: - example: - headerName: headerName - queueBindingName: queueBindingName - headerValue: headerValue - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - properties: - headerName: - description: The name of the HTTP request header. - type: string - headerValue: - description: A substitution expression for the value of the HTTP request - header. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `""`. - type: string - msgVpnName: - description: The name of the Message VPN. - type: string - queueBindingName: - description: The name of a queue in the Message VPN. - type: string - restDeliveryPointName: - description: The name of the REST Delivery Point. - type: string - type: object - MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Request Header object. - type: string - type: object - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse: - example: - data: - headerName: headerName - queueBindingName: queueBindingName - headerValue: headerValue - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingRequestHeader' - links: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse: - example: - data: - - headerName: headerName - queueBindingName: queueBindingName - headerValue: headerValue - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - - headerName: headerName - queueBindingName: queueBindingName - headerValue: headerValue - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingRequestHeader' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnRestDeliveryPointQueueBindingResponse: - example: - data: - requestTargetEvaluation: none - gatewayReplaceTargetAuthorityEnabled: true - queueBindingName: queueBindingName - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - postRequestTarget: postRequestTarget - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - requestHeadersUri: requestHeadersUri - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBinding' - links: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnRestDeliveryPointQueueBindingsResponse: - example: - data: - - requestTargetEvaluation: none - gatewayReplaceTargetAuthorityEnabled: true - queueBindingName: queueBindingName - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - postRequestTarget: postRequestTarget - - requestTargetEvaluation: none - gatewayReplaceTargetAuthorityEnabled: true - queueBindingName: queueBindingName - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - postRequestTarget: postRequestTarget - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - requestHeadersUri: requestHeadersUri - uri: uri - - requestHeadersUri: requestHeadersUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBinding' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointQueueBindingLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnRestDeliveryPointResponse: - example: - data: - service: service - vendor: vendor - clientProfileName: clientProfileName - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - enabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - restConsumersUri: restConsumersUri - queueBindingsUri: queueBindingsUri - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnRestDeliveryPoint' - links: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnRestDeliveryPointRestConsumer: - example: - authenticationAwsSecretAccessKey: authenticationAwsSecretAccessKey - authenticationOauthClientSecret: authenticationOauthClientSecret - remoteHost: remoteHost - httpMethod: post - enabled: true - authenticationAwsRegion: authenticationAwsRegion - localInterface: localInterface - outgoingConnectionCount: 6 - retryDelay: 5 - authenticationAwsService: authenticationAwsService - tlsEnabled: true - authenticationScheme: none - authenticationClientCertContent: authenticationClientCertContent - msgVpnName: msgVpnName - authenticationOauthClientTokenEndpoint: authenticationOauthClientTokenEndpoint - authenticationOauthJwtSecretKey: authenticationOauthJwtSecretKey - authenticationHttpBasicUsername: authenticationHttpBasicUsername - authenticationHttpHeaderValue: authenticationHttpHeaderValue - maxPostWaitTime: 0 - authenticationAwsAccessKeyId: authenticationAwsAccessKeyId - authenticationOauthClientId: authenticationOauthClientId - restConsumerName: restConsumerName - remotePort: 1 - authenticationClientCertPassword: authenticationClientCertPassword - authenticationHttpHeaderName: authenticationHttpHeaderName - authenticationHttpBasicPassword: authenticationHttpBasicPassword - authenticationOauthJwtTokenEndpoint: authenticationOauthJwtTokenEndpoint - tlsCipherSuiteList: tlsCipherSuiteList - authenticationOauthClientScope: authenticationOauthClientScope - restDeliveryPointName: restDeliveryPointName - properties: - authenticationAwsAccessKeyId: - description: The AWS access key id. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `""`. Available since 2.26. - type: string - authenticationAwsRegion: - description: The AWS region id. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `""`. Available since 2.26. - type: string - authenticationAwsSecretAccessKey: - description: "The AWS secret access key. This attribute is absent from a\ - \ GET and not updated when absent in a PUT, subject to the exceptions\ - \ in note 4. Changes to this attribute are synchronized to HA mates and\ - \ replication sites via config-sync. The default value is `\"\"`. Available\ - \ since 2.26." - type: string - authenticationAwsService: - description: The AWS service id. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `""`. Available since 2.26. - type: string - authenticationClientCertContent: - description: "The PEM formatted content for the client certificate that\ - \ the REST Consumer will present to the REST host. It must consist of\ - \ a private key and between one and three certificates comprising the\ - \ certificate trust chain. This attribute is absent from a GET and not\ - \ updated when absent in a PUT, subject to the exceptions in note 4. Changing\ - \ this attribute requires an HTTPS connection. The default value is `\"\ - \"`. Available since 2.9." - type: string - x-requires-https: true - authenticationClientCertPassword: - description: "The password for the client certificate. This attribute is\ - \ absent from a GET and not updated when absent in a PUT, subject to the\ - \ exceptions in note 4. Changing this attribute requires an HTTPS connection.\ - \ The default value is `\"\"`. Available since 2.9." - type: string - x-requires-https: true - authenticationHttpBasicPassword: - description: "The password for the username. This attribute is absent from\ - \ a GET and not updated when absent in a PUT, subject to the exceptions\ - \ in note 4. Changes to this attribute are synchronized to HA mates and\ - \ replication sites via config-sync. The default value is `\"\"`." - type: string - authenticationHttpBasicUsername: - description: The username that the REST Consumer will use to login to the - REST host. Normally a username is only configured when basic authentication - is selected for the REST Consumer. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `""`. - type: string - authenticationHttpHeaderName: - description: The authentication header name. Changes to this attribute are - synchronized to HA mates and replication sites via config-sync. The default - value is `""`. Available since 2.15. - type: string - authenticationHttpHeaderValue: - description: "The authentication header value. This attribute is absent\ - \ from a GET and not updated when absent in a PUT, subject to the exceptions\ - \ in note 4. Changes to this attribute are synchronized to HA mates and\ - \ replication sites via config-sync. The default value is `\"\"`. Available\ - \ since 2.15." - type: string - authenticationOauthClientId: - description: The OAuth client ID. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `""`. Available since 2.19. - type: string - authenticationOauthClientScope: - description: The OAuth scope. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `""`. Available since 2.19. - type: string - authenticationOauthClientSecret: - description: "The OAuth client secret. This attribute is absent from a GET\ - \ and not updated when absent in a PUT, subject to the exceptions in note\ - \ 4. Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `\"\"`. Available since\ - \ 2.19." - type: string - authenticationOauthClientTokenEndpoint: - description: The OAuth token endpoint URL that the REST Consumer will use - to request a token for login to the REST host. Must begin with "https". - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `""`. Available since 2.19. - type: string - authenticationOauthJwtSecretKey: - description: "The OAuth secret key used to sign the token request JWT. This\ - \ attribute is absent from a GET and not updated when absent in a PUT,\ - \ subject to the exceptions in note 4. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `\"\"`. Available since 2.21." - type: string - authenticationOauthJwtTokenEndpoint: - description: The OAuth token endpoint URL that the REST Consumer will use - to request a token for login to the REST host. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `""`. Available since 2.21. - type: string - authenticationScheme: - description: | - The authentication scheme used by the REST Consumer to login to the REST host. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"none"`. The allowed values and their meaning are: - - 
-            "none" - Login with no authentication. This may be useful for anonymous connections or when a REST Consumer does not require authentication.
-            "http-basic" - Login with a username and optional password according to HTTP Basic authentication as per RFC2616.
-            "client-certificate" - Login with a client TLS certificate as per RFC5246. Client certificate authentication is only available on TLS connections.
-            "http-header" - Login with a specified HTTP header.
-            "oauth-client" - Login with OAuth 2.0 client credentials.
-            "oauth-jwt" - Login with OAuth (RFC 7523 JWT Profile).
-            "transparent" - Login using the Authorization header from the message properties, if present. Transparent authentication passes along existing Authorization header metadata instead of discarding it. Note that if the message is coming from a REST producer, the REST service must be configured to forward the Authorization header.
-            "aws" - Login using AWS Signature Version 4 authentication (AWS4-HMAC-SHA256).
-
- enum: - - none - - http-basic - - client-certificate - - http-header - - oauth-client - - oauth-jwt - - transparent - - aws - type: string - enabled: - description: "Enable or disable the REST Consumer. When disabled, no connections\ - \ are initiated or messages delivered to this particular REST Consumer.\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `false`." - type: boolean - httpMethod: - description: |- - The HTTP method to use (POST or PUT). This is used only when operating in the REST service "messaging" mode and is ignored in "gateway" mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"post"`. The allowed values and their meaning are: - - 
-            "post" - Use the POST HTTP method.
-            "put" - Use the PUT HTTP method.
-
- Available since 2.17. - enum: - - post - - put - type: string - localInterface: - description: "The interface that will be used for all outgoing connections\ - \ associated with the REST Consumer. When unspecified, an interface is\ - \ automatically chosen. Changes to this attribute are synchronized to\ - \ HA mates and replication sites via config-sync. The default value is\ - \ `\"\"`." - type: string - maxPostWaitTime: - description: "The maximum amount of time (in seconds) to wait for an HTTP\ - \ POST response from the REST Consumer. Once this time is exceeded, the\ - \ TCP connection is reset. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `30`." - format: int32 - type: integer - msgVpnName: - description: The name of the Message VPN. - type: string - outgoingConnectionCount: - description: The number of concurrent TCP connections open to the REST Consumer. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `3`. - format: int32 - type: integer - remoteHost: - description: The IP address or DNS name to which the broker is to connect - to deliver messages for the REST Consumer. A host value must be configured - for the REST Consumer to be operationally up. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `""`. - type: string - remotePort: - description: The port associated with the host of the REST Consumer. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `8080`. - format: int64 - type: integer - restConsumerName: - description: The name of the REST Consumer. - type: string - restDeliveryPointName: - description: The name of the REST Delivery Point. - type: string - retryDelay: - description: The number of seconds that must pass before retrying the remote - REST Consumer connection. Changes to this attribute are synchronized to - HA mates and replication sites via config-sync. The default value is `3`. - format: int32 - type: integer - tlsCipherSuiteList: - description: The colon-separated list of cipher suites the REST Consumer - uses in its encrypted connection. The value `"default"` implies all supported - suites ordered from most secure to least secure. The list of default cipher - suites is available in the `tlsCipherSuiteMsgBackboneDefaultList` attribute - of the Broker object in the Monitoring API. The REST Consumer should choose - the first suite from this list that it supports. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `"default"`. - type: string - tlsEnabled: - description: Enable or disable encryption (TLS) for the REST Consumer. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `false`. - type: boolean - type: object - MsgVpnRestDeliveryPointRestConsumerLinks: - example: - oauthJwtClaimsUri: oauthJwtClaimsUri - uri: uri - tlsTrustedCommonNamesUri: tlsTrustedCommonNamesUri - properties: - oauthJwtClaimsUri: - description: The URI of this REST Consumer's collection of Claim objects. - Available since 2.21. - type: string - tlsTrustedCommonNamesUri: - description: The URI of this REST Consumer's collection of Trusted Common - Name objects. Deprecated since (will be deprecated in next SEMP version). - Common Name validation has been replaced by Server Certificate Name validation. - type: string - uri: - description: The URI of this REST Consumer object. - type: string - type: object - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim: - example: - oauthJwtClaimValue: oauthJwtClaimValue - oauthJwtClaimName: oauthJwtClaimName - restConsumerName: restConsumerName - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - properties: - msgVpnName: - description: The name of the Message VPN. - type: string - oauthJwtClaimName: - description: "The name of the additional claim. Cannot be \"exp\", \"iat\"\ - , or \"jti\"." - type: string - oauthJwtClaimValue: - description: "The value of the additional claim, which must be a string\ - \ containing a valid JSON value." - type: string - restConsumerName: - description: The name of the REST Consumer. - type: string - restDeliveryPointName: - description: The name of the REST Delivery Point. - type: string - type: object - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Claim object. - type: string - type: object - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse: - example: - data: - oauthJwtClaimValue: oauthJwtClaimValue - oauthJwtClaimName: oauthJwtClaimName - restConsumerName: restConsumerName - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim' - links: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse: - example: - data: - - oauthJwtClaimValue: oauthJwtClaimValue - oauthJwtClaimName: oauthJwtClaimName - restConsumerName: restConsumerName - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - - oauthJwtClaimValue: oauthJwtClaimValue - oauthJwtClaimName: oauthJwtClaimName - restConsumerName: restConsumerName - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnRestDeliveryPointRestConsumerResponse: - example: - data: - authenticationAwsSecretAccessKey: authenticationAwsSecretAccessKey - authenticationOauthClientSecret: authenticationOauthClientSecret - remoteHost: remoteHost - httpMethod: post - enabled: true - authenticationAwsRegion: authenticationAwsRegion - localInterface: localInterface - outgoingConnectionCount: 6 - retryDelay: 5 - authenticationAwsService: authenticationAwsService - tlsEnabled: true - authenticationScheme: none - authenticationClientCertContent: authenticationClientCertContent - msgVpnName: msgVpnName - authenticationOauthClientTokenEndpoint: authenticationOauthClientTokenEndpoint - authenticationOauthJwtSecretKey: authenticationOauthJwtSecretKey - authenticationHttpBasicUsername: authenticationHttpBasicUsername - authenticationHttpHeaderValue: authenticationHttpHeaderValue - maxPostWaitTime: 0 - authenticationAwsAccessKeyId: authenticationAwsAccessKeyId - authenticationOauthClientId: authenticationOauthClientId - restConsumerName: restConsumerName - remotePort: 1 - authenticationClientCertPassword: authenticationClientCertPassword - authenticationHttpHeaderName: authenticationHttpHeaderName - authenticationHttpBasicPassword: authenticationHttpBasicPassword - authenticationOauthJwtTokenEndpoint: authenticationOauthJwtTokenEndpoint - tlsCipherSuiteList: tlsCipherSuiteList - authenticationOauthClientScope: authenticationOauthClientScope - restDeliveryPointName: restDeliveryPointName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - oauthJwtClaimsUri: oauthJwtClaimsUri - uri: uri - tlsTrustedCommonNamesUri: tlsTrustedCommonNamesUri - properties: - data: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumer' - links: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName: - example: - restConsumerName: restConsumerName - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - tlsTrustedCommonName: tlsTrustedCommonName - properties: - msgVpnName: - description: The name of the Message VPN. Deprecated since (will be deprecated - in next SEMP version). Common Name validation has been replaced by Server - Certificate Name validation. - type: string - restConsumerName: - description: The name of the REST Consumer. Deprecated since (will be deprecated - in next SEMP version). Common Name validation has been replaced by Server - Certificate Name validation. - type: string - restDeliveryPointName: - description: The name of the REST Delivery Point. Deprecated since (will - be deprecated in next SEMP version). Common Name validation has been replaced - by Server Certificate Name validation. - type: string - tlsTrustedCommonName: - description: The expected trusted common name of the remote certificate. - Deprecated since (will be deprecated in next SEMP version). Common Name - validation has been replaced by Server Certificate Name validation. - type: string - type: object - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Trusted Common Name object. - type: string - type: object - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse: - example: - data: - restConsumerName: restConsumerName - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - tlsTrustedCommonName: tlsTrustedCommonName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName' - links: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse: - example: - data: - - restConsumerName: restConsumerName - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - tlsTrustedCommonName: tlsTrustedCommonName - - restConsumerName: restConsumerName - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - tlsTrustedCommonName: tlsTrustedCommonName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnRestDeliveryPointRestConsumersResponse: - example: - data: - - authenticationAwsSecretAccessKey: authenticationAwsSecretAccessKey - authenticationOauthClientSecret: authenticationOauthClientSecret - remoteHost: remoteHost - httpMethod: post - enabled: true - authenticationAwsRegion: authenticationAwsRegion - localInterface: localInterface - outgoingConnectionCount: 6 - retryDelay: 5 - authenticationAwsService: authenticationAwsService - tlsEnabled: true - authenticationScheme: none - authenticationClientCertContent: authenticationClientCertContent - msgVpnName: msgVpnName - authenticationOauthClientTokenEndpoint: authenticationOauthClientTokenEndpoint - authenticationOauthJwtSecretKey: authenticationOauthJwtSecretKey - authenticationHttpBasicUsername: authenticationHttpBasicUsername - authenticationHttpHeaderValue: authenticationHttpHeaderValue - maxPostWaitTime: 0 - authenticationAwsAccessKeyId: authenticationAwsAccessKeyId - authenticationOauthClientId: authenticationOauthClientId - restConsumerName: restConsumerName - remotePort: 1 - authenticationClientCertPassword: authenticationClientCertPassword - authenticationHttpHeaderName: authenticationHttpHeaderName - authenticationHttpBasicPassword: authenticationHttpBasicPassword - authenticationOauthJwtTokenEndpoint: authenticationOauthJwtTokenEndpoint - tlsCipherSuiteList: tlsCipherSuiteList - authenticationOauthClientScope: authenticationOauthClientScope - restDeliveryPointName: restDeliveryPointName - - authenticationAwsSecretAccessKey: authenticationAwsSecretAccessKey - authenticationOauthClientSecret: authenticationOauthClientSecret - remoteHost: remoteHost - httpMethod: post - enabled: true - authenticationAwsRegion: authenticationAwsRegion - localInterface: localInterface - outgoingConnectionCount: 6 - retryDelay: 5 - authenticationAwsService: authenticationAwsService - tlsEnabled: true - authenticationScheme: none - authenticationClientCertContent: authenticationClientCertContent - msgVpnName: msgVpnName - authenticationOauthClientTokenEndpoint: authenticationOauthClientTokenEndpoint - authenticationOauthJwtSecretKey: authenticationOauthJwtSecretKey - authenticationHttpBasicUsername: authenticationHttpBasicUsername - authenticationHttpHeaderValue: authenticationHttpHeaderValue - maxPostWaitTime: 0 - authenticationAwsAccessKeyId: authenticationAwsAccessKeyId - authenticationOauthClientId: authenticationOauthClientId - restConsumerName: restConsumerName - remotePort: 1 - authenticationClientCertPassword: authenticationClientCertPassword - authenticationHttpHeaderName: authenticationHttpHeaderName - authenticationHttpBasicPassword: authenticationHttpBasicPassword - authenticationOauthJwtTokenEndpoint: authenticationOauthJwtTokenEndpoint - tlsCipherSuiteList: tlsCipherSuiteList - authenticationOauthClientScope: authenticationOauthClientScope - restDeliveryPointName: restDeliveryPointName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - oauthJwtClaimsUri: oauthJwtClaimsUri - uri: uri - tlsTrustedCommonNamesUri: tlsTrustedCommonNamesUri - - oauthJwtClaimsUri: oauthJwtClaimsUri - uri: uri - tlsTrustedCommonNamesUri: tlsTrustedCommonNamesUri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumer' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointRestConsumerLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnRestDeliveryPointsResponse: - example: - data: - - service: service - vendor: vendor - clientProfileName: clientProfileName - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - enabled: true - - service: service - vendor: vendor - clientProfileName: clientProfileName - msgVpnName: msgVpnName - restDeliveryPointName: restDeliveryPointName - enabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - restConsumersUri: restConsumersUri - queueBindingsUri: queueBindingsUri - uri: uri - - restConsumersUri: restConsumersUri - queueBindingsUri: queueBindingsUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnRestDeliveryPoint' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnRestDeliveryPointLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnSequencedTopic: - example: - sequencedTopic: sequencedTopic - msgVpnName: msgVpnName - properties: - msgVpnName: - description: The name of the Message VPN. - type: string - sequencedTopic: - description: Topic for applying sequence numbers. - type: string - type: object - MsgVpnSequencedTopicLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Sequenced Topic object. - type: string - type: object - MsgVpnSequencedTopicResponse: - example: - data: - sequencedTopic: sequencedTopic - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnSequencedTopic' - links: - $ref: '#/components/schemas/MsgVpnSequencedTopicLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnSequencedTopicsResponse: - example: - data: - - sequencedTopic: sequencedTopic - msgVpnName: msgVpnName - - sequencedTopic: sequencedTopic - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnSequencedTopic' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnSequencedTopicLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnTopicEndpoint: - example: - redeliveryEnabled: true - rejectLowPriorityMsgLimit: 9 - eventSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - maxMsgSize: 5 - accessType: exclusive - deadMsgQueue: deadMsgQueue - deliveryCountEnabled: true - rejectMsgToSenderOnDiscardBehavior: always - consumerAckPropagationEnabled: true - eventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - respectMsgPriorityEnabled: true - msgVpnName: msgVpnName - maxDeliveredUnackedMsgsPerFlow: 1 - rejectLowPriorityMsgEnabled: true - deliveryDelay: 0 - maxBindCount: 6 - owner: owner - topicEndpointName: topicEndpointName - maxSpoolUsage: 2 - egressEnabled: true - maxTtl: 7 - respectTtlEnabled: true - permission: no-access - maxRedeliveryCount: 5 - ingressEnabled: true - eventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - properties: - accessType: - description: |- - The access type for delivering messages to consumer flows bound to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"exclusive"`. The allowed values and their meaning are: - - 
-            "exclusive" - Exclusive delivery of messages to the first bound consumer flow.
-            "non-exclusive" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion.
-
- Available since 2.4. - enum: - - exclusive - - non-exclusive - type: string - consumerAckPropagationEnabled: - description: Enable or disable the propagation of consumer acknowledgements - (ACKs) received on the active replication Message VPN to the standby replication - Message VPN. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default value is `true`. - type: boolean - deadMsgQueue: - description: The name of the Dead Message Queue (DMQ) used by the Topic - Endpoint. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `"#DEAD_MSG_QUEUE"`. Available - since 2.2. - type: string - deliveryCountEnabled: - description: Enable or disable the ability for client applications to query - the message delivery count of messages received from the Topic Endpoint. - This is a controlled availability feature. Please contact support to find - out if this feature is supported for your use case. Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `false`. Available since 2.19. - type: boolean - deliveryDelay: - description: "The delay, in seconds, to apply to messages arriving on the\ - \ Topic Endpoint before the messages are eligible for delivery. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `0`. Available since 2.22." - format: int64 - type: integer - egressEnabled: - description: Enable or disable the transmission of messages from the Topic - Endpoint. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `false`. - type: boolean - eventBindCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventRejectLowPriorityMsgLimitThreshold: - $ref: '#/components/schemas/EventThreshold' - eventSpoolUsageThreshold: - $ref: '#/components/schemas/EventThreshold' - ingressEnabled: - description: Enable or disable the reception of messages to the Topic Endpoint. - Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `false`. - type: boolean - maxBindCount: - description: The maximum number of consumer flows that can bind to the Topic - Endpoint. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `1`. Available since 2.4. - format: int64 - type: integer - maxDeliveredUnackedMsgsPerFlow: - description: The maximum number of messages delivered but not acknowledged - per flow for the Topic Endpoint. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `10000`. - format: int64 - type: integer - maxMsgSize: - description: "The maximum message size allowed in the Topic Endpoint, in\ - \ bytes (B). Changes to this attribute are synchronized to HA mates and\ - \ replication sites via config-sync. The default value is `10000000`." - format: int32 - type: integer - maxRedeliveryCount: - description: The maximum number of times the Topic Endpoint will attempt - redelivery of a message prior to it being discarded or moved to the DMQ. - A value of 0 means to retry forever. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `0`. - format: int64 - type: integer - maxSpoolUsage: - description: "The maximum message spool usage allowed by the Topic Endpoint,\ - \ in megabytes (MB). A value of 0 only allows spooling of the last message\ - \ received and disables quota checking. Changes to this attribute are\ - \ synchronized to HA mates and replication sites via config-sync. The\ - \ default value is `5000`." - format: int64 - type: integer - maxTtl: - description: "The maximum time in seconds a message can stay in the Topic\ - \ Endpoint when `respectTtlEnabled` is `\"true\"`. A message expires when\ - \ the lesser of the sender assigned time-to-live (TTL) in the message\ - \ and the `maxTtl` configured for the Topic Endpoint, is exceeded. A value\ - \ of 0 disables expiry. Changes to this attribute are synchronized to\ - \ HA mates and replication sites via config-sync. The default value is\ - \ `0`." - format: int64 - type: integer - msgVpnName: - description: The name of the Message VPN. - type: string - owner: - description: The Client Username that owns the Topic Endpoint and has permission - equivalent to `"delete"`. Changes to this attribute are synchronized to - HA mates and replication sites via config-sync. The default value is `""`. - type: string - permission: - description: | - The permission level for all consumers of the Topic Endpoint, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"no-access"`. The allowed values and their meaning are: - - 
-            "no-access" - Disallows all access.
-            "read-only" - Read-only access to the messages.
-            "consume" - Consume (read and remove) messages.
-            "modify-topic" - Consume messages or modify the topic/selector.
-            "delete" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.
-
- enum: - - no-access - - read-only - - consume - - modify-topic - - delete - type: string - redeliveryEnabled: - description: "Enable or disable message redelivery. When enabled, the number\ - \ of redelivery attempts is controlled by maxRedeliveryCount. When disabled,\ - \ the message will never be delivered from the topic-endpoint more than\ - \ once. Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `true`. Available since\ - \ 2.18." - type: boolean - rejectLowPriorityMsgEnabled: - description: Enable or disable the checking of low priority messages against - the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` - does not have a value of `"never"`. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. - type: boolean - rejectLowPriorityMsgLimit: - description: The number of messages of any priority in the Topic Endpoint - above which low priority messages are not admitted but higher priority - messages are allowed. Changes to this attribute are synchronized to HA - mates and replication sites via config-sync. The default value is `0`. - format: int64 - type: integer - rejectMsgToSenderOnDiscardBehavior: - description: | - Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"never"`. The allowed values and their meaning are: - - 
-            "always" - Always return a negative acknowledgment (NACK) to the sending client on message discard.
-            "when-topic-endpoint-enabled" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Topic Endpoint is enabled.
-            "never" - Never return a negative acknowledgment (NACK) to the sending client on message discard.
-
- enum: - - always - - when-topic-endpoint-enabled - - never - type: string - respectMsgPriorityEnabled: - description: "Enable or disable the respecting of message priority. When\ - \ enabled, messages contained in the Topic Endpoint are delivered in priority\ - \ order, from 9 (highest) to 0 (lowest). Changes to this attribute are\ - \ synchronized to HA mates and replication sites via config-sync. The\ - \ default value is `false`. Available since 2.8." - type: boolean - respectTtlEnabled: - description: "Enable or disable the respecting of the time-to-live (TTL)\ - \ for messages in the Topic Endpoint. When enabled, expired messages are\ - \ discarded or moved to the DMQ. Changes to this attribute are synchronized\ - \ to HA mates and replication sites via config-sync. The default value\ - \ is `false`." - type: boolean - topicEndpointName: - description: The name of the Topic Endpoint. - type: string - type: object - MsgVpnTopicEndpointLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Topic Endpoint object. - type: string - type: object - MsgVpnTopicEndpointResponse: - example: - data: - redeliveryEnabled: true - rejectLowPriorityMsgLimit: 9 - eventSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - maxMsgSize: 5 - accessType: exclusive - deadMsgQueue: deadMsgQueue - deliveryCountEnabled: true - rejectMsgToSenderOnDiscardBehavior: always - consumerAckPropagationEnabled: true - eventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - respectMsgPriorityEnabled: true - msgVpnName: msgVpnName - maxDeliveredUnackedMsgsPerFlow: 1 - rejectLowPriorityMsgEnabled: true - deliveryDelay: 0 - maxBindCount: 6 - owner: owner - topicEndpointName: topicEndpointName - maxSpoolUsage: 2 - egressEnabled: true - maxTtl: 7 - respectTtlEnabled: true - permission: no-access - maxRedeliveryCount: 5 - ingressEnabled: true - eventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnTopicEndpoint' - links: - $ref: '#/components/schemas/MsgVpnTopicEndpointLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnTopicEndpointTemplate: - example: - maxBindCount: 6 - eventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - topicEndpointTemplateName: topicEndpointTemplateName - redeliveryEnabled: true - maxTtl: 7 - respectTtlEnabled: true - permission: no-access - rejectLowPriorityMsgLimit: 9 - maxRedeliveryCount: 2 - maxMsgSize: 5 - accessType: exclusive - deadMsgQueue: deadMsgQueue - rejectMsgToSenderOnDiscardBehavior: always - consumerAckPropagationEnabled: true - eventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - respectMsgPriorityEnabled: true - eventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - topicEndpointNameFilter: topicEndpointNameFilter - maxMsgSpoolUsage: 5 - msgVpnName: msgVpnName - maxDeliveredUnackedMsgsPerFlow: 1 - rejectLowPriorityMsgEnabled: true - deliveryDelay: 0 - properties: - accessType: - description: | - The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"exclusive"`. The allowed values and their meaning are: - - 
-            "exclusive" - Exclusive delivery of messages to the first bound consumer flow.
-            "non-exclusive" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion.
-
- enum: - - exclusive - - non-exclusive - type: string - consumerAckPropagationEnabled: - description: Enable or disable the propagation of consumer acknowledgements - (ACKs) received on the active replication Message VPN to the standby replication - Message VPN. Changes to this attribute are synchronized to HA mates and - replication sites via config-sync. The default value is `true`. - type: boolean - deadMsgQueue: - description: The name of the Dead Message Queue (DMQ). Changes to this attribute - are synchronized to HA mates and replication sites via config-sync. The - default value is `"#DEAD_MSG_QUEUE"`. - type: string - deliveryDelay: - description: "The delay, in seconds, to apply to messages arriving on the\ - \ Topic Endpoint before the messages are eligible for delivery. Changes\ - \ to this attribute are synchronized to HA mates and replication sites\ - \ via config-sync. The default value is `0`. Available since 2.22." - format: int64 - type: integer - eventBindCountThreshold: - $ref: '#/components/schemas/EventThreshold' - eventMsgSpoolUsageThreshold: - $ref: '#/components/schemas/EventThreshold' - eventRejectLowPriorityMsgLimitThreshold: - $ref: '#/components/schemas/EventThreshold' - maxBindCount: - description: The maximum number of consumer flows that can bind. Changes - to this attribute are synchronized to HA mates and replication sites via - config-sync. The default value is `1`. - format: int64 - type: integer - maxDeliveredUnackedMsgsPerFlow: - description: The maximum number of messages delivered but not acknowledged - per flow. Changes to this attribute are synchronized to HA mates and replication - sites via config-sync. The default value is `10000`. - format: int64 - type: integer - maxMsgSize: - description: "The maximum message size allowed, in bytes (B). Changes to\ - \ this attribute are synchronized to HA mates and replication sites via\ - \ config-sync. The default value is `10000000`." - format: int32 - type: integer - maxMsgSpoolUsage: - description: "The maximum message spool usage allowed, in megabytes (MB).\ - \ A value of 0 only allows spooling of the last message received and disables\ - \ quota checking. Changes to this attribute are synchronized to HA mates\ - \ and replication sites via config-sync. The default value is `5000`." - format: int64 - type: integer - maxRedeliveryCount: - description: The maximum number of message redelivery attempts that will - occur prior to the message being discarded or moved to the DMQ. A value - of 0 means to retry forever. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `0`. - format: int64 - type: integer - maxTtl: - description: "The maximum time in seconds a message can stay in the Topic\ - \ Endpoint when `respectTtlEnabled` is `\"true\"`. A message expires when\ - \ the lesser of the sender assigned time-to-live (TTL) in the message\ - \ and the `maxTtl` configured for the Topic Endpoint, is exceeded. A value\ - \ of 0 disables expiry. Changes to this attribute are synchronized to\ - \ HA mates and replication sites via config-sync. The default value is\ - \ `0`." - format: int64 - type: integer - msgVpnName: - description: The name of the Message VPN. - type: string - permission: - description: | - The permission level for all consumers, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"no-access"`. The allowed values and their meaning are: - - 
-            "no-access" - Disallows all access.
-            "read-only" - Read-only access to the messages.
-            "consume" - Consume (read and remove) messages.
-            "modify-topic" - Consume messages or modify the topic/selector.
-            "delete" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.
-
- enum: - - no-access - - read-only - - consume - - modify-topic - - delete - type: string - redeliveryEnabled: - description: "Enable or disable message redelivery. When enabled, the number\ - \ of redelivery attempts is controlled by maxRedeliveryCount. When disabled,\ - \ the message will never be delivered from the topic-endpoint more than\ - \ once. Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `true`. Available since\ - \ 2.18." - type: boolean - rejectLowPriorityMsgEnabled: - description: Enable or disable the checking of low priority messages against - the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` - does not have a value of `"never"`. Changes to this attribute are synchronized - to HA mates and replication sites via config-sync. The default value is - `false`. - type: boolean - rejectLowPriorityMsgLimit: - description: The number of messages that are permitted before low priority - messages are rejected. Changes to this attribute are synchronized to HA - mates and replication sites via config-sync. The default value is `0`. - format: int64 - type: integer - rejectMsgToSenderOnDiscardBehavior: - description: | - Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"never"`. The allowed values and their meaning are: - - 
-            "always" - Always return a negative acknowledgment (NACK) to the sending client on message discard.
-            "when-topic-endpoint-enabled" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Topic Endpoint is enabled.
-            "never" - Never return a negative acknowledgment (NACK) to the sending client on message discard.
-
- enum: - - always - - when-topic-endpoint-enabled - - never - type: string - respectMsgPriorityEnabled: - description: "Enable or disable the respecting of message priority. When\ - \ enabled, messages are delivered in priority order, from 9 (highest)\ - \ to 0 (lowest). Changes to this attribute are synchronized to HA mates\ - \ and replication sites via config-sync. The default value is `false`." - type: boolean - respectTtlEnabled: - description: "Enable or disable the respecting of the time-to-live (TTL)\ - \ for messages. When enabled, expired messages are discarded or moved\ - \ to the DMQ. Changes to this attribute are synchronized to HA mates and\ - \ replication sites via config-sync. The default value is `false`." - type: boolean - topicEndpointNameFilter: - description: "A wildcardable pattern used to determine which Topic Endpoints\ - \ use settings from this Template. Two different wildcards are supported:\ - \ * and >. Similar to topic filters or subscription patterns, a > matches\ - \ anything (but only when used at the end), and a * matches zero or more\ - \ characters but never a slash (/). A > is only a wildcard when used at\ - \ the end, after a /. A * is only allowed at the end, after a slash (/).\ - \ Changes to this attribute are synchronized to HA mates and replication\ - \ sites via config-sync. The default value is `\"\"`." - type: string - topicEndpointTemplateName: - description: The name of the Topic Endpoint Template. - type: string - type: object - MsgVpnTopicEndpointTemplateLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Topic Endpoint Template object. - type: string - type: object - MsgVpnTopicEndpointTemplateResponse: - example: - data: - maxBindCount: 6 - eventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - topicEndpointTemplateName: topicEndpointTemplateName - redeliveryEnabled: true - maxTtl: 7 - respectTtlEnabled: true - permission: no-access - rejectLowPriorityMsgLimit: 9 - maxRedeliveryCount: 2 - maxMsgSize: 5 - accessType: exclusive - deadMsgQueue: deadMsgQueue - rejectMsgToSenderOnDiscardBehavior: always - consumerAckPropagationEnabled: true - eventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - respectMsgPriorityEnabled: true - eventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - topicEndpointNameFilter: topicEndpointNameFilter - maxMsgSpoolUsage: 5 - msgVpnName: msgVpnName - maxDeliveredUnackedMsgsPerFlow: 1 - rejectLowPriorityMsgEnabled: true - deliveryDelay: 0 - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/MsgVpnTopicEndpointTemplate' - links: - $ref: '#/components/schemas/MsgVpnTopicEndpointTemplateLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnTopicEndpointTemplatesResponse: - example: - data: - - maxBindCount: 6 - eventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - topicEndpointTemplateName: topicEndpointTemplateName - redeliveryEnabled: true - maxTtl: 7 - respectTtlEnabled: true - permission: no-access - rejectLowPriorityMsgLimit: 9 - maxRedeliveryCount: 2 - maxMsgSize: 5 - accessType: exclusive - deadMsgQueue: deadMsgQueue - rejectMsgToSenderOnDiscardBehavior: always - consumerAckPropagationEnabled: true - eventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - respectMsgPriorityEnabled: true - eventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - topicEndpointNameFilter: topicEndpointNameFilter - maxMsgSpoolUsage: 5 - msgVpnName: msgVpnName - maxDeliveredUnackedMsgsPerFlow: 1 - rejectLowPriorityMsgEnabled: true - deliveryDelay: 0 - - maxBindCount: 6 - eventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - topicEndpointTemplateName: topicEndpointTemplateName - redeliveryEnabled: true - maxTtl: 7 - respectTtlEnabled: true - permission: no-access - rejectLowPriorityMsgLimit: 9 - maxRedeliveryCount: 2 - maxMsgSize: 5 - accessType: exclusive - deadMsgQueue: deadMsgQueue - rejectMsgToSenderOnDiscardBehavior: always - consumerAckPropagationEnabled: true - eventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - respectMsgPriorityEnabled: true - eventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - topicEndpointNameFilter: topicEndpointNameFilter - maxMsgSpoolUsage: 5 - msgVpnName: msgVpnName - maxDeliveredUnackedMsgsPerFlow: 1 - rejectLowPriorityMsgEnabled: true - deliveryDelay: 0 - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnTopicEndpointTemplate' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnTopicEndpointTemplateLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnTopicEndpointsResponse: - example: - data: - - redeliveryEnabled: true - rejectLowPriorityMsgLimit: 9 - eventSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - maxMsgSize: 5 - accessType: exclusive - deadMsgQueue: deadMsgQueue - deliveryCountEnabled: true - rejectMsgToSenderOnDiscardBehavior: always - consumerAckPropagationEnabled: true - eventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - respectMsgPriorityEnabled: true - msgVpnName: msgVpnName - maxDeliveredUnackedMsgsPerFlow: 1 - rejectLowPriorityMsgEnabled: true - deliveryDelay: 0 - maxBindCount: 6 - owner: owner - topicEndpointName: topicEndpointName - maxSpoolUsage: 2 - egressEnabled: true - maxTtl: 7 - respectTtlEnabled: true - permission: no-access - maxRedeliveryCount: 5 - ingressEnabled: true - eventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - - redeliveryEnabled: true - rejectLowPriorityMsgLimit: 9 - eventSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - maxMsgSize: 5 - accessType: exclusive - deadMsgQueue: deadMsgQueue - deliveryCountEnabled: true - rejectMsgToSenderOnDiscardBehavior: always - consumerAckPropagationEnabled: true - eventBindCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - respectMsgPriorityEnabled: true - msgVpnName: msgVpnName - maxDeliveredUnackedMsgsPerFlow: 1 - rejectLowPriorityMsgEnabled: true - deliveryDelay: 0 - maxBindCount: 6 - owner: owner - topicEndpointName: topicEndpointName - maxSpoolUsage: 2 - egressEnabled: true - maxTtl: 7 - respectTtlEnabled: true - permission: no-access - maxRedeliveryCount: 5 - ingressEnabled: true - eventRejectLowPriorityMsgLimitThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpnTopicEndpoint' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnTopicEndpointLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - MsgVpnsResponse: - example: - data: - - serviceMqttMaxConnectionCount: 6 - authorizationProfileName: authorizationProfileName - replicationBridgeAuthenticationClientCertPassword: replicationBridgeAuthenticationClientCertPassword - replicationBridgeEgressFlowWindowSize: 6 - restTlsServerCertMaxChainDepth: 4 - serviceRestIncomingPlainTextEnabled: true - replicationEnabled: true - eventServiceWebConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - bridgingTlsServerCertValidateDateEnabled: true - authorizationType: ldap - replicationAckPropagationIntervalMsgCount: 1 - bridgingTlsServerCertMaxChainDepth: 6 - replicationBridgeCompressedDataEnabled: true - serviceAmqpPlainTextEnabled: true - bridgingTlsServerCertEnforceTrustedCommonNameEnabled: true - restTlsServerCertValidateDateEnabled: true - eventTransactedSessionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - authenticationKerberosEnabled: true - authorizationLdapGroupMembershipAttributeName: authorizationLdapGroupMembershipAttributeName - serviceRestIncomingPlainTextListenPort: 1 - authenticationClientCertUsernameSource: certificate-thumbprint - replicationBridgeAuthenticationClientCertContent: replicationBridgeAuthenticationClientCertContent - eventSubscriptionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceMqttPlainTextListenPort: 8 - authenticationClientCertMaxChainDepth: 0 - serviceMqttWebSocketEnabled: true - authorizationLdapTrimClientUsernameDomainEnabled: true - serviceRestIncomingAuthorizationHeaderHandling: drop - authenticationClientCertEnabled: true - restTlsServerCertEnforceTrustedCommonNameEnabled: true - replicationRejectMsgWhenSyncIneligibleEnabled: true - eventPublishTopicFormatSmfEnabled: true - authenticationBasicProfileName: authenticationBasicProfileName - enabled: true - replicationBridgeAuthenticationScheme: basic - serviceRestIncomingAuthenticationClientCertRequest: always - replicationBridgeUnidirectionalClientProfileName: replicationBridgeUnidirectionalClientProfileName - serviceRestIncomingMaxConnectionCount: 6 - sempOverMsgBusEnabled: true - maxTransactionCount: 1 - serviceAmqpTlsListenPort: 9 - serviceMqttTlsListenPort: 9 - eventServiceAmqpConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceRestMode: gateway - serviceRestIncomingTlsEnabled: true - authenticationKerberosAllowApiProvidedUsernameEnabled: true - sempOverMsgBusAdminDistributedCacheEnabled: true - maxSubscriptionCount: 4 - authenticationOauthEnabled: true - authenticationBasicType: internal - serviceWebMaxConnectionCount: 5 - serviceAmqpMaxConnectionCount: 5 - maxEgressFlowCount: 7 - serviceMqttWebSocketListenPort: 3 - serviceSmfPlainTextEnabled: true - maxEndpointCount: 9 - serviceWebTlsEnabled: true - serviceMqttTlsWebSocketEnabled: true - exportSubscriptionsEnabled: true - authenticationClientCertCertificateMatchingRulesEnabled: true - eventIngressMsgRateThreshold: - setValue: 5 - clearValue: 1 - eventPublishSubscriptionMode: "off" - serviceMqttTlsEnabled: true - eventConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceSmfTlsEnabled: true - eventLargeMsgThreshold: 5 - serviceRestIncomingTlsListenPort: 2 - replicationQueueRejectMsgToSenderOnDiscardEnabled: true - eventTransactionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - eventPublishMsgVpnEnabled: true - sempOverMsgBusShowEnabled: true - serviceWebPlainTextEnabled: true - dmrEnabled: true - msgVpnName: msgVpnName - eventEndpointCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - sempOverMsgBusAdminEnabled: true - eventEgressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - eventServiceRestIncomingConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - eventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceSmfMaxConnectionCount: 6 - jndiEnabled: true - restTlsServerCertValidateNameEnabled: true - serviceMqttPlainTextEnabled: true - eventPublishClientEnabled: true - replicationQueueMaxMsgSpoolUsage: 1 - eventServiceMqttConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - sempOverMsgBusAdminClientEnabled: true - tlsAllowDowngradeToPlainTextEnabled: true - maxConnectionCount: 2 - serviceWebAuthenticationClientCertRequest: always - serviceRestOutgoingMaxConnectionCount: 6 - replicationBridgeTlsEnabled: true - authenticationClientCertRevocationCheckMode: allow-all - authenticationClientCertAllowApiProvidedUsernameEnabled: true - eventServiceSmfConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceAmqpPlainTextListenPort: 9 - authenticationClientCertValidateDateEnabled: true - serviceAmqpTlsEnabled: true - eventEgressMsgRateThreshold: - setValue: 5 - clearValue: 1 - replicationTransactionMode: sync - replicationRole: active - authenticationBasicRadiusDomain: authenticationBasicRadiusDomain - replicationEnabledQueueBehavior: fail-on-existing-queue - replicationBridgeRetryDelay: 7 - eventLogTag: eventLogTag - distributedCacheManagementEnabled: true - alias: alias - authenticationOauthDefaultProfileName: authenticationOauthDefaultProfileName - serviceMqttTlsWebSocketListenPort: 6 - replicationBridgeAuthenticationBasicClientUsername: replicationBridgeAuthenticationBasicClientUsername - bridgingTlsServerCertValidateNameEnabled: true - replicationBridgeAuthenticationBasicPassword: replicationBridgeAuthenticationBasicPassword - maxIngressFlowCount: 3 - serviceMqttAuthenticationClientCertRequest: always - maxTransactedSessionCount: 7 - mqttRetainMaxMemory: 1 - eventPublishTopicFormatMqttEnabled: true - authenticationBasicEnabled: true - maxMsgSpoolUsage: 2 - authenticationOauthDefaultProviderName: authenticationOauthDefaultProviderName - eventIngressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - - serviceMqttMaxConnectionCount: 6 - authorizationProfileName: authorizationProfileName - replicationBridgeAuthenticationClientCertPassword: replicationBridgeAuthenticationClientCertPassword - replicationBridgeEgressFlowWindowSize: 6 - restTlsServerCertMaxChainDepth: 4 - serviceRestIncomingPlainTextEnabled: true - replicationEnabled: true - eventServiceWebConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - bridgingTlsServerCertValidateDateEnabled: true - authorizationType: ldap - replicationAckPropagationIntervalMsgCount: 1 - bridgingTlsServerCertMaxChainDepth: 6 - replicationBridgeCompressedDataEnabled: true - serviceAmqpPlainTextEnabled: true - bridgingTlsServerCertEnforceTrustedCommonNameEnabled: true - restTlsServerCertValidateDateEnabled: true - eventTransactedSessionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - authenticationKerberosEnabled: true - authorizationLdapGroupMembershipAttributeName: authorizationLdapGroupMembershipAttributeName - serviceRestIncomingPlainTextListenPort: 1 - authenticationClientCertUsernameSource: certificate-thumbprint - replicationBridgeAuthenticationClientCertContent: replicationBridgeAuthenticationClientCertContent - eventSubscriptionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceMqttPlainTextListenPort: 8 - authenticationClientCertMaxChainDepth: 0 - serviceMqttWebSocketEnabled: true - authorizationLdapTrimClientUsernameDomainEnabled: true - serviceRestIncomingAuthorizationHeaderHandling: drop - authenticationClientCertEnabled: true - restTlsServerCertEnforceTrustedCommonNameEnabled: true - replicationRejectMsgWhenSyncIneligibleEnabled: true - eventPublishTopicFormatSmfEnabled: true - authenticationBasicProfileName: authenticationBasicProfileName - enabled: true - replicationBridgeAuthenticationScheme: basic - serviceRestIncomingAuthenticationClientCertRequest: always - replicationBridgeUnidirectionalClientProfileName: replicationBridgeUnidirectionalClientProfileName - serviceRestIncomingMaxConnectionCount: 6 - sempOverMsgBusEnabled: true - maxTransactionCount: 1 - serviceAmqpTlsListenPort: 9 - serviceMqttTlsListenPort: 9 - eventServiceAmqpConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceRestMode: gateway - serviceRestIncomingTlsEnabled: true - authenticationKerberosAllowApiProvidedUsernameEnabled: true - sempOverMsgBusAdminDistributedCacheEnabled: true - maxSubscriptionCount: 4 - authenticationOauthEnabled: true - authenticationBasicType: internal - serviceWebMaxConnectionCount: 5 - serviceAmqpMaxConnectionCount: 5 - maxEgressFlowCount: 7 - serviceMqttWebSocketListenPort: 3 - serviceSmfPlainTextEnabled: true - maxEndpointCount: 9 - serviceWebTlsEnabled: true - serviceMqttTlsWebSocketEnabled: true - exportSubscriptionsEnabled: true - authenticationClientCertCertificateMatchingRulesEnabled: true - eventIngressMsgRateThreshold: - setValue: 5 - clearValue: 1 - eventPublishSubscriptionMode: "off" - serviceMqttTlsEnabled: true - eventConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceSmfTlsEnabled: true - eventLargeMsgThreshold: 5 - serviceRestIncomingTlsListenPort: 2 - replicationQueueRejectMsgToSenderOnDiscardEnabled: true - eventTransactionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - eventPublishMsgVpnEnabled: true - sempOverMsgBusShowEnabled: true - serviceWebPlainTextEnabled: true - dmrEnabled: true - msgVpnName: msgVpnName - eventEndpointCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - sempOverMsgBusAdminEnabled: true - eventEgressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - eventServiceRestIncomingConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - eventMsgSpoolUsageThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceSmfMaxConnectionCount: 6 - jndiEnabled: true - restTlsServerCertValidateNameEnabled: true - serviceMqttPlainTextEnabled: true - eventPublishClientEnabled: true - replicationQueueMaxMsgSpoolUsage: 1 - eventServiceMqttConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - sempOverMsgBusAdminClientEnabled: true - tlsAllowDowngradeToPlainTextEnabled: true - maxConnectionCount: 2 - serviceWebAuthenticationClientCertRequest: always - serviceRestOutgoingMaxConnectionCount: 6 - replicationBridgeTlsEnabled: true - authenticationClientCertRevocationCheckMode: allow-all - authenticationClientCertAllowApiProvidedUsernameEnabled: true - eventServiceSmfConnectionCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - serviceAmqpPlainTextListenPort: 9 - authenticationClientCertValidateDateEnabled: true - serviceAmqpTlsEnabled: true - eventEgressMsgRateThreshold: - setValue: 5 - clearValue: 1 - replicationTransactionMode: sync - replicationRole: active - authenticationBasicRadiusDomain: authenticationBasicRadiusDomain - replicationEnabledQueueBehavior: fail-on-existing-queue - replicationBridgeRetryDelay: 7 - eventLogTag: eventLogTag - distributedCacheManagementEnabled: true - alias: alias - authenticationOauthDefaultProfileName: authenticationOauthDefaultProfileName - serviceMqttTlsWebSocketListenPort: 6 - replicationBridgeAuthenticationBasicClientUsername: replicationBridgeAuthenticationBasicClientUsername - bridgingTlsServerCertValidateNameEnabled: true - replicationBridgeAuthenticationBasicPassword: replicationBridgeAuthenticationBasicPassword - maxIngressFlowCount: 3 - serviceMqttAuthenticationClientCertRequest: always - maxTransactedSessionCount: 7 - mqttRetainMaxMemory: 1 - eventPublishTopicFormatMqttEnabled: true - authenticationBasicEnabled: true - maxMsgSpoolUsage: 2 - authenticationOauthDefaultProviderName: authenticationOauthDefaultProviderName - eventIngressFlowCountThreshold: - clearPercent: 4 - setPercent: 1 - setValue: 1 - clearValue: 7 - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - authenticationOauthProvidersUri: authenticationOauthProvidersUri - authenticationOauthProfilesUri: authenticationOauthProfilesUri - clientProfilesUri: clientProfilesUri - topicEndpointsUri: topicEndpointsUri - jndiConnectionFactoriesUri: jndiConnectionFactoriesUri - mqttRetainCachesUri: mqttRetainCachesUri - clientUsernamesUri: clientUsernamesUri - bridgesUri: bridgesUri - replicatedTopicsUri: replicatedTopicsUri - topicEndpointTemplatesUri: topicEndpointTemplatesUri - aclProfilesUri: aclProfilesUri - sequencedTopicsUri: sequencedTopicsUri - uri: uri - jndiTopicsUri: jndiTopicsUri - dmrBridgesUri: dmrBridgesUri - replayLogsUri: replayLogsUri - certMatchingRulesUri: certMatchingRulesUri - queueTemplatesUri: queueTemplatesUri - queuesUri: queuesUri - restDeliveryPointsUri: restDeliveryPointsUri - distributedCachesUri: distributedCachesUri - mqttSessionsUri: mqttSessionsUri - authorizationGroupsUri: authorizationGroupsUri - jndiQueuesUri: jndiQueuesUri - - authenticationOauthProvidersUri: authenticationOauthProvidersUri - authenticationOauthProfilesUri: authenticationOauthProfilesUri - clientProfilesUri: clientProfilesUri - topicEndpointsUri: topicEndpointsUri - jndiConnectionFactoriesUri: jndiConnectionFactoriesUri - mqttRetainCachesUri: mqttRetainCachesUri - clientUsernamesUri: clientUsernamesUri - bridgesUri: bridgesUri - replicatedTopicsUri: replicatedTopicsUri - topicEndpointTemplatesUri: topicEndpointTemplatesUri - aclProfilesUri: aclProfilesUri - sequencedTopicsUri: sequencedTopicsUri - uri: uri - jndiTopicsUri: jndiTopicsUri - dmrBridgesUri: dmrBridgesUri - replayLogsUri: replayLogsUri - certMatchingRulesUri: certMatchingRulesUri - queueTemplatesUri: queueTemplatesUri - queuesUri: queuesUri - restDeliveryPointsUri: restDeliveryPointsUri - distributedCachesUri: distributedCachesUri - mqttSessionsUri: mqttSessionsUri - authorizationGroupsUri: authorizationGroupsUri - jndiQueuesUri: jndiQueuesUri - properties: - data: - items: - $ref: '#/components/schemas/MsgVpn' - type: array - links: - items: - $ref: '#/components/schemas/MsgVpnLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - OauthProfile: - example: - resourceServerValidateIssuerEnabled: true - displayName: displayName - endpointUserinfoTimeout: 5 - resourceServerRequiredType: resourceServerRequiredType - endpointTokenTimeout: 5 - interactivePromptForNewSession: interactivePromptForNewSession - enabled: true - issuer: issuer - endpointDiscoveryRefreshInterval: 0 - endpointIntrospectionTimeout: 6 - resourceServerRequiredScope: resourceServerRequiredScope - resourceServerValidateScopeEnabled: true - endpointJwksRefreshInterval: 1 - resourceServerRequiredIssuer: resourceServerRequiredIssuer - clientSecret: clientSecret - usernameClaimName: usernameClaimName - endpointToken: endpointToken - endpointUserinfo: endpointUserinfo - resourceServerRequiredAudience: resourceServerRequiredAudience - clientValidateTypeEnabled: true - clientId: clientId - oauthRole: client - sempEnabled: true - resourceServerParseAccessTokenEnabled: true - endpointAuthorization: endpointAuthorization - resourceServerValidateTypeEnabled: true - endpointJwks: endpointJwks - defaultGlobalAccessLevel: none - resourceServerValidateAudienceEnabled: true - defaultMsgVpnAccessLevel: none - clientRequiredType: clientRequiredType - interactivePromptForExpiredSession: interactivePromptForExpiredSession - clientRedirectUri: clientRedirectUri - oauthProfileName: oauthProfileName - endpointDiscovery: endpointDiscovery - endpointIntrospection: endpointIntrospection - clientScope: clientScope - interactiveEnabled: true - accessLevelGroupsClaimName: accessLevelGroupsClaimName - properties: - accessLevelGroupsClaimName: - description: The name of the groups claim. Changes to this attribute are - synchronized to HA mates via config-sync. The default value is `"groups"`. - type: string - clientId: - description: The OAuth client id. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `""`. - type: string - clientRedirectUri: - description: The OAuth redirect URI. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `""`. - type: string - clientRequiredType: - description: The required value for the TYP field in the ID token header. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `"JWT"`. - type: string - clientScope: - description: The OAuth scope. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `"openid email"`. - type: string - clientSecret: - description: "The OAuth client secret. This attribute is absent from a GET\ - \ and not updated when absent in a PUT, subject to the exceptions in note\ - \ 4. Changes to this attribute are synchronized to HA mates via config-sync.\ - \ The default value is `\"\"`." - type: string - clientValidateTypeEnabled: - description: Enable or disable verification of the TYP field in the ID token - header. Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `true`. - type: boolean - defaultGlobalAccessLevel: - description: | - The default global access level for this OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"none"`. The allowed values and their meaning are: - - 
-            "none" - User has no access to global data.
-            "read-only" - User has read-only access to global data.
-            "read-write" - User has read-write access to most global data.
-            "admin" - User has read-write access to all global data.
-
- enum: - - none - - read-only - - read-write - - admin - type: string - defaultMsgVpnAccessLevel: - description: | - The default message VPN access level for the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"none"`. The allowed values and their meaning are: - - 
-            "none" - User has no access to a Message VPN.
-            "read-only" - User has read-only access to a Message VPN.
-            "read-write" - User has read-write access to most Message VPN settings.
-
- enum: - - none - - read-only - - read-write - type: string - displayName: - description: The user friendly name for the OAuth profile. Changes to this - attribute are synchronized to HA mates via config-sync. The default value - is `""`. - type: string - enabled: - description: Enable or disable the OAuth profile. Changes to this attribute - are synchronized to HA mates via config-sync. The default value is `false`. - type: boolean - endpointAuthorization: - description: The OAuth authorization endpoint. Changes to this attribute - are synchronized to HA mates via config-sync. The default value is `""`. - type: string - endpointDiscovery: - description: The OpenID Connect discovery endpoint or OAuth Authorization - Server Metadata endpoint. Changes to this attribute are synchronized to - HA mates via config-sync. The default value is `""`. - type: string - endpointDiscoveryRefreshInterval: - description: The number of seconds between discovery endpoint requests. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `86400`. - format: int32 - type: integer - endpointIntrospection: - description: The OAuth introspection endpoint. Changes to this attribute - are synchronized to HA mates via config-sync. The default value is `""`. - type: string - endpointIntrospectionTimeout: - description: The maximum time in seconds a token introspection request is - allowed to take. Changes to this attribute are synchronized to HA mates - via config-sync. The default value is `1`. - format: int32 - type: integer - endpointJwks: - description: The OAuth JWKS endpoint. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `""`. - type: string - endpointJwksRefreshInterval: - description: The number of seconds between JWKS endpoint requests. Changes - to this attribute are synchronized to HA mates via config-sync. The default - value is `86400`. - format: int32 - type: integer - endpointToken: - description: The OAuth token endpoint. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `""`. - type: string - endpointTokenTimeout: - description: The maximum time in seconds a token request is allowed to take. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `1`. - format: int32 - type: integer - endpointUserinfo: - description: The OpenID Connect Userinfo endpoint. Changes to this attribute - are synchronized to HA mates via config-sync. The default value is `""`. - type: string - endpointUserinfoTimeout: - description: The maximum time in seconds a userinfo request is allowed to - take. Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `1`. - format: int32 - type: integer - interactiveEnabled: - description: Enable or disable interactive logins via this OAuth provider. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `true`. - type: boolean - interactivePromptForExpiredSession: - description: The value of the prompt parameter provided to the OAuth authorization - server for login requests where the session has expired. Changes to this - attribute are synchronized to HA mates via config-sync. The default value - is `""`. - type: string - interactivePromptForNewSession: - description: The value of the prompt parameter provided to the OAuth authorization - server for login requests where the session is new or the user has explicitly - logged out. Changes to this attribute are synchronized to HA mates via - config-sync. The default value is `"select_account"`. - type: string - issuer: - description: The Issuer Identifier for the OAuth provider. Changes to this - attribute are synchronized to HA mates via config-sync. The default value - is `""`. - type: string - oauthProfileName: - description: The name of the OAuth profile. - type: string - oauthRole: - description: | - The OAuth role of the broker. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"client"`. The allowed values and their meaning are: - - 
-            "client" - The broker is in the OAuth client role.
-            "resource-server" - The broker is in the OAuth resource server role.
-
- enum: - - client - - resource-server - type: string - resourceServerParseAccessTokenEnabled: - description: Enable or disable parsing of the access token as a JWT. Changes - to this attribute are synchronized to HA mates via config-sync. The default - value is `true`. - type: boolean - resourceServerRequiredAudience: - description: The required audience value. Changes to this attribute are - synchronized to HA mates via config-sync. The default value is `""`. - type: string - resourceServerRequiredIssuer: - description: The required issuer value. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `""`. - type: string - resourceServerRequiredScope: - description: A space-separated list of scopes that must be present in the - scope claim. Changes to this attribute are synchronized to HA mates via - config-sync. The default value is `""`. - type: string - resourceServerRequiredType: - description: The required TYP value. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `"at+jwt"`. - type: string - resourceServerValidateAudienceEnabled: - description: Enable or disable verification of the audience claim in the - access token or introspection response. Changes to this attribute are - synchronized to HA mates via config-sync. The default value is `true`. - type: boolean - resourceServerValidateIssuerEnabled: - description: Enable or disable verification of the issuer claim in the access - token or introspection response. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `true`. - type: boolean - resourceServerValidateScopeEnabled: - description: Enable or disable verification of the scope claim in the access - token or introspection response. Changes to this attribute are synchronized - to HA mates via config-sync. The default value is `true`. - type: boolean - resourceServerValidateTypeEnabled: - description: Enable or disable verification of the TYP field in the access - token header. Changes to this attribute are synchronized to HA mates via - config-sync. The default value is `true`. - type: boolean - sempEnabled: - description: Enable or disable authentication of SEMP requests with OAuth - tokens. Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `true`. - type: boolean - usernameClaimName: - description: The name of the username claim. Changes to this attribute are - synchronized to HA mates via config-sync. The default value is `"sub"`. - type: string - type: object - OauthProfileAccessLevelGroup: - example: - groupName: groupName - msgVpnAccessLevel: none - description: description - oauthProfileName: oauthProfileName - globalAccessLevel: none - properties: - description: - description: A description for the group. Changes to this attribute are - synchronized to HA mates via config-sync. The default value is `""`. - type: string - globalAccessLevel: - description: | - The global access level for this group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"none"`. The allowed values and their meaning are: - - 
-            "none" - User has no access to global data.
-            "read-only" - User has read-only access to global data.
-            "read-write" - User has read-write access to most global data.
-            "admin" - User has read-write access to all global data.
-
- enum: - - none - - read-only - - read-write - - admin - type: string - groupName: - description: The name of the group. - type: string - msgVpnAccessLevel: - description: | - The default message VPN access level for this group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"none"`. The allowed values and their meaning are: - - 
-            "none" - User has no access to a Message VPN.
-            "read-only" - User has read-only access to a Message VPN.
-            "read-write" - User has read-write access to most Message VPN settings.
-
- enum: - - none - - read-only - - read-write - type: string - oauthProfileName: - description: The name of the OAuth profile. - type: string - type: object - OauthProfileAccessLevelGroupLinks: - example: - msgVpnAccessLevelExceptionsUri: msgVpnAccessLevelExceptionsUri - uri: uri - properties: - msgVpnAccessLevelExceptionsUri: - description: The URI of this Group Access Level's collection of Message - VPN Access-Level Exception objects. - type: string - uri: - description: The URI of this Group Access Level object. - type: string - type: object - OauthProfileAccessLevelGroupMsgVpnAccessLevelException: - example: - groupName: groupName - accessLevel: none - oauthProfileName: oauthProfileName - msgVpnName: msgVpnName - properties: - accessLevel: - description: | - The message VPN access level. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"none"`. The allowed values and their meaning are: - - 
-            "none" - User has no access to a Message VPN.
-            "read-only" - User has read-only access to a Message VPN.
-            "read-write" - User has read-write access to most Message VPN settings.
-
- enum: - - none - - read-only - - read-write - type: string - groupName: - description: The name of the group. - type: string - msgVpnName: - description: The name of the message VPN. - type: string - oauthProfileName: - description: The name of the OAuth profile. - type: string - type: object - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Message VPN Access-Level Exception object. - type: string - type: object - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse: - example: - data: - groupName: groupName - accessLevel: none - oauthProfileName: oauthProfileName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupMsgVpnAccessLevelException' - links: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse: - example: - data: - - groupName: groupName - accessLevel: none - oauthProfileName: oauthProfileName - msgVpnName: msgVpnName - - groupName: groupName - accessLevel: none - oauthProfileName: oauthProfileName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupMsgVpnAccessLevelException' - type: array - links: - items: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - OauthProfileAccessLevelGroupResponse: - example: - data: - groupName: groupName - msgVpnAccessLevel: none - description: description - oauthProfileName: oauthProfileName - globalAccessLevel: none - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - msgVpnAccessLevelExceptionsUri: msgVpnAccessLevelExceptionsUri - uri: uri - properties: - data: - $ref: '#/components/schemas/OauthProfileAccessLevelGroup' - links: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - OauthProfileAccessLevelGroupsResponse: - example: - data: - - groupName: groupName - msgVpnAccessLevel: none - description: description - oauthProfileName: oauthProfileName - globalAccessLevel: none - - groupName: groupName - msgVpnAccessLevel: none - description: description - oauthProfileName: oauthProfileName - globalAccessLevel: none - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - msgVpnAccessLevelExceptionsUri: msgVpnAccessLevelExceptionsUri - uri: uri - - msgVpnAccessLevelExceptionsUri: msgVpnAccessLevelExceptionsUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/OauthProfileAccessLevelGroup' - type: array - links: - items: - $ref: '#/components/schemas/OauthProfileAccessLevelGroupLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - OauthProfileClientAllowedHost: - example: - allowedHost: allowedHost - oauthProfileName: oauthProfileName - properties: - allowedHost: - description: An allowed value for the Host header. - type: string - oauthProfileName: - description: The name of the OAuth profile. - type: string - type: object - OauthProfileClientAllowedHostLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Allowed Host Value object. - type: string - type: object - OauthProfileClientAllowedHostResponse: - example: - data: - allowedHost: allowedHost - oauthProfileName: oauthProfileName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/OauthProfileClientAllowedHost' - links: - $ref: '#/components/schemas/OauthProfileClientAllowedHostLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - OauthProfileClientAllowedHostsResponse: - example: - data: - - allowedHost: allowedHost - oauthProfileName: oauthProfileName - - allowedHost: allowedHost - oauthProfileName: oauthProfileName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/OauthProfileClientAllowedHost' - type: array - links: - items: - $ref: '#/components/schemas/OauthProfileClientAllowedHostLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - OauthProfileClientAuthorizationParameter: - example: - authorizationParameterValue: authorizationParameterValue - oauthProfileName: oauthProfileName - authorizationParameterName: authorizationParameterName - properties: - authorizationParameterName: - description: The name of the authorization parameter. - type: string - authorizationParameterValue: - description: The authorization parameter value. Changes to this attribute - are synchronized to HA mates via config-sync. The default value is `""`. - type: string - oauthProfileName: - description: The name of the OAuth profile. - type: string - type: object - OauthProfileClientAuthorizationParameterLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Authorization Parameter object. - type: string - type: object - OauthProfileClientAuthorizationParameterResponse: - example: - data: - authorizationParameterValue: authorizationParameterValue - oauthProfileName: oauthProfileName - authorizationParameterName: authorizationParameterName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/OauthProfileClientAuthorizationParameter' - links: - $ref: '#/components/schemas/OauthProfileClientAuthorizationParameterLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - OauthProfileClientAuthorizationParametersResponse: - example: - data: - - authorizationParameterValue: authorizationParameterValue - oauthProfileName: oauthProfileName - authorizationParameterName: authorizationParameterName - - authorizationParameterValue: authorizationParameterValue - oauthProfileName: oauthProfileName - authorizationParameterName: authorizationParameterName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/OauthProfileClientAuthorizationParameter' - type: array - links: - items: - $ref: '#/components/schemas/OauthProfileClientAuthorizationParameterLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - OauthProfileClientRequiredClaim: - example: - clientRequiredClaimValue: clientRequiredClaimValue - oauthProfileName: oauthProfileName - clientRequiredClaimName: clientRequiredClaimName - properties: - clientRequiredClaimName: - description: The name of the ID token claim to verify. - type: string - clientRequiredClaimValue: - description: "The required claim value, which must be a string containing\ - \ a valid JSON value." - type: string - oauthProfileName: - description: The name of the OAuth profile. - type: string - type: object - OauthProfileClientRequiredClaimLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Required Claim object. - type: string - type: object - OauthProfileClientRequiredClaimResponse: - example: - data: - clientRequiredClaimValue: clientRequiredClaimValue - oauthProfileName: oauthProfileName - clientRequiredClaimName: clientRequiredClaimName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/OauthProfileClientRequiredClaim' - links: - $ref: '#/components/schemas/OauthProfileClientRequiredClaimLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - OauthProfileClientRequiredClaimsResponse: - example: - data: - - clientRequiredClaimValue: clientRequiredClaimValue - oauthProfileName: oauthProfileName - clientRequiredClaimName: clientRequiredClaimName - - clientRequiredClaimValue: clientRequiredClaimValue - oauthProfileName: oauthProfileName - clientRequiredClaimName: clientRequiredClaimName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/OauthProfileClientRequiredClaim' - type: array - links: - items: - $ref: '#/components/schemas/OauthProfileClientRequiredClaimLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - OauthProfileDefaultMsgVpnAccessLevelException: - example: - accessLevel: none - oauthProfileName: oauthProfileName - msgVpnName: msgVpnName - properties: - accessLevel: - description: | - The message VPN access level. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"none"`. The allowed values and their meaning are: - - 
-            "none" - User has no access to a Message VPN.
-            "read-only" - User has read-only access to a Message VPN.
-            "read-write" - User has read-write access to most Message VPN settings.
-
- enum: - - none - - read-only - - read-write - type: string - msgVpnName: - description: The name of the message VPN. - type: string - oauthProfileName: - description: The name of the OAuth profile. - type: string - type: object - OauthProfileDefaultMsgVpnAccessLevelExceptionLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Message VPN Access-Level Exception object. - type: string - type: object - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse: - example: - data: - accessLevel: none - oauthProfileName: oauthProfileName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/OauthProfileDefaultMsgVpnAccessLevelException' - links: - $ref: '#/components/schemas/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse: - example: - data: - - accessLevel: none - oauthProfileName: oauthProfileName - msgVpnName: msgVpnName - - accessLevel: none - oauthProfileName: oauthProfileName - msgVpnName: msgVpnName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/OauthProfileDefaultMsgVpnAccessLevelException' - type: array - links: - items: - $ref: '#/components/schemas/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - OauthProfileLinks: - example: - accessLevelGroupsUri: accessLevelGroupsUri - clientAllowedHostsUri: clientAllowedHostsUri - resourceServerRequiredClaimsUri: resourceServerRequiredClaimsUri - defaultMsgVpnAccessLevelExceptionsUri: defaultMsgVpnAccessLevelExceptionsUri - clientAuthorizationParametersUri: clientAuthorizationParametersUri - clientRequiredClaimsUri: clientRequiredClaimsUri - uri: uri - properties: - accessLevelGroupsUri: - description: The URI of this OAuth Profile's collection of Group Access - Level objects. - type: string - clientAllowedHostsUri: - description: The URI of this OAuth Profile's collection of Allowed Host - Value objects. - type: string - clientAuthorizationParametersUri: - description: The URI of this OAuth Profile's collection of Authorization - Parameter objects. - type: string - clientRequiredClaimsUri: - description: The URI of this OAuth Profile's collection of Required Claim - objects. - type: string - defaultMsgVpnAccessLevelExceptionsUri: - description: The URI of this OAuth Profile's collection of Message VPN Access-Level - Exception objects. - type: string - resourceServerRequiredClaimsUri: - description: The URI of this OAuth Profile's collection of Required Claim - objects. - type: string - uri: - description: The URI of this OAuth Profile object. - type: string - type: object - OauthProfileResourceServerRequiredClaim: - example: - resourceServerRequiredClaimValue: resourceServerRequiredClaimValue - resourceServerRequiredClaimName: resourceServerRequiredClaimName - oauthProfileName: oauthProfileName - properties: - oauthProfileName: - description: The name of the OAuth profile. - type: string - resourceServerRequiredClaimName: - description: The name of the access token claim to verify. - type: string - resourceServerRequiredClaimValue: - description: "The required claim value, which must be a string containing\ - \ a valid JSON value." - type: string - type: object - OauthProfileResourceServerRequiredClaimLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Required Claim object. - type: string - type: object - OauthProfileResourceServerRequiredClaimResponse: - example: - data: - resourceServerRequiredClaimValue: resourceServerRequiredClaimValue - resourceServerRequiredClaimName: resourceServerRequiredClaimName - oauthProfileName: oauthProfileName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/OauthProfileResourceServerRequiredClaim' - links: - $ref: '#/components/schemas/OauthProfileResourceServerRequiredClaimLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - OauthProfileResourceServerRequiredClaimsResponse: - example: - data: - - resourceServerRequiredClaimValue: resourceServerRequiredClaimValue - resourceServerRequiredClaimName: resourceServerRequiredClaimName - oauthProfileName: oauthProfileName - - resourceServerRequiredClaimValue: resourceServerRequiredClaimValue - resourceServerRequiredClaimName: resourceServerRequiredClaimName - oauthProfileName: oauthProfileName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/OauthProfileResourceServerRequiredClaim' - type: array - links: - items: - $ref: '#/components/schemas/OauthProfileResourceServerRequiredClaimLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - OauthProfileResponse: - example: - data: - resourceServerValidateIssuerEnabled: true - displayName: displayName - endpointUserinfoTimeout: 5 - resourceServerRequiredType: resourceServerRequiredType - endpointTokenTimeout: 5 - interactivePromptForNewSession: interactivePromptForNewSession - enabled: true - issuer: issuer - endpointDiscoveryRefreshInterval: 0 - endpointIntrospectionTimeout: 6 - resourceServerRequiredScope: resourceServerRequiredScope - resourceServerValidateScopeEnabled: true - endpointJwksRefreshInterval: 1 - resourceServerRequiredIssuer: resourceServerRequiredIssuer - clientSecret: clientSecret - usernameClaimName: usernameClaimName - endpointToken: endpointToken - endpointUserinfo: endpointUserinfo - resourceServerRequiredAudience: resourceServerRequiredAudience - clientValidateTypeEnabled: true - clientId: clientId - oauthRole: client - sempEnabled: true - resourceServerParseAccessTokenEnabled: true - endpointAuthorization: endpointAuthorization - resourceServerValidateTypeEnabled: true - endpointJwks: endpointJwks - defaultGlobalAccessLevel: none - resourceServerValidateAudienceEnabled: true - defaultMsgVpnAccessLevel: none - clientRequiredType: clientRequiredType - interactivePromptForExpiredSession: interactivePromptForExpiredSession - clientRedirectUri: clientRedirectUri - oauthProfileName: oauthProfileName - endpointDiscovery: endpointDiscovery - endpointIntrospection: endpointIntrospection - clientScope: clientScope - interactiveEnabled: true - accessLevelGroupsClaimName: accessLevelGroupsClaimName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - accessLevelGroupsUri: accessLevelGroupsUri - clientAllowedHostsUri: clientAllowedHostsUri - resourceServerRequiredClaimsUri: resourceServerRequiredClaimsUri - defaultMsgVpnAccessLevelExceptionsUri: defaultMsgVpnAccessLevelExceptionsUri - clientAuthorizationParametersUri: clientAuthorizationParametersUri - clientRequiredClaimsUri: clientRequiredClaimsUri - uri: uri - properties: - data: - $ref: '#/components/schemas/OauthProfile' - links: - $ref: '#/components/schemas/OauthProfileLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - OauthProfilesResponse: - example: - data: - - resourceServerValidateIssuerEnabled: true - displayName: displayName - endpointUserinfoTimeout: 5 - resourceServerRequiredType: resourceServerRequiredType - endpointTokenTimeout: 5 - interactivePromptForNewSession: interactivePromptForNewSession - enabled: true - issuer: issuer - endpointDiscoveryRefreshInterval: 0 - endpointIntrospectionTimeout: 6 - resourceServerRequiredScope: resourceServerRequiredScope - resourceServerValidateScopeEnabled: true - endpointJwksRefreshInterval: 1 - resourceServerRequiredIssuer: resourceServerRequiredIssuer - clientSecret: clientSecret - usernameClaimName: usernameClaimName - endpointToken: endpointToken - endpointUserinfo: endpointUserinfo - resourceServerRequiredAudience: resourceServerRequiredAudience - clientValidateTypeEnabled: true - clientId: clientId - oauthRole: client - sempEnabled: true - resourceServerParseAccessTokenEnabled: true - endpointAuthorization: endpointAuthorization - resourceServerValidateTypeEnabled: true - endpointJwks: endpointJwks - defaultGlobalAccessLevel: none - resourceServerValidateAudienceEnabled: true - defaultMsgVpnAccessLevel: none - clientRequiredType: clientRequiredType - interactivePromptForExpiredSession: interactivePromptForExpiredSession - clientRedirectUri: clientRedirectUri - oauthProfileName: oauthProfileName - endpointDiscovery: endpointDiscovery - endpointIntrospection: endpointIntrospection - clientScope: clientScope - interactiveEnabled: true - accessLevelGroupsClaimName: accessLevelGroupsClaimName - - resourceServerValidateIssuerEnabled: true - displayName: displayName - endpointUserinfoTimeout: 5 - resourceServerRequiredType: resourceServerRequiredType - endpointTokenTimeout: 5 - interactivePromptForNewSession: interactivePromptForNewSession - enabled: true - issuer: issuer - endpointDiscoveryRefreshInterval: 0 - endpointIntrospectionTimeout: 6 - resourceServerRequiredScope: resourceServerRequiredScope - resourceServerValidateScopeEnabled: true - endpointJwksRefreshInterval: 1 - resourceServerRequiredIssuer: resourceServerRequiredIssuer - clientSecret: clientSecret - usernameClaimName: usernameClaimName - endpointToken: endpointToken - endpointUserinfo: endpointUserinfo - resourceServerRequiredAudience: resourceServerRequiredAudience - clientValidateTypeEnabled: true - clientId: clientId - oauthRole: client - sempEnabled: true - resourceServerParseAccessTokenEnabled: true - endpointAuthorization: endpointAuthorization - resourceServerValidateTypeEnabled: true - endpointJwks: endpointJwks - defaultGlobalAccessLevel: none - resourceServerValidateAudienceEnabled: true - defaultMsgVpnAccessLevel: none - clientRequiredType: clientRequiredType - interactivePromptForExpiredSession: interactivePromptForExpiredSession - clientRedirectUri: clientRedirectUri - oauthProfileName: oauthProfileName - endpointDiscovery: endpointDiscovery - endpointIntrospection: endpointIntrospection - clientScope: clientScope - interactiveEnabled: true - accessLevelGroupsClaimName: accessLevelGroupsClaimName - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - accessLevelGroupsUri: accessLevelGroupsUri - clientAllowedHostsUri: clientAllowedHostsUri - resourceServerRequiredClaimsUri: resourceServerRequiredClaimsUri - defaultMsgVpnAccessLevelExceptionsUri: defaultMsgVpnAccessLevelExceptionsUri - clientAuthorizationParametersUri: clientAuthorizationParametersUri - clientRequiredClaimsUri: clientRequiredClaimsUri - uri: uri - - accessLevelGroupsUri: accessLevelGroupsUri - clientAllowedHostsUri: clientAllowedHostsUri - resourceServerRequiredClaimsUri: resourceServerRequiredClaimsUri - defaultMsgVpnAccessLevelExceptionsUri: defaultMsgVpnAccessLevelExceptionsUri - clientAuthorizationParametersUri: clientAuthorizationParametersUri - clientRequiredClaimsUri: clientRequiredClaimsUri - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/OauthProfile' - type: array - links: - items: - $ref: '#/components/schemas/OauthProfileLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - SempError: - example: - code: 0 - description: description - status: status - properties: - code: - description: The error code which uniquely identifies the error that has - occurred. - format: int32 - type: integer - description: - description: The verbose description of the problem. - type: string - status: - description: The terse status string associated with `code`. - type: string - required: - - code - - description - - status - type: object - SempMeta: - example: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - properties: - count: - description: "The total number of objects requested, irrespective of page\ - \ size. This may be a count of all objects in a collection or a filtered\ - \ subset. It represents a snapshot in time and may change when paging\ - \ through results." - format: int64 - type: integer - error: - $ref: '#/components/schemas/SempError' - paging: - $ref: '#/components/schemas/SempPaging' - request: - $ref: '#/components/schemas/SempRequest' - responseCode: - description: "The HTTP response code, one of 200 (success), 4xx (client\ - \ error), or 5xx (server error)." - format: int32 - type: integer - required: - - request - - responseCode - type: object - SempMetaOnlyResponse: - example: - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - properties: - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - SempPaging: - example: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - properties: - cursorQuery: - description: "The cursor, or position, for the next page of objects. Use\ - \ this as the `cursor` query parameter of the next request." - type: string - nextPageUri: - description: The URI of the next page of objects. `cursorQuery` is already - embedded within this URI. - type: string - required: - - cursorQuery - - nextPageUri - type: object - SempRequest: - example: - method: method - uri: uri - properties: - method: - description: The HTTP method of the request which resulted in this response. - type: string - uri: - description: The URI of the request which resulted in this response. - type: string - required: - - method - type: object - SystemInformation: - example: - sempVersion: sempVersion - platform: platform - properties: - platform: - description: The platform running the SEMP API. Deprecated since 2.2. /systemInformation - was replaced by /about/api. - type: string - sempVersion: - description: The version of the SEMP API. Deprecated since 2.2. /systemInformation - was replaced by /about/api. - type: string - type: object - SystemInformationLinks: - example: - uri: uri - properties: - uri: - description: The URI of this System Information object. - type: string - type: object - SystemInformationResponse: - example: - data: - sempVersion: sempVersion - platform: platform - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/SystemInformation' - links: - $ref: '#/components/schemas/SystemInformationLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - VirtualHostname: - example: - virtualHostname: virtualHostname - msgVpnName: msgVpnName - enabled: true - properties: - enabled: - description: Enable or disable Virtual Hostname to Message VPN mapping. - Changes to this attribute are synchronized to HA mates via config-sync. - The default value is `false`. - type: boolean - msgVpnName: - description: The message VPN to which this virtual hostname is mapped. Changes - to this attribute are synchronized to HA mates via config-sync. The default - value is `""`. - type: string - virtualHostname: - description: The virtual hostname. - type: string - type: object - VirtualHostnameLinks: - example: - uri: uri - properties: - uri: - description: The URI of this Virtual Hostname object. - type: string - type: object - VirtualHostnameResponse: - example: - data: - virtualHostname: virtualHostname - msgVpnName: msgVpnName - enabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - uri: uri - properties: - data: - $ref: '#/components/schemas/VirtualHostname' - links: - $ref: '#/components/schemas/VirtualHostnameLinks' - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - VirtualHostnamesResponse: - example: - data: - - virtualHostname: virtualHostname - msgVpnName: msgVpnName - enabled: true - - virtualHostname: virtualHostname - msgVpnName: msgVpnName - enabled: true - meta: - request: - method: method - uri: uri - count: 7 - paging: - nextPageUri: nextPageUri - cursorQuery: cursorQuery - error: - code: 0 - description: description - status: status - responseCode: 7 - links: - - uri: uri - - uri: uri - properties: - data: - items: - $ref: '#/components/schemas/VirtualHostname' - type: array - links: - items: - $ref: '#/components/schemas/VirtualHostnameLinks' - type: array - meta: - $ref: '#/components/schemas/SempMeta' - required: - - meta - type: object - securitySchemes: - basicAuth: - description: basic authentication - scheme: basic - type: http -x-original-swagger-version: "2.0" - diff --git a/service/solace-config-client/docs/AboutApi.md b/service/solace-config-client/docs/AboutApi.md deleted file mode 100644 index fa8caf4e1..000000000 --- a/service/solace-config-client/docs/AboutApi.md +++ /dev/null @@ -1,396 +0,0 @@ -# AboutApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**getAbout**](AboutApi.md#getAbout) | **GET** /about | Get an About object. | -| [**getAboutApi**](AboutApi.md#getAboutApi) | **GET** /about/api | Get an API Description object. | -| [**getAboutUser**](AboutApi.md#getAboutUser) | **GET** /about/user | Get a User object. | -| [**getAboutUserMsgVpn**](AboutApi.md#getAboutUserMsgVpn) | **GET** /about/user/msgVpns/{msgVpnName} | Get a User Message VPN object. | -| [**getAboutUserMsgVpns**](AboutApi.md#getAboutUserMsgVpns) | **GET** /about/user/msgVpns | Get a list of User Message VPN objects. | - - - -## getAbout - -> AboutResponse getAbout(opaquePassword, select) - -Get an About object. - -Get an About object. This provides metadata about the SEMP API, such as the version of the API supported by the broker. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.13. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AboutApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AboutApi apiInstance = new AboutApi(defaultClient); - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - AboutResponse result = apiInstance.getAbout(opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AboutApi#getAbout"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**AboutResponse**](AboutResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The About object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getAboutApi - -> AboutApiResponse getAboutApi(opaquePassword, select) - -Get an API Description object. - -Get an API Description object. The API Description object provides metadata about the SEMP API. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AboutApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AboutApi apiInstance = new AboutApi(defaultClient); - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - AboutApiResponse result = apiInstance.getAboutApi(opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AboutApi#getAboutApi"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**AboutApiResponse**](AboutApiResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The API Description object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getAboutUser - -> AboutUserResponse getAboutUser(opaquePassword, select) - -Get a User object. - -Get a User object. Session and access level information about the user accessing the SEMP API. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AboutApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AboutApi apiInstance = new AboutApi(defaultClient); - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - AboutUserResponse result = apiInstance.getAboutUser(opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AboutApi#getAboutUser"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**AboutUserResponse**](AboutUserResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The User object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getAboutUserMsgVpn - -> AboutUserMsgVpnResponse getAboutUserMsgVpn(msgVpnName, opaquePassword, select) - -Get a User Message VPN object. - -Get a User Message VPN object. This provides information about the Message VPN access level for the username used to access the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AboutApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AboutApi apiInstance = new AboutApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - AboutUserMsgVpnResponse result = apiInstance.getAboutUserMsgVpn(msgVpnName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AboutApi#getAboutUserMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**AboutUserMsgVpnResponse**](AboutUserMsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The User Message VPN object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getAboutUserMsgVpns - -> AboutUserMsgVpnsResponse getAboutUserMsgVpns(count, cursor, opaquePassword, where, select) - -Get a list of User Message VPN objects. - -Get a list of User Message VPN objects. This provides information about the Message VPN access level for the username used to access the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AboutApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AboutApi apiInstance = new AboutApi(defaultClient); - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - AboutUserMsgVpnsResponse result = apiInstance.getAboutUserMsgVpns(count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AboutApi#getAboutUserMsgVpns"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**AboutUserMsgVpnsResponse**](AboutUserMsgVpnsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of User Message VPN objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/AboutApiLinks.md b/service/solace-config-client/docs/AboutApiLinks.md deleted file mode 100644 index e5bdc30cf..000000000 --- a/service/solace-config-client/docs/AboutApiLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# AboutApiLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this API Description object. | [optional] | - - - diff --git a/service/solace-config-client/docs/AboutApiResponse.md b/service/solace-config-client/docs/AboutApiResponse.md deleted file mode 100644 index 0eec0d3b6..000000000 --- a/service/solace-config-client/docs/AboutApiResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# AboutApiResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**AboutApi**](AboutApi.md) | | [optional] | -|**links** | [**AboutApiLinks**](AboutApiLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/AboutLinks.md b/service/solace-config-client/docs/AboutLinks.md deleted file mode 100644 index a66aefe19..000000000 --- a/service/solace-config-client/docs/AboutLinks.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# AboutLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**apiUri** | **String** | The URI of this About's API Description object. Available since 2.2. | [optional] | -|**uri** | **String** | The URI of this About object. | [optional] | -|**userUri** | **String** | The URI of this About's User object. Available since 2.2. | [optional] | - - - diff --git a/service/solace-config-client/docs/AboutResponse.md b/service/solace-config-client/docs/AboutResponse.md deleted file mode 100644 index cd8a60253..000000000 --- a/service/solace-config-client/docs/AboutResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# AboutResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | **Object** | | [optional] | -|**links** | [**AboutLinks**](AboutLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/AboutUser.md b/service/solace-config-client/docs/AboutUser.md deleted file mode 100644 index 9177abdf4..000000000 --- a/service/solace-config-client/docs/AboutUser.md +++ /dev/null @@ -1,31 +0,0 @@ - - -# AboutUser - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**globalAccessLevel** | [**GlobalAccessLevelEnum**](#GlobalAccessLevelEnum) | The global access level of the User. The allowed values and their meaning are: <pre> \"admin\" - Full administrative access. \"none\" - No access. \"read-only\" - Read only access. \"read-write\" - Read and write access. </pre> | [optional] | -|**sessionActive** | **Boolean** | Indicates whether a session is active for this request. Available since 2.24. | [optional] | -|**sessionCreateTime** | **Integer** | The timestamp of when the session was created. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21. | [optional] | -|**sessionCurrentTime** | **Integer** | The current server timestamp. This is provided as a reference point for the other timestamps provided. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21. | [optional] | -|**sessionHardExpiryTime** | **Integer** | The hard expiry time for the session. After this time the session will be invalid, regardless of activity. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21. | [optional] | -|**sessionId** | **String** | An identifier for the session to differentiate this session from other sessions for the same user. This value is not guaranteed to be unique between active sessions for different users. This attribute may not be returned in a GET. Available since 2.21. | [optional] | -|**sessionIdleExpiryTime** | **Integer** | The session idle expiry time. After this time the session will be invalid if there has been no activity. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21. | [optional] | -|**username** | **String** | The username of the User. Available since 2.21. | [optional] | - - - -## Enum: GlobalAccessLevelEnum - -| Name | Value | -|---- | -----| -| ADMIN | "admin" | -| NONE | "none" | -| READ_ONLY | "read-only" | -| READ_WRITE | "read-write" | - - - diff --git a/service/solace-config-client/docs/AboutUserLinks.md b/service/solace-config-client/docs/AboutUserLinks.md deleted file mode 100644 index 5b6a1dce5..000000000 --- a/service/solace-config-client/docs/AboutUserLinks.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# AboutUserLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**msgVpnsUri** | **String** | The URI of this User's collection of User Message VPN objects. | [optional] | -|**uri** | **String** | The URI of this User object. | [optional] | - - - diff --git a/service/solace-config-client/docs/AboutUserMsgVpn.md b/service/solace-config-client/docs/AboutUserMsgVpn.md deleted file mode 100644 index 9e91347ef..000000000 --- a/service/solace-config-client/docs/AboutUserMsgVpn.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# AboutUserMsgVpn - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**accessLevel** | [**AccessLevelEnum**](#AccessLevelEnum) | The Message VPN access level of the User. The allowed values and their meaning are: <pre> \"none\" - No access. \"read-only\" - Read only access. \"read-write\" - Read and write access. </pre> | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | - - - -## Enum: AccessLevelEnum - -| Name | Value | -|---- | -----| -| NONE | "none" | -| READ_ONLY | "read-only" | -| READ_WRITE | "read-write" | - - - diff --git a/service/solace-config-client/docs/AboutUserMsgVpnLinks.md b/service/solace-config-client/docs/AboutUserMsgVpnLinks.md deleted file mode 100644 index c5d2738af..000000000 --- a/service/solace-config-client/docs/AboutUserMsgVpnLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# AboutUserMsgVpnLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this User Message VPN object. | [optional] | - - - diff --git a/service/solace-config-client/docs/AboutUserMsgVpnResponse.md b/service/solace-config-client/docs/AboutUserMsgVpnResponse.md deleted file mode 100644 index 09ef72ca7..000000000 --- a/service/solace-config-client/docs/AboutUserMsgVpnResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# AboutUserMsgVpnResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**AboutUserMsgVpn**](AboutUserMsgVpn.md) | | [optional] | -|**links** | [**AboutUserMsgVpnLinks**](AboutUserMsgVpnLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/AboutUserMsgVpnsResponse.md b/service/solace-config-client/docs/AboutUserMsgVpnsResponse.md deleted file mode 100644 index c955c9d48..000000000 --- a/service/solace-config-client/docs/AboutUserMsgVpnsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# AboutUserMsgVpnsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<AboutUserMsgVpn>**](AboutUserMsgVpn.md) | | [optional] | -|**links** | [**List<AboutUserMsgVpnLinks>**](AboutUserMsgVpnLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/AboutUserResponse.md b/service/solace-config-client/docs/AboutUserResponse.md deleted file mode 100644 index f8ace82e5..000000000 --- a/service/solace-config-client/docs/AboutUserResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# AboutUserResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**AboutUser**](AboutUser.md) | | [optional] | -|**links** | [**AboutUserLinks**](AboutUserLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/AclProfileApi.md b/service/solace-config-client/docs/AclProfileApi.md deleted file mode 100644 index 68b72bbae..000000000 --- a/service/solace-config-client/docs/AclProfileApi.md +++ /dev/null @@ -1,2480 +0,0 @@ -# AclProfileApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnAclProfile**](AclProfileApi.md#createMsgVpnAclProfile) | **POST** /msgVpns/{msgVpnName}/aclProfiles | Create an ACL Profile object. | -| [**createMsgVpnAclProfileClientConnectException**](AclProfileApi.md#createMsgVpnAclProfileClientConnectException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions | Create a Client Connect Exception object. | -| [**createMsgVpnAclProfilePublishException**](AclProfileApi.md#createMsgVpnAclProfilePublishException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions | Create a Publish Topic Exception object. | -| [**createMsgVpnAclProfilePublishTopicException**](AclProfileApi.md#createMsgVpnAclProfilePublishTopicException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions | Create a Publish Topic Exception object. | -| [**createMsgVpnAclProfileSubscribeException**](AclProfileApi.md#createMsgVpnAclProfileSubscribeException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions | Create a Subscribe Topic Exception object. | -| [**createMsgVpnAclProfileSubscribeShareNameException**](AclProfileApi.md#createMsgVpnAclProfileSubscribeShareNameException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions | Create a Subscribe Share Name Exception object. | -| [**createMsgVpnAclProfileSubscribeTopicException**](AclProfileApi.md#createMsgVpnAclProfileSubscribeTopicException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions | Create a Subscribe Topic Exception object. | -| [**deleteMsgVpnAclProfile**](AclProfileApi.md#deleteMsgVpnAclProfile) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Delete an ACL Profile object. | -| [**deleteMsgVpnAclProfileClientConnectException**](AclProfileApi.md#deleteMsgVpnAclProfileClientConnectException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress} | Delete a Client Connect Exception object. | -| [**deleteMsgVpnAclProfilePublishException**](AclProfileApi.md#deleteMsgVpnAclProfilePublishException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic} | Delete a Publish Topic Exception object. | -| [**deleteMsgVpnAclProfilePublishTopicException**](AclProfileApi.md#deleteMsgVpnAclProfilePublishTopicException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException} | Delete a Publish Topic Exception object. | -| [**deleteMsgVpnAclProfileSubscribeException**](AclProfileApi.md#deleteMsgVpnAclProfileSubscribeException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic} | Delete a Subscribe Topic Exception object. | -| [**deleteMsgVpnAclProfileSubscribeShareNameException**](AclProfileApi.md#deleteMsgVpnAclProfileSubscribeShareNameException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException} | Delete a Subscribe Share Name Exception object. | -| [**deleteMsgVpnAclProfileSubscribeTopicException**](AclProfileApi.md#deleteMsgVpnAclProfileSubscribeTopicException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException} | Delete a Subscribe Topic Exception object. | -| [**getMsgVpnAclProfile**](AclProfileApi.md#getMsgVpnAclProfile) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Get an ACL Profile object. | -| [**getMsgVpnAclProfileClientConnectException**](AclProfileApi.md#getMsgVpnAclProfileClientConnectException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress} | Get a Client Connect Exception object. | -| [**getMsgVpnAclProfileClientConnectExceptions**](AclProfileApi.md#getMsgVpnAclProfileClientConnectExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions | Get a list of Client Connect Exception objects. | -| [**getMsgVpnAclProfilePublishException**](AclProfileApi.md#getMsgVpnAclProfilePublishException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic} | Get a Publish Topic Exception object. | -| [**getMsgVpnAclProfilePublishExceptions**](AclProfileApi.md#getMsgVpnAclProfilePublishExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions | Get a list of Publish Topic Exception objects. | -| [**getMsgVpnAclProfilePublishTopicException**](AclProfileApi.md#getMsgVpnAclProfilePublishTopicException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException} | Get a Publish Topic Exception object. | -| [**getMsgVpnAclProfilePublishTopicExceptions**](AclProfileApi.md#getMsgVpnAclProfilePublishTopicExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions | Get a list of Publish Topic Exception objects. | -| [**getMsgVpnAclProfileSubscribeException**](AclProfileApi.md#getMsgVpnAclProfileSubscribeException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic} | Get a Subscribe Topic Exception object. | -| [**getMsgVpnAclProfileSubscribeExceptions**](AclProfileApi.md#getMsgVpnAclProfileSubscribeExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions | Get a list of Subscribe Topic Exception objects. | -| [**getMsgVpnAclProfileSubscribeShareNameException**](AclProfileApi.md#getMsgVpnAclProfileSubscribeShareNameException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException} | Get a Subscribe Share Name Exception object. | -| [**getMsgVpnAclProfileSubscribeShareNameExceptions**](AclProfileApi.md#getMsgVpnAclProfileSubscribeShareNameExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions | Get a list of Subscribe Share Name Exception objects. | -| [**getMsgVpnAclProfileSubscribeTopicException**](AclProfileApi.md#getMsgVpnAclProfileSubscribeTopicException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException} | Get a Subscribe Topic Exception object. | -| [**getMsgVpnAclProfileSubscribeTopicExceptions**](AclProfileApi.md#getMsgVpnAclProfileSubscribeTopicExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions | Get a list of Subscribe Topic Exception objects. | -| [**getMsgVpnAclProfiles**](AclProfileApi.md#getMsgVpnAclProfiles) | **GET** /msgVpns/{msgVpnName}/aclProfiles | Get a list of ACL Profile objects. | -| [**replaceMsgVpnAclProfile**](AclProfileApi.md#replaceMsgVpnAclProfile) | **PUT** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Replace an ACL Profile object. | -| [**updateMsgVpnAclProfile**](AclProfileApi.md#updateMsgVpnAclProfile) | **PATCH** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Update an ACL Profile object. | - - - -## createMsgVpnAclProfile - -> MsgVpnAclProfileResponse createMsgVpnAclProfile(msgVpnName, body, opaquePassword, select) - -Create an ACL Profile object. - -Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnAclProfile body = new MsgVpnAclProfile(); // MsgVpnAclProfile | The ACL Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileResponse result = apiInstance.createMsgVpnAclProfile(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#createMsgVpnAclProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnAclProfile**](MsgVpnAclProfile.md)| The ACL Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileResponse**](MsgVpnAclProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The ACL Profile object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfileClientConnectException - -> MsgVpnAclProfileClientConnectExceptionResponse createMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Client Connect Exception object. - -Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| clientConnectExceptionAddress|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfileClientConnectException body = new MsgVpnAclProfileClientConnectException(); // MsgVpnAclProfileClientConnectException | The Client Connect Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileClientConnectExceptionResponse result = apiInstance.createMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#createMsgVpnAclProfileClientConnectException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfileClientConnectException**](MsgVpnAclProfileClientConnectException.md)| The Client Connect Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileClientConnectExceptionResponse**](MsgVpnAclProfileClientConnectExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Connect Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfilePublishException - -> MsgVpnAclProfilePublishExceptionResponse createMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Publish Topic Exception object. - -Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| publishExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfilePublishException body = new MsgVpnAclProfilePublishException(); // MsgVpnAclProfilePublishException | The Publish Topic Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishExceptionResponse result = apiInstance.createMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#createMsgVpnAclProfilePublishException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfilePublishException**](MsgVpnAclProfilePublishException.md)| The Publish Topic Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishExceptionResponse**](MsgVpnAclProfilePublishExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Publish Topic Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfilePublishTopicException - -> MsgVpnAclProfilePublishTopicExceptionResponse createMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Publish Topic Exception object. - -Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| publishTopicException|x|x|||| publishTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfilePublishTopicException body = new MsgVpnAclProfilePublishTopicException(); // MsgVpnAclProfilePublishTopicException | The Publish Topic Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishTopicExceptionResponse result = apiInstance.createMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#createMsgVpnAclProfilePublishTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfilePublishTopicException**](MsgVpnAclProfilePublishTopicException.md)| The Publish Topic Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishTopicExceptionResponse**](MsgVpnAclProfilePublishTopicExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Publish Topic Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfileSubscribeException - -> MsgVpnAclProfileSubscribeExceptionResponse createMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Subscribe Topic Exception object. - -Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| subscribeExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfileSubscribeException body = new MsgVpnAclProfileSubscribeException(); // MsgVpnAclProfileSubscribeException | The Subscribe Topic Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeExceptionResponse result = apiInstance.createMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#createMsgVpnAclProfileSubscribeException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfileSubscribeException**](MsgVpnAclProfileSubscribeException.md)| The Subscribe Topic Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeExceptionResponse**](MsgVpnAclProfileSubscribeExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Topic Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfileSubscribeShareNameException - -> MsgVpnAclProfileSubscribeShareNameExceptionResponse createMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Subscribe Share Name Exception object. - -Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeShareNameException|x|x|||| subscribeShareNameExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfileSubscribeShareNameException body = new MsgVpnAclProfileSubscribeShareNameException(); // MsgVpnAclProfileSubscribeShareNameException | The Subscribe Share Name Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeShareNameExceptionResponse result = apiInstance.createMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#createMsgVpnAclProfileSubscribeShareNameException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfileSubscribeShareNameException**](MsgVpnAclProfileSubscribeShareNameException.md)| The Subscribe Share Name Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeShareNameExceptionResponse**](MsgVpnAclProfileSubscribeShareNameExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Share Name Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfileSubscribeTopicException - -> MsgVpnAclProfileSubscribeTopicExceptionResponse createMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Subscribe Topic Exception object. - -Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeTopicException|x|x|||| subscribeTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfileSubscribeTopicException body = new MsgVpnAclProfileSubscribeTopicException(); // MsgVpnAclProfileSubscribeTopicException | The Subscribe Topic Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeTopicExceptionResponse result = apiInstance.createMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#createMsgVpnAclProfileSubscribeTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfileSubscribeTopicException**](MsgVpnAclProfileSubscribeTopicException.md)| The Subscribe Topic Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeTopicExceptionResponse**](MsgVpnAclProfileSubscribeTopicExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Topic Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfile - -> SempMetaOnlyResponse deleteMsgVpnAclProfile(msgVpnName, aclProfileName) - -Delete an ACL Profile object. - -Delete an ACL Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfile(msgVpnName, aclProfileName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#deleteMsgVpnAclProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfileClientConnectException - -> SempMetaOnlyResponse deleteMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress) - -Delete a Client Connect Exception object. - -Delete a Client Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String clientConnectExceptionAddress = "clientConnectExceptionAddress_example"; // String | The IP address/netmask of the client connect exception in CIDR form. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#deleteMsgVpnAclProfileClientConnectException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **clientConnectExceptionAddress** | **String**| The IP address/netmask of the client connect exception in CIDR form. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfilePublishException - -> SempMetaOnlyResponse deleteMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic) - -Delete a Publish Topic Exception object. - -Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String topicSyntax = "topicSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String publishExceptionTopic = "publishExceptionTopic_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#deleteMsgVpnAclProfilePublishException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **topicSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **publishExceptionTopic** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfilePublishTopicException - -> SempMetaOnlyResponse deleteMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException) - -Delete a Publish Topic Exception object. - -Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String publishTopicExceptionSyntax = "publishTopicExceptionSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String publishTopicException = "publishTopicException_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#deleteMsgVpnAclProfilePublishTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **publishTopicExceptionSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **publishTopicException** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfileSubscribeException - -> SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic) - -Delete a Subscribe Topic Exception object. - -Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String topicSyntax = "topicSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String subscribeExceptionTopic = "subscribeExceptionTopic_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#deleteMsgVpnAclProfileSubscribeException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **topicSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **subscribeExceptionTopic** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfileSubscribeShareNameException - -> SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException) - -Delete a Subscribe Share Name Exception object. - -Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String subscribeShareNameExceptionSyntax = "subscribeShareNameExceptionSyntax_example"; // String | The syntax of the subscribe share name for the exception to the default action taken. - String subscribeShareNameException = "subscribeShareNameException_example"; // String | The subscribe share name exception to the default action taken. May include wildcard characters. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#deleteMsgVpnAclProfileSubscribeShareNameException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **subscribeShareNameExceptionSyntax** | **String**| The syntax of the subscribe share name for the exception to the default action taken. | | -| **subscribeShareNameException** | **String**| The subscribe share name exception to the default action taken. May include wildcard characters. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfileSubscribeTopicException - -> SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException) - -Delete a Subscribe Topic Exception object. - -Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String subscribeTopicExceptionSyntax = "subscribeTopicExceptionSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String subscribeTopicException = "subscribeTopicException_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#deleteMsgVpnAclProfileSubscribeTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **subscribeTopicExceptionSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **subscribeTopicException** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfile - -> MsgVpnAclProfileResponse getMsgVpnAclProfile(msgVpnName, aclProfileName, opaquePassword, select) - -Get an ACL Profile object. - -Get an ACL Profile object. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileResponse result = apiInstance.getMsgVpnAclProfile(msgVpnName, aclProfileName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#getMsgVpnAclProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileResponse**](MsgVpnAclProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The ACL Profile object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileClientConnectException - -> MsgVpnAclProfileClientConnectExceptionResponse getMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress, opaquePassword, select) - -Get a Client Connect Exception object. - -Get a Client Connect Exception object. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String clientConnectExceptionAddress = "clientConnectExceptionAddress_example"; // String | The IP address/netmask of the client connect exception in CIDR form. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileClientConnectExceptionResponse result = apiInstance.getMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#getMsgVpnAclProfileClientConnectException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **clientConnectExceptionAddress** | **String**| The IP address/netmask of the client connect exception in CIDR form. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileClientConnectExceptionResponse**](MsgVpnAclProfileClientConnectExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Connect Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileClientConnectExceptions - -> MsgVpnAclProfileClientConnectExceptionsResponse getMsgVpnAclProfileClientConnectExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Client Connect Exception objects. - -Get a list of Client Connect Exception objects. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileClientConnectExceptionsResponse result = apiInstance.getMsgVpnAclProfileClientConnectExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#getMsgVpnAclProfileClientConnectExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileClientConnectExceptionsResponse**](MsgVpnAclProfileClientConnectExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Client Connect Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfilePublishException - -> MsgVpnAclProfilePublishExceptionResponse getMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic, opaquePassword, select) - -Get a Publish Topic Exception object. - -Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String topicSyntax = "topicSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String publishExceptionTopic = "publishExceptionTopic_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishExceptionResponse result = apiInstance.getMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#getMsgVpnAclProfilePublishException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **topicSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **publishExceptionTopic** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishExceptionResponse**](MsgVpnAclProfilePublishExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Publish Topic Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfilePublishExceptions - -> MsgVpnAclProfilePublishExceptionsResponse getMsgVpnAclProfilePublishExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Publish Topic Exception objects. - -Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishExceptionsResponse result = apiInstance.getMsgVpnAclProfilePublishExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#getMsgVpnAclProfilePublishExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishExceptionsResponse**](MsgVpnAclProfilePublishExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Publish Topic Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfilePublishTopicException - -> MsgVpnAclProfilePublishTopicExceptionResponse getMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException, opaquePassword, select) - -Get a Publish Topic Exception object. - -Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String publishTopicExceptionSyntax = "publishTopicExceptionSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String publishTopicException = "publishTopicException_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishTopicExceptionResponse result = apiInstance.getMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#getMsgVpnAclProfilePublishTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **publishTopicExceptionSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **publishTopicException** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishTopicExceptionResponse**](MsgVpnAclProfilePublishTopicExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Publish Topic Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfilePublishTopicExceptions - -> MsgVpnAclProfilePublishTopicExceptionsResponse getMsgVpnAclProfilePublishTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Publish Topic Exception objects. - -Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishTopicExceptionsResponse result = apiInstance.getMsgVpnAclProfilePublishTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#getMsgVpnAclProfilePublishTopicExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishTopicExceptionsResponse**](MsgVpnAclProfilePublishTopicExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Publish Topic Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeException - -> MsgVpnAclProfileSubscribeExceptionResponse getMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic, opaquePassword, select) - -Get a Subscribe Topic Exception object. - -Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String topicSyntax = "topicSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String subscribeExceptionTopic = "subscribeExceptionTopic_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeExceptionResponse result = apiInstance.getMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#getMsgVpnAclProfileSubscribeException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **topicSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **subscribeExceptionTopic** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeExceptionResponse**](MsgVpnAclProfileSubscribeExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Topic Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeExceptions - -> MsgVpnAclProfileSubscribeExceptionsResponse getMsgVpnAclProfileSubscribeExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Subscribe Topic Exception objects. - -Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeExceptionsResponse result = apiInstance.getMsgVpnAclProfileSubscribeExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#getMsgVpnAclProfileSubscribeExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeExceptionsResponse**](MsgVpnAclProfileSubscribeExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Subscribe Topic Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeShareNameException - -> MsgVpnAclProfileSubscribeShareNameExceptionResponse getMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException, opaquePassword, select) - -Get a Subscribe Share Name Exception object. - -Get a Subscribe Share Name Exception object. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String subscribeShareNameExceptionSyntax = "subscribeShareNameExceptionSyntax_example"; // String | The syntax of the subscribe share name for the exception to the default action taken. - String subscribeShareNameException = "subscribeShareNameException_example"; // String | The subscribe share name exception to the default action taken. May include wildcard characters. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeShareNameExceptionResponse result = apiInstance.getMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#getMsgVpnAclProfileSubscribeShareNameException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **subscribeShareNameExceptionSyntax** | **String**| The syntax of the subscribe share name for the exception to the default action taken. | | -| **subscribeShareNameException** | **String**| The subscribe share name exception to the default action taken. May include wildcard characters. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeShareNameExceptionResponse**](MsgVpnAclProfileSubscribeShareNameExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Share Name Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeShareNameExceptions - -> MsgVpnAclProfileSubscribeShareNameExceptionsResponse getMsgVpnAclProfileSubscribeShareNameExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Subscribe Share Name Exception objects. - -Get a list of Subscribe Share Name Exception objects. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeShareNameExceptionsResponse result = apiInstance.getMsgVpnAclProfileSubscribeShareNameExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#getMsgVpnAclProfileSubscribeShareNameExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeShareNameExceptionsResponse**](MsgVpnAclProfileSubscribeShareNameExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Subscribe Share Name Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeTopicException - -> MsgVpnAclProfileSubscribeTopicExceptionResponse getMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException, opaquePassword, select) - -Get a Subscribe Topic Exception object. - -Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String subscribeTopicExceptionSyntax = "subscribeTopicExceptionSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String subscribeTopicException = "subscribeTopicException_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeTopicExceptionResponse result = apiInstance.getMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#getMsgVpnAclProfileSubscribeTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **subscribeTopicExceptionSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **subscribeTopicException** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeTopicExceptionResponse**](MsgVpnAclProfileSubscribeTopicExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Topic Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeTopicExceptions - -> MsgVpnAclProfileSubscribeTopicExceptionsResponse getMsgVpnAclProfileSubscribeTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Subscribe Topic Exception objects. - -Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeTopicExceptionsResponse result = apiInstance.getMsgVpnAclProfileSubscribeTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#getMsgVpnAclProfileSubscribeTopicExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeTopicExceptionsResponse**](MsgVpnAclProfileSubscribeTopicExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Subscribe Topic Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfiles - -> MsgVpnAclProfilesResponse getMsgVpnAclProfiles(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of ACL Profile objects. - -Get a list of ACL Profile objects. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilesResponse result = apiInstance.getMsgVpnAclProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#getMsgVpnAclProfiles"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilesResponse**](MsgVpnAclProfilesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of ACL Profile objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnAclProfile - -> MsgVpnAclProfileResponse replaceMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select) - -Replace an ACL Profile object. - -Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfile body = new MsgVpnAclProfile(); // MsgVpnAclProfile | The ACL Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileResponse result = apiInstance.replaceMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#replaceMsgVpnAclProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfile**](MsgVpnAclProfile.md)| The ACL Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileResponse**](MsgVpnAclProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The ACL Profile object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnAclProfile - -> MsgVpnAclProfileResponse updateMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select) - -Update an ACL Profile object. - -Update an ACL Profile object. Any attribute missing from the request will be left unchanged. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AclProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AclProfileApi apiInstance = new AclProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfile body = new MsgVpnAclProfile(); // MsgVpnAclProfile | The ACL Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileResponse result = apiInstance.updateMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AclProfileApi#updateMsgVpnAclProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfile**](MsgVpnAclProfile.md)| The ACL Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileResponse**](MsgVpnAclProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The ACL Profile object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/AllApi.md b/service/solace-config-client/docs/AllApi.md deleted file mode 100644 index f06c8e6d6..000000000 --- a/service/solace-config-client/docs/AllApi.md +++ /dev/null @@ -1,31566 +0,0 @@ -# AllApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createCertAuthority**](AllApi.md#createCertAuthority) | **POST** /certAuthorities | Create a Certificate Authority object. | -| [**createCertAuthorityOcspTlsTrustedCommonName**](AllApi.md#createCertAuthorityOcspTlsTrustedCommonName) | **POST** /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames | Create an OCSP Responder Trusted Common Name object. | -| [**createClientCertAuthority**](AllApi.md#createClientCertAuthority) | **POST** /clientCertAuthorities | Create a Client Certificate Authority object. | -| [**createClientCertAuthorityOcspTlsTrustedCommonName**](AllApi.md#createClientCertAuthorityOcspTlsTrustedCommonName) | **POST** /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames | Create an OCSP Responder Trusted Common Name object. | -| [**createDmrCluster**](AllApi.md#createDmrCluster) | **POST** /dmrClusters | Create a Cluster object. | -| [**createDmrClusterCertMatchingRule**](AllApi.md#createDmrClusterCertMatchingRule) | **POST** /dmrClusters/{dmrClusterName}/certMatchingRules | Create a Certificate Matching Rule object. | -| [**createDmrClusterCertMatchingRuleAttributeFilter**](AllApi.md#createDmrClusterCertMatchingRuleAttributeFilter) | **POST** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters | Create a Certificate Matching Rule Attribute Filter object. | -| [**createDmrClusterCertMatchingRuleCondition**](AllApi.md#createDmrClusterCertMatchingRuleCondition) | **POST** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions | Create a Certificate Matching Rule Condition object. | -| [**createDmrClusterLink**](AllApi.md#createDmrClusterLink) | **POST** /dmrClusters/{dmrClusterName}/links | Create a Link object. | -| [**createDmrClusterLinkAttribute**](AllApi.md#createDmrClusterLinkAttribute) | **POST** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes | Create a Link Attribute object. | -| [**createDmrClusterLinkRemoteAddress**](AllApi.md#createDmrClusterLinkRemoteAddress) | **POST** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses | Create a Remote Address object. | -| [**createDmrClusterLinkTlsTrustedCommonName**](AllApi.md#createDmrClusterLinkTlsTrustedCommonName) | **POST** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames | Create a Trusted Common Name object. | -| [**createDomainCertAuthority**](AllApi.md#createDomainCertAuthority) | **POST** /domainCertAuthorities | Create a Domain Certificate Authority object. | -| [**createMsgVpn**](AllApi.md#createMsgVpn) | **POST** /msgVpns | Create a Message VPN object. | -| [**createMsgVpnAclProfile**](AllApi.md#createMsgVpnAclProfile) | **POST** /msgVpns/{msgVpnName}/aclProfiles | Create an ACL Profile object. | -| [**createMsgVpnAclProfileClientConnectException**](AllApi.md#createMsgVpnAclProfileClientConnectException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions | Create a Client Connect Exception object. | -| [**createMsgVpnAclProfilePublishException**](AllApi.md#createMsgVpnAclProfilePublishException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions | Create a Publish Topic Exception object. | -| [**createMsgVpnAclProfilePublishTopicException**](AllApi.md#createMsgVpnAclProfilePublishTopicException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions | Create a Publish Topic Exception object. | -| [**createMsgVpnAclProfileSubscribeException**](AllApi.md#createMsgVpnAclProfileSubscribeException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions | Create a Subscribe Topic Exception object. | -| [**createMsgVpnAclProfileSubscribeShareNameException**](AllApi.md#createMsgVpnAclProfileSubscribeShareNameException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions | Create a Subscribe Share Name Exception object. | -| [**createMsgVpnAclProfileSubscribeTopicException**](AllApi.md#createMsgVpnAclProfileSubscribeTopicException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions | Create a Subscribe Topic Exception object. | -| [**createMsgVpnAuthenticationOauthProfile**](AllApi.md#createMsgVpnAuthenticationOauthProfile) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles | Create an OAuth Profile object. | -| [**createMsgVpnAuthenticationOauthProfileClientRequiredClaim**](AllApi.md#createMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims | Create a Required Claim object. | -| [**createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](AllApi.md#createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Create a Required Claim object. | -| [**createMsgVpnAuthenticationOauthProvider**](AllApi.md#createMsgVpnAuthenticationOauthProvider) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProviders | Create an OAuth Provider object. | -| [**createMsgVpnAuthorizationGroup**](AllApi.md#createMsgVpnAuthorizationGroup) | **POST** /msgVpns/{msgVpnName}/authorizationGroups | Create an Authorization Group object. | -| [**createMsgVpnBridge**](AllApi.md#createMsgVpnBridge) | **POST** /msgVpns/{msgVpnName}/bridges | Create a Bridge object. | -| [**createMsgVpnBridgeRemoteMsgVpn**](AllApi.md#createMsgVpnBridgeRemoteMsgVpn) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns | Create a Remote Message VPN object. | -| [**createMsgVpnBridgeRemoteSubscription**](AllApi.md#createMsgVpnBridgeRemoteSubscription) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions | Create a Remote Subscription object. | -| [**createMsgVpnBridgeTlsTrustedCommonName**](AllApi.md#createMsgVpnBridgeTlsTrustedCommonName) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames | Create a Trusted Common Name object. | -| [**createMsgVpnCertMatchingRule**](AllApi.md#createMsgVpnCertMatchingRule) | **POST** /msgVpns/{msgVpnName}/certMatchingRules | Create a Certificate Matching Rule object. | -| [**createMsgVpnCertMatchingRuleAttributeFilter**](AllApi.md#createMsgVpnCertMatchingRuleAttributeFilter) | **POST** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters | Create a Certificate Matching Rule Attribute Filter object. | -| [**createMsgVpnCertMatchingRuleCondition**](AllApi.md#createMsgVpnCertMatchingRuleCondition) | **POST** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions | Create a Certificate Matching Rule Condition object. | -| [**createMsgVpnClientProfile**](AllApi.md#createMsgVpnClientProfile) | **POST** /msgVpns/{msgVpnName}/clientProfiles | Create a Client Profile object. | -| [**createMsgVpnClientUsername**](AllApi.md#createMsgVpnClientUsername) | **POST** /msgVpns/{msgVpnName}/clientUsernames | Create a Client Username object. | -| [**createMsgVpnClientUsernameAttribute**](AllApi.md#createMsgVpnClientUsernameAttribute) | **POST** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes | Create a Client Username Attribute object. | -| [**createMsgVpnDistributedCache**](AllApi.md#createMsgVpnDistributedCache) | **POST** /msgVpns/{msgVpnName}/distributedCaches | Create a Distributed Cache object. | -| [**createMsgVpnDistributedCacheCluster**](AllApi.md#createMsgVpnDistributedCacheCluster) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters | Create a Cache Cluster object. | -| [**createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](AllApi.md#createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters | Create a Home Cache Cluster object. | -| [**createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](AllApi.md#createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes | Create a Topic Prefix object. | -| [**createMsgVpnDistributedCacheClusterInstance**](AllApi.md#createMsgVpnDistributedCacheClusterInstance) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances | Create a Cache Instance object. | -| [**createMsgVpnDistributedCacheClusterTopic**](AllApi.md#createMsgVpnDistributedCacheClusterTopic) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics | Create a Topic object. | -| [**createMsgVpnDmrBridge**](AllApi.md#createMsgVpnDmrBridge) | **POST** /msgVpns/{msgVpnName}/dmrBridges | Create a DMR Bridge object. | -| [**createMsgVpnJndiConnectionFactory**](AllApi.md#createMsgVpnJndiConnectionFactory) | **POST** /msgVpns/{msgVpnName}/jndiConnectionFactories | Create a JNDI Connection Factory object. | -| [**createMsgVpnJndiQueue**](AllApi.md#createMsgVpnJndiQueue) | **POST** /msgVpns/{msgVpnName}/jndiQueues | Create a JNDI Queue object. | -| [**createMsgVpnJndiTopic**](AllApi.md#createMsgVpnJndiTopic) | **POST** /msgVpns/{msgVpnName}/jndiTopics | Create a JNDI Topic object. | -| [**createMsgVpnMqttRetainCache**](AllApi.md#createMsgVpnMqttRetainCache) | **POST** /msgVpns/{msgVpnName}/mqttRetainCaches | Create an MQTT Retain Cache object. | -| [**createMsgVpnMqttSession**](AllApi.md#createMsgVpnMqttSession) | **POST** /msgVpns/{msgVpnName}/mqttSessions | Create an MQTT Session object. | -| [**createMsgVpnMqttSessionSubscription**](AllApi.md#createMsgVpnMqttSessionSubscription) | **POST** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions | Create a Subscription object. | -| [**createMsgVpnQueue**](AllApi.md#createMsgVpnQueue) | **POST** /msgVpns/{msgVpnName}/queues | Create a Queue object. | -| [**createMsgVpnQueueSubscription**](AllApi.md#createMsgVpnQueueSubscription) | **POST** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions | Create a Queue Subscription object. | -| [**createMsgVpnQueueTemplate**](AllApi.md#createMsgVpnQueueTemplate) | **POST** /msgVpns/{msgVpnName}/queueTemplates | Create a Queue Template object. | -| [**createMsgVpnReplayLog**](AllApi.md#createMsgVpnReplayLog) | **POST** /msgVpns/{msgVpnName}/replayLogs | Create a Replay Log object. | -| [**createMsgVpnReplayLogTopicFilterSubscription**](AllApi.md#createMsgVpnReplayLogTopicFilterSubscription) | **POST** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions | Create a Topic Filter Subscription object. | -| [**createMsgVpnReplicatedTopic**](AllApi.md#createMsgVpnReplicatedTopic) | **POST** /msgVpns/{msgVpnName}/replicatedTopics | Create a Replicated Topic object. | -| [**createMsgVpnRestDeliveryPoint**](AllApi.md#createMsgVpnRestDeliveryPoint) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints | Create a REST Delivery Point object. | -| [**createMsgVpnRestDeliveryPointQueueBinding**](AllApi.md#createMsgVpnRestDeliveryPointQueueBinding) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings | Create a Queue Binding object. | -| [**createMsgVpnRestDeliveryPointQueueBindingRequestHeader**](AllApi.md#createMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders | Create a Request Header object. | -| [**createMsgVpnRestDeliveryPointRestConsumer**](AllApi.md#createMsgVpnRestDeliveryPointRestConsumer) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers | Create a REST Consumer object. | -| [**createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](AllApi.md#createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims | Create a Claim object. | -| [**createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](AllApi.md#createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames | Create a Trusted Common Name object. | -| [**createMsgVpnSequencedTopic**](AllApi.md#createMsgVpnSequencedTopic) | **POST** /msgVpns/{msgVpnName}/sequencedTopics | Create a Sequenced Topic object. | -| [**createMsgVpnTopicEndpoint**](AllApi.md#createMsgVpnTopicEndpoint) | **POST** /msgVpns/{msgVpnName}/topicEndpoints | Create a Topic Endpoint object. | -| [**createMsgVpnTopicEndpointTemplate**](AllApi.md#createMsgVpnTopicEndpointTemplate) | **POST** /msgVpns/{msgVpnName}/topicEndpointTemplates | Create a Topic Endpoint Template object. | -| [**createOauthProfile**](AllApi.md#createOauthProfile) | **POST** /oauthProfiles | Create an OAuth Profile object. | -| [**createOauthProfileAccessLevelGroup**](AllApi.md#createOauthProfileAccessLevelGroup) | **POST** /oauthProfiles/{oauthProfileName}/accessLevelGroups | Create a Group Access Level object. | -| [**createOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](AllApi.md#createOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **POST** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions | Create a Message VPN Access-Level Exception object. | -| [**createOauthProfileClientAllowedHost**](AllApi.md#createOauthProfileClientAllowedHost) | **POST** /oauthProfiles/{oauthProfileName}/clientAllowedHosts | Create an Allowed Host Value object. | -| [**createOauthProfileClientAuthorizationParameter**](AllApi.md#createOauthProfileClientAuthorizationParameter) | **POST** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters | Create an Authorization Parameter object. | -| [**createOauthProfileClientRequiredClaim**](AllApi.md#createOauthProfileClientRequiredClaim) | **POST** /oauthProfiles/{oauthProfileName}/clientRequiredClaims | Create a Required Claim object. | -| [**createOauthProfileDefaultMsgVpnAccessLevelException**](AllApi.md#createOauthProfileDefaultMsgVpnAccessLevelException) | **POST** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions | Create a Message VPN Access-Level Exception object. | -| [**createOauthProfileResourceServerRequiredClaim**](AllApi.md#createOauthProfileResourceServerRequiredClaim) | **POST** /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Create a Required Claim object. | -| [**createVirtualHostname**](AllApi.md#createVirtualHostname) | **POST** /virtualHostnames | Create a Virtual Hostname object. | -| [**deleteCertAuthority**](AllApi.md#deleteCertAuthority) | **DELETE** /certAuthorities/{certAuthorityName} | Delete a Certificate Authority object. | -| [**deleteCertAuthorityOcspTlsTrustedCommonName**](AllApi.md#deleteCertAuthorityOcspTlsTrustedCommonName) | **DELETE** /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName} | Delete an OCSP Responder Trusted Common Name object. | -| [**deleteClientCertAuthority**](AllApi.md#deleteClientCertAuthority) | **DELETE** /clientCertAuthorities/{certAuthorityName} | Delete a Client Certificate Authority object. | -| [**deleteClientCertAuthorityOcspTlsTrustedCommonName**](AllApi.md#deleteClientCertAuthorityOcspTlsTrustedCommonName) | **DELETE** /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName} | Delete an OCSP Responder Trusted Common Name object. | -| [**deleteDmrCluster**](AllApi.md#deleteDmrCluster) | **DELETE** /dmrClusters/{dmrClusterName} | Delete a Cluster object. | -| [**deleteDmrClusterCertMatchingRule**](AllApi.md#deleteDmrClusterCertMatchingRule) | **DELETE** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName} | Delete a Certificate Matching Rule object. | -| [**deleteDmrClusterCertMatchingRuleAttributeFilter**](AllApi.md#deleteDmrClusterCertMatchingRuleAttributeFilter) | **DELETE** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Delete a Certificate Matching Rule Attribute Filter object. | -| [**deleteDmrClusterCertMatchingRuleCondition**](AllApi.md#deleteDmrClusterCertMatchingRuleCondition) | **DELETE** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source} | Delete a Certificate Matching Rule Condition object. | -| [**deleteDmrClusterLink**](AllApi.md#deleteDmrClusterLink) | **DELETE** /dmrClusters/{dmrClusterName}/links/{remoteNodeName} | Delete a Link object. | -| [**deleteDmrClusterLinkAttribute**](AllApi.md#deleteDmrClusterLinkAttribute) | **DELETE** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue} | Delete a Link Attribute object. | -| [**deleteDmrClusterLinkRemoteAddress**](AllApi.md#deleteDmrClusterLinkRemoteAddress) | **DELETE** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress} | Delete a Remote Address object. | -| [**deleteDmrClusterLinkTlsTrustedCommonName**](AllApi.md#deleteDmrClusterLinkTlsTrustedCommonName) | **DELETE** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Delete a Trusted Common Name object. | -| [**deleteDomainCertAuthority**](AllApi.md#deleteDomainCertAuthority) | **DELETE** /domainCertAuthorities/{certAuthorityName} | Delete a Domain Certificate Authority object. | -| [**deleteMsgVpn**](AllApi.md#deleteMsgVpn) | **DELETE** /msgVpns/{msgVpnName} | Delete a Message VPN object. | -| [**deleteMsgVpnAclProfile**](AllApi.md#deleteMsgVpnAclProfile) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Delete an ACL Profile object. | -| [**deleteMsgVpnAclProfileClientConnectException**](AllApi.md#deleteMsgVpnAclProfileClientConnectException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress} | Delete a Client Connect Exception object. | -| [**deleteMsgVpnAclProfilePublishException**](AllApi.md#deleteMsgVpnAclProfilePublishException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic} | Delete a Publish Topic Exception object. | -| [**deleteMsgVpnAclProfilePublishTopicException**](AllApi.md#deleteMsgVpnAclProfilePublishTopicException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException} | Delete a Publish Topic Exception object. | -| [**deleteMsgVpnAclProfileSubscribeException**](AllApi.md#deleteMsgVpnAclProfileSubscribeException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic} | Delete a Subscribe Topic Exception object. | -| [**deleteMsgVpnAclProfileSubscribeShareNameException**](AllApi.md#deleteMsgVpnAclProfileSubscribeShareNameException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException} | Delete a Subscribe Share Name Exception object. | -| [**deleteMsgVpnAclProfileSubscribeTopicException**](AllApi.md#deleteMsgVpnAclProfileSubscribeTopicException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException} | Delete a Subscribe Topic Exception object. | -| [**deleteMsgVpnAuthenticationOauthProfile**](AllApi.md#deleteMsgVpnAuthenticationOauthProfile) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Delete an OAuth Profile object. | -| [**deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim**](AllApi.md#deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Delete a Required Claim object. | -| [**deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](AllApi.md#deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Delete a Required Claim object. | -| [**deleteMsgVpnAuthenticationOauthProvider**](AllApi.md#deleteMsgVpnAuthenticationOauthProvider) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Delete an OAuth Provider object. | -| [**deleteMsgVpnAuthorizationGroup**](AllApi.md#deleteMsgVpnAuthorizationGroup) | **DELETE** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Delete an Authorization Group object. | -| [**deleteMsgVpnBridge**](AllApi.md#deleteMsgVpnBridge) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Delete a Bridge object. | -| [**deleteMsgVpnBridgeRemoteMsgVpn**](AllApi.md#deleteMsgVpnBridgeRemoteMsgVpn) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Delete a Remote Message VPN object. | -| [**deleteMsgVpnBridgeRemoteSubscription**](AllApi.md#deleteMsgVpnBridgeRemoteSubscription) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic} | Delete a Remote Subscription object. | -| [**deleteMsgVpnBridgeTlsTrustedCommonName**](AllApi.md#deleteMsgVpnBridgeTlsTrustedCommonName) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Delete a Trusted Common Name object. | -| [**deleteMsgVpnCertMatchingRule**](AllApi.md#deleteMsgVpnCertMatchingRule) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Delete a Certificate Matching Rule object. | -| [**deleteMsgVpnCertMatchingRuleAttributeFilter**](AllApi.md#deleteMsgVpnCertMatchingRuleAttributeFilter) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Delete a Certificate Matching Rule Attribute Filter object. | -| [**deleteMsgVpnCertMatchingRuleCondition**](AllApi.md#deleteMsgVpnCertMatchingRuleCondition) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source} | Delete a Certificate Matching Rule Condition object. | -| [**deleteMsgVpnClientProfile**](AllApi.md#deleteMsgVpnClientProfile) | **DELETE** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Delete a Client Profile object. | -| [**deleteMsgVpnClientUsername**](AllApi.md#deleteMsgVpnClientUsername) | **DELETE** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Delete a Client Username object. | -| [**deleteMsgVpnClientUsernameAttribute**](AllApi.md#deleteMsgVpnClientUsernameAttribute) | **DELETE** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue} | Delete a Client Username Attribute object. | -| [**deleteMsgVpnDistributedCache**](AllApi.md#deleteMsgVpnDistributedCache) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Delete a Distributed Cache object. | -| [**deleteMsgVpnDistributedCacheCluster**](AllApi.md#deleteMsgVpnDistributedCacheCluster) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Delete a Cache Cluster object. | -| [**deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](AllApi.md#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName} | Delete a Home Cache Cluster object. | -| [**deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](AllApi.md#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix} | Delete a Topic Prefix object. | -| [**deleteMsgVpnDistributedCacheClusterInstance**](AllApi.md#deleteMsgVpnDistributedCacheClusterInstance) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Delete a Cache Instance object. | -| [**deleteMsgVpnDistributedCacheClusterTopic**](AllApi.md#deleteMsgVpnDistributedCacheClusterTopic) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic} | Delete a Topic object. | -| [**deleteMsgVpnDmrBridge**](AllApi.md#deleteMsgVpnDmrBridge) | **DELETE** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Delete a DMR Bridge object. | -| [**deleteMsgVpnJndiConnectionFactory**](AllApi.md#deleteMsgVpnJndiConnectionFactory) | **DELETE** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Delete a JNDI Connection Factory object. | -| [**deleteMsgVpnJndiQueue**](AllApi.md#deleteMsgVpnJndiQueue) | **DELETE** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Delete a JNDI Queue object. | -| [**deleteMsgVpnJndiTopic**](AllApi.md#deleteMsgVpnJndiTopic) | **DELETE** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Delete a JNDI Topic object. | -| [**deleteMsgVpnMqttRetainCache**](AllApi.md#deleteMsgVpnMqttRetainCache) | **DELETE** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Delete an MQTT Retain Cache object. | -| [**deleteMsgVpnMqttSession**](AllApi.md#deleteMsgVpnMqttSession) | **DELETE** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Delete an MQTT Session object. | -| [**deleteMsgVpnMqttSessionSubscription**](AllApi.md#deleteMsgVpnMqttSessionSubscription) | **DELETE** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Delete a Subscription object. | -| [**deleteMsgVpnQueue**](AllApi.md#deleteMsgVpnQueue) | **DELETE** /msgVpns/{msgVpnName}/queues/{queueName} | Delete a Queue object. | -| [**deleteMsgVpnQueueSubscription**](AllApi.md#deleteMsgVpnQueueSubscription) | **DELETE** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic} | Delete a Queue Subscription object. | -| [**deleteMsgVpnQueueTemplate**](AllApi.md#deleteMsgVpnQueueTemplate) | **DELETE** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Delete a Queue Template object. | -| [**deleteMsgVpnReplayLog**](AllApi.md#deleteMsgVpnReplayLog) | **DELETE** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Delete a Replay Log object. | -| [**deleteMsgVpnReplayLogTopicFilterSubscription**](AllApi.md#deleteMsgVpnReplayLogTopicFilterSubscription) | **DELETE** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription} | Delete a Topic Filter Subscription object. | -| [**deleteMsgVpnReplicatedTopic**](AllApi.md#deleteMsgVpnReplicatedTopic) | **DELETE** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Delete a Replicated Topic object. | -| [**deleteMsgVpnRestDeliveryPoint**](AllApi.md#deleteMsgVpnRestDeliveryPoint) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Delete a REST Delivery Point object. | -| [**deleteMsgVpnRestDeliveryPointQueueBinding**](AllApi.md#deleteMsgVpnRestDeliveryPointQueueBinding) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Delete a Queue Binding object. | -| [**deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader**](AllApi.md#deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Delete a Request Header object. | -| [**deleteMsgVpnRestDeliveryPointRestConsumer**](AllApi.md#deleteMsgVpnRestDeliveryPointRestConsumer) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Delete a REST Consumer object. | -| [**deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](AllApi.md#deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName} | Delete a Claim object. | -| [**deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](AllApi.md#deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Delete a Trusted Common Name object. | -| [**deleteMsgVpnSequencedTopic**](AllApi.md#deleteMsgVpnSequencedTopic) | **DELETE** /msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic} | Delete a Sequenced Topic object. | -| [**deleteMsgVpnTopicEndpoint**](AllApi.md#deleteMsgVpnTopicEndpoint) | **DELETE** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Delete a Topic Endpoint object. | -| [**deleteMsgVpnTopicEndpointTemplate**](AllApi.md#deleteMsgVpnTopicEndpointTemplate) | **DELETE** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Delete a Topic Endpoint Template object. | -| [**deleteOauthProfile**](AllApi.md#deleteOauthProfile) | **DELETE** /oauthProfiles/{oauthProfileName} | Delete an OAuth Profile object. | -| [**deleteOauthProfileAccessLevelGroup**](AllApi.md#deleteOauthProfileAccessLevelGroup) | **DELETE** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName} | Delete a Group Access Level object. | -| [**deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](AllApi.md#deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **DELETE** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName} | Delete a Message VPN Access-Level Exception object. | -| [**deleteOauthProfileClientAllowedHost**](AllApi.md#deleteOauthProfileClientAllowedHost) | **DELETE** /oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost} | Delete an Allowed Host Value object. | -| [**deleteOauthProfileClientAuthorizationParameter**](AllApi.md#deleteOauthProfileClientAuthorizationParameter) | **DELETE** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName} | Delete an Authorization Parameter object. | -| [**deleteOauthProfileClientRequiredClaim**](AllApi.md#deleteOauthProfileClientRequiredClaim) | **DELETE** /oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Delete a Required Claim object. | -| [**deleteOauthProfileDefaultMsgVpnAccessLevelException**](AllApi.md#deleteOauthProfileDefaultMsgVpnAccessLevelException) | **DELETE** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName} | Delete a Message VPN Access-Level Exception object. | -| [**deleteOauthProfileResourceServerRequiredClaim**](AllApi.md#deleteOauthProfileResourceServerRequiredClaim) | **DELETE** /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Delete a Required Claim object. | -| [**deleteVirtualHostname**](AllApi.md#deleteVirtualHostname) | **DELETE** /virtualHostnames/{virtualHostname} | Delete a Virtual Hostname object. | -| [**getAbout**](AllApi.md#getAbout) | **GET** /about | Get an About object. | -| [**getAboutApi**](AllApi.md#getAboutApi) | **GET** /about/api | Get an API Description object. | -| [**getAboutUser**](AllApi.md#getAboutUser) | **GET** /about/user | Get a User object. | -| [**getAboutUserMsgVpn**](AllApi.md#getAboutUserMsgVpn) | **GET** /about/user/msgVpns/{msgVpnName} | Get a User Message VPN object. | -| [**getAboutUserMsgVpns**](AllApi.md#getAboutUserMsgVpns) | **GET** /about/user/msgVpns | Get a list of User Message VPN objects. | -| [**getBroker**](AllApi.md#getBroker) | **GET** / | Get a Broker object. | -| [**getCertAuthorities**](AllApi.md#getCertAuthorities) | **GET** /certAuthorities | Get a list of Certificate Authority objects. | -| [**getCertAuthority**](AllApi.md#getCertAuthority) | **GET** /certAuthorities/{certAuthorityName} | Get a Certificate Authority object. | -| [**getCertAuthorityOcspTlsTrustedCommonName**](AllApi.md#getCertAuthorityOcspTlsTrustedCommonName) | **GET** /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName} | Get an OCSP Responder Trusted Common Name object. | -| [**getCertAuthorityOcspTlsTrustedCommonNames**](AllApi.md#getCertAuthorityOcspTlsTrustedCommonNames) | **GET** /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames | Get a list of OCSP Responder Trusted Common Name objects. | -| [**getClientCertAuthorities**](AllApi.md#getClientCertAuthorities) | **GET** /clientCertAuthorities | Get a list of Client Certificate Authority objects. | -| [**getClientCertAuthority**](AllApi.md#getClientCertAuthority) | **GET** /clientCertAuthorities/{certAuthorityName} | Get a Client Certificate Authority object. | -| [**getClientCertAuthorityOcspTlsTrustedCommonName**](AllApi.md#getClientCertAuthorityOcspTlsTrustedCommonName) | **GET** /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName} | Get an OCSP Responder Trusted Common Name object. | -| [**getClientCertAuthorityOcspTlsTrustedCommonNames**](AllApi.md#getClientCertAuthorityOcspTlsTrustedCommonNames) | **GET** /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames | Get a list of OCSP Responder Trusted Common Name objects. | -| [**getDmrCluster**](AllApi.md#getDmrCluster) | **GET** /dmrClusters/{dmrClusterName} | Get a Cluster object. | -| [**getDmrClusterCertMatchingRule**](AllApi.md#getDmrClusterCertMatchingRule) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName} | Get a Certificate Matching Rule object. | -| [**getDmrClusterCertMatchingRuleAttributeFilter**](AllApi.md#getDmrClusterCertMatchingRuleAttributeFilter) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Get a Certificate Matching Rule Attribute Filter object. | -| [**getDmrClusterCertMatchingRuleAttributeFilters**](AllApi.md#getDmrClusterCertMatchingRuleAttributeFilters) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters | Get a list of Certificate Matching Rule Attribute Filter objects. | -| [**getDmrClusterCertMatchingRuleCondition**](AllApi.md#getDmrClusterCertMatchingRuleCondition) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source} | Get a Certificate Matching Rule Condition object. | -| [**getDmrClusterCertMatchingRuleConditions**](AllApi.md#getDmrClusterCertMatchingRuleConditions) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions | Get a list of Certificate Matching Rule Condition objects. | -| [**getDmrClusterCertMatchingRules**](AllApi.md#getDmrClusterCertMatchingRules) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules | Get a list of Certificate Matching Rule objects. | -| [**getDmrClusterLink**](AllApi.md#getDmrClusterLink) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName} | Get a Link object. | -| [**getDmrClusterLinkAttribute**](AllApi.md#getDmrClusterLinkAttribute) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue} | Get a Link Attribute object. | -| [**getDmrClusterLinkAttributes**](AllApi.md#getDmrClusterLinkAttributes) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes | Get a list of Link Attribute objects. | -| [**getDmrClusterLinkRemoteAddress**](AllApi.md#getDmrClusterLinkRemoteAddress) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress} | Get a Remote Address object. | -| [**getDmrClusterLinkRemoteAddresses**](AllApi.md#getDmrClusterLinkRemoteAddresses) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses | Get a list of Remote Address objects. | -| [**getDmrClusterLinkTlsTrustedCommonName**](AllApi.md#getDmrClusterLinkTlsTrustedCommonName) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Get a Trusted Common Name object. | -| [**getDmrClusterLinkTlsTrustedCommonNames**](AllApi.md#getDmrClusterLinkTlsTrustedCommonNames) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames | Get a list of Trusted Common Name objects. | -| [**getDmrClusterLinks**](AllApi.md#getDmrClusterLinks) | **GET** /dmrClusters/{dmrClusterName}/links | Get a list of Link objects. | -| [**getDmrClusters**](AllApi.md#getDmrClusters) | **GET** /dmrClusters | Get a list of Cluster objects. | -| [**getDomainCertAuthorities**](AllApi.md#getDomainCertAuthorities) | **GET** /domainCertAuthorities | Get a list of Domain Certificate Authority objects. | -| [**getDomainCertAuthority**](AllApi.md#getDomainCertAuthority) | **GET** /domainCertAuthorities/{certAuthorityName} | Get a Domain Certificate Authority object. | -| [**getMsgVpn**](AllApi.md#getMsgVpn) | **GET** /msgVpns/{msgVpnName} | Get a Message VPN object. | -| [**getMsgVpnAclProfile**](AllApi.md#getMsgVpnAclProfile) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Get an ACL Profile object. | -| [**getMsgVpnAclProfileClientConnectException**](AllApi.md#getMsgVpnAclProfileClientConnectException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress} | Get a Client Connect Exception object. | -| [**getMsgVpnAclProfileClientConnectExceptions**](AllApi.md#getMsgVpnAclProfileClientConnectExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions | Get a list of Client Connect Exception objects. | -| [**getMsgVpnAclProfilePublishException**](AllApi.md#getMsgVpnAclProfilePublishException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic} | Get a Publish Topic Exception object. | -| [**getMsgVpnAclProfilePublishExceptions**](AllApi.md#getMsgVpnAclProfilePublishExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions | Get a list of Publish Topic Exception objects. | -| [**getMsgVpnAclProfilePublishTopicException**](AllApi.md#getMsgVpnAclProfilePublishTopicException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException} | Get a Publish Topic Exception object. | -| [**getMsgVpnAclProfilePublishTopicExceptions**](AllApi.md#getMsgVpnAclProfilePublishTopicExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions | Get a list of Publish Topic Exception objects. | -| [**getMsgVpnAclProfileSubscribeException**](AllApi.md#getMsgVpnAclProfileSubscribeException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic} | Get a Subscribe Topic Exception object. | -| [**getMsgVpnAclProfileSubscribeExceptions**](AllApi.md#getMsgVpnAclProfileSubscribeExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions | Get a list of Subscribe Topic Exception objects. | -| [**getMsgVpnAclProfileSubscribeShareNameException**](AllApi.md#getMsgVpnAclProfileSubscribeShareNameException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException} | Get a Subscribe Share Name Exception object. | -| [**getMsgVpnAclProfileSubscribeShareNameExceptions**](AllApi.md#getMsgVpnAclProfileSubscribeShareNameExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions | Get a list of Subscribe Share Name Exception objects. | -| [**getMsgVpnAclProfileSubscribeTopicException**](AllApi.md#getMsgVpnAclProfileSubscribeTopicException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException} | Get a Subscribe Topic Exception object. | -| [**getMsgVpnAclProfileSubscribeTopicExceptions**](AllApi.md#getMsgVpnAclProfileSubscribeTopicExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions | Get a list of Subscribe Topic Exception objects. | -| [**getMsgVpnAclProfiles**](AllApi.md#getMsgVpnAclProfiles) | **GET** /msgVpns/{msgVpnName}/aclProfiles | Get a list of ACL Profile objects. | -| [**getMsgVpnAuthenticationOauthProfile**](AllApi.md#getMsgVpnAuthenticationOauthProfile) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Get an OAuth Profile object. | -| [**getMsgVpnAuthenticationOauthProfileClientRequiredClaim**](AllApi.md#getMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Get a Required Claim object. | -| [**getMsgVpnAuthenticationOauthProfileClientRequiredClaims**](AllApi.md#getMsgVpnAuthenticationOauthProfileClientRequiredClaims) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims | Get a list of Required Claim objects. | -| [**getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](AllApi.md#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Get a Required Claim object. | -| [**getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims**](AllApi.md#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Get a list of Required Claim objects. | -| [**getMsgVpnAuthenticationOauthProfiles**](AllApi.md#getMsgVpnAuthenticationOauthProfiles) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles | Get a list of OAuth Profile objects. | -| [**getMsgVpnAuthenticationOauthProvider**](AllApi.md#getMsgVpnAuthenticationOauthProvider) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Get an OAuth Provider object. | -| [**getMsgVpnAuthenticationOauthProviders**](AllApi.md#getMsgVpnAuthenticationOauthProviders) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProviders | Get a list of OAuth Provider objects. | -| [**getMsgVpnAuthorizationGroup**](AllApi.md#getMsgVpnAuthorizationGroup) | **GET** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Get an Authorization Group object. | -| [**getMsgVpnAuthorizationGroups**](AllApi.md#getMsgVpnAuthorizationGroups) | **GET** /msgVpns/{msgVpnName}/authorizationGroups | Get a list of Authorization Group objects. | -| [**getMsgVpnBridge**](AllApi.md#getMsgVpnBridge) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Get a Bridge object. | -| [**getMsgVpnBridgeRemoteMsgVpn**](AllApi.md#getMsgVpnBridgeRemoteMsgVpn) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Get a Remote Message VPN object. | -| [**getMsgVpnBridgeRemoteMsgVpns**](AllApi.md#getMsgVpnBridgeRemoteMsgVpns) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns | Get a list of Remote Message VPN objects. | -| [**getMsgVpnBridgeRemoteSubscription**](AllApi.md#getMsgVpnBridgeRemoteSubscription) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic} | Get a Remote Subscription object. | -| [**getMsgVpnBridgeRemoteSubscriptions**](AllApi.md#getMsgVpnBridgeRemoteSubscriptions) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions | Get a list of Remote Subscription objects. | -| [**getMsgVpnBridgeTlsTrustedCommonName**](AllApi.md#getMsgVpnBridgeTlsTrustedCommonName) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Get a Trusted Common Name object. | -| [**getMsgVpnBridgeTlsTrustedCommonNames**](AllApi.md#getMsgVpnBridgeTlsTrustedCommonNames) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames | Get a list of Trusted Common Name objects. | -| [**getMsgVpnBridges**](AllApi.md#getMsgVpnBridges) | **GET** /msgVpns/{msgVpnName}/bridges | Get a list of Bridge objects. | -| [**getMsgVpnCertMatchingRule**](AllApi.md#getMsgVpnCertMatchingRule) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Get a Certificate Matching Rule object. | -| [**getMsgVpnCertMatchingRuleAttributeFilter**](AllApi.md#getMsgVpnCertMatchingRuleAttributeFilter) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Get a Certificate Matching Rule Attribute Filter object. | -| [**getMsgVpnCertMatchingRuleAttributeFilters**](AllApi.md#getMsgVpnCertMatchingRuleAttributeFilters) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters | Get a list of Certificate Matching Rule Attribute Filter objects. | -| [**getMsgVpnCertMatchingRuleCondition**](AllApi.md#getMsgVpnCertMatchingRuleCondition) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source} | Get a Certificate Matching Rule Condition object. | -| [**getMsgVpnCertMatchingRuleConditions**](AllApi.md#getMsgVpnCertMatchingRuleConditions) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions | Get a list of Certificate Matching Rule Condition objects. | -| [**getMsgVpnCertMatchingRules**](AllApi.md#getMsgVpnCertMatchingRules) | **GET** /msgVpns/{msgVpnName}/certMatchingRules | Get a list of Certificate Matching Rule objects. | -| [**getMsgVpnClientProfile**](AllApi.md#getMsgVpnClientProfile) | **GET** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Get a Client Profile object. | -| [**getMsgVpnClientProfiles**](AllApi.md#getMsgVpnClientProfiles) | **GET** /msgVpns/{msgVpnName}/clientProfiles | Get a list of Client Profile objects. | -| [**getMsgVpnClientUsername**](AllApi.md#getMsgVpnClientUsername) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Get a Client Username object. | -| [**getMsgVpnClientUsernameAttribute**](AllApi.md#getMsgVpnClientUsernameAttribute) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue} | Get a Client Username Attribute object. | -| [**getMsgVpnClientUsernameAttributes**](AllApi.md#getMsgVpnClientUsernameAttributes) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes | Get a list of Client Username Attribute objects. | -| [**getMsgVpnClientUsernames**](AllApi.md#getMsgVpnClientUsernames) | **GET** /msgVpns/{msgVpnName}/clientUsernames | Get a list of Client Username objects. | -| [**getMsgVpnDistributedCache**](AllApi.md#getMsgVpnDistributedCache) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Get a Distributed Cache object. | -| [**getMsgVpnDistributedCacheCluster**](AllApi.md#getMsgVpnDistributedCacheCluster) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Get a Cache Cluster object. | -| [**getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](AllApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName} | Get a Home Cache Cluster object. | -| [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](AllApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix} | Get a Topic Prefix object. | -| [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes**](AllApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes | Get a list of Topic Prefix objects. | -| [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters**](AllApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters | Get a list of Home Cache Cluster objects. | -| [**getMsgVpnDistributedCacheClusterInstance**](AllApi.md#getMsgVpnDistributedCacheClusterInstance) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Get a Cache Instance object. | -| [**getMsgVpnDistributedCacheClusterInstances**](AllApi.md#getMsgVpnDistributedCacheClusterInstances) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances | Get a list of Cache Instance objects. | -| [**getMsgVpnDistributedCacheClusterTopic**](AllApi.md#getMsgVpnDistributedCacheClusterTopic) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic} | Get a Topic object. | -| [**getMsgVpnDistributedCacheClusterTopics**](AllApi.md#getMsgVpnDistributedCacheClusterTopics) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics | Get a list of Topic objects. | -| [**getMsgVpnDistributedCacheClusters**](AllApi.md#getMsgVpnDistributedCacheClusters) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters | Get a list of Cache Cluster objects. | -| [**getMsgVpnDistributedCaches**](AllApi.md#getMsgVpnDistributedCaches) | **GET** /msgVpns/{msgVpnName}/distributedCaches | Get a list of Distributed Cache objects. | -| [**getMsgVpnDmrBridge**](AllApi.md#getMsgVpnDmrBridge) | **GET** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Get a DMR Bridge object. | -| [**getMsgVpnDmrBridges**](AllApi.md#getMsgVpnDmrBridges) | **GET** /msgVpns/{msgVpnName}/dmrBridges | Get a list of DMR Bridge objects. | -| [**getMsgVpnJndiConnectionFactories**](AllApi.md#getMsgVpnJndiConnectionFactories) | **GET** /msgVpns/{msgVpnName}/jndiConnectionFactories | Get a list of JNDI Connection Factory objects. | -| [**getMsgVpnJndiConnectionFactory**](AllApi.md#getMsgVpnJndiConnectionFactory) | **GET** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Get a JNDI Connection Factory object. | -| [**getMsgVpnJndiQueue**](AllApi.md#getMsgVpnJndiQueue) | **GET** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Get a JNDI Queue object. | -| [**getMsgVpnJndiQueues**](AllApi.md#getMsgVpnJndiQueues) | **GET** /msgVpns/{msgVpnName}/jndiQueues | Get a list of JNDI Queue objects. | -| [**getMsgVpnJndiTopic**](AllApi.md#getMsgVpnJndiTopic) | **GET** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Get a JNDI Topic object. | -| [**getMsgVpnJndiTopics**](AllApi.md#getMsgVpnJndiTopics) | **GET** /msgVpns/{msgVpnName}/jndiTopics | Get a list of JNDI Topic objects. | -| [**getMsgVpnMqttRetainCache**](AllApi.md#getMsgVpnMqttRetainCache) | **GET** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Get an MQTT Retain Cache object. | -| [**getMsgVpnMqttRetainCaches**](AllApi.md#getMsgVpnMqttRetainCaches) | **GET** /msgVpns/{msgVpnName}/mqttRetainCaches | Get a list of MQTT Retain Cache objects. | -| [**getMsgVpnMqttSession**](AllApi.md#getMsgVpnMqttSession) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Get an MQTT Session object. | -| [**getMsgVpnMqttSessionSubscription**](AllApi.md#getMsgVpnMqttSessionSubscription) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Get a Subscription object. | -| [**getMsgVpnMqttSessionSubscriptions**](AllApi.md#getMsgVpnMqttSessionSubscriptions) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions | Get a list of Subscription objects. | -| [**getMsgVpnMqttSessions**](AllApi.md#getMsgVpnMqttSessions) | **GET** /msgVpns/{msgVpnName}/mqttSessions | Get a list of MQTT Session objects. | -| [**getMsgVpnQueue**](AllApi.md#getMsgVpnQueue) | **GET** /msgVpns/{msgVpnName}/queues/{queueName} | Get a Queue object. | -| [**getMsgVpnQueueSubscription**](AllApi.md#getMsgVpnQueueSubscription) | **GET** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic} | Get a Queue Subscription object. | -| [**getMsgVpnQueueSubscriptions**](AllApi.md#getMsgVpnQueueSubscriptions) | **GET** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions | Get a list of Queue Subscription objects. | -| [**getMsgVpnQueueTemplate**](AllApi.md#getMsgVpnQueueTemplate) | **GET** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Get a Queue Template object. | -| [**getMsgVpnQueueTemplates**](AllApi.md#getMsgVpnQueueTemplates) | **GET** /msgVpns/{msgVpnName}/queueTemplates | Get a list of Queue Template objects. | -| [**getMsgVpnQueues**](AllApi.md#getMsgVpnQueues) | **GET** /msgVpns/{msgVpnName}/queues | Get a list of Queue objects. | -| [**getMsgVpnReplayLog**](AllApi.md#getMsgVpnReplayLog) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Get a Replay Log object. | -| [**getMsgVpnReplayLogTopicFilterSubscription**](AllApi.md#getMsgVpnReplayLogTopicFilterSubscription) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription} | Get a Topic Filter Subscription object. | -| [**getMsgVpnReplayLogTopicFilterSubscriptions**](AllApi.md#getMsgVpnReplayLogTopicFilterSubscriptions) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions | Get a list of Topic Filter Subscription objects. | -| [**getMsgVpnReplayLogs**](AllApi.md#getMsgVpnReplayLogs) | **GET** /msgVpns/{msgVpnName}/replayLogs | Get a list of Replay Log objects. | -| [**getMsgVpnReplicatedTopic**](AllApi.md#getMsgVpnReplicatedTopic) | **GET** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Get a Replicated Topic object. | -| [**getMsgVpnReplicatedTopics**](AllApi.md#getMsgVpnReplicatedTopics) | **GET** /msgVpns/{msgVpnName}/replicatedTopics | Get a list of Replicated Topic objects. | -| [**getMsgVpnRestDeliveryPoint**](AllApi.md#getMsgVpnRestDeliveryPoint) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Get a REST Delivery Point object. | -| [**getMsgVpnRestDeliveryPointQueueBinding**](AllApi.md#getMsgVpnRestDeliveryPointQueueBinding) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Get a Queue Binding object. | -| [**getMsgVpnRestDeliveryPointQueueBindingRequestHeader**](AllApi.md#getMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Get a Request Header object. | -| [**getMsgVpnRestDeliveryPointQueueBindingRequestHeaders**](AllApi.md#getMsgVpnRestDeliveryPointQueueBindingRequestHeaders) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders | Get a list of Request Header objects. | -| [**getMsgVpnRestDeliveryPointQueueBindings**](AllApi.md#getMsgVpnRestDeliveryPointQueueBindings) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings | Get a list of Queue Binding objects. | -| [**getMsgVpnRestDeliveryPointRestConsumer**](AllApi.md#getMsgVpnRestDeliveryPointRestConsumer) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Get a REST Consumer object. | -| [**getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](AllApi.md#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName} | Get a Claim object. | -| [**getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims**](AllApi.md#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims | Get a list of Claim objects. | -| [**getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](AllApi.md#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Get a Trusted Common Name object. | -| [**getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames**](AllApi.md#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames | Get a list of Trusted Common Name objects. | -| [**getMsgVpnRestDeliveryPointRestConsumers**](AllApi.md#getMsgVpnRestDeliveryPointRestConsumers) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers | Get a list of REST Consumer objects. | -| [**getMsgVpnRestDeliveryPoints**](AllApi.md#getMsgVpnRestDeliveryPoints) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints | Get a list of REST Delivery Point objects. | -| [**getMsgVpnSequencedTopic**](AllApi.md#getMsgVpnSequencedTopic) | **GET** /msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic} | Get a Sequenced Topic object. | -| [**getMsgVpnSequencedTopics**](AllApi.md#getMsgVpnSequencedTopics) | **GET** /msgVpns/{msgVpnName}/sequencedTopics | Get a list of Sequenced Topic objects. | -| [**getMsgVpnTopicEndpoint**](AllApi.md#getMsgVpnTopicEndpoint) | **GET** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Get a Topic Endpoint object. | -| [**getMsgVpnTopicEndpointTemplate**](AllApi.md#getMsgVpnTopicEndpointTemplate) | **GET** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Get a Topic Endpoint Template object. | -| [**getMsgVpnTopicEndpointTemplates**](AllApi.md#getMsgVpnTopicEndpointTemplates) | **GET** /msgVpns/{msgVpnName}/topicEndpointTemplates | Get a list of Topic Endpoint Template objects. | -| [**getMsgVpnTopicEndpoints**](AllApi.md#getMsgVpnTopicEndpoints) | **GET** /msgVpns/{msgVpnName}/topicEndpoints | Get a list of Topic Endpoint objects. | -| [**getMsgVpns**](AllApi.md#getMsgVpns) | **GET** /msgVpns | Get a list of Message VPN objects. | -| [**getOauthProfile**](AllApi.md#getOauthProfile) | **GET** /oauthProfiles/{oauthProfileName} | Get an OAuth Profile object. | -| [**getOauthProfileAccessLevelGroup**](AllApi.md#getOauthProfileAccessLevelGroup) | **GET** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName} | Get a Group Access Level object. | -| [**getOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](AllApi.md#getOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **GET** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName} | Get a Message VPN Access-Level Exception object. | -| [**getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions**](AllApi.md#getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions) | **GET** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions | Get a list of Message VPN Access-Level Exception objects. | -| [**getOauthProfileAccessLevelGroups**](AllApi.md#getOauthProfileAccessLevelGroups) | **GET** /oauthProfiles/{oauthProfileName}/accessLevelGroups | Get a list of Group Access Level objects. | -| [**getOauthProfileClientAllowedHost**](AllApi.md#getOauthProfileClientAllowedHost) | **GET** /oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost} | Get an Allowed Host Value object. | -| [**getOauthProfileClientAllowedHosts**](AllApi.md#getOauthProfileClientAllowedHosts) | **GET** /oauthProfiles/{oauthProfileName}/clientAllowedHosts | Get a list of Allowed Host Value objects. | -| [**getOauthProfileClientAuthorizationParameter**](AllApi.md#getOauthProfileClientAuthorizationParameter) | **GET** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName} | Get an Authorization Parameter object. | -| [**getOauthProfileClientAuthorizationParameters**](AllApi.md#getOauthProfileClientAuthorizationParameters) | **GET** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters | Get a list of Authorization Parameter objects. | -| [**getOauthProfileClientRequiredClaim**](AllApi.md#getOauthProfileClientRequiredClaim) | **GET** /oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Get a Required Claim object. | -| [**getOauthProfileClientRequiredClaims**](AllApi.md#getOauthProfileClientRequiredClaims) | **GET** /oauthProfiles/{oauthProfileName}/clientRequiredClaims | Get a list of Required Claim objects. | -| [**getOauthProfileDefaultMsgVpnAccessLevelException**](AllApi.md#getOauthProfileDefaultMsgVpnAccessLevelException) | **GET** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName} | Get a Message VPN Access-Level Exception object. | -| [**getOauthProfileDefaultMsgVpnAccessLevelExceptions**](AllApi.md#getOauthProfileDefaultMsgVpnAccessLevelExceptions) | **GET** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions | Get a list of Message VPN Access-Level Exception objects. | -| [**getOauthProfileResourceServerRequiredClaim**](AllApi.md#getOauthProfileResourceServerRequiredClaim) | **GET** /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Get a Required Claim object. | -| [**getOauthProfileResourceServerRequiredClaims**](AllApi.md#getOauthProfileResourceServerRequiredClaims) | **GET** /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Get a list of Required Claim objects. | -| [**getOauthProfiles**](AllApi.md#getOauthProfiles) | **GET** /oauthProfiles | Get a list of OAuth Profile objects. | -| [**getSystemInformation**](AllApi.md#getSystemInformation) | **GET** /systemInformation | Get a System Information object. | -| [**getVirtualHostname**](AllApi.md#getVirtualHostname) | **GET** /virtualHostnames/{virtualHostname} | Get a Virtual Hostname object. | -| [**getVirtualHostnames**](AllApi.md#getVirtualHostnames) | **GET** /virtualHostnames | Get a list of Virtual Hostname objects. | -| [**replaceCertAuthority**](AllApi.md#replaceCertAuthority) | **PUT** /certAuthorities/{certAuthorityName} | Replace a Certificate Authority object. | -| [**replaceClientCertAuthority**](AllApi.md#replaceClientCertAuthority) | **PUT** /clientCertAuthorities/{certAuthorityName} | Replace a Client Certificate Authority object. | -| [**replaceDmrCluster**](AllApi.md#replaceDmrCluster) | **PUT** /dmrClusters/{dmrClusterName} | Replace a Cluster object. | -| [**replaceDmrClusterCertMatchingRule**](AllApi.md#replaceDmrClusterCertMatchingRule) | **PUT** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName} | Replace a Certificate Matching Rule object. | -| [**replaceDmrClusterCertMatchingRuleAttributeFilter**](AllApi.md#replaceDmrClusterCertMatchingRuleAttributeFilter) | **PUT** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Replace a Certificate Matching Rule Attribute Filter object. | -| [**replaceDmrClusterLink**](AllApi.md#replaceDmrClusterLink) | **PUT** /dmrClusters/{dmrClusterName}/links/{remoteNodeName} | Replace a Link object. | -| [**replaceDomainCertAuthority**](AllApi.md#replaceDomainCertAuthority) | **PUT** /domainCertAuthorities/{certAuthorityName} | Replace a Domain Certificate Authority object. | -| [**replaceMsgVpn**](AllApi.md#replaceMsgVpn) | **PUT** /msgVpns/{msgVpnName} | Replace a Message VPN object. | -| [**replaceMsgVpnAclProfile**](AllApi.md#replaceMsgVpnAclProfile) | **PUT** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Replace an ACL Profile object. | -| [**replaceMsgVpnAuthenticationOauthProfile**](AllApi.md#replaceMsgVpnAuthenticationOauthProfile) | **PUT** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Replace an OAuth Profile object. | -| [**replaceMsgVpnAuthenticationOauthProvider**](AllApi.md#replaceMsgVpnAuthenticationOauthProvider) | **PUT** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Replace an OAuth Provider object. | -| [**replaceMsgVpnAuthorizationGroup**](AllApi.md#replaceMsgVpnAuthorizationGroup) | **PUT** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Replace an Authorization Group object. | -| [**replaceMsgVpnBridge**](AllApi.md#replaceMsgVpnBridge) | **PUT** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Replace a Bridge object. | -| [**replaceMsgVpnBridgeRemoteMsgVpn**](AllApi.md#replaceMsgVpnBridgeRemoteMsgVpn) | **PUT** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Replace a Remote Message VPN object. | -| [**replaceMsgVpnCertMatchingRule**](AllApi.md#replaceMsgVpnCertMatchingRule) | **PUT** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Replace a Certificate Matching Rule object. | -| [**replaceMsgVpnCertMatchingRuleAttributeFilter**](AllApi.md#replaceMsgVpnCertMatchingRuleAttributeFilter) | **PUT** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Replace a Certificate Matching Rule Attribute Filter object. | -| [**replaceMsgVpnClientProfile**](AllApi.md#replaceMsgVpnClientProfile) | **PUT** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Replace a Client Profile object. | -| [**replaceMsgVpnClientUsername**](AllApi.md#replaceMsgVpnClientUsername) | **PUT** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Replace a Client Username object. | -| [**replaceMsgVpnDistributedCache**](AllApi.md#replaceMsgVpnDistributedCache) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Replace a Distributed Cache object. | -| [**replaceMsgVpnDistributedCacheCluster**](AllApi.md#replaceMsgVpnDistributedCacheCluster) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Replace a Cache Cluster object. | -| [**replaceMsgVpnDistributedCacheClusterInstance**](AllApi.md#replaceMsgVpnDistributedCacheClusterInstance) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Replace a Cache Instance object. | -| [**replaceMsgVpnDmrBridge**](AllApi.md#replaceMsgVpnDmrBridge) | **PUT** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Replace a DMR Bridge object. | -| [**replaceMsgVpnJndiConnectionFactory**](AllApi.md#replaceMsgVpnJndiConnectionFactory) | **PUT** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Replace a JNDI Connection Factory object. | -| [**replaceMsgVpnJndiQueue**](AllApi.md#replaceMsgVpnJndiQueue) | **PUT** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Replace a JNDI Queue object. | -| [**replaceMsgVpnJndiTopic**](AllApi.md#replaceMsgVpnJndiTopic) | **PUT** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Replace a JNDI Topic object. | -| [**replaceMsgVpnMqttRetainCache**](AllApi.md#replaceMsgVpnMqttRetainCache) | **PUT** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Replace an MQTT Retain Cache object. | -| [**replaceMsgVpnMqttSession**](AllApi.md#replaceMsgVpnMqttSession) | **PUT** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Replace an MQTT Session object. | -| [**replaceMsgVpnMqttSessionSubscription**](AllApi.md#replaceMsgVpnMqttSessionSubscription) | **PUT** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Replace a Subscription object. | -| [**replaceMsgVpnQueue**](AllApi.md#replaceMsgVpnQueue) | **PUT** /msgVpns/{msgVpnName}/queues/{queueName} | Replace a Queue object. | -| [**replaceMsgVpnQueueTemplate**](AllApi.md#replaceMsgVpnQueueTemplate) | **PUT** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Replace a Queue Template object. | -| [**replaceMsgVpnReplayLog**](AllApi.md#replaceMsgVpnReplayLog) | **PUT** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Replace a Replay Log object. | -| [**replaceMsgVpnReplicatedTopic**](AllApi.md#replaceMsgVpnReplicatedTopic) | **PUT** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Replace a Replicated Topic object. | -| [**replaceMsgVpnRestDeliveryPoint**](AllApi.md#replaceMsgVpnRestDeliveryPoint) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Replace a REST Delivery Point object. | -| [**replaceMsgVpnRestDeliveryPointQueueBinding**](AllApi.md#replaceMsgVpnRestDeliveryPointQueueBinding) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Replace a Queue Binding object. | -| [**replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader**](AllApi.md#replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Replace a Request Header object. | -| [**replaceMsgVpnRestDeliveryPointRestConsumer**](AllApi.md#replaceMsgVpnRestDeliveryPointRestConsumer) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Replace a REST Consumer object. | -| [**replaceMsgVpnTopicEndpoint**](AllApi.md#replaceMsgVpnTopicEndpoint) | **PUT** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Replace a Topic Endpoint object. | -| [**replaceMsgVpnTopicEndpointTemplate**](AllApi.md#replaceMsgVpnTopicEndpointTemplate) | **PUT** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Replace a Topic Endpoint Template object. | -| [**replaceOauthProfile**](AllApi.md#replaceOauthProfile) | **PUT** /oauthProfiles/{oauthProfileName} | Replace an OAuth Profile object. | -| [**replaceOauthProfileAccessLevelGroup**](AllApi.md#replaceOauthProfileAccessLevelGroup) | **PUT** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName} | Replace a Group Access Level object. | -| [**replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](AllApi.md#replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **PUT** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName} | Replace a Message VPN Access-Level Exception object. | -| [**replaceOauthProfileClientAuthorizationParameter**](AllApi.md#replaceOauthProfileClientAuthorizationParameter) | **PUT** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName} | Replace an Authorization Parameter object. | -| [**replaceOauthProfileDefaultMsgVpnAccessLevelException**](AllApi.md#replaceOauthProfileDefaultMsgVpnAccessLevelException) | **PUT** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName} | Replace a Message VPN Access-Level Exception object. | -| [**replaceVirtualHostname**](AllApi.md#replaceVirtualHostname) | **PUT** /virtualHostnames/{virtualHostname} | Replace a Virtual Hostname object. | -| [**updateBroker**](AllApi.md#updateBroker) | **PATCH** / | Update a Broker object. | -| [**updateCertAuthority**](AllApi.md#updateCertAuthority) | **PATCH** /certAuthorities/{certAuthorityName} | Update a Certificate Authority object. | -| [**updateClientCertAuthority**](AllApi.md#updateClientCertAuthority) | **PATCH** /clientCertAuthorities/{certAuthorityName} | Update a Client Certificate Authority object. | -| [**updateDmrCluster**](AllApi.md#updateDmrCluster) | **PATCH** /dmrClusters/{dmrClusterName} | Update a Cluster object. | -| [**updateDmrClusterCertMatchingRule**](AllApi.md#updateDmrClusterCertMatchingRule) | **PATCH** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName} | Update a Certificate Matching Rule object. | -| [**updateDmrClusterCertMatchingRuleAttributeFilter**](AllApi.md#updateDmrClusterCertMatchingRuleAttributeFilter) | **PATCH** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Update a Certificate Matching Rule Attribute Filter object. | -| [**updateDmrClusterLink**](AllApi.md#updateDmrClusterLink) | **PATCH** /dmrClusters/{dmrClusterName}/links/{remoteNodeName} | Update a Link object. | -| [**updateDomainCertAuthority**](AllApi.md#updateDomainCertAuthority) | **PATCH** /domainCertAuthorities/{certAuthorityName} | Update a Domain Certificate Authority object. | -| [**updateMsgVpn**](AllApi.md#updateMsgVpn) | **PATCH** /msgVpns/{msgVpnName} | Update a Message VPN object. | -| [**updateMsgVpnAclProfile**](AllApi.md#updateMsgVpnAclProfile) | **PATCH** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Update an ACL Profile object. | -| [**updateMsgVpnAuthenticationOauthProfile**](AllApi.md#updateMsgVpnAuthenticationOauthProfile) | **PATCH** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Update an OAuth Profile object. | -| [**updateMsgVpnAuthenticationOauthProvider**](AllApi.md#updateMsgVpnAuthenticationOauthProvider) | **PATCH** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Update an OAuth Provider object. | -| [**updateMsgVpnAuthorizationGroup**](AllApi.md#updateMsgVpnAuthorizationGroup) | **PATCH** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Update an Authorization Group object. | -| [**updateMsgVpnBridge**](AllApi.md#updateMsgVpnBridge) | **PATCH** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Update a Bridge object. | -| [**updateMsgVpnBridgeRemoteMsgVpn**](AllApi.md#updateMsgVpnBridgeRemoteMsgVpn) | **PATCH** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Update a Remote Message VPN object. | -| [**updateMsgVpnCertMatchingRule**](AllApi.md#updateMsgVpnCertMatchingRule) | **PATCH** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Update a Certificate Matching Rule object. | -| [**updateMsgVpnCertMatchingRuleAttributeFilter**](AllApi.md#updateMsgVpnCertMatchingRuleAttributeFilter) | **PATCH** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Update a Certificate Matching Rule Attribute Filter object. | -| [**updateMsgVpnClientProfile**](AllApi.md#updateMsgVpnClientProfile) | **PATCH** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Update a Client Profile object. | -| [**updateMsgVpnClientUsername**](AllApi.md#updateMsgVpnClientUsername) | **PATCH** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Update a Client Username object. | -| [**updateMsgVpnDistributedCache**](AllApi.md#updateMsgVpnDistributedCache) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Update a Distributed Cache object. | -| [**updateMsgVpnDistributedCacheCluster**](AllApi.md#updateMsgVpnDistributedCacheCluster) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Update a Cache Cluster object. | -| [**updateMsgVpnDistributedCacheClusterInstance**](AllApi.md#updateMsgVpnDistributedCacheClusterInstance) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Update a Cache Instance object. | -| [**updateMsgVpnDmrBridge**](AllApi.md#updateMsgVpnDmrBridge) | **PATCH** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Update a DMR Bridge object. | -| [**updateMsgVpnJndiConnectionFactory**](AllApi.md#updateMsgVpnJndiConnectionFactory) | **PATCH** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Update a JNDI Connection Factory object. | -| [**updateMsgVpnJndiQueue**](AllApi.md#updateMsgVpnJndiQueue) | **PATCH** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Update a JNDI Queue object. | -| [**updateMsgVpnJndiTopic**](AllApi.md#updateMsgVpnJndiTopic) | **PATCH** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Update a JNDI Topic object. | -| [**updateMsgVpnMqttRetainCache**](AllApi.md#updateMsgVpnMqttRetainCache) | **PATCH** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Update an MQTT Retain Cache object. | -| [**updateMsgVpnMqttSession**](AllApi.md#updateMsgVpnMqttSession) | **PATCH** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Update an MQTT Session object. | -| [**updateMsgVpnMqttSessionSubscription**](AllApi.md#updateMsgVpnMqttSessionSubscription) | **PATCH** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Update a Subscription object. | -| [**updateMsgVpnQueue**](AllApi.md#updateMsgVpnQueue) | **PATCH** /msgVpns/{msgVpnName}/queues/{queueName} | Update a Queue object. | -| [**updateMsgVpnQueueTemplate**](AllApi.md#updateMsgVpnQueueTemplate) | **PATCH** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Update a Queue Template object. | -| [**updateMsgVpnReplayLog**](AllApi.md#updateMsgVpnReplayLog) | **PATCH** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Update a Replay Log object. | -| [**updateMsgVpnReplicatedTopic**](AllApi.md#updateMsgVpnReplicatedTopic) | **PATCH** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Update a Replicated Topic object. | -| [**updateMsgVpnRestDeliveryPoint**](AllApi.md#updateMsgVpnRestDeliveryPoint) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Update a REST Delivery Point object. | -| [**updateMsgVpnRestDeliveryPointQueueBinding**](AllApi.md#updateMsgVpnRestDeliveryPointQueueBinding) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Update a Queue Binding object. | -| [**updateMsgVpnRestDeliveryPointQueueBindingRequestHeader**](AllApi.md#updateMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Update a Request Header object. | -| [**updateMsgVpnRestDeliveryPointRestConsumer**](AllApi.md#updateMsgVpnRestDeliveryPointRestConsumer) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Update a REST Consumer object. | -| [**updateMsgVpnTopicEndpoint**](AllApi.md#updateMsgVpnTopicEndpoint) | **PATCH** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Update a Topic Endpoint object. | -| [**updateMsgVpnTopicEndpointTemplate**](AllApi.md#updateMsgVpnTopicEndpointTemplate) | **PATCH** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Update a Topic Endpoint Template object. | -| [**updateOauthProfile**](AllApi.md#updateOauthProfile) | **PATCH** /oauthProfiles/{oauthProfileName} | Update an OAuth Profile object. | -| [**updateOauthProfileAccessLevelGroup**](AllApi.md#updateOauthProfileAccessLevelGroup) | **PATCH** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName} | Update a Group Access Level object. | -| [**updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](AllApi.md#updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **PATCH** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName} | Update a Message VPN Access-Level Exception object. | -| [**updateOauthProfileClientAuthorizationParameter**](AllApi.md#updateOauthProfileClientAuthorizationParameter) | **PATCH** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName} | Update an Authorization Parameter object. | -| [**updateOauthProfileDefaultMsgVpnAccessLevelException**](AllApi.md#updateOauthProfileDefaultMsgVpnAccessLevelException) | **PATCH** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName} | Update a Message VPN Access-Level Exception object. | -| [**updateVirtualHostname**](AllApi.md#updateVirtualHostname) | **PATCH** /virtualHostnames/{virtualHostname} | Update a Virtual Hostname object. | - - - -## createCertAuthority - -> CertAuthorityResponse createCertAuthority(body, opaquePassword, select) - -Create a Certificate Authority object. - -Create a Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||x| certContent|||||x| crlDayList|||||x| crlTimeList|||||x| crlUrl|||||x| ocspNonResponderCertEnabled|||||x| ocspOverrideUrl|||||x| ocspTimeout|||||x| revocationCheckEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - CertAuthority body = new CertAuthority(); // CertAuthority | The Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - CertAuthorityResponse result = apiInstance.createCertAuthority(body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **body** | [**CertAuthority**](CertAuthority.md)| The Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**CertAuthorityResponse**](CertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Authority object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createCertAuthorityOcspTlsTrustedCommonName - -> CertAuthorityOcspTlsTrustedCommonNameResponse createCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, body, opaquePassword, select) - -Create an OCSP Responder Trusted Common Name object. - -Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x||x||x| ocspTlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - CertAuthorityOcspTlsTrustedCommonName body = new CertAuthorityOcspTlsTrustedCommonName(); // CertAuthorityOcspTlsTrustedCommonName | The OCSP Responder Trusted Common Name object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - CertAuthorityOcspTlsTrustedCommonNameResponse result = apiInstance.createCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createCertAuthorityOcspTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **body** | [**CertAuthorityOcspTlsTrustedCommonName**](CertAuthorityOcspTlsTrustedCommonName.md)| The OCSP Responder Trusted Common Name object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**CertAuthorityOcspTlsTrustedCommonNameResponse**](CertAuthorityOcspTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createClientCertAuthority - -> ClientCertAuthorityResponse createClientCertAuthority(body, opaquePassword, select) - -Create a Client Certificate Authority object. - -Create a Client Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - ClientCertAuthority body = new ClientCertAuthority(); // ClientCertAuthority | The Client Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - ClientCertAuthorityResponse result = apiInstance.createClientCertAuthority(body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createClientCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **body** | [**ClientCertAuthority**](ClientCertAuthority.md)| The Client Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**ClientCertAuthorityResponse**](ClientCertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Certificate Authority object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createClientCertAuthorityOcspTlsTrustedCommonName - -> ClientCertAuthorityOcspTlsTrustedCommonNameResponse createClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, body, opaquePassword, select) - -Create an OCSP Responder Trusted Common Name object. - -Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x||x||| ocspTlsTrustedCommonName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - ClientCertAuthorityOcspTlsTrustedCommonName body = new ClientCertAuthorityOcspTlsTrustedCommonName(); // ClientCertAuthorityOcspTlsTrustedCommonName | The OCSP Responder Trusted Common Name object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - ClientCertAuthorityOcspTlsTrustedCommonNameResponse result = apiInstance.createClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createClientCertAuthorityOcspTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **body** | [**ClientCertAuthorityOcspTlsTrustedCommonName**](ClientCertAuthorityOcspTlsTrustedCommonName.md)| The OCSP Responder Trusted Common Name object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**ClientCertAuthorityOcspTlsTrustedCommonNameResponse**](ClientCertAuthorityOcspTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createDmrCluster - -> DmrClusterResponse createDmrCluster(body, opaquePassword, select) - -Create a Cluster object. - -Create a Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationBasicPassword||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| dmrClusterName|x|x|||| nodeName|||x||| tlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - DmrCluster body = new DmrCluster(); // DmrCluster | The Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterResponse result = apiInstance.createDmrCluster(body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createDmrCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **body** | [**DmrCluster**](DmrCluster.md)| The Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterResponse**](DmrClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cluster object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createDmrClusterCertMatchingRule - -> DmrClusterCertMatchingRuleResponse createDmrClusterCertMatchingRule(dmrClusterName, body, opaquePassword, select) - -Create a Certificate Matching Rule object. - -Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - DmrClusterCertMatchingRule body = new DmrClusterCertMatchingRule(); // DmrClusterCertMatchingRule | The Certificate Matching Rule object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleResponse result = apiInstance.createDmrClusterCertMatchingRule(dmrClusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createDmrClusterCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **body** | [**DmrClusterCertMatchingRule**](DmrClusterCertMatchingRule.md)| The Certificate Matching Rule object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleResponse**](DmrClusterCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createDmrClusterCertMatchingRuleAttributeFilter - -> DmrClusterCertMatchingRuleAttributeFilterResponse createDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, body, opaquePassword, select) - -Create a Certificate Matching Rule Attribute Filter object. - -Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| filterName|x|x|||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - DmrClusterCertMatchingRuleAttributeFilter body = new DmrClusterCertMatchingRuleAttributeFilter(); // DmrClusterCertMatchingRuleAttributeFilter | The Certificate Matching Rule Attribute Filter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleAttributeFilterResponse result = apiInstance.createDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createDmrClusterCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**DmrClusterCertMatchingRuleAttributeFilter**](DmrClusterCertMatchingRuleAttributeFilter.md)| The Certificate Matching Rule Attribute Filter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleAttributeFilterResponse**](DmrClusterCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createDmrClusterCertMatchingRuleCondition - -> DmrClusterCertMatchingRuleConditionResponse createDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, body, opaquePassword, select) - -Create a Certificate Matching Rule Condition object. - -Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - DmrClusterCertMatchingRuleCondition body = new DmrClusterCertMatchingRuleCondition(); // DmrClusterCertMatchingRuleCondition | The Certificate Matching Rule Condition object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleConditionResponse result = apiInstance.createDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createDmrClusterCertMatchingRuleCondition"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**DmrClusterCertMatchingRuleCondition**](DmrClusterCertMatchingRuleCondition.md)| The Certificate Matching Rule Condition object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleConditionResponse**](DmrClusterCertMatchingRuleConditionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Condition object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createDmrClusterLink - -> DmrClusterLinkResponse createDmrClusterLink(dmrClusterName, body, opaquePassword, select) - -Create a Link object. - -Create a Link object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationBasicPassword||||x||x dmrClusterName|x||x||| remoteNodeName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - DmrClusterLink body = new DmrClusterLink(); // DmrClusterLink | The Link object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkResponse result = apiInstance.createDmrClusterLink(dmrClusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createDmrClusterLink"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **body** | [**DmrClusterLink**](DmrClusterLink.md)| The Link object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkResponse**](DmrClusterLinkResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Link object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createDmrClusterLinkAttribute - -> DmrClusterLinkAttributeResponse createDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, body, opaquePassword, select) - -Create a Link Attribute object. - -Create a Link Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| dmrClusterName|x||x||| remoteNodeName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - DmrClusterLinkAttribute body = new DmrClusterLinkAttribute(); // DmrClusterLinkAttribute | The Link Attribute object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkAttributeResponse result = apiInstance.createDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createDmrClusterLinkAttribute"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **body** | [**DmrClusterLinkAttribute**](DmrClusterLinkAttribute.md)| The Link Attribute object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkAttributeResponse**](DmrClusterLinkAttributeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Link Attribute object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createDmrClusterLinkRemoteAddress - -> DmrClusterLinkRemoteAddressResponse createDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, body, opaquePassword, select) - -Create a Remote Address object. - -Create a Remote Address object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| remoteAddress|x|x|||| remoteNodeName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - DmrClusterLinkRemoteAddress body = new DmrClusterLinkRemoteAddress(); // DmrClusterLinkRemoteAddress | The Remote Address object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkRemoteAddressResponse result = apiInstance.createDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createDmrClusterLinkRemoteAddress"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **body** | [**DmrClusterLinkRemoteAddress**](DmrClusterLinkRemoteAddress.md)| The Remote Address object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkRemoteAddressResponse**](DmrClusterLinkRemoteAddressResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Address object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createDmrClusterLinkTlsTrustedCommonName - -> DmrClusterLinkTlsTrustedCommonNameResponse createDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, body, opaquePassword, select) - -Create a Trusted Common Name object. - -Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||x| remoteNodeName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - DmrClusterLinkTlsTrustedCommonName body = new DmrClusterLinkTlsTrustedCommonName(); // DmrClusterLinkTlsTrustedCommonName | The Trusted Common Name object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkTlsTrustedCommonNameResponse result = apiInstance.createDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createDmrClusterLinkTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **body** | [**DmrClusterLinkTlsTrustedCommonName**](DmrClusterLinkTlsTrustedCommonName.md)| The Trusted Common Name object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkTlsTrustedCommonNameResponse**](DmrClusterLinkTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Trusted Common Name object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createDomainCertAuthority - -> DomainCertAuthorityResponse createDomainCertAuthority(body, opaquePassword, select) - -Create a Domain Certificate Authority object. - -Create a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Certificate Authorities trusted for domain verification. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - DomainCertAuthority body = new DomainCertAuthority(); // DomainCertAuthority | The Domain Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DomainCertAuthorityResponse result = apiInstance.createDomainCertAuthority(body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createDomainCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **body** | [**DomainCertAuthority**](DomainCertAuthority.md)| The Domain Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DomainCertAuthorityResponse**](DomainCertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Domain Certificate Authority object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpn - -> MsgVpnResponse createMsgVpn(body, opaquePassword, select) - -Create a Message VPN object. - -Create a Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| distributedCacheManagementEnabled|||||x| msgVpnName|x|x|||| replicationBridgeAuthenticationBasicPassword||||x||x replicationBridgeAuthenticationClientCertContent||||x||x replicationBridgeAuthenticationClientCertPassword||||x|| replicationEnabledQueueBehavior||||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - MsgVpn body = new MsgVpn(); // MsgVpn | The Message VPN object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnResponse result = apiInstance.createMsgVpn(body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **body** | [**MsgVpn**](MsgVpn.md)| The Message VPN object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnResponse**](MsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfile - -> MsgVpnAclProfileResponse createMsgVpnAclProfile(msgVpnName, body, opaquePassword, select) - -Create an ACL Profile object. - -Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnAclProfile body = new MsgVpnAclProfile(); // MsgVpnAclProfile | The ACL Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileResponse result = apiInstance.createMsgVpnAclProfile(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnAclProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnAclProfile**](MsgVpnAclProfile.md)| The ACL Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileResponse**](MsgVpnAclProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The ACL Profile object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfileClientConnectException - -> MsgVpnAclProfileClientConnectExceptionResponse createMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Client Connect Exception object. - -Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| clientConnectExceptionAddress|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfileClientConnectException body = new MsgVpnAclProfileClientConnectException(); // MsgVpnAclProfileClientConnectException | The Client Connect Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileClientConnectExceptionResponse result = apiInstance.createMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnAclProfileClientConnectException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfileClientConnectException**](MsgVpnAclProfileClientConnectException.md)| The Client Connect Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileClientConnectExceptionResponse**](MsgVpnAclProfileClientConnectExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Connect Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfilePublishException - -> MsgVpnAclProfilePublishExceptionResponse createMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Publish Topic Exception object. - -Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| publishExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfilePublishException body = new MsgVpnAclProfilePublishException(); // MsgVpnAclProfilePublishException | The Publish Topic Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishExceptionResponse result = apiInstance.createMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnAclProfilePublishException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfilePublishException**](MsgVpnAclProfilePublishException.md)| The Publish Topic Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishExceptionResponse**](MsgVpnAclProfilePublishExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Publish Topic Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfilePublishTopicException - -> MsgVpnAclProfilePublishTopicExceptionResponse createMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Publish Topic Exception object. - -Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| publishTopicException|x|x|||| publishTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfilePublishTopicException body = new MsgVpnAclProfilePublishTopicException(); // MsgVpnAclProfilePublishTopicException | The Publish Topic Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishTopicExceptionResponse result = apiInstance.createMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnAclProfilePublishTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfilePublishTopicException**](MsgVpnAclProfilePublishTopicException.md)| The Publish Topic Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishTopicExceptionResponse**](MsgVpnAclProfilePublishTopicExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Publish Topic Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfileSubscribeException - -> MsgVpnAclProfileSubscribeExceptionResponse createMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Subscribe Topic Exception object. - -Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| subscribeExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfileSubscribeException body = new MsgVpnAclProfileSubscribeException(); // MsgVpnAclProfileSubscribeException | The Subscribe Topic Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeExceptionResponse result = apiInstance.createMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnAclProfileSubscribeException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfileSubscribeException**](MsgVpnAclProfileSubscribeException.md)| The Subscribe Topic Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeExceptionResponse**](MsgVpnAclProfileSubscribeExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Topic Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfileSubscribeShareNameException - -> MsgVpnAclProfileSubscribeShareNameExceptionResponse createMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Subscribe Share Name Exception object. - -Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeShareNameException|x|x|||| subscribeShareNameExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfileSubscribeShareNameException body = new MsgVpnAclProfileSubscribeShareNameException(); // MsgVpnAclProfileSubscribeShareNameException | The Subscribe Share Name Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeShareNameExceptionResponse result = apiInstance.createMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnAclProfileSubscribeShareNameException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfileSubscribeShareNameException**](MsgVpnAclProfileSubscribeShareNameException.md)| The Subscribe Share Name Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeShareNameExceptionResponse**](MsgVpnAclProfileSubscribeShareNameExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Share Name Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfileSubscribeTopicException - -> MsgVpnAclProfileSubscribeTopicExceptionResponse createMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Subscribe Topic Exception object. - -Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeTopicException|x|x|||| subscribeTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfileSubscribeTopicException body = new MsgVpnAclProfileSubscribeTopicException(); // MsgVpnAclProfileSubscribeTopicException | The Subscribe Topic Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeTopicExceptionResponse result = apiInstance.createMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnAclProfileSubscribeTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfileSubscribeTopicException**](MsgVpnAclProfileSubscribeTopicException.md)| The Subscribe Topic Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeTopicExceptionResponse**](MsgVpnAclProfileSubscribeTopicExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Topic Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAuthenticationOauthProfile - -> MsgVpnAuthenticationOauthProfileResponse createMsgVpnAuthenticationOauthProfile(msgVpnName, body, opaquePassword, select) - -Create an OAuth Profile object. - -Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x msgVpnName|x||x||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnAuthenticationOauthProfile body = new MsgVpnAuthenticationOauthProfile(); // MsgVpnAuthenticationOauthProfile | The OAuth Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResponse result = apiInstance.createMsgVpnAuthenticationOauthProfile(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnAuthenticationOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnAuthenticationOauthProfile**](MsgVpnAuthenticationOauthProfile.md)| The OAuth Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResponse**](MsgVpnAuthenticationOauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAuthenticationOauthProfileClientRequiredClaim - -> MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse createMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select) - -Create a Required Claim object. - -Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| msgVpnName|x||x||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - MsgVpnAuthenticationOauthProfileClientRequiredClaim body = new MsgVpnAuthenticationOauthProfileClientRequiredClaim(); // MsgVpnAuthenticationOauthProfileClientRequiredClaim | The Required Claim object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse result = apiInstance.createMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**MsgVpnAuthenticationOauthProfileClientRequiredClaim**](MsgVpnAuthenticationOauthProfileClientRequiredClaim.md)| The Required Claim object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse**](MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - -> MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select) - -Create a Required Claim object. - -Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim body = new MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(); // MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim | The Required Claim object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse result = apiInstance.createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.md)| The Required Claim object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse**](MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAuthenticationOauthProvider - -> MsgVpnAuthenticationOauthProviderResponse createMsgVpnAuthenticationOauthProvider(msgVpnName, body, opaquePassword, select) - -Create an OAuth Provider object. - -Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x||x||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword||||x|x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnAuthenticationOauthProvider body = new MsgVpnAuthenticationOauthProvider(); // MsgVpnAuthenticationOauthProvider | The OAuth Provider object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProviderResponse result = apiInstance.createMsgVpnAuthenticationOauthProvider(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnAuthenticationOauthProvider"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnAuthenticationOauthProvider**](MsgVpnAuthenticationOauthProvider.md)| The OAuth Provider object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProviderResponse**](MsgVpnAuthenticationOauthProviderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Provider object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAuthorizationGroup - -> MsgVpnAuthorizationGroupResponse createMsgVpnAuthorizationGroup(msgVpnName, body, opaquePassword, select) - -Create an Authorization Group object. - -Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationGroupName|x|x|||| msgVpnName|x||x||| orderAfterAuthorizationGroupName||||x|| orderBeforeAuthorizationGroupName||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnAuthorizationGroup body = new MsgVpnAuthorizationGroup(); // MsgVpnAuthorizationGroup | The Authorization Group object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthorizationGroupResponse result = apiInstance.createMsgVpnAuthorizationGroup(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnAuthorizationGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnAuthorizationGroup**](MsgVpnAuthorizationGroup.md)| The Authorization Group object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthorizationGroupResponse**](MsgVpnAuthorizationGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Group object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnBridge - -> MsgVpnBridgeResponse createMsgVpnBridge(msgVpnName, body, opaquePassword, select) - -Create a Bridge object. - -Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| msgVpnName|x||x||| remoteAuthenticationBasicPassword||||x||x remoteAuthenticationClientCertContent||||x||x remoteAuthenticationClientCertPassword||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnBridge body = new MsgVpnBridge(); // MsgVpnBridge | The Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeResponse result = apiInstance.createMsgVpnBridge(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnBridge**](MsgVpnBridge.md)| The Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeResponse**](MsgVpnBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Bridge object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnBridgeRemoteMsgVpn - -> MsgVpnBridgeRemoteMsgVpnResponse createMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select) - -Create a Remote Message VPN object. - -Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| msgVpnName|x||x||| password||||x||x remoteMsgVpnInterface|x||||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - MsgVpnBridgeRemoteMsgVpn body = new MsgVpnBridgeRemoteMsgVpn(); // MsgVpnBridgeRemoteMsgVpn | The Remote Message VPN object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteMsgVpnResponse result = apiInstance.createMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnBridgeRemoteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **body** | [**MsgVpnBridgeRemoteMsgVpn**](MsgVpnBridgeRemoteMsgVpn.md)| The Remote Message VPN object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteMsgVpnResponse**](MsgVpnBridgeRemoteMsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Message VPN object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnBridgeRemoteSubscription - -> MsgVpnBridgeRemoteSubscriptionResponse createMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select) - -Create a Remote Subscription object. - -Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| deliverAlwaysEnabled||x|||| msgVpnName|x||x||| remoteSubscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - MsgVpnBridgeRemoteSubscription body = new MsgVpnBridgeRemoteSubscription(); // MsgVpnBridgeRemoteSubscription | The Remote Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteSubscriptionResponse result = apiInstance.createMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnBridgeRemoteSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **body** | [**MsgVpnBridgeRemoteSubscription**](MsgVpnBridgeRemoteSubscription.md)| The Remote Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteSubscriptionResponse**](MsgVpnBridgeRemoteSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Subscription object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnBridgeTlsTrustedCommonName - -> MsgVpnBridgeTlsTrustedCommonNameResponse createMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select) - -Create a Trusted Common Name object. - -Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||x| bridgeVirtualRouter|x||x||x| msgVpnName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - MsgVpnBridgeTlsTrustedCommonName body = new MsgVpnBridgeTlsTrustedCommonName(); // MsgVpnBridgeTlsTrustedCommonName | The Trusted Common Name object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeTlsTrustedCommonNameResponse result = apiInstance.createMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnBridgeTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **body** | [**MsgVpnBridgeTlsTrustedCommonName**](MsgVpnBridgeTlsTrustedCommonName.md)| The Trusted Common Name object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeTlsTrustedCommonNameResponse**](MsgVpnBridgeTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Trusted Common Name object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnCertMatchingRule - -> MsgVpnCertMatchingRuleResponse createMsgVpnCertMatchingRule(msgVpnName, body, opaquePassword, select) - -Create a Certificate Matching Rule object. - -Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnCertMatchingRule body = new MsgVpnCertMatchingRule(); // MsgVpnCertMatchingRule | The Certificate Matching Rule object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleResponse result = apiInstance.createMsgVpnCertMatchingRule(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnCertMatchingRule**](MsgVpnCertMatchingRule.md)| The Certificate Matching Rule object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleResponse**](MsgVpnCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnCertMatchingRuleAttributeFilter - -> MsgVpnCertMatchingRuleAttributeFilterResponse createMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, body, opaquePassword, select) - -Create a Certificate Matching Rule Attribute Filter object. - -Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: filterName|x|x|||| msgVpnName|x||x||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - MsgVpnCertMatchingRuleAttributeFilter body = new MsgVpnCertMatchingRuleAttributeFilter(); // MsgVpnCertMatchingRuleAttributeFilter | The Certificate Matching Rule Attribute Filter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleAttributeFilterResponse result = apiInstance.createMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**MsgVpnCertMatchingRuleAttributeFilter**](MsgVpnCertMatchingRuleAttributeFilter.md)| The Certificate Matching Rule Attribute Filter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleAttributeFilterResponse**](MsgVpnCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnCertMatchingRuleCondition - -> MsgVpnCertMatchingRuleConditionResponse createMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, body, opaquePassword, select) - -Create a Certificate Matching Rule Condition object. - -Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - MsgVpnCertMatchingRuleCondition body = new MsgVpnCertMatchingRuleCondition(); // MsgVpnCertMatchingRuleCondition | The Certificate Matching Rule Condition object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleConditionResponse result = apiInstance.createMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnCertMatchingRuleCondition"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**MsgVpnCertMatchingRuleCondition**](MsgVpnCertMatchingRuleCondition.md)| The Certificate Matching Rule Condition object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleConditionResponse**](MsgVpnCertMatchingRuleConditionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Condition object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnClientProfile - -> MsgVpnClientProfileResponse createMsgVpnClientProfile(msgVpnName, body, opaquePassword, select) - -Create a Client Profile object. - -Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnClientProfile body = new MsgVpnClientProfile(); // MsgVpnClientProfile | The Client Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientProfileResponse result = apiInstance.createMsgVpnClientProfile(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnClientProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnClientProfile**](MsgVpnClientProfile.md)| The Client Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientProfileResponse**](MsgVpnClientProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Profile object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnClientUsername - -> MsgVpnClientUsernameResponse createMsgVpnClientUsername(msgVpnName, body, opaquePassword, select) - -Create a Client Username object. - -Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientUsername|x|x|||| msgVpnName|x||x||| password||||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnClientUsername body = new MsgVpnClientUsername(); // MsgVpnClientUsername | The Client Username object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameResponse result = apiInstance.createMsgVpnClientUsername(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnClientUsername"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnClientUsername**](MsgVpnClientUsername.md)| The Client Username object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameResponse**](MsgVpnClientUsernameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnClientUsernameAttribute - -> MsgVpnClientUsernameAttributeResponse createMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, body, opaquePassword, select) - -Create a Client Username Attribute object. - -Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| clientUsername|x||x||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - MsgVpnClientUsernameAttribute body = new MsgVpnClientUsernameAttribute(); // MsgVpnClientUsernameAttribute | The Client Username Attribute object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameAttributeResponse result = apiInstance.createMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnClientUsernameAttribute"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **body** | [**MsgVpnClientUsernameAttribute**](MsgVpnClientUsernameAttribute.md)| The Client Username Attribute object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameAttributeResponse**](MsgVpnClientUsernameAttributeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username Attribute object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCache - -> MsgVpnDistributedCacheResponse createMsgVpnDistributedCache(msgVpnName, body, opaquePassword, select) - -Create a Distributed Cache object. - -Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnDistributedCache body = new MsgVpnDistributedCache(); // MsgVpnDistributedCache | The Distributed Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheResponse result = apiInstance.createMsgVpnDistributedCache(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnDistributedCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnDistributedCache**](MsgVpnDistributedCache.md)| The Distributed Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheResponse**](MsgVpnDistributedCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Distributed Cache object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCacheCluster - -> MsgVpnDistributedCacheClusterResponse createMsgVpnDistributedCacheCluster(msgVpnName, cacheName, body, opaquePassword, select) - -Create a Cache Cluster object. - -Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - MsgVpnDistributedCacheCluster body = new MsgVpnDistributedCacheCluster(); // MsgVpnDistributedCacheCluster | The Cache Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterResponse result = apiInstance.createMsgVpnDistributedCacheCluster(msgVpnName, cacheName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnDistributedCacheCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **body** | [**MsgVpnDistributedCacheCluster**](MsgVpnDistributedCacheCluster.md)| The Cache Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterResponse**](MsgVpnDistributedCacheClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Cluster object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select) - -Create a Home Cache Cluster object. - -Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - MsgVpnDistributedCacheClusterGlobalCachingHomeCluster body = new MsgVpnDistributedCacheClusterGlobalCachingHomeCluster(); // MsgVpnDistributedCacheClusterGlobalCachingHomeCluster | The Home Cache Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse result = apiInstance.createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.md)| The Home Cache Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Home Cache Cluster object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, body, opaquePassword, select) - -Create a Topic Prefix object. - -Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x||x||| msgVpnName|x||x||| topicPrefix|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix body = new MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(); // MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix | The Topic Prefix object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse result = apiInstance.createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.md)| The Topic Prefix object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Prefix object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCacheClusterInstance - -> MsgVpnDistributedCacheClusterInstanceResponse createMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, body, opaquePassword, select) - -Create a Cache Instance object. - -Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| instanceName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - MsgVpnDistributedCacheClusterInstance body = new MsgVpnDistributedCacheClusterInstance(); // MsgVpnDistributedCacheClusterInstance | The Cache Instance object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterInstanceResponse result = apiInstance.createMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnDistributedCacheClusterInstance"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheClusterInstance**](MsgVpnDistributedCacheClusterInstance.md)| The Cache Instance object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterInstanceResponse**](MsgVpnDistributedCacheClusterInstanceResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Instance object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCacheClusterTopic - -> MsgVpnDistributedCacheClusterTopicResponse createMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, body, opaquePassword, select) - -Create a Topic object. - -Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| msgVpnName|x||x||| topic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - MsgVpnDistributedCacheClusterTopic body = new MsgVpnDistributedCacheClusterTopic(); // MsgVpnDistributedCacheClusterTopic | The Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterTopicResponse result = apiInstance.createMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnDistributedCacheClusterTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheClusterTopic**](MsgVpnDistributedCacheClusterTopic.md)| The Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterTopicResponse**](MsgVpnDistributedCacheClusterTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDmrBridge - -> MsgVpnDmrBridgeResponse createMsgVpnDmrBridge(msgVpnName, body, opaquePassword, select) - -Create a DMR Bridge object. - -Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnDmrBridge body = new MsgVpnDmrBridge(); // MsgVpnDmrBridge | The DMR Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDmrBridgeResponse result = apiInstance.createMsgVpnDmrBridge(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnDmrBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnDmrBridge**](MsgVpnDmrBridge.md)| The DMR Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDmrBridgeResponse**](MsgVpnDmrBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The DMR Bridge object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnJndiConnectionFactory - -> MsgVpnJndiConnectionFactoryResponse createMsgVpnJndiConnectionFactory(msgVpnName, body, opaquePassword, select) - -Create a JNDI Connection Factory object. - -Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: connectionFactoryName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnJndiConnectionFactory body = new MsgVpnJndiConnectionFactory(); // MsgVpnJndiConnectionFactory | The JNDI Connection Factory object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiConnectionFactoryResponse result = apiInstance.createMsgVpnJndiConnectionFactory(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnJndiConnectionFactory"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnJndiConnectionFactory**](MsgVpnJndiConnectionFactory.md)| The JNDI Connection Factory object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiConnectionFactoryResponse**](MsgVpnJndiConnectionFactoryResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Connection Factory object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnJndiQueue - -> MsgVpnJndiQueueResponse createMsgVpnJndiQueue(msgVpnName, body, opaquePassword, select) - -Create a JNDI Queue object. - -Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnJndiQueue body = new MsgVpnJndiQueue(); // MsgVpnJndiQueue | The JNDI Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiQueueResponse result = apiInstance.createMsgVpnJndiQueue(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnJndiQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnJndiQueue**](MsgVpnJndiQueue.md)| The JNDI Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiQueueResponse**](MsgVpnJndiQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Queue object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnJndiTopic - -> MsgVpnJndiTopicResponse createMsgVpnJndiTopic(msgVpnName, body, opaquePassword, select) - -Create a JNDI Topic object. - -Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnJndiTopic body = new MsgVpnJndiTopic(); // MsgVpnJndiTopic | The JNDI Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiTopicResponse result = apiInstance.createMsgVpnJndiTopic(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnJndiTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnJndiTopic**](MsgVpnJndiTopic.md)| The JNDI Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiTopicResponse**](MsgVpnJndiTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Topic object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnMqttRetainCache - -> MsgVpnMqttRetainCacheResponse createMsgVpnMqttRetainCache(msgVpnName, body, opaquePassword, select) - -Create an MQTT Retain Cache object. - -Create an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnMqttRetainCache body = new MsgVpnMqttRetainCache(); // MsgVpnMqttRetainCache | The MQTT Retain Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttRetainCacheResponse result = apiInstance.createMsgVpnMqttRetainCache(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnMqttRetainCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnMqttRetainCache**](MsgVpnMqttRetainCache.md)| The MQTT Retain Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttRetainCacheResponse**](MsgVpnMqttRetainCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Retain Cache object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnMqttSession - -> MsgVpnMqttSessionResponse createMsgVpnMqttSession(msgVpnName, body, opaquePassword, select) - -Create an MQTT Session object. - -Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnMqttSession body = new MsgVpnMqttSession(); // MsgVpnMqttSession | The MQTT Session object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionResponse result = apiInstance.createMsgVpnMqttSession(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnMqttSession"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnMqttSession**](MsgVpnMqttSession.md)| The MQTT Session object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionResponse**](MsgVpnMqttSessionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Session object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnMqttSessionSubscription - -> MsgVpnMqttSessionSubscriptionResponse createMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select) - -Create a Subscription object. - -Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x||x||| mqttSessionVirtualRouter|x||x||| msgVpnName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - MsgVpnMqttSessionSubscription body = new MsgVpnMqttSessionSubscription(); // MsgVpnMqttSessionSubscription | The Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionSubscriptionResponse result = apiInstance.createMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnMqttSessionSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **body** | [**MsgVpnMqttSessionSubscription**](MsgVpnMqttSessionSubscription.md)| The Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionSubscriptionResponse**](MsgVpnMqttSessionSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscription object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnQueue - -> MsgVpnQueueResponse createMsgVpnQueue(msgVpnName, body, opaquePassword, select) - -Create a Queue object. - -Create a Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnQueue body = new MsgVpnQueue(); // MsgVpnQueue | The Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueResponse result = apiInstance.createMsgVpnQueue(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnQueue**](MsgVpnQueue.md)| The Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueResponse**](MsgVpnQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnQueueSubscription - -> MsgVpnQueueSubscriptionResponse createMsgVpnQueueSubscription(msgVpnName, queueName, body, opaquePassword, select) - -Create a Queue Subscription object. - -Create a Queue Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - MsgVpnQueueSubscription body = new MsgVpnQueueSubscription(); // MsgVpnQueueSubscription | The Queue Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueSubscriptionResponse result = apiInstance.createMsgVpnQueueSubscription(msgVpnName, queueName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnQueueSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **body** | [**MsgVpnQueueSubscription**](MsgVpnQueueSubscription.md)| The Queue Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueSubscriptionResponse**](MsgVpnQueueSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Subscription object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnQueueTemplate - -> MsgVpnQueueTemplateResponse createMsgVpnQueueTemplate(msgVpnName, body, opaquePassword, select) - -Create a Queue Template object. - -Create a Queue Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnQueueTemplate body = new MsgVpnQueueTemplate(); // MsgVpnQueueTemplate | The Queue Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueTemplateResponse result = apiInstance.createMsgVpnQueueTemplate(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnQueueTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnQueueTemplate**](MsgVpnQueueTemplate.md)| The Queue Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueTemplateResponse**](MsgVpnQueueTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Template object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnReplayLog - -> MsgVpnReplayLogResponse createMsgVpnReplayLog(msgVpnName, body, opaquePassword, select) - -Create a Replay Log object. - -Create a Replay Log object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnReplayLog body = new MsgVpnReplayLog(); // MsgVpnReplayLog | The Replay Log object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogResponse result = apiInstance.createMsgVpnReplayLog(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnReplayLog"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnReplayLog**](MsgVpnReplayLog.md)| The Replay Log object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogResponse**](MsgVpnReplayLogResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replay Log object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnReplayLogTopicFilterSubscription - -> MsgVpnReplayLogTopicFilterSubscriptionResponse createMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, body, opaquePassword, select) - -Create a Topic Filter Subscription object. - -Create a Topic Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x||x||| topicFilterSubscription|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - MsgVpnReplayLogTopicFilterSubscription body = new MsgVpnReplayLogTopicFilterSubscription(); // MsgVpnReplayLogTopicFilterSubscription | The Topic Filter Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogTopicFilterSubscriptionResponse result = apiInstance.createMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnReplayLogTopicFilterSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **body** | [**MsgVpnReplayLogTopicFilterSubscription**](MsgVpnReplayLogTopicFilterSubscription.md)| The Topic Filter Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogTopicFilterSubscriptionResponse**](MsgVpnReplayLogTopicFilterSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Filter Subscription object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnReplicatedTopic - -> MsgVpnReplicatedTopicResponse createMsgVpnReplicatedTopic(msgVpnName, body, opaquePassword, select) - -Create a Replicated Topic object. - -Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnReplicatedTopic body = new MsgVpnReplicatedTopic(); // MsgVpnReplicatedTopic | The Replicated Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplicatedTopicResponse result = apiInstance.createMsgVpnReplicatedTopic(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnReplicatedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnReplicatedTopic**](MsgVpnReplicatedTopic.md)| The Replicated Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplicatedTopicResponse**](MsgVpnReplicatedTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replicated Topic object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPoint - -> MsgVpnRestDeliveryPointResponse createMsgVpnRestDeliveryPoint(msgVpnName, body, opaquePassword, select) - -Create a REST Delivery Point object. - -Create a REST Delivery Point object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnRestDeliveryPoint body = new MsgVpnRestDeliveryPoint(); // MsgVpnRestDeliveryPoint | The REST Delivery Point object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointResponse result = apiInstance.createMsgVpnRestDeliveryPoint(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnRestDeliveryPoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnRestDeliveryPoint**](MsgVpnRestDeliveryPoint.md)| The REST Delivery Point object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointResponse**](MsgVpnRestDeliveryPointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Delivery Point object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPointQueueBinding - -> MsgVpnRestDeliveryPointQueueBindingResponse createMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, body, opaquePassword, select) - -Create a Queue Binding object. - -Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueBindingName|x|x|||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - MsgVpnRestDeliveryPointQueueBinding body = new MsgVpnRestDeliveryPointQueueBinding(); // MsgVpnRestDeliveryPointQueueBinding | The Queue Binding object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingResponse result = apiInstance.createMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnRestDeliveryPointQueueBinding"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBinding**](MsgVpnRestDeliveryPointQueueBinding.md)| The Queue Binding object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingResponse**](MsgVpnRestDeliveryPointQueueBindingResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Binding object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPointQueueBindingRequestHeader - -> MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse createMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select) - -Create a Request Header object. - -Create a Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: headerName|x|x|||| msgVpnName|x||x||| queueBindingName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = new MsgVpnRestDeliveryPointQueueBindingRequestHeader(); // MsgVpnRestDeliveryPointQueueBindingRequestHeader | The Request Header object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse result = apiInstance.createMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBindingRequestHeader**](MsgVpnRestDeliveryPointQueueBindingRequestHeader.md)| The Request Header object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse**](MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Request Header object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPointRestConsumer - -> MsgVpnRestDeliveryPointRestConsumerResponse createMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, body, opaquePassword, select) - -Create a REST Consumer object. - -Create a REST Consumer object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| authenticationHttpBasicPassword||||x||x authenticationHttpHeaderValue||||x||x authenticationOauthClientSecret||||x||x authenticationOauthJwtSecretKey||||x||x msgVpnName|x||x||| restConsumerName|x|x|||| restDeliveryPointName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - MsgVpnRestDeliveryPointRestConsumer body = new MsgVpnRestDeliveryPointRestConsumer(); // MsgVpnRestDeliveryPointRestConsumer | The REST Consumer object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerResponse result = apiInstance.createMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnRestDeliveryPointRestConsumer"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **body** | [**MsgVpnRestDeliveryPointRestConsumer**](MsgVpnRestDeliveryPointRestConsumer.md)| The REST Consumer object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerResponse**](MsgVpnRestDeliveryPointRestConsumerResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Consumer object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - -> MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select) - -Create a Claim object. - -Create a Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthJwtClaimName|x|x|||| oauthJwtClaimValue||x|||| restConsumerName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim body = new MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(); // MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim | The Claim object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse result = apiInstance.createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **body** | [**MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.md)| The Claim object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse**](MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Claim object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - -> MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select) - -Create a Trusted Common Name object. - -Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||x| restConsumerName|x||x||x| restDeliveryPointName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName body = new MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(); // MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName | The Trusted Common Name object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse result = apiInstance.createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **body** | [**MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.md)| The Trusted Common Name object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse**](MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Trusted Common Name object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnSequencedTopic - -> MsgVpnSequencedTopicResponse createMsgVpnSequencedTopic(msgVpnName, body, opaquePassword, select) - -Create a Sequenced Topic object. - -Create a Sequenced Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| sequencedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnSequencedTopic body = new MsgVpnSequencedTopic(); // MsgVpnSequencedTopic | The Sequenced Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnSequencedTopicResponse result = apiInstance.createMsgVpnSequencedTopic(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnSequencedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnSequencedTopic**](MsgVpnSequencedTopic.md)| The Sequenced Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnSequencedTopicResponse**](MsgVpnSequencedTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Sequenced Topic object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnTopicEndpoint - -> MsgVpnTopicEndpointResponse createMsgVpnTopicEndpoint(msgVpnName, body, opaquePassword, select) - -Create a Topic Endpoint object. - -Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnTopicEndpoint body = new MsgVpnTopicEndpoint(); // MsgVpnTopicEndpoint | The Topic Endpoint object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointResponse result = apiInstance.createMsgVpnTopicEndpoint(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnTopicEndpoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnTopicEndpoint**](MsgVpnTopicEndpoint.md)| The Topic Endpoint object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointResponse**](MsgVpnTopicEndpointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnTopicEndpointTemplate - -> MsgVpnTopicEndpointTemplateResponse createMsgVpnTopicEndpointTemplate(msgVpnName, body, opaquePassword, select) - -Create a Topic Endpoint Template object. - -Create a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnTopicEndpointTemplate body = new MsgVpnTopicEndpointTemplate(); // MsgVpnTopicEndpointTemplate | The Topic Endpoint Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointTemplateResponse result = apiInstance.createMsgVpnTopicEndpointTemplate(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createMsgVpnTopicEndpointTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnTopicEndpointTemplate**](MsgVpnTopicEndpointTemplate.md)| The Topic Endpoint Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointTemplateResponse**](MsgVpnTopicEndpointTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint Template object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createOauthProfile - -> OauthProfileResponse createOauthProfile(body, opaquePassword, select) - -Create an OAuth Profile object. - -Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - OauthProfile body = new OauthProfile(); // OauthProfile | The OAuth Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileResponse result = apiInstance.createOauthProfile(body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **body** | [**OauthProfile**](OauthProfile.md)| The OAuth Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileResponse**](OauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createOauthProfileAccessLevelGroup - -> OauthProfileAccessLevelGroupResponse createOauthProfileAccessLevelGroup(oauthProfileName, body, opaquePassword, select) - -Create a Group Access Level object. - -Create a Group Access Level object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: groupName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - OauthProfileAccessLevelGroup body = new OauthProfileAccessLevelGroup(); // OauthProfileAccessLevelGroup | The Group Access Level object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupResponse result = apiInstance.createOauthProfileAccessLevelGroup(oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createOauthProfileAccessLevelGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**OauthProfileAccessLevelGroup**](OauthProfileAccessLevelGroup.md)| The Group Access Level object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupResponse**](OauthProfileAccessLevelGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Group Access Level object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createOauthProfileAccessLevelGroupMsgVpnAccessLevelException - -> OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse createOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, body, opaquePassword, select) - -Create a Message VPN Access-Level Exception object. - -Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: groupName|x||x||| msgVpnName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - OauthProfileAccessLevelGroupMsgVpnAccessLevelException body = new OauthProfileAccessLevelGroupMsgVpnAccessLevelException(); // OauthProfileAccessLevelGroupMsgVpnAccessLevelException | The Message VPN Access-Level Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse result = apiInstance.createOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **body** | [**OauthProfileAccessLevelGroupMsgVpnAccessLevelException**](OauthProfileAccessLevelGroupMsgVpnAccessLevelException.md)| The Message VPN Access-Level Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse**](OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN Access-Level Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createOauthProfileClientAllowedHost - -> OauthProfileClientAllowedHostResponse createOauthProfileClientAllowedHost(oauthProfileName, body, opaquePassword, select) - -Create an Allowed Host Value object. - -Create an Allowed Host Value object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowedHost|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - OauthProfileClientAllowedHost body = new OauthProfileClientAllowedHost(); // OauthProfileClientAllowedHost | The Allowed Host Value object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientAllowedHostResponse result = apiInstance.createOauthProfileClientAllowedHost(oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createOauthProfileClientAllowedHost"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**OauthProfileClientAllowedHost**](OauthProfileClientAllowedHost.md)| The Allowed Host Value object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientAllowedHostResponse**](OauthProfileClientAllowedHostResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Allowed Host Value object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createOauthProfileClientAuthorizationParameter - -> OauthProfileClientAuthorizationParameterResponse createOauthProfileClientAuthorizationParameter(oauthProfileName, body, opaquePassword, select) - -Create an Authorization Parameter object. - -Create an Authorization Parameter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationParameterName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - OauthProfileClientAuthorizationParameter body = new OauthProfileClientAuthorizationParameter(); // OauthProfileClientAuthorizationParameter | The Authorization Parameter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientAuthorizationParameterResponse result = apiInstance.createOauthProfileClientAuthorizationParameter(oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createOauthProfileClientAuthorizationParameter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**OauthProfileClientAuthorizationParameter**](OauthProfileClientAuthorizationParameter.md)| The Authorization Parameter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientAuthorizationParameterResponse**](OauthProfileClientAuthorizationParameterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Parameter object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createOauthProfileClientRequiredClaim - -> OauthProfileClientRequiredClaimResponse createOauthProfileClientRequiredClaim(oauthProfileName, body, opaquePassword, select) - -Create a Required Claim object. - -Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - OauthProfileClientRequiredClaim body = new OauthProfileClientRequiredClaim(); // OauthProfileClientRequiredClaim | The Required Claim object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientRequiredClaimResponse result = apiInstance.createOauthProfileClientRequiredClaim(oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createOauthProfileClientRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**OauthProfileClientRequiredClaim**](OauthProfileClientRequiredClaim.md)| The Required Claim object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientRequiredClaimResponse**](OauthProfileClientRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createOauthProfileDefaultMsgVpnAccessLevelException - -> OauthProfileDefaultMsgVpnAccessLevelExceptionResponse createOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, body, opaquePassword, select) - -Create a Message VPN Access-Level Exception object. - -Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Default message VPN access-level exceptions. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - OauthProfileDefaultMsgVpnAccessLevelException body = new OauthProfileDefaultMsgVpnAccessLevelException(); // OauthProfileDefaultMsgVpnAccessLevelException | The Message VPN Access-Level Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse result = apiInstance.createOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createOauthProfileDefaultMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**OauthProfileDefaultMsgVpnAccessLevelException**](OauthProfileDefaultMsgVpnAccessLevelException.md)| The Message VPN Access-Level Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileDefaultMsgVpnAccessLevelExceptionResponse**](OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN Access-Level Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createOauthProfileResourceServerRequiredClaim - -> OauthProfileResourceServerRequiredClaimResponse createOauthProfileResourceServerRequiredClaim(oauthProfileName, body, opaquePassword, select) - -Create a Required Claim object. - -Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - OauthProfileResourceServerRequiredClaim body = new OauthProfileResourceServerRequiredClaim(); // OauthProfileResourceServerRequiredClaim | The Required Claim object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileResourceServerRequiredClaimResponse result = apiInstance.createOauthProfileResourceServerRequiredClaim(oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createOauthProfileResourceServerRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**OauthProfileResourceServerRequiredClaim**](OauthProfileResourceServerRequiredClaim.md)| The Required Claim object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileResourceServerRequiredClaimResponse**](OauthProfileResourceServerRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createVirtualHostname - -> VirtualHostnameResponse createVirtualHostname(body, opaquePassword, select) - -Create a Virtual Hostname object. - -Create a Virtual Hostname object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: virtualHostname|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - VirtualHostname body = new VirtualHostname(); // VirtualHostname | The Virtual Hostname object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - VirtualHostnameResponse result = apiInstance.createVirtualHostname(body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#createVirtualHostname"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **body** | [**VirtualHostname**](VirtualHostname.md)| The Virtual Hostname object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**VirtualHostnameResponse**](VirtualHostnameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Virtual Hostname object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteCertAuthority - -> SempMetaOnlyResponse deleteCertAuthority(certAuthorityName) - -Delete a Certificate Authority object. - -Delete a Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - try { - SempMetaOnlyResponse result = apiInstance.deleteCertAuthority(certAuthorityName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteCertAuthorityOcspTlsTrustedCommonName - -> SempMetaOnlyResponse deleteCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName) - -Delete an OCSP Responder Trusted Common Name object. - -Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String ocspTlsTrustedCommonName = "ocspTlsTrustedCommonName_example"; // String | The expected Trusted Common Name of the OCSP responder remote certificate. - try { - SempMetaOnlyResponse result = apiInstance.deleteCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteCertAuthorityOcspTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **ocspTlsTrustedCommonName** | **String**| The expected Trusted Common Name of the OCSP responder remote certificate. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteClientCertAuthority - -> SempMetaOnlyResponse deleteClientCertAuthority(certAuthorityName) - -Delete a Client Certificate Authority object. - -Delete a Client Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - try { - SempMetaOnlyResponse result = apiInstance.deleteClientCertAuthority(certAuthorityName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteClientCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteClientCertAuthorityOcspTlsTrustedCommonName - -> SempMetaOnlyResponse deleteClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName) - -Delete an OCSP Responder Trusted Common Name object. - -Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String ocspTlsTrustedCommonName = "ocspTlsTrustedCommonName_example"; // String | The expected Trusted Common Name of the OCSP responder remote certificate. - try { - SempMetaOnlyResponse result = apiInstance.deleteClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteClientCertAuthorityOcspTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **ocspTlsTrustedCommonName** | **String**| The expected Trusted Common Name of the OCSP responder remote certificate. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteDmrCluster - -> SempMetaOnlyResponse deleteDmrCluster(dmrClusterName) - -Delete a Cluster object. - -Delete a Cluster object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - try { - SempMetaOnlyResponse result = apiInstance.deleteDmrCluster(dmrClusterName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteDmrCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteDmrClusterCertMatchingRule - -> SempMetaOnlyResponse deleteDmrClusterCertMatchingRule(dmrClusterName, ruleName) - -Delete a Certificate Matching Rule object. - -Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - try { - SempMetaOnlyResponse result = apiInstance.deleteDmrClusterCertMatchingRule(dmrClusterName, ruleName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteDmrClusterCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteDmrClusterCertMatchingRuleAttributeFilter - -> SempMetaOnlyResponse deleteDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName) - -Delete a Certificate Matching Rule Attribute Filter object. - -Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Attribute Filter compares a link attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - try { - SempMetaOnlyResponse result = apiInstance.deleteDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteDmrClusterCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteDmrClusterCertMatchingRuleCondition - -> SempMetaOnlyResponse deleteDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, source) - -Delete a Certificate Matching Rule Condition object. - -Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - String source = "source_example"; // String | Certificate field to be compared with the Attribute. - try { - SempMetaOnlyResponse result = apiInstance.deleteDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, source); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteDmrClusterCertMatchingRuleCondition"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **source** | **String**| Certificate field to be compared with the Attribute. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteDmrClusterLink - -> SempMetaOnlyResponse deleteDmrClusterLink(dmrClusterName, remoteNodeName) - -Delete a Link object. - -Delete a Link object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - try { - SempMetaOnlyResponse result = apiInstance.deleteDmrClusterLink(dmrClusterName, remoteNodeName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteDmrClusterLink"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteDmrClusterLinkAttribute - -> SempMetaOnlyResponse deleteDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, attributeName, attributeValue) - -Delete a Link Attribute object. - -Delete a Link Attribute object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String attributeName = "attributeName_example"; // String | The name of the Attribute. - String attributeValue = "attributeValue_example"; // String | The value of the Attribute. - try { - SempMetaOnlyResponse result = apiInstance.deleteDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, attributeName, attributeValue); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteDmrClusterLinkAttribute"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **attributeName** | **String**| The name of the Attribute. | | -| **attributeValue** | **String**| The value of the Attribute. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteDmrClusterLinkRemoteAddress - -> SempMetaOnlyResponse deleteDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, remoteAddress) - -Delete a Remote Address object. - -Delete a Remote Address object. The deletion of instances of this object are synchronized to HA mates via config-sync. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String remoteAddress = "remoteAddress_example"; // String | The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). - try { - SempMetaOnlyResponse result = apiInstance.deleteDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, remoteAddress); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteDmrClusterLinkRemoteAddress"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **remoteAddress** | **String**| The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteDmrClusterLinkTlsTrustedCommonName - -> SempMetaOnlyResponse deleteDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, tlsTrustedCommonName) - -Delete a Trusted Common Name object. - -Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String tlsTrustedCommonName = "tlsTrustedCommonName_example"; // String | The expected trusted common name of the remote certificate. - try { - SempMetaOnlyResponse result = apiInstance.deleteDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, tlsTrustedCommonName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteDmrClusterLinkTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **tlsTrustedCommonName** | **String**| The expected trusted common name of the remote certificate. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteDomainCertAuthority - -> SempMetaOnlyResponse deleteDomainCertAuthority(certAuthorityName) - -Delete a Domain Certificate Authority object. - -Delete a Domain Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Certificate Authorities trusted for domain verification. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - try { - SempMetaOnlyResponse result = apiInstance.deleteDomainCertAuthority(certAuthorityName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteDomainCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpn - -> SempMetaOnlyResponse deleteMsgVpn(msgVpnName) - -Delete a Message VPN object. - -Delete a Message VPN object. The deletion of instances of this object are synchronized to HA mates via config-sync. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpn(msgVpnName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfile - -> SempMetaOnlyResponse deleteMsgVpnAclProfile(msgVpnName, aclProfileName) - -Delete an ACL Profile object. - -Delete an ACL Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfile(msgVpnName, aclProfileName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnAclProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfileClientConnectException - -> SempMetaOnlyResponse deleteMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress) - -Delete a Client Connect Exception object. - -Delete a Client Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String clientConnectExceptionAddress = "clientConnectExceptionAddress_example"; // String | The IP address/netmask of the client connect exception in CIDR form. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnAclProfileClientConnectException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **clientConnectExceptionAddress** | **String**| The IP address/netmask of the client connect exception in CIDR form. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfilePublishException - -> SempMetaOnlyResponse deleteMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic) - -Delete a Publish Topic Exception object. - -Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String topicSyntax = "topicSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String publishExceptionTopic = "publishExceptionTopic_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnAclProfilePublishException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **topicSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **publishExceptionTopic** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfilePublishTopicException - -> SempMetaOnlyResponse deleteMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException) - -Delete a Publish Topic Exception object. - -Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String publishTopicExceptionSyntax = "publishTopicExceptionSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String publishTopicException = "publishTopicException_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnAclProfilePublishTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **publishTopicExceptionSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **publishTopicException** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfileSubscribeException - -> SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic) - -Delete a Subscribe Topic Exception object. - -Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String topicSyntax = "topicSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String subscribeExceptionTopic = "subscribeExceptionTopic_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnAclProfileSubscribeException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **topicSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **subscribeExceptionTopic** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfileSubscribeShareNameException - -> SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException) - -Delete a Subscribe Share Name Exception object. - -Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String subscribeShareNameExceptionSyntax = "subscribeShareNameExceptionSyntax_example"; // String | The syntax of the subscribe share name for the exception to the default action taken. - String subscribeShareNameException = "subscribeShareNameException_example"; // String | The subscribe share name exception to the default action taken. May include wildcard characters. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnAclProfileSubscribeShareNameException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **subscribeShareNameExceptionSyntax** | **String**| The syntax of the subscribe share name for the exception to the default action taken. | | -| **subscribeShareNameException** | **String**| The subscribe share name exception to the default action taken. May include wildcard characters. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfileSubscribeTopicException - -> SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException) - -Delete a Subscribe Topic Exception object. - -Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String subscribeTopicExceptionSyntax = "subscribeTopicExceptionSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String subscribeTopicException = "subscribeTopicException_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnAclProfileSubscribeTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **subscribeTopicExceptionSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **subscribeTopicException** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAuthenticationOauthProfile - -> SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName) - -Delete an OAuth Profile object. - -Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnAuthenticationOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim - -> SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName) - -Delete a Required Claim object. - -Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String clientRequiredClaimName = "clientRequiredClaimName_example"; // String | The name of the ID token claim to verify. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **clientRequiredClaimName** | **String**| The name of the ID token claim to verify. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - -> SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName) - -Delete a Required Claim object. - -Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String resourceServerRequiredClaimName = "resourceServerRequiredClaimName_example"; // String | The name of the access token claim to verify. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **resourceServerRequiredClaimName** | **String**| The name of the access token claim to verify. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAuthenticationOauthProvider - -> SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName) - -Delete an OAuth Provider object. - -Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProviderName = "oauthProviderName_example"; // String | The name of the OAuth Provider. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnAuthenticationOauthProvider"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProviderName** | **String**| The name of the OAuth Provider. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAuthorizationGroup - -> SempMetaOnlyResponse deleteMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName) - -Delete an Authorization Group object. - -Delete an Authorization Group object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String authorizationGroupName = "authorizationGroupName_example"; // String | The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnAuthorizationGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **authorizationGroupName** | **String**| The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnBridge - -> SempMetaOnlyResponse deleteMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter) - -Delete a Bridge object. - -Delete a Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnBridgeRemoteMsgVpn - -> SempMetaOnlyResponse deleteMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface) - -Delete a Remote Message VPN object. - -Delete a Remote Message VPN object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteMsgVpnName = "remoteMsgVpnName_example"; // String | The name of the remote Message VPN. - String remoteMsgVpnLocation = "remoteMsgVpnLocation_example"; // String | The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). - String remoteMsgVpnInterface = "remoteMsgVpnInterface_example"; // String | The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnBridgeRemoteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteMsgVpnName** | **String**| The name of the remote Message VPN. | | -| **remoteMsgVpnLocation** | **String**| The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). | | -| **remoteMsgVpnInterface** | **String**| The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnBridgeRemoteSubscription - -> SempMetaOnlyResponse deleteMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic) - -Delete a Remote Subscription object. - -Delete a Remote Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteSubscriptionTopic = "remoteSubscriptionTopic_example"; // String | The topic of the Bridge remote subscription. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnBridgeRemoteSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteSubscriptionTopic** | **String**| The topic of the Bridge remote subscription. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnBridgeTlsTrustedCommonName - -> SempMetaOnlyResponse deleteMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName) - -Delete a Trusted Common Name object. - -Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String tlsTrustedCommonName = "tlsTrustedCommonName_example"; // String | The expected trusted common name of the remote certificate. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnBridgeTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **tlsTrustedCommonName** | **String**| The expected trusted common name of the remote certificate. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnCertMatchingRule - -> SempMetaOnlyResponse deleteMsgVpnCertMatchingRule(msgVpnName, ruleName) - -Delete a Certificate Matching Rule object. - -Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnCertMatchingRule(msgVpnName, ruleName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnCertMatchingRuleAttributeFilter - -> SempMetaOnlyResponse deleteMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName) - -Delete a Certificate Matching Rule Attribute Filter object. - -Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnCertMatchingRuleCondition - -> SempMetaOnlyResponse deleteMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source) - -Delete a Certificate Matching Rule Condition object. - -Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String source = "source_example"; // String | Certificate field to be compared with the Attribute. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnCertMatchingRuleCondition"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **source** | **String**| Certificate field to be compared with the Attribute. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnClientProfile - -> SempMetaOnlyResponse deleteMsgVpnClientProfile(msgVpnName, clientProfileName) - -Delete a Client Profile object. - -Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientProfileName = "clientProfileName_example"; // String | The name of the Client Profile. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnClientProfile(msgVpnName, clientProfileName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnClientProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientProfileName** | **String**| The name of the Client Profile. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnClientUsername - -> SempMetaOnlyResponse deleteMsgVpnClientUsername(msgVpnName, clientUsername) - -Delete a Client Username object. - -Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnClientUsername(msgVpnName, clientUsername); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnClientUsername"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnClientUsernameAttribute - -> SempMetaOnlyResponse deleteMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue) - -Delete a Client Username Attribute object. - -Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - String attributeName = "attributeName_example"; // String | The name of the Attribute. - String attributeValue = "attributeValue_example"; // String | The value of the Attribute. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnClientUsernameAttribute"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **attributeName** | **String**| The name of the Attribute. | | -| **attributeValue** | **String**| The value of the Attribute. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCache - -> SempMetaOnlyResponse deleteMsgVpnDistributedCache(msgVpnName, cacheName) - -Delete a Distributed Cache object. - -Delete a Distributed Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCache(msgVpnName, cacheName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnDistributedCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCacheCluster - -> SempMetaOnlyResponse deleteMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName) - -Delete a Cache Cluster object. - -Delete a Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnDistributedCacheCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster - -> SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName) - -Delete a Home Cache Cluster object. - -Delete a Home Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - -> SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix) - -Delete a Topic Prefix object. - -Delete a Topic Prefix object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - String topicPrefix = "topicPrefix_example"; // String | A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | -| **topicPrefix** | **String**| A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCacheClusterInstance - -> SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName) - -Delete a Cache Instance object. - -Delete a Cache Instance object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String instanceName = "instanceName_example"; // String | The name of the Cache Instance. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnDistributedCacheClusterInstance"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **instanceName** | **String**| The name of the Cache Instance. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCacheClusterTopic - -> SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic) - -Delete a Topic object. - -Delete a Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String topic = "topic_example"; // String | The value of the Topic in the form a/b/c. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnDistributedCacheClusterTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **topic** | **String**| The value of the Topic in the form a/b/c. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDmrBridge - -> SempMetaOnlyResponse deleteMsgVpnDmrBridge(msgVpnName, remoteNodeName) - -Delete a DMR Bridge object. - -Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the DMR Bridge. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDmrBridge(msgVpnName, remoteNodeName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnDmrBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the DMR Bridge. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnJndiConnectionFactory - -> SempMetaOnlyResponse deleteMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName) - -Delete a JNDI Connection Factory object. - -Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String connectionFactoryName = "connectionFactoryName_example"; // String | The name of the JMS Connection Factory. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnJndiConnectionFactory"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **connectionFactoryName** | **String**| The name of the JMS Connection Factory. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnJndiQueue - -> SempMetaOnlyResponse deleteMsgVpnJndiQueue(msgVpnName, queueName) - -Delete a JNDI Queue object. - -Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The JNDI name of the JMS Queue. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnJndiQueue(msgVpnName, queueName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnJndiQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The JNDI name of the JMS Queue. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnJndiTopic - -> SempMetaOnlyResponse deleteMsgVpnJndiTopic(msgVpnName, topicName) - -Delete a JNDI Topic object. - -Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicName = "topicName_example"; // String | The JNDI name of the JMS Topic. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnJndiTopic(msgVpnName, topicName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnJndiTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicName** | **String**| The JNDI name of the JMS Topic. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnMqttRetainCache - -> SempMetaOnlyResponse deleteMsgVpnMqttRetainCache(msgVpnName, cacheName) - -Delete an MQTT Retain Cache object. - -Delete an MQTT Retain Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the MQTT Retain Cache. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnMqttRetainCache(msgVpnName, cacheName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnMqttRetainCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the MQTT Retain Cache. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnMqttSession - -> SempMetaOnlyResponse deleteMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter) - -Delete an MQTT Session object. - -Delete an MQTT Session object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnMqttSession"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnMqttSessionSubscription - -> SempMetaOnlyResponse deleteMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic) - -Delete a Subscription object. - -Delete a Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - String subscriptionTopic = "subscriptionTopic_example"; // String | The MQTT subscription topic. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnMqttSessionSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **subscriptionTopic** | **String**| The MQTT subscription topic. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnQueue - -> SempMetaOnlyResponse deleteMsgVpnQueue(msgVpnName, queueName) - -Delete a Queue object. - -Delete a Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnQueue(msgVpnName, queueName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnQueueSubscription - -> SempMetaOnlyResponse deleteMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic) - -Delete a Queue Subscription object. - -Delete a Queue Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - String subscriptionTopic = "subscriptionTopic_example"; // String | The topic of the Subscription. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnQueueSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **subscriptionTopic** | **String**| The topic of the Subscription. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnQueueTemplate - -> SempMetaOnlyResponse deleteMsgVpnQueueTemplate(msgVpnName, queueTemplateName) - -Delete a Queue Template object. - -Delete a Queue Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueTemplateName = "queueTemplateName_example"; // String | The name of the Queue Template. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnQueueTemplate(msgVpnName, queueTemplateName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnQueueTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueTemplateName** | **String**| The name of the Queue Template. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnReplayLog - -> SempMetaOnlyResponse deleteMsgVpnReplayLog(msgVpnName, replayLogName) - -Delete a Replay Log object. - -Delete a Replay Log object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnReplayLog(msgVpnName, replayLogName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnReplayLog"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnReplayLogTopicFilterSubscription - -> SempMetaOnlyResponse deleteMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription) - -Delete a Topic Filter Subscription object. - -Delete a Topic Filter Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - String topicFilterSubscription = "topicFilterSubscription_example"; // String | The topic of the Subscription. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnReplayLogTopicFilterSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **topicFilterSubscription** | **String**| The topic of the Subscription. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnReplicatedTopic - -> SempMetaOnlyResponse deleteMsgVpnReplicatedTopic(msgVpnName, replicatedTopic) - -Delete a Replicated Topic object. - -Delete a Replicated Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replicatedTopic = "replicatedTopic_example"; // String | The topic for applying replication. Published messages matching this topic will be replicated to the standby site. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnReplicatedTopic(msgVpnName, replicatedTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnReplicatedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replicatedTopic** | **String**| The topic for applying replication. Published messages matching this topic will be replicated to the standby site. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPoint - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName) - -Delete a REST Delivery Point object. - -Delete a REST Delivery Point object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnRestDeliveryPoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPointQueueBinding - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName) - -Delete a Queue Binding object. - -Delete a Queue Binding object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnRestDeliveryPointQueueBinding"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName) - -Delete a Request Header object. - -Delete a Request Header object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - String headerName = "headerName_example"; // String | The name of the HTTP request header. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **headerName** | **String**| The name of the HTTP request header. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPointRestConsumer - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName) - -Delete a REST Consumer object. - -Delete a REST Consumer object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnRestDeliveryPointRestConsumer"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName) - -Delete a Claim object. - -Delete a Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String oauthJwtClaimName = "oauthJwtClaimName_example"; // String | The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **oauthJwtClaimName** | **String**| The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName) - -Delete a Trusted Common Name object. - -Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String tlsTrustedCommonName = "tlsTrustedCommonName_example"; // String | The expected trusted common name of the remote certificate. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **tlsTrustedCommonName** | **String**| The expected trusted common name of the remote certificate. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnSequencedTopic - -> SempMetaOnlyResponse deleteMsgVpnSequencedTopic(msgVpnName, sequencedTopic) - -Delete a Sequenced Topic object. - -Delete a Sequenced Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String sequencedTopic = "sequencedTopic_example"; // String | Topic for applying sequence numbers. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnSequencedTopic(msgVpnName, sequencedTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnSequencedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **sequencedTopic** | **String**| Topic for applying sequence numbers. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnTopicEndpoint - -> SempMetaOnlyResponse deleteMsgVpnTopicEndpoint(msgVpnName, topicEndpointName) - -Delete a Topic Endpoint object. - -Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointName = "topicEndpointName_example"; // String | The name of the Topic Endpoint. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnTopicEndpoint(msgVpnName, topicEndpointName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnTopicEndpoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointName** | **String**| The name of the Topic Endpoint. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnTopicEndpointTemplate - -> SempMetaOnlyResponse deleteMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName) - -Delete a Topic Endpoint Template object. - -Delete a Topic Endpoint Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointTemplateName = "topicEndpointTemplateName_example"; // String | The name of the Topic Endpoint Template. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteMsgVpnTopicEndpointTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointTemplateName** | **String**| The name of the Topic Endpoint Template. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteOauthProfile - -> SempMetaOnlyResponse deleteOauthProfile(oauthProfileName) - -Delete an OAuth Profile object. - -Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - try { - SempMetaOnlyResponse result = apiInstance.deleteOauthProfile(oauthProfileName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteOauthProfileAccessLevelGroup - -> SempMetaOnlyResponse deleteOauthProfileAccessLevelGroup(oauthProfileName, groupName) - -Delete a Group Access Level object. - -Delete a Group Access Level object. The deletion of instances of this object are synchronized to HA mates via config-sync. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - try { - SempMetaOnlyResponse result = apiInstance.deleteOauthProfileAccessLevelGroup(oauthProfileName, groupName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteOauthProfileAccessLevelGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException - -> SempMetaOnlyResponse deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName) - -Delete a Message VPN Access-Level Exception object. - -Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. Message VPN access-level exceptions for members of this group. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - String msgVpnName = "msgVpnName_example"; // String | The name of the message VPN. - try { - SempMetaOnlyResponse result = apiInstance.deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **msgVpnName** | **String**| The name of the message VPN. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteOauthProfileClientAllowedHost - -> SempMetaOnlyResponse deleteOauthProfileClientAllowedHost(oauthProfileName, allowedHost) - -Delete an Allowed Host Value object. - -Delete an Allowed Host Value object. The deletion of instances of this object are synchronized to HA mates via config-sync. A valid hostname for this broker in OAuth redirects. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String allowedHost = "allowedHost_example"; // String | An allowed value for the Host header. - try { - SempMetaOnlyResponse result = apiInstance.deleteOauthProfileClientAllowedHost(oauthProfileName, allowedHost); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteOauthProfileClientAllowedHost"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **allowedHost** | **String**| An allowed value for the Host header. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteOauthProfileClientAuthorizationParameter - -> SempMetaOnlyResponse deleteOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName) - -Delete an Authorization Parameter object. - -Delete an Authorization Parameter object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional parameters to be passed to the OAuth authorization endpoint. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String authorizationParameterName = "authorizationParameterName_example"; // String | The name of the authorization parameter. - try { - SempMetaOnlyResponse result = apiInstance.deleteOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteOauthProfileClientAuthorizationParameter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **authorizationParameterName** | **String**| The name of the authorization parameter. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteOauthProfileClientRequiredClaim - -> SempMetaOnlyResponse deleteOauthProfileClientRequiredClaim(oauthProfileName, clientRequiredClaimName) - -Delete a Required Claim object. - -Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String clientRequiredClaimName = "clientRequiredClaimName_example"; // String | The name of the ID token claim to verify. - try { - SempMetaOnlyResponse result = apiInstance.deleteOauthProfileClientRequiredClaim(oauthProfileName, clientRequiredClaimName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteOauthProfileClientRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **clientRequiredClaimName** | **String**| The name of the ID token claim to verify. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteOauthProfileDefaultMsgVpnAccessLevelException - -> SempMetaOnlyResponse deleteOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName) - -Delete a Message VPN Access-Level Exception object. - -Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. Default message VPN access-level exceptions. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String msgVpnName = "msgVpnName_example"; // String | The name of the message VPN. - try { - SempMetaOnlyResponse result = apiInstance.deleteOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteOauthProfileDefaultMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **msgVpnName** | **String**| The name of the message VPN. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteOauthProfileResourceServerRequiredClaim - -> SempMetaOnlyResponse deleteOauthProfileResourceServerRequiredClaim(oauthProfileName, resourceServerRequiredClaimName) - -Delete a Required Claim object. - -Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String resourceServerRequiredClaimName = "resourceServerRequiredClaimName_example"; // String | The name of the access token claim to verify. - try { - SempMetaOnlyResponse result = apiInstance.deleteOauthProfileResourceServerRequiredClaim(oauthProfileName, resourceServerRequiredClaimName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteOauthProfileResourceServerRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **resourceServerRequiredClaimName** | **String**| The name of the access token claim to verify. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteVirtualHostname - -> SempMetaOnlyResponse deleteVirtualHostname(virtualHostname) - -Delete a Virtual Hostname object. - -Delete a Virtual Hostname object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String virtualHostname = "virtualHostname_example"; // String | The virtual hostname. - try { - SempMetaOnlyResponse result = apiInstance.deleteVirtualHostname(virtualHostname); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#deleteVirtualHostname"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **virtualHostname** | **String**| The virtual hostname. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getAbout - -> AboutResponse getAbout(opaquePassword, select) - -Get an About object. - -Get an About object. This provides metadata about the SEMP API, such as the version of the API supported by the broker. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.13. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - AboutResponse result = apiInstance.getAbout(opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getAbout"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**AboutResponse**](AboutResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The About object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getAboutApi - -> AboutApiResponse getAboutApi(opaquePassword, select) - -Get an API Description object. - -Get an API Description object. The API Description object provides metadata about the SEMP API. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - AboutApiResponse result = apiInstance.getAboutApi(opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getAboutApi"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**AboutApiResponse**](AboutApiResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The API Description object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getAboutUser - -> AboutUserResponse getAboutUser(opaquePassword, select) - -Get a User object. - -Get a User object. Session and access level information about the user accessing the SEMP API. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - AboutUserResponse result = apiInstance.getAboutUser(opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getAboutUser"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**AboutUserResponse**](AboutUserResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The User object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getAboutUserMsgVpn - -> AboutUserMsgVpnResponse getAboutUserMsgVpn(msgVpnName, opaquePassword, select) - -Get a User Message VPN object. - -Get a User Message VPN object. This provides information about the Message VPN access level for the username used to access the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - AboutUserMsgVpnResponse result = apiInstance.getAboutUserMsgVpn(msgVpnName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getAboutUserMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**AboutUserMsgVpnResponse**](AboutUserMsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The User Message VPN object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getAboutUserMsgVpns - -> AboutUserMsgVpnsResponse getAboutUserMsgVpns(count, cursor, opaquePassword, where, select) - -Get a list of User Message VPN objects. - -Get a list of User Message VPN objects. This provides information about the Message VPN access level for the username used to access the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - AboutUserMsgVpnsResponse result = apiInstance.getAboutUserMsgVpns(count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getAboutUserMsgVpns"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**AboutUserMsgVpnsResponse**](AboutUserMsgVpnsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of User Message VPN objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getBroker - -> BrokerResponse getBroker(opaquePassword, select) - -Get a Broker object. - -Get a Broker object. This object contains global configuration for the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: tlsServerCertContent||x||x tlsServerCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: configSyncAuthenticationClientCertMaxChainDepth|global/read-only configSyncAuthenticationClientCertValidateDateEnabled|global/read-only configSyncClientProfileTcpInitialCongestionWindow|global/read-only configSyncClientProfileTcpKeepaliveCount|global/read-only configSyncClientProfileTcpKeepaliveIdle|global/read-only configSyncClientProfileTcpKeepaliveInterval|global/read-only configSyncClientProfileTcpMaxWindow|global/read-only configSyncClientProfileTcpMss|global/read-only configSyncEnabled|global/read-only configSyncSynchronizeUsernameEnabled|global/read-only configSyncTlsEnabled|global/read-only guaranteedMsgingDefragmentationScheduleDayList|global/read-only guaranteedMsgingDefragmentationScheduleEnabled|global/read-only guaranteedMsgingDefragmentationScheduleTimeList|global/read-only guaranteedMsgingDefragmentationThresholdEnabled|global/read-only guaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-only guaranteedMsgingDefragmentationThresholdMinInterval|global/read-only guaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-only guaranteedMsgingEnabled|global/read-only guaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-only guaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-only guaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-only guaranteedMsgingEventCacheUsageThreshold.setValue|global/read-only guaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-only guaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-only guaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-only guaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-only guaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-only guaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-only guaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-only guaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-only guaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-only guaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-only guaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-only guaranteedMsgingEventEndpointCountThreshold.setValue|global/read-only guaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-only guaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-only guaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-only guaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-only guaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-only guaranteedMsgingEventMsgCountThreshold.setPercent|global/read-only guaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-only guaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-only guaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-only guaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-only guaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-only guaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-only guaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-only guaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-only guaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-only guaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-only guaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-only guaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-only guaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-only guaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-only guaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-only guaranteedMsgingEventTransactionCountThreshold.setValue|global/read-only guaranteedMsgingMaxCacheUsage|global/read-only guaranteedMsgingMaxMsgSpoolUsage|global/read-only guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-only guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-only guaranteedMsgingTransactionReplicationCompatibilityMode|global/read-only oauthProfileDefault|global/read-only serviceAmqpEnabled|global/read-only serviceAmqpTlsListenPort|global/read-only serviceEventConnectionCountThreshold.clearPercent|global/read-only serviceEventConnectionCountThreshold.clearValue|global/read-only serviceEventConnectionCountThreshold.setPercent|global/read-only serviceEventConnectionCountThreshold.setValue|global/read-only serviceHealthCheckEnabled|global/read-only serviceHealthCheckListenPort|global/read-only serviceMateLinkEnabled|global/read-only serviceMateLinkListenPort|global/read-only serviceMqttEnabled|global/read-only serviceMsgBackboneEnabled|global/read-only serviceRedundancyEnabled|global/read-only serviceRedundancyFirstListenPort|global/read-only serviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-only serviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-only serviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-only serviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-only serviceRestIncomingEnabled|global/read-only serviceRestOutgoingEnabled|global/read-only serviceSempCorsAllowAnyHostEnabled|global/read-only serviceSempLegacyTimeoutEnabled|global/read-only serviceSempPlainTextEnabled|global/read-only serviceSempPlainTextListenPort|global/read-only serviceSempSessionIdleTimeout|global/read-only serviceSempSessionMaxLifetime|global/read-only serviceSempTlsEnabled|global/read-only serviceSempTlsListenPort|global/read-only serviceSmfCompressionListenPort|global/read-only serviceSmfEnabled|global/read-only serviceSmfEventConnectionCountThreshold.clearPercent|global/read-only serviceSmfEventConnectionCountThreshold.clearValue|global/read-only serviceSmfEventConnectionCountThreshold.setPercent|global/read-only serviceSmfEventConnectionCountThreshold.setValue|global/read-only serviceSmfPlainTextListenPort|global/read-only serviceSmfRoutingControlListenPort|global/read-only serviceSmfTlsListenPort|global/read-only serviceTlsEventConnectionCountThreshold.clearPercent|global/read-only serviceTlsEventConnectionCountThreshold.clearValue|global/read-only serviceTlsEventConnectionCountThreshold.setPercent|global/read-only serviceTlsEventConnectionCountThreshold.setValue|global/read-only serviceWebTransportEnabled|global/read-only serviceWebTransportPlainTextListenPort|global/read-only serviceWebTransportTlsListenPort|global/read-only serviceWebTransportWebUrlSuffix|global/read-only tlsBlockVersion11Enabled|global/read-only tlsCipherSuiteManagementList|global/read-only tlsCipherSuiteMsgBackboneList|global/read-only tlsCipherSuiteSecureShellList|global/read-only tlsCrimeExploitProtectionEnabled|global/read-only tlsServerCertContent|global/read-only tlsStandardDomainCertificateAuthoritiesEnabled|vpn/read-only tlsTicketLifetime|global/read-only webManagerAllowUnencryptedWizardsEnabled|vpn/read-only webManagerCustomization|vpn/read-only webManagerRedirectHttpEnabled|vpn/read-only webManagerRedirectHttpOverrideTlsPort|vpn/read-only This has been available since 2.13. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - BrokerResponse result = apiInstance.getBroker(opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getBroker"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**BrokerResponse**](BrokerResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Broker object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getCertAuthorities - -> CertAuthoritiesResponse getCertAuthorities(count, cursor, opaquePassword, where, select) - -Get a list of Certificate Authority objects. - -Get a list of Certificate Authority objects. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| certContent|||x| crlDayList|||x| crlTimeList|||x| crlUrl|||x| ocspNonResponderCertEnabled|||x| ocspOverrideUrl|||x| ocspTimeout|||x| revocationCheckEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - CertAuthoritiesResponse result = apiInstance.getCertAuthorities(count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getCertAuthorities"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**CertAuthoritiesResponse**](CertAuthoritiesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Authority objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getCertAuthority - -> CertAuthorityResponse getCertAuthority(certAuthorityName, opaquePassword, select) - -Get a Certificate Authority object. - -Get a Certificate Authority object. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| certContent|||x| crlDayList|||x| crlTimeList|||x| crlUrl|||x| ocspNonResponderCertEnabled|||x| ocspOverrideUrl|||x| ocspTimeout|||x| revocationCheckEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - CertAuthorityResponse result = apiInstance.getCertAuthority(certAuthorityName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**CertAuthorityResponse**](CertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Authority object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getCertAuthorityOcspTlsTrustedCommonName - -> CertAuthorityOcspTlsTrustedCommonNameResponse getCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName, opaquePassword, select) - -Get an OCSP Responder Trusted Common Name object. - -Get an OCSP Responder Trusted Common Name object. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| ocspTlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String ocspTlsTrustedCommonName = "ocspTlsTrustedCommonName_example"; // String | The expected Trusted Common Name of the OCSP responder remote certificate. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - CertAuthorityOcspTlsTrustedCommonNameResponse result = apiInstance.getCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getCertAuthorityOcspTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **ocspTlsTrustedCommonName** | **String**| The expected Trusted Common Name of the OCSP responder remote certificate. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**CertAuthorityOcspTlsTrustedCommonNameResponse**](CertAuthorityOcspTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OCSP Responder Trusted Common Name object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getCertAuthorityOcspTlsTrustedCommonNames - -> CertAuthorityOcspTlsTrustedCommonNamesResponse getCertAuthorityOcspTlsTrustedCommonNames(certAuthorityName, opaquePassword, where, select) - -Get a list of OCSP Responder Trusted Common Name objects. - -Get a list of OCSP Responder Trusted Common Name objects. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| ocspTlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - CertAuthorityOcspTlsTrustedCommonNamesResponse result = apiInstance.getCertAuthorityOcspTlsTrustedCommonNames(certAuthorityName, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getCertAuthorityOcspTlsTrustedCommonNames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**CertAuthorityOcspTlsTrustedCommonNamesResponse**](CertAuthorityOcspTlsTrustedCommonNamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getClientCertAuthorities - -> ClientCertAuthoritiesResponse getClientCertAuthorities(count, cursor, opaquePassword, where, select) - -Get a list of Client Certificate Authority objects. - -Get a list of Client Certificate Authority objects. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - ClientCertAuthoritiesResponse result = apiInstance.getClientCertAuthorities(count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getClientCertAuthorities"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**ClientCertAuthoritiesResponse**](ClientCertAuthoritiesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Client Certificate Authority objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getClientCertAuthority - -> ClientCertAuthorityResponse getClientCertAuthority(certAuthorityName, opaquePassword, select) - -Get a Client Certificate Authority object. - -Get a Client Certificate Authority object. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - ClientCertAuthorityResponse result = apiInstance.getClientCertAuthority(certAuthorityName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getClientCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**ClientCertAuthorityResponse**](ClientCertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Certificate Authority object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getClientCertAuthorityOcspTlsTrustedCommonName - -> ClientCertAuthorityOcspTlsTrustedCommonNameResponse getClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName, opaquePassword, select) - -Get an OCSP Responder Trusted Common Name object. - -Get an OCSP Responder Trusted Common Name object. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| ocspTlsTrustedCommonName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String ocspTlsTrustedCommonName = "ocspTlsTrustedCommonName_example"; // String | The expected Trusted Common Name of the OCSP responder remote certificate. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - ClientCertAuthorityOcspTlsTrustedCommonNameResponse result = apiInstance.getClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getClientCertAuthorityOcspTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **ocspTlsTrustedCommonName** | **String**| The expected Trusted Common Name of the OCSP responder remote certificate. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**ClientCertAuthorityOcspTlsTrustedCommonNameResponse**](ClientCertAuthorityOcspTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OCSP Responder Trusted Common Name object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getClientCertAuthorityOcspTlsTrustedCommonNames - -> ClientCertAuthorityOcspTlsTrustedCommonNamesResponse getClientCertAuthorityOcspTlsTrustedCommonNames(certAuthorityName, opaquePassword, where, select) - -Get a list of OCSP Responder Trusted Common Name objects. - -Get a list of OCSP Responder Trusted Common Name objects. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| ocspTlsTrustedCommonName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - ClientCertAuthorityOcspTlsTrustedCommonNamesResponse result = apiInstance.getClientCertAuthorityOcspTlsTrustedCommonNames(certAuthorityName, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getClientCertAuthorityOcspTlsTrustedCommonNames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**ClientCertAuthorityOcspTlsTrustedCommonNamesResponse**](ClientCertAuthorityOcspTlsTrustedCommonNamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrCluster - -> DmrClusterResponse getDmrCluster(dmrClusterName, opaquePassword, select) - -Get a Cluster object. - -Get a Cluster object. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| dmrClusterName|x||| tlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterResponse result = apiInstance.getDmrCluster(dmrClusterName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDmrCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterResponse**](DmrClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cluster object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterCertMatchingRule - -> DmrClusterCertMatchingRuleResponse getDmrClusterCertMatchingRule(dmrClusterName, ruleName, opaquePassword, select) - -Get a Certificate Matching Rule object. - -Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleResponse result = apiInstance.getDmrClusterCertMatchingRule(dmrClusterName, ruleName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDmrClusterCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleResponse**](DmrClusterCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterCertMatchingRuleAttributeFilter - -> DmrClusterCertMatchingRuleAttributeFilterResponse getDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, opaquePassword, select) - -Get a Certificate Matching Rule Attribute Filter object. - -Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| filterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleAttributeFilterResponse result = apiInstance.getDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDmrClusterCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleAttributeFilterResponse**](DmrClusterCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterCertMatchingRuleAttributeFilters - -> DmrClusterCertMatchingRuleAttributeFiltersResponse getDmrClusterCertMatchingRuleAttributeFilters(dmrClusterName, ruleName, count, cursor, opaquePassword, where, select) - -Get a list of Certificate Matching Rule Attribute Filter objects. - -Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| filterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleAttributeFiltersResponse result = apiInstance.getDmrClusterCertMatchingRuleAttributeFilters(dmrClusterName, ruleName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDmrClusterCertMatchingRuleAttributeFilters"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleAttributeFiltersResponse**](DmrClusterCertMatchingRuleAttributeFiltersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterCertMatchingRuleCondition - -> DmrClusterCertMatchingRuleConditionResponse getDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, source, opaquePassword, select) - -Get a Certificate Matching Rule Condition object. - -Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - String source = "source_example"; // String | Certificate field to be compared with the Attribute. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleConditionResponse result = apiInstance.getDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, source, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDmrClusterCertMatchingRuleCondition"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **source** | **String**| Certificate field to be compared with the Attribute. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleConditionResponse**](DmrClusterCertMatchingRuleConditionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Condition object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterCertMatchingRuleConditions - -> DmrClusterCertMatchingRuleConditionsResponse getDmrClusterCertMatchingRuleConditions(dmrClusterName, ruleName, count, cursor, opaquePassword, where, select) - -Get a list of Certificate Matching Rule Condition objects. - -Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleConditionsResponse result = apiInstance.getDmrClusterCertMatchingRuleConditions(dmrClusterName, ruleName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDmrClusterCertMatchingRuleConditions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleConditionsResponse**](DmrClusterCertMatchingRuleConditionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Matching Rule Condition objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterCertMatchingRules - -> DmrClusterCertMatchingRulesResponse getDmrClusterCertMatchingRules(dmrClusterName, count, cursor, opaquePassword, where, select) - -Get a list of Certificate Matching Rule objects. - -Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRulesResponse result = apiInstance.getDmrClusterCertMatchingRules(dmrClusterName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDmrClusterCertMatchingRules"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRulesResponse**](DmrClusterCertMatchingRulesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Matching Rule objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterLink - -> DmrClusterLinkResponse getDmrClusterLink(dmrClusterName, remoteNodeName, opaquePassword, select) - -Get a Link object. - -Get a Link object. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkResponse result = apiInstance.getDmrClusterLink(dmrClusterName, remoteNodeName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDmrClusterLink"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkResponse**](DmrClusterLinkResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Link object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterLinkAttribute - -> DmrClusterLinkAttributeResponse getDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, attributeName, attributeValue, opaquePassword, select) - -Get a Link Attribute object. - -Get a Link Attribute object. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String attributeName = "attributeName_example"; // String | The name of the Attribute. - String attributeValue = "attributeValue_example"; // String | The value of the Attribute. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkAttributeResponse result = apiInstance.getDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, attributeName, attributeValue, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDmrClusterLinkAttribute"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **attributeName** | **String**| The name of the Attribute. | | -| **attributeValue** | **String**| The value of the Attribute. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkAttributeResponse**](DmrClusterLinkAttributeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Link Attribute object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterLinkAttributes - -> DmrClusterLinkAttributesResponse getDmrClusterLinkAttributes(dmrClusterName, remoteNodeName, count, cursor, opaquePassword, where, select) - -Get a list of Link Attribute objects. - -Get a list of Link Attribute objects. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkAttributesResponse result = apiInstance.getDmrClusterLinkAttributes(dmrClusterName, remoteNodeName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDmrClusterLinkAttributes"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkAttributesResponse**](DmrClusterLinkAttributesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Link Attribute objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterLinkRemoteAddress - -> DmrClusterLinkRemoteAddressResponse getDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, remoteAddress, opaquePassword, select) - -Get a Remote Address object. - -Get a Remote Address object. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| remoteAddress|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String remoteAddress = "remoteAddress_example"; // String | The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkRemoteAddressResponse result = apiInstance.getDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, remoteAddress, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDmrClusterLinkRemoteAddress"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **remoteAddress** | **String**| The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkRemoteAddressResponse**](DmrClusterLinkRemoteAddressResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Address object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterLinkRemoteAddresses - -> DmrClusterLinkRemoteAddressesResponse getDmrClusterLinkRemoteAddresses(dmrClusterName, remoteNodeName, opaquePassword, where, select) - -Get a list of Remote Address objects. - -Get a list of Remote Address objects. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| remoteAddress|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkRemoteAddressesResponse result = apiInstance.getDmrClusterLinkRemoteAddresses(dmrClusterName, remoteNodeName, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDmrClusterLinkRemoteAddresses"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkRemoteAddressesResponse**](DmrClusterLinkRemoteAddressesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Remote Address objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterLinkTlsTrustedCommonName - -> DmrClusterLinkTlsTrustedCommonNameResponse getDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, tlsTrustedCommonName, opaquePassword, select) - -Get a Trusted Common Name object. - -Get a Trusted Common Name object. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||x| remoteNodeName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String tlsTrustedCommonName = "tlsTrustedCommonName_example"; // String | The expected trusted common name of the remote certificate. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkTlsTrustedCommonNameResponse result = apiInstance.getDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, tlsTrustedCommonName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDmrClusterLinkTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **tlsTrustedCommonName** | **String**| The expected trusted common name of the remote certificate. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkTlsTrustedCommonNameResponse**](DmrClusterLinkTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Trusted Common Name object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterLinkTlsTrustedCommonNames - -> DmrClusterLinkTlsTrustedCommonNamesResponse getDmrClusterLinkTlsTrustedCommonNames(dmrClusterName, remoteNodeName, opaquePassword, where, select) - -Get a list of Trusted Common Name objects. - -Get a list of Trusted Common Name objects. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||x| remoteNodeName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkTlsTrustedCommonNamesResponse result = apiInstance.getDmrClusterLinkTlsTrustedCommonNames(dmrClusterName, remoteNodeName, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDmrClusterLinkTlsTrustedCommonNames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkTlsTrustedCommonNamesResponse**](DmrClusterLinkTlsTrustedCommonNamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Trusted Common Name objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterLinks - -> DmrClusterLinksResponse getDmrClusterLinks(dmrClusterName, count, cursor, opaquePassword, where, select) - -Get a list of Link objects. - -Get a list of Link objects. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinksResponse result = apiInstance.getDmrClusterLinks(dmrClusterName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDmrClusterLinks"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinksResponse**](DmrClusterLinksResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Link objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusters - -> DmrClustersResponse getDmrClusters(count, cursor, opaquePassword, where, select) - -Get a list of Cluster objects. - -Get a list of Cluster objects. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| dmrClusterName|x||| tlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClustersResponse result = apiInstance.getDmrClusters(count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDmrClusters"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClustersResponse**](DmrClustersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Cluster objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDomainCertAuthorities - -> DomainCertAuthoritiesResponse getDomainCertAuthorities(count, cursor, opaquePassword, where, select) - -Get a list of Domain Certificate Authority objects. - -Get a list of Domain Certificate Authority objects. Certificate Authorities trusted for domain verification. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DomainCertAuthoritiesResponse result = apiInstance.getDomainCertAuthorities(count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDomainCertAuthorities"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DomainCertAuthoritiesResponse**](DomainCertAuthoritiesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Domain Certificate Authority objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDomainCertAuthority - -> DomainCertAuthorityResponse getDomainCertAuthority(certAuthorityName, opaquePassword, select) - -Get a Domain Certificate Authority object. - -Get a Domain Certificate Authority object. Certificate Authorities trusted for domain verification. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DomainCertAuthorityResponse result = apiInstance.getDomainCertAuthority(certAuthorityName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getDomainCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DomainCertAuthorityResponse**](DomainCertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Domain Certificate Authority object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpn - -> MsgVpnResponse getMsgVpn(msgVpnName, opaquePassword, select) - -Get a Message VPN object. - -Get a Message VPN object. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| distributedCacheManagementEnabled|||x| msgVpnName|x||| replicationBridgeAuthenticationBasicPassword||x||x replicationBridgeAuthenticationClientCertContent||x||x replicationBridgeAuthenticationClientCertPassword||x|| replicationEnabledQueueBehavior||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnResponse result = apiInstance.getMsgVpn(msgVpnName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnResponse**](MsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfile - -> MsgVpnAclProfileResponse getMsgVpnAclProfile(msgVpnName, aclProfileName, opaquePassword, select) - -Get an ACL Profile object. - -Get an ACL Profile object. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileResponse result = apiInstance.getMsgVpnAclProfile(msgVpnName, aclProfileName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAclProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileResponse**](MsgVpnAclProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The ACL Profile object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileClientConnectException - -> MsgVpnAclProfileClientConnectExceptionResponse getMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress, opaquePassword, select) - -Get a Client Connect Exception object. - -Get a Client Connect Exception object. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String clientConnectExceptionAddress = "clientConnectExceptionAddress_example"; // String | The IP address/netmask of the client connect exception in CIDR form. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileClientConnectExceptionResponse result = apiInstance.getMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAclProfileClientConnectException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **clientConnectExceptionAddress** | **String**| The IP address/netmask of the client connect exception in CIDR form. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileClientConnectExceptionResponse**](MsgVpnAclProfileClientConnectExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Connect Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileClientConnectExceptions - -> MsgVpnAclProfileClientConnectExceptionsResponse getMsgVpnAclProfileClientConnectExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Client Connect Exception objects. - -Get a list of Client Connect Exception objects. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileClientConnectExceptionsResponse result = apiInstance.getMsgVpnAclProfileClientConnectExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAclProfileClientConnectExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileClientConnectExceptionsResponse**](MsgVpnAclProfileClientConnectExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Client Connect Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfilePublishException - -> MsgVpnAclProfilePublishExceptionResponse getMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic, opaquePassword, select) - -Get a Publish Topic Exception object. - -Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String topicSyntax = "topicSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String publishExceptionTopic = "publishExceptionTopic_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishExceptionResponse result = apiInstance.getMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAclProfilePublishException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **topicSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **publishExceptionTopic** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishExceptionResponse**](MsgVpnAclProfilePublishExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Publish Topic Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfilePublishExceptions - -> MsgVpnAclProfilePublishExceptionsResponse getMsgVpnAclProfilePublishExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Publish Topic Exception objects. - -Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishExceptionsResponse result = apiInstance.getMsgVpnAclProfilePublishExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAclProfilePublishExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishExceptionsResponse**](MsgVpnAclProfilePublishExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Publish Topic Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfilePublishTopicException - -> MsgVpnAclProfilePublishTopicExceptionResponse getMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException, opaquePassword, select) - -Get a Publish Topic Exception object. - -Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String publishTopicExceptionSyntax = "publishTopicExceptionSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String publishTopicException = "publishTopicException_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishTopicExceptionResponse result = apiInstance.getMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAclProfilePublishTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **publishTopicExceptionSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **publishTopicException** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishTopicExceptionResponse**](MsgVpnAclProfilePublishTopicExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Publish Topic Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfilePublishTopicExceptions - -> MsgVpnAclProfilePublishTopicExceptionsResponse getMsgVpnAclProfilePublishTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Publish Topic Exception objects. - -Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishTopicExceptionsResponse result = apiInstance.getMsgVpnAclProfilePublishTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAclProfilePublishTopicExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishTopicExceptionsResponse**](MsgVpnAclProfilePublishTopicExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Publish Topic Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeException - -> MsgVpnAclProfileSubscribeExceptionResponse getMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic, opaquePassword, select) - -Get a Subscribe Topic Exception object. - -Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String topicSyntax = "topicSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String subscribeExceptionTopic = "subscribeExceptionTopic_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeExceptionResponse result = apiInstance.getMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAclProfileSubscribeException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **topicSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **subscribeExceptionTopic** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeExceptionResponse**](MsgVpnAclProfileSubscribeExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Topic Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeExceptions - -> MsgVpnAclProfileSubscribeExceptionsResponse getMsgVpnAclProfileSubscribeExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Subscribe Topic Exception objects. - -Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeExceptionsResponse result = apiInstance.getMsgVpnAclProfileSubscribeExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAclProfileSubscribeExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeExceptionsResponse**](MsgVpnAclProfileSubscribeExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Subscribe Topic Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeShareNameException - -> MsgVpnAclProfileSubscribeShareNameExceptionResponse getMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException, opaquePassword, select) - -Get a Subscribe Share Name Exception object. - -Get a Subscribe Share Name Exception object. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String subscribeShareNameExceptionSyntax = "subscribeShareNameExceptionSyntax_example"; // String | The syntax of the subscribe share name for the exception to the default action taken. - String subscribeShareNameException = "subscribeShareNameException_example"; // String | The subscribe share name exception to the default action taken. May include wildcard characters. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeShareNameExceptionResponse result = apiInstance.getMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAclProfileSubscribeShareNameException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **subscribeShareNameExceptionSyntax** | **String**| The syntax of the subscribe share name for the exception to the default action taken. | | -| **subscribeShareNameException** | **String**| The subscribe share name exception to the default action taken. May include wildcard characters. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeShareNameExceptionResponse**](MsgVpnAclProfileSubscribeShareNameExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Share Name Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeShareNameExceptions - -> MsgVpnAclProfileSubscribeShareNameExceptionsResponse getMsgVpnAclProfileSubscribeShareNameExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Subscribe Share Name Exception objects. - -Get a list of Subscribe Share Name Exception objects. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeShareNameExceptionsResponse result = apiInstance.getMsgVpnAclProfileSubscribeShareNameExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAclProfileSubscribeShareNameExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeShareNameExceptionsResponse**](MsgVpnAclProfileSubscribeShareNameExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Subscribe Share Name Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeTopicException - -> MsgVpnAclProfileSubscribeTopicExceptionResponse getMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException, opaquePassword, select) - -Get a Subscribe Topic Exception object. - -Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String subscribeTopicExceptionSyntax = "subscribeTopicExceptionSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String subscribeTopicException = "subscribeTopicException_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeTopicExceptionResponse result = apiInstance.getMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAclProfileSubscribeTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **subscribeTopicExceptionSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **subscribeTopicException** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeTopicExceptionResponse**](MsgVpnAclProfileSubscribeTopicExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Topic Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeTopicExceptions - -> MsgVpnAclProfileSubscribeTopicExceptionsResponse getMsgVpnAclProfileSubscribeTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Subscribe Topic Exception objects. - -Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeTopicExceptionsResponse result = apiInstance.getMsgVpnAclProfileSubscribeTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAclProfileSubscribeTopicExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeTopicExceptionsResponse**](MsgVpnAclProfileSubscribeTopicExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Subscribe Topic Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfiles - -> MsgVpnAclProfilesResponse getMsgVpnAclProfiles(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of ACL Profile objects. - -Get a list of ACL Profile objects. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilesResponse result = apiInstance.getMsgVpnAclProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAclProfiles"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilesResponse**](MsgVpnAclProfilesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of ACL Profile objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfile - -> MsgVpnAuthenticationOauthProfileResponse getMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, opaquePassword, select) - -Get an OAuth Profile object. - -Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResponse result = apiInstance.getMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAuthenticationOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResponse**](MsgVpnAuthenticationOauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfileClientRequiredClaim - -> MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse getMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName, opaquePassword, select) - -Get a Required Claim object. - -Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String clientRequiredClaimName = "clientRequiredClaimName_example"; // String | The name of the ID token claim to verify. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse result = apiInstance.getMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **clientRequiredClaimName** | **String**| The name of the ID token claim to verify. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse**](MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfileClientRequiredClaims - -> MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse getMsgVpnAuthenticationOauthProfileClientRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Required Claim objects. - -Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse result = apiInstance.getMsgVpnAuthenticationOauthProfileClientRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAuthenticationOauthProfileClientRequiredClaims"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse**](MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Required Claim objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - -> MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select) - -Get a Required Claim object. - -Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String resourceServerRequiredClaimName = "resourceServerRequiredClaimName_example"; // String | The name of the access token claim to verify. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse result = apiInstance.getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **resourceServerRequiredClaimName** | **String**| The name of the access token claim to verify. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse**](MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims - -> MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Required Claim objects. - -Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse result = apiInstance.getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse**](MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Required Claim objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfiles - -> MsgVpnAuthenticationOauthProfilesResponse getMsgVpnAuthenticationOauthProfiles(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of OAuth Profile objects. - -Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfilesResponse result = apiInstance.getMsgVpnAuthenticationOauthProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAuthenticationOauthProfiles"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfilesResponse**](MsgVpnAuthenticationOauthProfilesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of OAuth Profile objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProvider - -> MsgVpnAuthenticationOauthProviderResponse getMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, opaquePassword, select) - -Get an OAuth Provider object. - -Get an OAuth Provider object. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProviderName = "oauthProviderName_example"; // String | The name of the OAuth Provider. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProviderResponse result = apiInstance.getMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAuthenticationOauthProvider"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProviderName** | **String**| The name of the OAuth Provider. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProviderResponse**](MsgVpnAuthenticationOauthProviderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Provider object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProviders - -> MsgVpnAuthenticationOauthProvidersResponse getMsgVpnAuthenticationOauthProviders(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of OAuth Provider objects. - -Get a list of OAuth Provider objects. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProvidersResponse result = apiInstance.getMsgVpnAuthenticationOauthProviders(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAuthenticationOauthProviders"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProvidersResponse**](MsgVpnAuthenticationOauthProvidersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of OAuth Provider objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthorizationGroup - -> MsgVpnAuthorizationGroupResponse getMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, opaquePassword, select) - -Get an Authorization Group object. - -Get an Authorization Group object. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String authorizationGroupName = "authorizationGroupName_example"; // String | The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthorizationGroupResponse result = apiInstance.getMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAuthorizationGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **authorizationGroupName** | **String**| The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthorizationGroupResponse**](MsgVpnAuthorizationGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Group object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthorizationGroups - -> MsgVpnAuthorizationGroupsResponse getMsgVpnAuthorizationGroups(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Authorization Group objects. - -Get a list of Authorization Group objects. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthorizationGroupsResponse result = apiInstance.getMsgVpnAuthorizationGroups(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnAuthorizationGroups"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthorizationGroupsResponse**](MsgVpnAuthorizationGroupsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Authorization Group objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridge - -> MsgVpnBridgeResponse getMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, select) - -Get a Bridge object. - -Get a Bridge object. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeResponse result = apiInstance.getMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeResponse**](MsgVpnBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Bridge object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeRemoteMsgVpn - -> MsgVpnBridgeRemoteMsgVpnResponse getMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, opaquePassword, select) - -Get a Remote Message VPN object. - -Get a Remote Message VPN object. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteMsgVpnName = "remoteMsgVpnName_example"; // String | The name of the remote Message VPN. - String remoteMsgVpnLocation = "remoteMsgVpnLocation_example"; // String | The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). - String remoteMsgVpnInterface = "remoteMsgVpnInterface_example"; // String | The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteMsgVpnResponse result = apiInstance.getMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnBridgeRemoteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteMsgVpnName** | **String**| The name of the remote Message VPN. | | -| **remoteMsgVpnLocation** | **String**| The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). | | -| **remoteMsgVpnInterface** | **String**| The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteMsgVpnResponse**](MsgVpnBridgeRemoteMsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Message VPN object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeRemoteMsgVpns - -> MsgVpnBridgeRemoteMsgVpnsResponse getMsgVpnBridgeRemoteMsgVpns(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select) - -Get a list of Remote Message VPN objects. - -Get a list of Remote Message VPN objects. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteMsgVpnsResponse result = apiInstance.getMsgVpnBridgeRemoteMsgVpns(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnBridgeRemoteMsgVpns"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteMsgVpnsResponse**](MsgVpnBridgeRemoteMsgVpnsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Remote Message VPN objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeRemoteSubscription - -> MsgVpnBridgeRemoteSubscriptionResponse getMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic, opaquePassword, select) - -Get a Remote Subscription object. - -Get a Remote Subscription object. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteSubscriptionTopic = "remoteSubscriptionTopic_example"; // String | The topic of the Bridge remote subscription. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteSubscriptionResponse result = apiInstance.getMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnBridgeRemoteSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteSubscriptionTopic** | **String**| The topic of the Bridge remote subscription. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteSubscriptionResponse**](MsgVpnBridgeRemoteSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Subscription object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeRemoteSubscriptions - -> MsgVpnBridgeRemoteSubscriptionsResponse getMsgVpnBridgeRemoteSubscriptions(msgVpnName, bridgeName, bridgeVirtualRouter, count, cursor, opaquePassword, where, select) - -Get a list of Remote Subscription objects. - -Get a list of Remote Subscription objects. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteSubscriptionsResponse result = apiInstance.getMsgVpnBridgeRemoteSubscriptions(msgVpnName, bridgeName, bridgeVirtualRouter, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnBridgeRemoteSubscriptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteSubscriptionsResponse**](MsgVpnBridgeRemoteSubscriptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Remote Subscription objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeTlsTrustedCommonName - -> MsgVpnBridgeTlsTrustedCommonNameResponse getMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName, opaquePassword, select) - -Get a Trusted Common Name object. - -Get a Trusted Common Name object. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String tlsTrustedCommonName = "tlsTrustedCommonName_example"; // String | The expected trusted common name of the remote certificate. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeTlsTrustedCommonNameResponse result = apiInstance.getMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnBridgeTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **tlsTrustedCommonName** | **String**| The expected trusted common name of the remote certificate. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeTlsTrustedCommonNameResponse**](MsgVpnBridgeTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Trusted Common Name object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeTlsTrustedCommonNames - -> MsgVpnBridgeTlsTrustedCommonNamesResponse getMsgVpnBridgeTlsTrustedCommonNames(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select) - -Get a list of Trusted Common Name objects. - -Get a list of Trusted Common Name objects. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeTlsTrustedCommonNamesResponse result = apiInstance.getMsgVpnBridgeTlsTrustedCommonNames(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnBridgeTlsTrustedCommonNames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeTlsTrustedCommonNamesResponse**](MsgVpnBridgeTlsTrustedCommonNamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Trusted Common Name objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridges - -> MsgVpnBridgesResponse getMsgVpnBridges(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Bridge objects. - -Get a list of Bridge objects. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgesResponse result = apiInstance.getMsgVpnBridges(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnBridges"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgesResponse**](MsgVpnBridgesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Bridge objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRule - -> MsgVpnCertMatchingRuleResponse getMsgVpnCertMatchingRule(msgVpnName, ruleName, opaquePassword, select) - -Get a Certificate Matching Rule object. - -Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleResponse result = apiInstance.getMsgVpnCertMatchingRule(msgVpnName, ruleName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleResponse**](MsgVpnCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRuleAttributeFilter - -> MsgVpnCertMatchingRuleAttributeFilterResponse getMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, opaquePassword, select) - -Get a Certificate Matching Rule Attribute Filter object. - -Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleAttributeFilterResponse result = apiInstance.getMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleAttributeFilterResponse**](MsgVpnCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRuleAttributeFilters - -> MsgVpnCertMatchingRuleAttributeFiltersResponse getMsgVpnCertMatchingRuleAttributeFilters(msgVpnName, ruleName, count, cursor, opaquePassword, where, select) - -Get a list of Certificate Matching Rule Attribute Filter objects. - -Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleAttributeFiltersResponse result = apiInstance.getMsgVpnCertMatchingRuleAttributeFilters(msgVpnName, ruleName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnCertMatchingRuleAttributeFilters"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleAttributeFiltersResponse**](MsgVpnCertMatchingRuleAttributeFiltersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRuleCondition - -> MsgVpnCertMatchingRuleConditionResponse getMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source, opaquePassword, select) - -Get a Certificate Matching Rule Condition object. - -Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String source = "source_example"; // String | Certificate field to be compared with the Attribute. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleConditionResponse result = apiInstance.getMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnCertMatchingRuleCondition"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **source** | **String**| Certificate field to be compared with the Attribute. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleConditionResponse**](MsgVpnCertMatchingRuleConditionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Condition object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRuleConditions - -> MsgVpnCertMatchingRuleConditionsResponse getMsgVpnCertMatchingRuleConditions(msgVpnName, ruleName, count, cursor, opaquePassword, where, select) - -Get a list of Certificate Matching Rule Condition objects. - -Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleConditionsResponse result = apiInstance.getMsgVpnCertMatchingRuleConditions(msgVpnName, ruleName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnCertMatchingRuleConditions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleConditionsResponse**](MsgVpnCertMatchingRuleConditionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Matching Rule Condition objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRules - -> MsgVpnCertMatchingRulesResponse getMsgVpnCertMatchingRules(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Certificate Matching Rule objects. - -Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRulesResponse result = apiInstance.getMsgVpnCertMatchingRules(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnCertMatchingRules"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRulesResponse**](MsgVpnCertMatchingRulesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Matching Rule objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientProfile - -> MsgVpnClientProfileResponse getMsgVpnClientProfile(msgVpnName, clientProfileName, opaquePassword, select) - -Get a Client Profile object. - -Get a Client Profile object. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientProfileName = "clientProfileName_example"; // String | The name of the Client Profile. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientProfileResponse result = apiInstance.getMsgVpnClientProfile(msgVpnName, clientProfileName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnClientProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientProfileName** | **String**| The name of the Client Profile. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientProfileResponse**](MsgVpnClientProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Profile object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientProfiles - -> MsgVpnClientProfilesResponse getMsgVpnClientProfiles(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Client Profile objects. - -Get a list of Client Profile objects. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientProfilesResponse result = apiInstance.getMsgVpnClientProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnClientProfiles"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientProfilesResponse**](MsgVpnClientProfilesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Client Profile objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientUsername - -> MsgVpnClientUsernameResponse getMsgVpnClientUsername(msgVpnName, clientUsername, opaquePassword, select) - -Get a Client Username object. - -Get a Client Username object. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameResponse result = apiInstance.getMsgVpnClientUsername(msgVpnName, clientUsername, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnClientUsername"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameResponse**](MsgVpnClientUsernameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientUsernameAttribute - -> MsgVpnClientUsernameAttributeResponse getMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue, opaquePassword, select) - -Get a Client Username Attribute object. - -Get a Client Username Attribute object. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - String attributeName = "attributeName_example"; // String | The name of the Attribute. - String attributeValue = "attributeValue_example"; // String | The value of the Attribute. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameAttributeResponse result = apiInstance.getMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnClientUsernameAttribute"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **attributeName** | **String**| The name of the Attribute. | | -| **attributeValue** | **String**| The value of the Attribute. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameAttributeResponse**](MsgVpnClientUsernameAttributeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username Attribute object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientUsernameAttributes - -> MsgVpnClientUsernameAttributesResponse getMsgVpnClientUsernameAttributes(msgVpnName, clientUsername, count, cursor, opaquePassword, where, select) - -Get a list of Client Username Attribute objects. - -Get a list of Client Username Attribute objects. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameAttributesResponse result = apiInstance.getMsgVpnClientUsernameAttributes(msgVpnName, clientUsername, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnClientUsernameAttributes"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameAttributesResponse**](MsgVpnClientUsernameAttributesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Client Username Attribute objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientUsernames - -> MsgVpnClientUsernamesResponse getMsgVpnClientUsernames(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Client Username objects. - -Get a list of Client Username objects. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernamesResponse result = apiInstance.getMsgVpnClientUsernames(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnClientUsernames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernamesResponse**](MsgVpnClientUsernamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Client Username objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCache - -> MsgVpnDistributedCacheResponse getMsgVpnDistributedCache(msgVpnName, cacheName, opaquePassword, select) - -Get a Distributed Cache object. - -Get a Distributed Cache object. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheResponse result = apiInstance.getMsgVpnDistributedCache(msgVpnName, cacheName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnDistributedCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheResponse**](MsgVpnDistributedCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Distributed Cache object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheCluster - -> MsgVpnDistributedCacheClusterResponse getMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, opaquePassword, select) - -Get a Cache Cluster object. - -Get a Cache Cluster object. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterResponse result = apiInstance.getMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnDistributedCacheCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterResponse**](MsgVpnDistributedCacheClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Cluster object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName, opaquePassword, select) - -Get a Home Cache Cluster object. - -Get a Home Cache Cluster object. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse result = apiInstance.getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Home Cache Cluster object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix, opaquePassword, select) - -Get a Topic Prefix object. - -Get a Topic Prefix object. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - String topicPrefix = "topicPrefix_example"; // String | A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse result = apiInstance.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | -| **topicPrefix** | **String**| A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Prefix object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes(msgVpnName, cacheName, clusterName, homeClusterName, count, cursor, opaquePassword, where, select) - -Get a list of Topic Prefix objects. - -Get a list of Topic Prefix objects. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse result = apiInstance.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes(msgVpnName, cacheName, clusterName, homeClusterName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Topic Prefix objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select) - -Get a list of Home Cache Cluster objects. - -Get a list of Home Cache Cluster objects. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse result = apiInstance.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Home Cache Cluster objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterInstance - -> MsgVpnDistributedCacheClusterInstanceResponse getMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, opaquePassword, select) - -Get a Cache Instance object. - -Get a Cache Instance object. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String instanceName = "instanceName_example"; // String | The name of the Cache Instance. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterInstanceResponse result = apiInstance.getMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnDistributedCacheClusterInstance"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **instanceName** | **String**| The name of the Cache Instance. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterInstanceResponse**](MsgVpnDistributedCacheClusterInstanceResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Instance object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterInstances - -> MsgVpnDistributedCacheClusterInstancesResponse getMsgVpnDistributedCacheClusterInstances(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select) - -Get a list of Cache Instance objects. - -Get a list of Cache Instance objects. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterInstancesResponse result = apiInstance.getMsgVpnDistributedCacheClusterInstances(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnDistributedCacheClusterInstances"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterInstancesResponse**](MsgVpnDistributedCacheClusterInstancesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Cache Instance objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterTopic - -> MsgVpnDistributedCacheClusterTopicResponse getMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic, opaquePassword, select) - -Get a Topic object. - -Get a Topic object. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String topic = "topic_example"; // String | The value of the Topic in the form a/b/c. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterTopicResponse result = apiInstance.getMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnDistributedCacheClusterTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **topic** | **String**| The value of the Topic in the form a/b/c. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterTopicResponse**](MsgVpnDistributedCacheClusterTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterTopics - -> MsgVpnDistributedCacheClusterTopicsResponse getMsgVpnDistributedCacheClusterTopics(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select) - -Get a list of Topic objects. - -Get a list of Topic objects. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterTopicsResponse result = apiInstance.getMsgVpnDistributedCacheClusterTopics(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnDistributedCacheClusterTopics"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterTopicsResponse**](MsgVpnDistributedCacheClusterTopicsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Topic objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusters - -> MsgVpnDistributedCacheClustersResponse getMsgVpnDistributedCacheClusters(msgVpnName, cacheName, count, cursor, opaquePassword, where, select) - -Get a list of Cache Cluster objects. - -Get a list of Cache Cluster objects. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClustersResponse result = apiInstance.getMsgVpnDistributedCacheClusters(msgVpnName, cacheName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnDistributedCacheClusters"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClustersResponse**](MsgVpnDistributedCacheClustersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Cache Cluster objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCaches - -> MsgVpnDistributedCachesResponse getMsgVpnDistributedCaches(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Distributed Cache objects. - -Get a list of Distributed Cache objects. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCachesResponse result = apiInstance.getMsgVpnDistributedCaches(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnDistributedCaches"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCachesResponse**](MsgVpnDistributedCachesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Distributed Cache objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDmrBridge - -> MsgVpnDmrBridgeResponse getMsgVpnDmrBridge(msgVpnName, remoteNodeName, opaquePassword, select) - -Get a DMR Bridge object. - -Get a DMR Bridge object. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the DMR Bridge. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDmrBridgeResponse result = apiInstance.getMsgVpnDmrBridge(msgVpnName, remoteNodeName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnDmrBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the DMR Bridge. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDmrBridgeResponse**](MsgVpnDmrBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The DMR Bridge object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDmrBridges - -> MsgVpnDmrBridgesResponse getMsgVpnDmrBridges(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of DMR Bridge objects. - -Get a list of DMR Bridge objects. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDmrBridgesResponse result = apiInstance.getMsgVpnDmrBridges(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnDmrBridges"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDmrBridgesResponse**](MsgVpnDmrBridgesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of DMR Bridge objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiConnectionFactories - -> MsgVpnJndiConnectionFactoriesResponse getMsgVpnJndiConnectionFactories(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of JNDI Connection Factory objects. - -Get a list of JNDI Connection Factory objects. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiConnectionFactoriesResponse result = apiInstance.getMsgVpnJndiConnectionFactories(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnJndiConnectionFactories"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiConnectionFactoriesResponse**](MsgVpnJndiConnectionFactoriesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of JNDI Connection Factory objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiConnectionFactory - -> MsgVpnJndiConnectionFactoryResponse getMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, opaquePassword, select) - -Get a JNDI Connection Factory object. - -Get a JNDI Connection Factory object. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String connectionFactoryName = "connectionFactoryName_example"; // String | The name of the JMS Connection Factory. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiConnectionFactoryResponse result = apiInstance.getMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnJndiConnectionFactory"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **connectionFactoryName** | **String**| The name of the JMS Connection Factory. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiConnectionFactoryResponse**](MsgVpnJndiConnectionFactoryResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Connection Factory object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiQueue - -> MsgVpnJndiQueueResponse getMsgVpnJndiQueue(msgVpnName, queueName, opaquePassword, select) - -Get a JNDI Queue object. - -Get a JNDI Queue object. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The JNDI name of the JMS Queue. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiQueueResponse result = apiInstance.getMsgVpnJndiQueue(msgVpnName, queueName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnJndiQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The JNDI name of the JMS Queue. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiQueueResponse**](MsgVpnJndiQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Queue object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiQueues - -> MsgVpnJndiQueuesResponse getMsgVpnJndiQueues(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of JNDI Queue objects. - -Get a list of JNDI Queue objects. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiQueuesResponse result = apiInstance.getMsgVpnJndiQueues(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnJndiQueues"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiQueuesResponse**](MsgVpnJndiQueuesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of JNDI Queue objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiTopic - -> MsgVpnJndiTopicResponse getMsgVpnJndiTopic(msgVpnName, topicName, opaquePassword, select) - -Get a JNDI Topic object. - -Get a JNDI Topic object. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicName = "topicName_example"; // String | The JNDI name of the JMS Topic. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiTopicResponse result = apiInstance.getMsgVpnJndiTopic(msgVpnName, topicName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnJndiTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicName** | **String**| The JNDI name of the JMS Topic. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiTopicResponse**](MsgVpnJndiTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Topic object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiTopics - -> MsgVpnJndiTopicsResponse getMsgVpnJndiTopics(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of JNDI Topic objects. - -Get a list of JNDI Topic objects. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiTopicsResponse result = apiInstance.getMsgVpnJndiTopics(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnJndiTopics"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiTopicsResponse**](MsgVpnJndiTopicsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of JNDI Topic objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttRetainCache - -> MsgVpnMqttRetainCacheResponse getMsgVpnMqttRetainCache(msgVpnName, cacheName, opaquePassword, select) - -Get an MQTT Retain Cache object. - -Get an MQTT Retain Cache object. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the MQTT Retain Cache. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttRetainCacheResponse result = apiInstance.getMsgVpnMqttRetainCache(msgVpnName, cacheName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnMqttRetainCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the MQTT Retain Cache. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttRetainCacheResponse**](MsgVpnMqttRetainCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Retain Cache object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttRetainCaches - -> MsgVpnMqttRetainCachesResponse getMsgVpnMqttRetainCaches(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of MQTT Retain Cache objects. - -Get a list of MQTT Retain Cache objects. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttRetainCachesResponse result = apiInstance.getMsgVpnMqttRetainCaches(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnMqttRetainCaches"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttRetainCachesResponse**](MsgVpnMqttRetainCachesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of MQTT Retain Cache objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttSession - -> MsgVpnMqttSessionResponse getMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, opaquePassword, select) - -Get an MQTT Session object. - -Get an MQTT Session object. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionResponse result = apiInstance.getMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnMqttSession"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionResponse**](MsgVpnMqttSessionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Session object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttSessionSubscription - -> MsgVpnMqttSessionSubscriptionResponse getMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, opaquePassword, select) - -Get a Subscription object. - -Get a Subscription object. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - String subscriptionTopic = "subscriptionTopic_example"; // String | The MQTT subscription topic. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionSubscriptionResponse result = apiInstance.getMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnMqttSessionSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **subscriptionTopic** | **String**| The MQTT subscription topic. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionSubscriptionResponse**](MsgVpnMqttSessionSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscription object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttSessionSubscriptions - -> MsgVpnMqttSessionSubscriptionsResponse getMsgVpnMqttSessionSubscriptions(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, count, cursor, opaquePassword, where, select) - -Get a list of Subscription objects. - -Get a list of Subscription objects. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionSubscriptionsResponse result = apiInstance.getMsgVpnMqttSessionSubscriptions(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnMqttSessionSubscriptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionSubscriptionsResponse**](MsgVpnMqttSessionSubscriptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Subscription objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttSessions - -> MsgVpnMqttSessionsResponse getMsgVpnMqttSessions(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of MQTT Session objects. - -Get a list of MQTT Session objects. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionsResponse result = apiInstance.getMsgVpnMqttSessions(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnMqttSessions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionsResponse**](MsgVpnMqttSessionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of MQTT Session objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueue - -> MsgVpnQueueResponse getMsgVpnQueue(msgVpnName, queueName, opaquePassword, select) - -Get a Queue object. - -Get a Queue object. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueResponse result = apiInstance.getMsgVpnQueue(msgVpnName, queueName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueResponse**](MsgVpnQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueueSubscription - -> MsgVpnQueueSubscriptionResponse getMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic, opaquePassword, select) - -Get a Queue Subscription object. - -Get a Queue Subscription object. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - String subscriptionTopic = "subscriptionTopic_example"; // String | The topic of the Subscription. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueSubscriptionResponse result = apiInstance.getMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnQueueSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **subscriptionTopic** | **String**| The topic of the Subscription. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueSubscriptionResponse**](MsgVpnQueueSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Subscription object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueueSubscriptions - -> MsgVpnQueueSubscriptionsResponse getMsgVpnQueueSubscriptions(msgVpnName, queueName, count, cursor, opaquePassword, where, select) - -Get a list of Queue Subscription objects. - -Get a list of Queue Subscription objects. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueSubscriptionsResponse result = apiInstance.getMsgVpnQueueSubscriptions(msgVpnName, queueName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnQueueSubscriptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueSubscriptionsResponse**](MsgVpnQueueSubscriptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Queue Subscription objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueueTemplate - -> MsgVpnQueueTemplateResponse getMsgVpnQueueTemplate(msgVpnName, queueTemplateName, opaquePassword, select) - -Get a Queue Template object. - -Get a Queue Template object. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueTemplateName = "queueTemplateName_example"; // String | The name of the Queue Template. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueTemplateResponse result = apiInstance.getMsgVpnQueueTemplate(msgVpnName, queueTemplateName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnQueueTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueTemplateName** | **String**| The name of the Queue Template. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueTemplateResponse**](MsgVpnQueueTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Template object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueueTemplates - -> MsgVpnQueueTemplatesResponse getMsgVpnQueueTemplates(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Queue Template objects. - -Get a list of Queue Template objects. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueTemplatesResponse result = apiInstance.getMsgVpnQueueTemplates(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnQueueTemplates"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueTemplatesResponse**](MsgVpnQueueTemplatesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Queue Template objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueues - -> MsgVpnQueuesResponse getMsgVpnQueues(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Queue objects. - -Get a list of Queue objects. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueuesResponse result = apiInstance.getMsgVpnQueues(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnQueues"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueuesResponse**](MsgVpnQueuesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Queue objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplayLog - -> MsgVpnReplayLogResponse getMsgVpnReplayLog(msgVpnName, replayLogName, opaquePassword, select) - -Get a Replay Log object. - -Get a Replay Log object. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogResponse result = apiInstance.getMsgVpnReplayLog(msgVpnName, replayLogName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnReplayLog"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogResponse**](MsgVpnReplayLogResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replay Log object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplayLogTopicFilterSubscription - -> MsgVpnReplayLogTopicFilterSubscriptionResponse getMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription, opaquePassword, select) - -Get a Topic Filter Subscription object. - -Get a Topic Filter Subscription object. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - String topicFilterSubscription = "topicFilterSubscription_example"; // String | The topic of the Subscription. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogTopicFilterSubscriptionResponse result = apiInstance.getMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnReplayLogTopicFilterSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **topicFilterSubscription** | **String**| The topic of the Subscription. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogTopicFilterSubscriptionResponse**](MsgVpnReplayLogTopicFilterSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Filter Subscription object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplayLogTopicFilterSubscriptions - -> MsgVpnReplayLogTopicFilterSubscriptionsResponse getMsgVpnReplayLogTopicFilterSubscriptions(msgVpnName, replayLogName, count, cursor, opaquePassword, where, select) - -Get a list of Topic Filter Subscription objects. - -Get a list of Topic Filter Subscription objects. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogTopicFilterSubscriptionsResponse result = apiInstance.getMsgVpnReplayLogTopicFilterSubscriptions(msgVpnName, replayLogName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnReplayLogTopicFilterSubscriptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogTopicFilterSubscriptionsResponse**](MsgVpnReplayLogTopicFilterSubscriptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Topic Filter Subscription objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplayLogs - -> MsgVpnReplayLogsResponse getMsgVpnReplayLogs(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Replay Log objects. - -Get a list of Replay Log objects. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogsResponse result = apiInstance.getMsgVpnReplayLogs(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnReplayLogs"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogsResponse**](MsgVpnReplayLogsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Replay Log objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplicatedTopic - -> MsgVpnReplicatedTopicResponse getMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, opaquePassword, select) - -Get a Replicated Topic object. - -Get a Replicated Topic object. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replicatedTopic = "replicatedTopic_example"; // String | The topic for applying replication. Published messages matching this topic will be replicated to the standby site. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplicatedTopicResponse result = apiInstance.getMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnReplicatedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replicatedTopic** | **String**| The topic for applying replication. Published messages matching this topic will be replicated to the standby site. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplicatedTopicResponse**](MsgVpnReplicatedTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replicated Topic object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplicatedTopics - -> MsgVpnReplicatedTopicsResponse getMsgVpnReplicatedTopics(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Replicated Topic objects. - -Get a list of Replicated Topic objects. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplicatedTopicsResponse result = apiInstance.getMsgVpnReplicatedTopics(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnReplicatedTopics"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplicatedTopicsResponse**](MsgVpnReplicatedTopicsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Replicated Topic objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPoint - -> MsgVpnRestDeliveryPointResponse getMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, opaquePassword, select) - -Get a REST Delivery Point object. - -Get a REST Delivery Point object. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointResponse result = apiInstance.getMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnRestDeliveryPoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointResponse**](MsgVpnRestDeliveryPointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Delivery Point object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointQueueBinding - -> MsgVpnRestDeliveryPointQueueBindingResponse getMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, opaquePassword, select) - -Get a Queue Binding object. - -Get a Queue Binding object. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingResponse result = apiInstance.getMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnRestDeliveryPointQueueBinding"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingResponse**](MsgVpnRestDeliveryPointQueueBindingResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Binding object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointQueueBindingRequestHeader - -> MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse getMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, opaquePassword, select) - -Get a Request Header object. - -Get a Request Header object. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - String headerName = "headerName_example"; // String | The name of the HTTP request header. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse result = apiInstance.getMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **headerName** | **String**| The name of the HTTP request header. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse**](MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Request Header object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointQueueBindingRequestHeaders - -> MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse getMsgVpnRestDeliveryPointQueueBindingRequestHeaders(msgVpnName, restDeliveryPointName, queueBindingName, count, cursor, opaquePassword, where, select) - -Get a list of Request Header objects. - -Get a list of Request Header objects. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse result = apiInstance.getMsgVpnRestDeliveryPointQueueBindingRequestHeaders(msgVpnName, restDeliveryPointName, queueBindingName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnRestDeliveryPointQueueBindingRequestHeaders"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse**](MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Request Header objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointQueueBindings - -> MsgVpnRestDeliveryPointQueueBindingsResponse getMsgVpnRestDeliveryPointQueueBindings(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select) - -Get a list of Queue Binding objects. - -Get a list of Queue Binding objects. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingsResponse result = apiInstance.getMsgVpnRestDeliveryPointQueueBindings(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnRestDeliveryPointQueueBindings"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingsResponse**](MsgVpnRestDeliveryPointQueueBindingsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Queue Binding objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumer - -> MsgVpnRestDeliveryPointRestConsumerResponse getMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, select) - -Get a REST Consumer object. - -Get a REST Consumer object. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnRestDeliveryPointRestConsumer"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerResponse**](MsgVpnRestDeliveryPointRestConsumerResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Consumer object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - -> MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName, opaquePassword, select) - -Get a Claim object. - -Get a Claim object. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String oauthJwtClaimName = "oauthJwtClaimName_example"; // String | The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **oauthJwtClaimName** | **String**| The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse**](MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Claim object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims - -> MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims(msgVpnName, restDeliveryPointName, restConsumerName, count, cursor, opaquePassword, where, select) - -Get a list of Claim objects. - -Get a list of Claim objects. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims(msgVpnName, restDeliveryPointName, restConsumerName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse**](MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Claim objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - -> MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName, opaquePassword, select) - -Get a Trusted Common Name object. - -Get a Trusted Common Name object. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String tlsTrustedCommonName = "tlsTrustedCommonName_example"; // String | The expected trusted common name of the remote certificate. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **tlsTrustedCommonName** | **String**| The expected trusted common name of the remote certificate. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse**](MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Trusted Common Name object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames - -> MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, where, select) - -Get a list of Trusted Common Name objects. - -Get a list of Trusted Common Name objects. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse**](MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Trusted Common Name objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumers - -> MsgVpnRestDeliveryPointRestConsumersResponse getMsgVpnRestDeliveryPointRestConsumers(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select) - -Get a list of REST Consumer objects. - -Get a list of REST Consumer objects. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumersResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumers(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnRestDeliveryPointRestConsumers"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumersResponse**](MsgVpnRestDeliveryPointRestConsumersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of REST Consumer objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPoints - -> MsgVpnRestDeliveryPointsResponse getMsgVpnRestDeliveryPoints(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of REST Delivery Point objects. - -Get a list of REST Delivery Point objects. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointsResponse result = apiInstance.getMsgVpnRestDeliveryPoints(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnRestDeliveryPoints"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointsResponse**](MsgVpnRestDeliveryPointsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of REST Delivery Point objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnSequencedTopic - -> MsgVpnSequencedTopicResponse getMsgVpnSequencedTopic(msgVpnName, sequencedTopic, opaquePassword, select) - -Get a Sequenced Topic object. - -Get a Sequenced Topic object. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| sequencedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String sequencedTopic = "sequencedTopic_example"; // String | Topic for applying sequence numbers. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnSequencedTopicResponse result = apiInstance.getMsgVpnSequencedTopic(msgVpnName, sequencedTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnSequencedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **sequencedTopic** | **String**| Topic for applying sequence numbers. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnSequencedTopicResponse**](MsgVpnSequencedTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Sequenced Topic object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnSequencedTopics - -> MsgVpnSequencedTopicsResponse getMsgVpnSequencedTopics(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Sequenced Topic objects. - -Get a list of Sequenced Topic objects. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| sequencedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnSequencedTopicsResponse result = apiInstance.getMsgVpnSequencedTopics(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnSequencedTopics"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnSequencedTopicsResponse**](MsgVpnSequencedTopicsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Sequenced Topic objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnTopicEndpoint - -> MsgVpnTopicEndpointResponse getMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, opaquePassword, select) - -Get a Topic Endpoint object. - -Get a Topic Endpoint object. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointName = "topicEndpointName_example"; // String | The name of the Topic Endpoint. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointResponse result = apiInstance.getMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnTopicEndpoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointName** | **String**| The name of the Topic Endpoint. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointResponse**](MsgVpnTopicEndpointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnTopicEndpointTemplate - -> MsgVpnTopicEndpointTemplateResponse getMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, opaquePassword, select) - -Get a Topic Endpoint Template object. - -Get a Topic Endpoint Template object. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointTemplateName = "topicEndpointTemplateName_example"; // String | The name of the Topic Endpoint Template. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointTemplateResponse result = apiInstance.getMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnTopicEndpointTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointTemplateName** | **String**| The name of the Topic Endpoint Template. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointTemplateResponse**](MsgVpnTopicEndpointTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint Template object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnTopicEndpointTemplates - -> MsgVpnTopicEndpointTemplatesResponse getMsgVpnTopicEndpointTemplates(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Topic Endpoint Template objects. - -Get a list of Topic Endpoint Template objects. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointTemplatesResponse result = apiInstance.getMsgVpnTopicEndpointTemplates(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnTopicEndpointTemplates"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointTemplatesResponse**](MsgVpnTopicEndpointTemplatesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Topic Endpoint Template objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnTopicEndpoints - -> MsgVpnTopicEndpointsResponse getMsgVpnTopicEndpoints(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Topic Endpoint objects. - -Get a list of Topic Endpoint objects. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointsResponse result = apiInstance.getMsgVpnTopicEndpoints(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpnTopicEndpoints"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointsResponse**](MsgVpnTopicEndpointsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Topic Endpoint objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpns - -> MsgVpnsResponse getMsgVpns(count, cursor, opaquePassword, where, select) - -Get a list of Message VPN objects. - -Get a list of Message VPN objects. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| distributedCacheManagementEnabled|||x| msgVpnName|x||| replicationBridgeAuthenticationBasicPassword||x||x replicationBridgeAuthenticationClientCertContent||x||x replicationBridgeAuthenticationClientCertPassword||x|| replicationEnabledQueueBehavior||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnsResponse result = apiInstance.getMsgVpns(count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getMsgVpns"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnsResponse**](MsgVpnsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Message VPN objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfile - -> OauthProfileResponse getOauthProfile(oauthProfileName, opaquePassword, select) - -Get an OAuth Profile object. - -Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileResponse result = apiInstance.getOauthProfile(oauthProfileName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileResponse**](OauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileAccessLevelGroup - -> OauthProfileAccessLevelGroupResponse getOauthProfileAccessLevelGroup(oauthProfileName, groupName, opaquePassword, select) - -Get a Group Access Level object. - -Get a Group Access Level object. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupResponse result = apiInstance.getOauthProfileAccessLevelGroup(oauthProfileName, groupName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getOauthProfileAccessLevelGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupResponse**](OauthProfileAccessLevelGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Group Access Level object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileAccessLevelGroupMsgVpnAccessLevelException - -> OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse getOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, opaquePassword, select) - -Get a Message VPN Access-Level Exception object. - -Get a Message VPN Access-Level Exception object. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - String msgVpnName = "msgVpnName_example"; // String | The name of the message VPN. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse result = apiInstance.getOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **msgVpnName** | **String**| The name of the message VPN. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse**](OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN Access-Level Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions - -> OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions(oauthProfileName, groupName, count, cursor, opaquePassword, where, select) - -Get a list of Message VPN Access-Level Exception objects. - -Get a list of Message VPN Access-Level Exception objects. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse result = apiInstance.getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions(oauthProfileName, groupName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse**](OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Message VPN Access-Level Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileAccessLevelGroups - -> OauthProfileAccessLevelGroupsResponse getOauthProfileAccessLevelGroups(oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Group Access Level objects. - -Get a list of Group Access Level objects. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupsResponse result = apiInstance.getOauthProfileAccessLevelGroups(oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getOauthProfileAccessLevelGroups"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupsResponse**](OauthProfileAccessLevelGroupsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Group Access Level objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileClientAllowedHost - -> OauthProfileClientAllowedHostResponse getOauthProfileClientAllowedHost(oauthProfileName, allowedHost, opaquePassword, select) - -Get an Allowed Host Value object. - -Get an Allowed Host Value object. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowedHost|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String allowedHost = "allowedHost_example"; // String | An allowed value for the Host header. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientAllowedHostResponse result = apiInstance.getOauthProfileClientAllowedHost(oauthProfileName, allowedHost, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getOauthProfileClientAllowedHost"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **allowedHost** | **String**| An allowed value for the Host header. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientAllowedHostResponse**](OauthProfileClientAllowedHostResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Allowed Host Value object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileClientAllowedHosts - -> OauthProfileClientAllowedHostsResponse getOauthProfileClientAllowedHosts(oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Allowed Host Value objects. - -Get a list of Allowed Host Value objects. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowedHost|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientAllowedHostsResponse result = apiInstance.getOauthProfileClientAllowedHosts(oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getOauthProfileClientAllowedHosts"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientAllowedHostsResponse**](OauthProfileClientAllowedHostsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Allowed Host Value objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileClientAuthorizationParameter - -> OauthProfileClientAuthorizationParameterResponse getOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, opaquePassword, select) - -Get an Authorization Parameter object. - -Get an Authorization Parameter object. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationParameterName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String authorizationParameterName = "authorizationParameterName_example"; // String | The name of the authorization parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientAuthorizationParameterResponse result = apiInstance.getOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getOauthProfileClientAuthorizationParameter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **authorizationParameterName** | **String**| The name of the authorization parameter. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientAuthorizationParameterResponse**](OauthProfileClientAuthorizationParameterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Parameter object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileClientAuthorizationParameters - -> OauthProfileClientAuthorizationParametersResponse getOauthProfileClientAuthorizationParameters(oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Authorization Parameter objects. - -Get a list of Authorization Parameter objects. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationParameterName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientAuthorizationParametersResponse result = apiInstance.getOauthProfileClientAuthorizationParameters(oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getOauthProfileClientAuthorizationParameters"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientAuthorizationParametersResponse**](OauthProfileClientAuthorizationParametersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Authorization Parameter objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileClientRequiredClaim - -> OauthProfileClientRequiredClaimResponse getOauthProfileClientRequiredClaim(oauthProfileName, clientRequiredClaimName, opaquePassword, select) - -Get a Required Claim object. - -Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String clientRequiredClaimName = "clientRequiredClaimName_example"; // String | The name of the ID token claim to verify. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientRequiredClaimResponse result = apiInstance.getOauthProfileClientRequiredClaim(oauthProfileName, clientRequiredClaimName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getOauthProfileClientRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **clientRequiredClaimName** | **String**| The name of the ID token claim to verify. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientRequiredClaimResponse**](OauthProfileClientRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileClientRequiredClaims - -> OauthProfileClientRequiredClaimsResponse getOauthProfileClientRequiredClaims(oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Required Claim objects. - -Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientRequiredClaimsResponse result = apiInstance.getOauthProfileClientRequiredClaims(oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getOauthProfileClientRequiredClaims"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientRequiredClaimsResponse**](OauthProfileClientRequiredClaimsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Required Claim objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileDefaultMsgVpnAccessLevelException - -> OauthProfileDefaultMsgVpnAccessLevelExceptionResponse getOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, opaquePassword, select) - -Get a Message VPN Access-Level Exception object. - -Get a Message VPN Access-Level Exception object. Default message VPN access-level exceptions. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String msgVpnName = "msgVpnName_example"; // String | The name of the message VPN. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse result = apiInstance.getOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getOauthProfileDefaultMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **msgVpnName** | **String**| The name of the message VPN. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileDefaultMsgVpnAccessLevelExceptionResponse**](OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN Access-Level Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileDefaultMsgVpnAccessLevelExceptions - -> OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse getOauthProfileDefaultMsgVpnAccessLevelExceptions(oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Message VPN Access-Level Exception objects. - -Get a list of Message VPN Access-Level Exception objects. Default message VPN access-level exceptions. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse result = apiInstance.getOauthProfileDefaultMsgVpnAccessLevelExceptions(oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getOauthProfileDefaultMsgVpnAccessLevelExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse**](OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Message VPN Access-Level Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileResourceServerRequiredClaim - -> OauthProfileResourceServerRequiredClaimResponse getOauthProfileResourceServerRequiredClaim(oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select) - -Get a Required Claim object. - -Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String resourceServerRequiredClaimName = "resourceServerRequiredClaimName_example"; // String | The name of the access token claim to verify. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileResourceServerRequiredClaimResponse result = apiInstance.getOauthProfileResourceServerRequiredClaim(oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getOauthProfileResourceServerRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **resourceServerRequiredClaimName** | **String**| The name of the access token claim to verify. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileResourceServerRequiredClaimResponse**](OauthProfileResourceServerRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileResourceServerRequiredClaims - -> OauthProfileResourceServerRequiredClaimsResponse getOauthProfileResourceServerRequiredClaims(oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Required Claim objects. - -Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileResourceServerRequiredClaimsResponse result = apiInstance.getOauthProfileResourceServerRequiredClaims(oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getOauthProfileResourceServerRequiredClaims"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileResourceServerRequiredClaimsResponse**](OauthProfileResourceServerRequiredClaimsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Required Claim objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfiles - -> OauthProfilesResponse getOauthProfiles(count, cursor, opaquePassword, where, select) - -Get a list of OAuth Profile objects. - -Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfilesResponse result = apiInstance.getOauthProfiles(count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getOauthProfiles"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfilesResponse**](OauthProfilesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of OAuth Profile objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getSystemInformation - -> SystemInformationResponse getSystemInformation(opaquePassword, select) - -Get a System Information object. - -Get a System Information object. The System Information object provides metadata about the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: platform|||x| sempVersion|||x| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been deprecated since 2.2. /systemInformation was replaced by /about/api. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - SystemInformationResponse result = apiInstance.getSystemInformation(opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getSystemInformation"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**SystemInformationResponse**](SystemInformationResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The System Information object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getVirtualHostname - -> VirtualHostnameResponse getVirtualHostname(virtualHostname, opaquePassword, select) - -Get a Virtual Hostname object. - -Get a Virtual Hostname object. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: virtualHostname|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.17. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String virtualHostname = "virtualHostname_example"; // String | The virtual hostname. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - VirtualHostnameResponse result = apiInstance.getVirtualHostname(virtualHostname, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getVirtualHostname"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **virtualHostname** | **String**| The virtual hostname. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**VirtualHostnameResponse**](VirtualHostnameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Virtual Hostname object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getVirtualHostnames - -> VirtualHostnamesResponse getVirtualHostnames(count, cursor, opaquePassword, where, select) - -Get a list of Virtual Hostname objects. - -Get a list of Virtual Hostname objects. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: virtualHostname|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.17. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - VirtualHostnamesResponse result = apiInstance.getVirtualHostnames(count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#getVirtualHostnames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**VirtualHostnamesResponse**](VirtualHostnamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Virtual Hostname objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceCertAuthority - -> CertAuthorityResponse replaceCertAuthority(certAuthorityName, body, opaquePassword, select) - -Replace a Certificate Authority object. - -Replace a Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||x| certContent||||||x| crlDayList||||||x| crlTimeList||||||x| crlUrl|||||x|x| ocspNonResponderCertEnabled||||||x| ocspOverrideUrl||||||x| ocspTimeout||||||x| revocationCheckEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - CertAuthority body = new CertAuthority(); // CertAuthority | The Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - CertAuthorityResponse result = apiInstance.replaceCertAuthority(certAuthorityName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **body** | [**CertAuthority**](CertAuthority.md)| The Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**CertAuthorityResponse**](CertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Authority object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceClientCertAuthority - -> ClientCertAuthorityResponse replaceClientCertAuthority(certAuthorityName, body, opaquePassword, select) - -Replace a Client Certificate Authority object. - -Replace a Client Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||| crlUrl|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - ClientCertAuthority body = new ClientCertAuthority(); // ClientCertAuthority | The Client Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - ClientCertAuthorityResponse result = apiInstance.replaceClientCertAuthority(certAuthorityName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceClientCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **body** | [**ClientCertAuthority**](ClientCertAuthority.md)| The Client Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**ClientCertAuthorityResponse**](ClientCertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Certificate Authority object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceDmrCluster - -> DmrClusterResponse replaceDmrCluster(dmrClusterName, body, opaquePassword, select) - -Replace a Cluster object. - -Replace a Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword||||x|x||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| directOnlyEnabled||x||||| dmrClusterName|x||x|||| nodeName|||x|||| tlsServerCertEnforceTrustedCommonNameEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - DmrCluster body = new DmrCluster(); // DmrCluster | The Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterResponse result = apiInstance.replaceDmrCluster(dmrClusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceDmrCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **body** | [**DmrCluster**](DmrCluster.md)| The Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterResponse**](DmrClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cluster object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceDmrClusterCertMatchingRule - -> DmrClusterCertMatchingRuleResponse replaceDmrClusterCertMatchingRule(dmrClusterName, ruleName, body, opaquePassword, select) - -Replace a Certificate Matching Rule object. - -Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- dmrClusterName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - DmrClusterCertMatchingRule body = new DmrClusterCertMatchingRule(); // DmrClusterCertMatchingRule | The Certificate Matching Rule object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleResponse result = apiInstance.replaceDmrClusterCertMatchingRule(dmrClusterName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceDmrClusterCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**DmrClusterCertMatchingRule**](DmrClusterCertMatchingRule.md)| The Certificate Matching Rule object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleResponse**](DmrClusterCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceDmrClusterCertMatchingRuleAttributeFilter - -> DmrClusterCertMatchingRuleAttributeFilterResponse replaceDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, body, opaquePassword, select) - -Replace a Certificate Matching Rule Attribute Filter object. - -Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- dmrClusterName|x||x|||| filterName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - DmrClusterCertMatchingRuleAttributeFilter body = new DmrClusterCertMatchingRuleAttributeFilter(); // DmrClusterCertMatchingRuleAttributeFilter | The Certificate Matching Rule Attribute Filter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleAttributeFilterResponse result = apiInstance.replaceDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceDmrClusterCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | -| **body** | [**DmrClusterCertMatchingRuleAttributeFilter**](DmrClusterCertMatchingRuleAttributeFilter.md)| The Certificate Matching Rule Attribute Filter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleAttributeFilterResponse**](DmrClusterCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceDmrClusterLink - -> DmrClusterLinkResponse replaceDmrClusterLink(dmrClusterName, remoteNodeName, body, opaquePassword, select) - -Replace a Link object. - -Replace a Link object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword||||x|x||x authenticationScheme|||||x|| dmrClusterName|x||x|||| egressFlowWindowSize|||||x|| initiator|||||x|| remoteNodeName|x||x|||| span|||||x|| transportCompressedEnabled|||||x|| transportTlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - DmrClusterLink body = new DmrClusterLink(); // DmrClusterLink | The Link object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkResponse result = apiInstance.replaceDmrClusterLink(dmrClusterName, remoteNodeName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceDmrClusterLink"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **body** | [**DmrClusterLink**](DmrClusterLink.md)| The Link object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkResponse**](DmrClusterLinkResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Link object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceDomainCertAuthority - -> DomainCertAuthorityResponse replaceDomainCertAuthority(certAuthorityName, body, opaquePassword, select) - -Replace a Domain Certificate Authority object. - -Replace a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Certificate Authorities trusted for domain verification. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - DomainCertAuthority body = new DomainCertAuthority(); // DomainCertAuthority | The Domain Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DomainCertAuthorityResponse result = apiInstance.replaceDomainCertAuthority(certAuthorityName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceDomainCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **body** | [**DomainCertAuthority**](DomainCertAuthority.md)| The Domain Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DomainCertAuthorityResponse**](DomainCertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Domain Certificate Authority object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpn - -> MsgVpnResponse replaceMsgVpn(msgVpnName, body, opaquePassword, select) - -Replace a Message VPN object. - -Replace a Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationOauthDefaultProviderName||||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled||||||x| distributedCacheManagementEnabled||||||x| msgVpnName|x||x|||| replicationBridgeAuthenticationBasicPassword||||x|||x replicationBridgeAuthenticationClientCertContent||||x|||x replicationBridgeAuthenticationClientCertPassword||||x||| replicationEnabledQueueBehavior||||x||| restTlsServerCertEnforceTrustedCommonNameEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: alias|global/read-write authenticationBasicEnabled|global/read-write authenticationBasicProfileName|global/read-write authenticationBasicRadiusDomain|global/read-write authenticationBasicType|global/read-write authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write authenticationClientCertCertificateMatchingRulesEnabled|global/read-write authenticationClientCertEnabled|global/read-write authenticationClientCertMaxChainDepth|global/read-write authenticationClientCertRevocationCheckMode|global/read-write authenticationClientCertUsernameSource|global/read-write authenticationClientCertValidateDateEnabled|global/read-write authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write authenticationKerberosEnabled|global/read-write authenticationOauthEnabled|global/read-write bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write bridgingTlsServerCertMaxChainDepth|global/read-write bridgingTlsServerCertValidateDateEnabled|global/read-write bridgingTlsServerCertValidateNameEnabled|global/read-write dmrEnabled|global/read-write exportSubscriptionsEnabled|global/read-write maxConnectionCount|global/read-write maxEgressFlowCount|global/read-write maxEndpointCount|global/read-write maxIngressFlowCount|global/read-write maxMsgSpoolUsage|global/read-write maxSubscriptionCount|global/read-write maxTransactedSessionCount|global/read-write maxTransactionCount|global/read-write mqttRetainMaxMemory|global/read-write replicationBridgeAuthenticationBasicClientUsername|global/read-write replicationBridgeAuthenticationBasicPassword|global/read-write replicationBridgeAuthenticationClientCertContent|global/read-write replicationBridgeAuthenticationClientCertPassword|global/read-write replicationBridgeAuthenticationScheme|global/read-write replicationBridgeCompressedDataEnabled|global/read-write replicationBridgeEgressFlowWindowSize|global/read-write replicationBridgeRetryDelay|global/read-write replicationBridgeTlsEnabled|global/read-write replicationBridgeUnidirectionalClientProfileName|global/read-write replicationEnabled|global/read-write replicationEnabledQueueBehavior|global/read-write replicationQueueMaxMsgSpoolUsage|global/read-write replicationRole|global/read-write restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write restTlsServerCertMaxChainDepth|global/read-write restTlsServerCertValidateDateEnabled|global/read-write restTlsServerCertValidateNameEnabled|global/read-write sempOverMsgBusAdminClientEnabled|global/read-write sempOverMsgBusAdminDistributedCacheEnabled|global/read-write sempOverMsgBusAdminEnabled|global/read-write sempOverMsgBusEnabled|global/read-write sempOverMsgBusShowEnabled|global/read-write serviceAmqpMaxConnectionCount|global/read-write serviceAmqpPlainTextListenPort|global/read-write serviceAmqpTlsListenPort|global/read-write serviceMqttMaxConnectionCount|global/read-write serviceMqttPlainTextListenPort|global/read-write serviceMqttTlsListenPort|global/read-write serviceMqttTlsWebSocketListenPort|global/read-write serviceMqttWebSocketListenPort|global/read-write serviceRestIncomingMaxConnectionCount|global/read-write serviceRestIncomingPlainTextListenPort|global/read-write serviceRestIncomingTlsListenPort|global/read-write serviceRestOutgoingMaxConnectionCount|global/read-write serviceSmfMaxConnectionCount|global/read-write serviceWebMaxConnectionCount|global/read-write This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpn body = new MsgVpn(); // MsgVpn | The Message VPN object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnResponse result = apiInstance.replaceMsgVpn(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpn**](MsgVpn.md)| The Message VPN object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnResponse**](MsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnAclProfile - -> MsgVpnAclProfileResponse replaceMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select) - -Replace an ACL Profile object. - -Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfile body = new MsgVpnAclProfile(); // MsgVpnAclProfile | The ACL Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileResponse result = apiInstance.replaceMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnAclProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfile**](MsgVpnAclProfile.md)| The ACL Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileResponse**](MsgVpnAclProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The ACL Profile object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnAuthenticationOauthProfile - -> MsgVpnAuthenticationOauthProfileResponse replaceMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select) - -Replace an OAuth Profile object. - -Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - MsgVpnAuthenticationOauthProfile body = new MsgVpnAuthenticationOauthProfile(); // MsgVpnAuthenticationOauthProfile | The OAuth Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResponse result = apiInstance.replaceMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnAuthenticationOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**MsgVpnAuthenticationOauthProfile**](MsgVpnAuthenticationOauthProfile.md)| The OAuth Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResponse**](MsgVpnAuthenticationOauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnAuthenticationOauthProvider - -> MsgVpnAuthenticationOauthProviderResponse replaceMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select) - -Replace an OAuth Provider object. - -Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- audienceClaimName||||||x| audienceClaimSource||||||x| audienceClaimValue||||||x| audienceValidationEnabled||||||x| authorizationGroupClaimName||||||x| authorizationGroupClaimSource||||||x| authorizationGroupEnabled||||||x| disconnectOnTokenExpirationEnabled||||||x| enabled||||||x| jwksRefreshInterval||||||x| jwksUri||||||x| msgVpnName|x||x|||x| oauthProviderName|x||x|||x| tokenIgnoreTimeLimitsEnabled||||||x| tokenIntrospectionParameterName||||||x| tokenIntrospectionPassword||||x||x|x tokenIntrospectionTimeout||||||x| tokenIntrospectionUri||||||x| tokenIntrospectionUsername||||||x| usernameClaimName||||||x| usernameClaimSource||||||x| usernameValidateEnabled||||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProviderName = "oauthProviderName_example"; // String | The name of the OAuth Provider. - MsgVpnAuthenticationOauthProvider body = new MsgVpnAuthenticationOauthProvider(); // MsgVpnAuthenticationOauthProvider | The OAuth Provider object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProviderResponse result = apiInstance.replaceMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnAuthenticationOauthProvider"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProviderName** | **String**| The name of the OAuth Provider. | | -| **body** | [**MsgVpnAuthenticationOauthProvider**](MsgVpnAuthenticationOauthProvider.md)| The OAuth Provider object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProviderResponse**](MsgVpnAuthenticationOauthProviderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Provider object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnAuthorizationGroup - -> MsgVpnAuthorizationGroupResponse replaceMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select) - -Replace an Authorization Group object. - -Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| authorizationGroupName|x||x|||| clientProfileName|||||x|| msgVpnName|x||x|||| orderAfterAuthorizationGroupName||||x||| orderBeforeAuthorizationGroupName||||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String authorizationGroupName = "authorizationGroupName_example"; // String | The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. - MsgVpnAuthorizationGroup body = new MsgVpnAuthorizationGroup(); // MsgVpnAuthorizationGroup | The Authorization Group object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthorizationGroupResponse result = apiInstance.replaceMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnAuthorizationGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **authorizationGroupName** | **String**| The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. | | -| **body** | [**MsgVpnAuthorizationGroup**](MsgVpnAuthorizationGroup.md)| The Authorization Group object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthorizationGroupResponse**](MsgVpnAuthorizationGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Group object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnBridge - -> MsgVpnBridgeResponse replaceMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select) - -Replace a Bridge object. - -Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| maxTtl|||||x|| msgVpnName|x||x|||| remoteAuthenticationBasicClientUsername|||||x|| remoteAuthenticationBasicPassword||||x|x||x remoteAuthenticationClientCertContent||||x|x||x remoteAuthenticationClientCertPassword||||x|x|| remoteAuthenticationScheme|||||x|| remoteDeliverToOnePriority|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - MsgVpnBridge body = new MsgVpnBridge(); // MsgVpnBridge | The Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeResponse result = apiInstance.replaceMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **body** | [**MsgVpnBridge**](MsgVpnBridge.md)| The Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeResponse**](MsgVpnBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Bridge object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnBridgeRemoteMsgVpn - -> MsgVpnBridgeRemoteMsgVpnResponse replaceMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select) - -Replace a Remote Message VPN object. - -Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| clientUsername|||||x|| compressedDataEnabled|||||x|| egressFlowWindowSize|||||x|| msgVpnName|x||x|||| password||||x|x||x remoteMsgVpnInterface|x||x|||| remoteMsgVpnLocation|x||x|||| remoteMsgVpnName|x||x|||| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteMsgVpnName = "remoteMsgVpnName_example"; // String | The name of the remote Message VPN. - String remoteMsgVpnLocation = "remoteMsgVpnLocation_example"; // String | The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). - String remoteMsgVpnInterface = "remoteMsgVpnInterface_example"; // String | The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. - MsgVpnBridgeRemoteMsgVpn body = new MsgVpnBridgeRemoteMsgVpn(); // MsgVpnBridgeRemoteMsgVpn | The Remote Message VPN object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteMsgVpnResponse result = apiInstance.replaceMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnBridgeRemoteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteMsgVpnName** | **String**| The name of the remote Message VPN. | | -| **remoteMsgVpnLocation** | **String**| The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). | | -| **remoteMsgVpnInterface** | **String**| The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. | | -| **body** | [**MsgVpnBridgeRemoteMsgVpn**](MsgVpnBridgeRemoteMsgVpn.md)| The Remote Message VPN object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteMsgVpnResponse**](MsgVpnBridgeRemoteMsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Message VPN object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnCertMatchingRule - -> MsgVpnCertMatchingRuleResponse replaceMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select) - -Replace a Certificate Matching Rule object. - -Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - MsgVpnCertMatchingRule body = new MsgVpnCertMatchingRule(); // MsgVpnCertMatchingRule | The Certificate Matching Rule object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleResponse result = apiInstance.replaceMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**MsgVpnCertMatchingRule**](MsgVpnCertMatchingRule.md)| The Certificate Matching Rule object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleResponse**](MsgVpnCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnCertMatchingRuleAttributeFilter - -> MsgVpnCertMatchingRuleAttributeFilterResponse replaceMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select) - -Replace a Certificate Matching Rule Attribute Filter object. - -Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- filterName|x||x|||| msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - MsgVpnCertMatchingRuleAttributeFilter body = new MsgVpnCertMatchingRuleAttributeFilter(); // MsgVpnCertMatchingRuleAttributeFilter | The Certificate Matching Rule Attribute Filter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleAttributeFilterResponse result = apiInstance.replaceMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | -| **body** | [**MsgVpnCertMatchingRuleAttributeFilter**](MsgVpnCertMatchingRuleAttributeFilter.md)| The Certificate Matching Rule Attribute Filter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleAttributeFilterResponse**](MsgVpnCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnClientProfile - -> MsgVpnClientProfileResponse replaceMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select) - -Replace a Client Profile object. - -Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled||||||x| apiQueueManagementCopyFromOnCreateName||||||x| apiTopicEndpointManagementCopyFromOnCreateName||||||x| clientProfileName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientProfileName = "clientProfileName_example"; // String | The name of the Client Profile. - MsgVpnClientProfile body = new MsgVpnClientProfile(); // MsgVpnClientProfile | The Client Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientProfileResponse result = apiInstance.replaceMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnClientProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientProfileName** | **String**| The name of the Client Profile. | | -| **body** | [**MsgVpnClientProfile**](MsgVpnClientProfile.md)| The Client Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientProfileResponse**](MsgVpnClientProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Profile object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnClientUsername - -> MsgVpnClientUsernameResponse replaceMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select) - -Replace a Client Username object. - -Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| clientProfileName|||||x|| clientUsername|x||x|||| msgVpnName|x||x|||| password||||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - MsgVpnClientUsername body = new MsgVpnClientUsername(); // MsgVpnClientUsername | The Client Username object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameResponse result = apiInstance.replaceMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnClientUsername"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **body** | [**MsgVpnClientUsername**](MsgVpnClientUsername.md)| The Client Username object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameResponse**](MsgVpnClientUsernameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnDistributedCache - -> MsgVpnDistributedCacheResponse replaceMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select) - -Replace a Distributed Cache object. - -Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| cacheVirtualRouter||x||||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - MsgVpnDistributedCache body = new MsgVpnDistributedCache(); // MsgVpnDistributedCache | The Distributed Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheResponse result = apiInstance.replaceMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnDistributedCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **body** | [**MsgVpnDistributedCache**](MsgVpnDistributedCache.md)| The Distributed Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheResponse**](MsgVpnDistributedCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Distributed Cache object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnDistributedCacheCluster - -> MsgVpnDistributedCacheClusterResponse replaceMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select) - -Replace a Cache Cluster object. - -Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - MsgVpnDistributedCacheCluster body = new MsgVpnDistributedCacheCluster(); // MsgVpnDistributedCacheCluster | The Cache Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterResponse result = apiInstance.replaceMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnDistributedCacheCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheCluster**](MsgVpnDistributedCacheCluster.md)| The Cache Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterResponse**](MsgVpnDistributedCacheClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Cluster object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnDistributedCacheClusterInstance - -> MsgVpnDistributedCacheClusterInstanceResponse replaceMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select) - -Replace a Cache Instance object. - -Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| instanceName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String instanceName = "instanceName_example"; // String | The name of the Cache Instance. - MsgVpnDistributedCacheClusterInstance body = new MsgVpnDistributedCacheClusterInstance(); // MsgVpnDistributedCacheClusterInstance | The Cache Instance object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterInstanceResponse result = apiInstance.replaceMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnDistributedCacheClusterInstance"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **instanceName** | **String**| The name of the Cache Instance. | | -| **body** | [**MsgVpnDistributedCacheClusterInstance**](MsgVpnDistributedCacheClusterInstance.md)| The Cache Instance object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterInstanceResponse**](MsgVpnDistributedCacheClusterInstanceResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Instance object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnDmrBridge - -> MsgVpnDmrBridgeResponse replaceMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select) - -Replace a DMR Bridge object. - -Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| remoteNodeName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the DMR Bridge. - MsgVpnDmrBridge body = new MsgVpnDmrBridge(); // MsgVpnDmrBridge | The DMR Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDmrBridgeResponse result = apiInstance.replaceMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnDmrBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the DMR Bridge. | | -| **body** | [**MsgVpnDmrBridge**](MsgVpnDmrBridge.md)| The DMR Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDmrBridgeResponse**](MsgVpnDmrBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The DMR Bridge object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnJndiConnectionFactory - -> MsgVpnJndiConnectionFactoryResponse replaceMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select) - -Replace a JNDI Connection Factory object. - -Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String connectionFactoryName = "connectionFactoryName_example"; // String | The name of the JMS Connection Factory. - MsgVpnJndiConnectionFactory body = new MsgVpnJndiConnectionFactory(); // MsgVpnJndiConnectionFactory | The JNDI Connection Factory object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiConnectionFactoryResponse result = apiInstance.replaceMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnJndiConnectionFactory"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **connectionFactoryName** | **String**| The name of the JMS Connection Factory. | | -| **body** | [**MsgVpnJndiConnectionFactory**](MsgVpnJndiConnectionFactory.md)| The JNDI Connection Factory object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiConnectionFactoryResponse**](MsgVpnJndiConnectionFactoryResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Connection Factory object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnJndiQueue - -> MsgVpnJndiQueueResponse replaceMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select) - -Replace a JNDI Queue object. - -Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The JNDI name of the JMS Queue. - MsgVpnJndiQueue body = new MsgVpnJndiQueue(); // MsgVpnJndiQueue | The JNDI Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiQueueResponse result = apiInstance.replaceMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnJndiQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The JNDI name of the JMS Queue. | | -| **body** | [**MsgVpnJndiQueue**](MsgVpnJndiQueue.md)| The JNDI Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiQueueResponse**](MsgVpnJndiQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Queue object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnJndiTopic - -> MsgVpnJndiTopicResponse replaceMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select) - -Replace a JNDI Topic object. - -Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicName = "topicName_example"; // String | The JNDI name of the JMS Topic. - MsgVpnJndiTopic body = new MsgVpnJndiTopic(); // MsgVpnJndiTopic | The JNDI Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiTopicResponse result = apiInstance.replaceMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnJndiTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicName** | **String**| The JNDI name of the JMS Topic. | | -| **body** | [**MsgVpnJndiTopic**](MsgVpnJndiTopic.md)| The JNDI Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiTopicResponse**](MsgVpnJndiTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Topic object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnMqttRetainCache - -> MsgVpnMqttRetainCacheResponse replaceMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select) - -Replace an MQTT Retain Cache object. - -Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the MQTT Retain Cache. - MsgVpnMqttRetainCache body = new MsgVpnMqttRetainCache(); // MsgVpnMqttRetainCache | The MQTT Retain Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttRetainCacheResponse result = apiInstance.replaceMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnMqttRetainCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the MQTT Retain Cache. | | -| **body** | [**MsgVpnMqttRetainCache**](MsgVpnMqttRetainCache.md)| The MQTT Retain Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttRetainCacheResponse**](MsgVpnMqttRetainCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Retain Cache object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnMqttSession - -> MsgVpnMqttSessionResponse replaceMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select) - -Replace an MQTT Session object. - -Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| owner|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - MsgVpnMqttSession body = new MsgVpnMqttSession(); // MsgVpnMqttSession | The MQTT Session object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionResponse result = apiInstance.replaceMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnMqttSession"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **body** | [**MsgVpnMqttSession**](MsgVpnMqttSession.md)| The MQTT Session object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionResponse**](MsgVpnMqttSessionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Session object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnMqttSessionSubscription - -> MsgVpnMqttSessionSubscriptionResponse replaceMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select) - -Replace a Subscription object. - -Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| subscriptionTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - String subscriptionTopic = "subscriptionTopic_example"; // String | The MQTT subscription topic. - MsgVpnMqttSessionSubscription body = new MsgVpnMqttSessionSubscription(); // MsgVpnMqttSessionSubscription | The Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionSubscriptionResponse result = apiInstance.replaceMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnMqttSessionSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **subscriptionTopic** | **String**| The MQTT subscription topic. | | -| **body** | [**MsgVpnMqttSessionSubscription**](MsgVpnMqttSessionSubscription.md)| The Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionSubscriptionResponse**](MsgVpnMqttSessionSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscription object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnQueue - -> MsgVpnQueueResponse replaceMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select) - -Replace a Queue object. - -Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| queueName|x||x|||| respectMsgPriorityEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - MsgVpnQueue body = new MsgVpnQueue(); // MsgVpnQueue | The Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueResponse result = apiInstance.replaceMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **body** | [**MsgVpnQueue**](MsgVpnQueue.md)| The Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueResponse**](MsgVpnQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnQueueTemplate - -> MsgVpnQueueTemplateResponse replaceMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select) - -Replace a Queue Template object. - -Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueTemplateName = "queueTemplateName_example"; // String | The name of the Queue Template. - MsgVpnQueueTemplate body = new MsgVpnQueueTemplate(); // MsgVpnQueueTemplate | The Queue Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueTemplateResponse result = apiInstance.replaceMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnQueueTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueTemplateName** | **String**| The name of the Queue Template. | | -| **body** | [**MsgVpnQueueTemplate**](MsgVpnQueueTemplate.md)| The Queue Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueTemplateResponse**](MsgVpnQueueTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Template object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnReplayLog - -> MsgVpnReplayLogResponse replaceMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select) - -Replace a Replay Log object. - -Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replayLogName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - MsgVpnReplayLog body = new MsgVpnReplayLog(); // MsgVpnReplayLog | The Replay Log object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogResponse result = apiInstance.replaceMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnReplayLog"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **body** | [**MsgVpnReplayLog**](MsgVpnReplayLog.md)| The Replay Log object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogResponse**](MsgVpnReplayLogResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replay Log object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnReplicatedTopic - -> MsgVpnReplicatedTopicResponse replaceMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select) - -Replace a Replicated Topic object. - -Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replicatedTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replicatedTopic = "replicatedTopic_example"; // String | The topic for applying replication. Published messages matching this topic will be replicated to the standby site. - MsgVpnReplicatedTopic body = new MsgVpnReplicatedTopic(); // MsgVpnReplicatedTopic | The Replicated Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplicatedTopicResponse result = apiInstance.replaceMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnReplicatedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replicatedTopic** | **String**| The topic for applying replication. Published messages matching this topic will be replicated to the standby site. | | -| **body** | [**MsgVpnReplicatedTopic**](MsgVpnReplicatedTopic.md)| The Replicated Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplicatedTopicResponse**](MsgVpnReplicatedTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replicated Topic object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnRestDeliveryPoint - -> MsgVpnRestDeliveryPointResponse replaceMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select) - -Replace a REST Delivery Point object. - -Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientProfileName|||||x|| msgVpnName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - MsgVpnRestDeliveryPoint body = new MsgVpnRestDeliveryPoint(); // MsgVpnRestDeliveryPoint | The REST Delivery Point object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointResponse result = apiInstance.replaceMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnRestDeliveryPoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **body** | [**MsgVpnRestDeliveryPoint**](MsgVpnRestDeliveryPoint.md)| The REST Delivery Point object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointResponse**](MsgVpnRestDeliveryPointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Delivery Point object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnRestDeliveryPointQueueBinding - -> MsgVpnRestDeliveryPointQueueBindingResponse replaceMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select) - -Replace a Queue Binding object. - -Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - MsgVpnRestDeliveryPointQueueBinding body = new MsgVpnRestDeliveryPointQueueBinding(); // MsgVpnRestDeliveryPointQueueBinding | The Queue Binding object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingResponse result = apiInstance.replaceMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnRestDeliveryPointQueueBinding"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBinding**](MsgVpnRestDeliveryPointQueueBinding.md)| The Queue Binding object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingResponse**](MsgVpnRestDeliveryPointQueueBindingResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Binding object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader - -> MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select) - -Replace a Request Header object. - -Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A request header to be added to the HTTP request. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- headerName|x||x|||| msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - String headerName = "headerName_example"; // String | The name of the HTTP request header. - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = new MsgVpnRestDeliveryPointQueueBindingRequestHeader(); // MsgVpnRestDeliveryPointQueueBindingRequestHeader | The Request Header object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse result = apiInstance.replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **headerName** | **String**| The name of the HTTP request header. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBindingRequestHeader**](MsgVpnRestDeliveryPointQueueBindingRequestHeader.md)| The Request Header object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse**](MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Request Header object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnRestDeliveryPointRestConsumer - -> MsgVpnRestDeliveryPointRestConsumerResponse replaceMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select) - -Replace a REST Consumer object. - -Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey||||x|||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| authenticationHttpBasicPassword||||x|x||x authenticationHttpBasicUsername|||||x|| authenticationHttpHeaderValue||||x|||x authenticationOauthClientId|||||x|| authenticationOauthClientScope|||||x|| authenticationOauthClientSecret||||x|x||x authenticationOauthClientTokenEndpoint|||||x|| authenticationOauthJwtSecretKey||||x|x||x authenticationOauthJwtTokenEndpoint|||||x|| authenticationScheme|||||x|| msgVpnName|x||x|||| outgoingConnectionCount|||||x|| remoteHost|||||x|| remotePort|||||x|| restConsumerName|x||x|||| restDeliveryPointName|x||x|||| tlsCipherSuiteList|||||x|| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - MsgVpnRestDeliveryPointRestConsumer body = new MsgVpnRestDeliveryPointRestConsumer(); // MsgVpnRestDeliveryPointRestConsumer | The REST Consumer object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerResponse result = apiInstance.replaceMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnRestDeliveryPointRestConsumer"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **body** | [**MsgVpnRestDeliveryPointRestConsumer**](MsgVpnRestDeliveryPointRestConsumer.md)| The REST Consumer object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerResponse**](MsgVpnRestDeliveryPointRestConsumerResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Consumer object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnTopicEndpoint - -> MsgVpnTopicEndpointResponse replaceMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select) - -Replace a Topic Endpoint object. - -Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| respectMsgPriorityEnabled|||||x|| topicEndpointName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointName = "topicEndpointName_example"; // String | The name of the Topic Endpoint. - MsgVpnTopicEndpoint body = new MsgVpnTopicEndpoint(); // MsgVpnTopicEndpoint | The Topic Endpoint object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointResponse result = apiInstance.replaceMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnTopicEndpoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointName** | **String**| The name of the Topic Endpoint. | | -| **body** | [**MsgVpnTopicEndpoint**](MsgVpnTopicEndpoint.md)| The Topic Endpoint object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointResponse**](MsgVpnTopicEndpointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnTopicEndpointTemplate - -> MsgVpnTopicEndpointTemplateResponse replaceMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select) - -Replace a Topic Endpoint Template object. - -Replace a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicEndpointTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointTemplateName = "topicEndpointTemplateName_example"; // String | The name of the Topic Endpoint Template. - MsgVpnTopicEndpointTemplate body = new MsgVpnTopicEndpointTemplate(); // MsgVpnTopicEndpointTemplate | The Topic Endpoint Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointTemplateResponse result = apiInstance.replaceMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceMsgVpnTopicEndpointTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointTemplateName** | **String**| The name of the Topic Endpoint Template. | | -| **body** | [**MsgVpnTopicEndpointTemplate**](MsgVpnTopicEndpointTemplate.md)| The Topic Endpoint Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointTemplateResponse**](MsgVpnTopicEndpointTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint Template object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceOauthProfile - -> OauthProfileResponse replaceOauthProfile(oauthProfileName, body, opaquePassword, select) - -Replace an OAuth Profile object. - -Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: accessLevelGroupsClaimName|global/admin clientId|global/admin clientRedirectUri|global/admin clientRequiredType|global/admin clientScope|global/admin clientSecret|global/admin clientValidateTypeEnabled|global/admin defaultGlobalAccessLevel|global/admin displayName|global/admin enabled|global/admin endpointAuthorization|global/admin endpointDiscovery|global/admin endpointDiscoveryRefreshInterval|global/admin endpointIntrospection|global/admin endpointIntrospectionTimeout|global/admin endpointJwks|global/admin endpointJwksRefreshInterval|global/admin endpointToken|global/admin endpointTokenTimeout|global/admin endpointUserinfo|global/admin endpointUserinfoTimeout|global/admin interactiveEnabled|global/admin interactivePromptForExpiredSession|global/admin interactivePromptForNewSession|global/admin issuer|global/admin oauthRole|global/admin resourceServerParseAccessTokenEnabled|global/admin resourceServerRequiredAudience|global/admin resourceServerRequiredIssuer|global/admin resourceServerRequiredScope|global/admin resourceServerRequiredType|global/admin resourceServerValidateAudienceEnabled|global/admin resourceServerValidateIssuerEnabled|global/admin resourceServerValidateScopeEnabled|global/admin resourceServerValidateTypeEnabled|global/admin sempEnabled|global/admin usernameClaimName|global/admin This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - OauthProfile body = new OauthProfile(); // OauthProfile | The OAuth Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileResponse result = apiInstance.replaceOauthProfile(oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**OauthProfile**](OauthProfile.md)| The OAuth Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileResponse**](OauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceOauthProfileAccessLevelGroup - -> OauthProfileAccessLevelGroupResponse replaceOauthProfileAccessLevelGroup(oauthProfileName, groupName, body, opaquePassword, select) - -Replace a Group Access Level object. - -Replace a Group Access Level object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- groupName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - OauthProfileAccessLevelGroup body = new OauthProfileAccessLevelGroup(); // OauthProfileAccessLevelGroup | The Group Access Level object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupResponse result = apiInstance.replaceOauthProfileAccessLevelGroup(oauthProfileName, groupName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceOauthProfileAccessLevelGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **body** | [**OauthProfileAccessLevelGroup**](OauthProfileAccessLevelGroup.md)| The Group Access Level object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupResponse**](OauthProfileAccessLevelGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Group Access Level object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException - -> OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, body, opaquePassword, select) - -Replace a Message VPN Access-Level Exception object. - -Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- groupName|x||x|||| msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - String msgVpnName = "msgVpnName_example"; // String | The name of the message VPN. - OauthProfileAccessLevelGroupMsgVpnAccessLevelException body = new OauthProfileAccessLevelGroupMsgVpnAccessLevelException(); // OauthProfileAccessLevelGroupMsgVpnAccessLevelException | The Message VPN Access-Level Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse result = apiInstance.replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **msgVpnName** | **String**| The name of the message VPN. | | -| **body** | [**OauthProfileAccessLevelGroupMsgVpnAccessLevelException**](OauthProfileAccessLevelGroupMsgVpnAccessLevelException.md)| The Message VPN Access-Level Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse**](OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceOauthProfileClientAuthorizationParameter - -> OauthProfileClientAuthorizationParameterResponse replaceOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, body, opaquePassword, select) - -Replace an Authorization Parameter object. - -Replace an Authorization Parameter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authorizationParameterName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String authorizationParameterName = "authorizationParameterName_example"; // String | The name of the authorization parameter. - OauthProfileClientAuthorizationParameter body = new OauthProfileClientAuthorizationParameter(); // OauthProfileClientAuthorizationParameter | The Authorization Parameter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientAuthorizationParameterResponse result = apiInstance.replaceOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceOauthProfileClientAuthorizationParameter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **authorizationParameterName** | **String**| The name of the authorization parameter. | | -| **body** | [**OauthProfileClientAuthorizationParameter**](OauthProfileClientAuthorizationParameter.md)| The Authorization Parameter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientAuthorizationParameterResponse**](OauthProfileClientAuthorizationParameterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Parameter object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceOauthProfileDefaultMsgVpnAccessLevelException - -> OauthProfileDefaultMsgVpnAccessLevelExceptionResponse replaceOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, body, opaquePassword, select) - -Replace a Message VPN Access-Level Exception object. - -Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Default message VPN access-level exceptions. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String msgVpnName = "msgVpnName_example"; // String | The name of the message VPN. - OauthProfileDefaultMsgVpnAccessLevelException body = new OauthProfileDefaultMsgVpnAccessLevelException(); // OauthProfileDefaultMsgVpnAccessLevelException | The Message VPN Access-Level Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse result = apiInstance.replaceOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceOauthProfileDefaultMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **msgVpnName** | **String**| The name of the message VPN. | | -| **body** | [**OauthProfileDefaultMsgVpnAccessLevelException**](OauthProfileDefaultMsgVpnAccessLevelException.md)| The Message VPN Access-Level Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileDefaultMsgVpnAccessLevelExceptionResponse**](OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceVirtualHostname - -> VirtualHostnameResponse replaceVirtualHostname(virtualHostname, body, opaquePassword, select) - -Replace a Virtual Hostname object. - -Replace a Virtual Hostname object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- virtualHostname|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String virtualHostname = "virtualHostname_example"; // String | The virtual hostname. - VirtualHostname body = new VirtualHostname(); // VirtualHostname | The Virtual Hostname object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - VirtualHostnameResponse result = apiInstance.replaceVirtualHostname(virtualHostname, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#replaceVirtualHostname"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **virtualHostname** | **String**| The virtual hostname. | | -| **body** | [**VirtualHostname**](VirtualHostname.md)| The Virtual Hostname object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**VirtualHostnameResponse**](VirtualHostnameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Virtual Hostname object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateBroker - -> BrokerResponse updateBroker(body, opaquePassword, select) - -Update a Broker object. - -Update a Broker object. Any attribute missing from the request will be left unchanged. This object contains global configuration for the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- serviceAmqpTlsListenPort||||x|| serviceHealthCheckListenPort||||x|| serviceMateLinkListenPort||||x|| serviceRedundancyFirstListenPort||||x|| serviceSempPlainTextListenPort||||x|| serviceSempTlsListenPort||||x|| serviceSmfCompressionListenPort||||x|| serviceSmfPlainTextListenPort||||x|| serviceSmfRoutingControlListenPort||||x|| serviceSmfTlsListenPort||||x|| serviceWebTransportPlainTextListenPort||||x|| serviceWebTransportTlsListenPort||||x|| serviceWebTransportWebUrlSuffix||||x|| tlsServerCertContent|||x|||x tlsServerCertPassword|||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- Broker|tlsServerCertPassword|tlsServerCertContent| EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: authClientCertRevocationCheckMode|global/admin configSyncAuthenticationClientCertMaxChainDepth|global/read-write configSyncAuthenticationClientCertValidateDateEnabled|global/read-write configSyncClientProfileTcpInitialCongestionWindow|global/read-write configSyncClientProfileTcpKeepaliveCount|global/read-write configSyncClientProfileTcpKeepaliveIdle|global/read-write configSyncClientProfileTcpKeepaliveInterval|global/read-write configSyncClientProfileTcpMaxWindow|global/read-write configSyncClientProfileTcpMss|global/read-write configSyncEnabled|global/read-write configSyncSynchronizeUsernameEnabled|global/read-write configSyncTlsEnabled|global/read-write guaranteedMsgingDefragmentationScheduleDayList|global/read-write guaranteedMsgingDefragmentationScheduleEnabled|global/read-write guaranteedMsgingDefragmentationScheduleTimeList|global/read-write guaranteedMsgingDefragmentationThresholdEnabled|global/read-write guaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-write guaranteedMsgingDefragmentationThresholdMinInterval|global/read-write guaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-write guaranteedMsgingEnabled|global/read-write guaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-write guaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-write guaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-write guaranteedMsgingEventCacheUsageThreshold.setValue|global/read-write guaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-write guaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-write guaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-write guaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-write guaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-write guaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-write guaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-write guaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-write guaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-write guaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-write guaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-write guaranteedMsgingEventEndpointCountThreshold.setValue|global/read-write guaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-write guaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-write guaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-write guaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-write guaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-write guaranteedMsgingEventMsgCountThreshold.setPercent|global/read-write guaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-write guaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-write guaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-write guaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-write guaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-write guaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-write guaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-write guaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-write guaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-write guaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-write guaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-write guaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-write guaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-write guaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-write guaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-write guaranteedMsgingEventTransactionCountThreshold.setValue|global/read-write guaranteedMsgingMaxCacheUsage|global/read-write guaranteedMsgingMaxMsgSpoolUsage|global/read-write guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-write guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-write guaranteedMsgingTransactionReplicationCompatibilityMode|global/read-write oauthProfileDefault|global/admin serviceAmqpEnabled|global/read-write serviceAmqpTlsListenPort|global/read-write serviceEventConnectionCountThreshold.clearPercent|global/read-write serviceEventConnectionCountThreshold.clearValue|global/read-write serviceEventConnectionCountThreshold.setPercent|global/read-write serviceEventConnectionCountThreshold.setValue|global/read-write serviceHealthCheckEnabled|global/read-write serviceHealthCheckListenPort|global/read-write serviceMateLinkEnabled|global/read-write serviceMateLinkListenPort|global/read-write serviceMqttEnabled|global/read-write serviceMsgBackboneEnabled|global/read-write serviceRedundancyEnabled|global/read-write serviceRedundancyFirstListenPort|global/read-write serviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-write serviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-write serviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-write serviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-write serviceRestIncomingEnabled|global/read-write serviceRestOutgoingEnabled|global/read-write serviceSempCorsAllowAnyHostEnabled|global/read-write serviceSempLegacyTimeoutEnabled|global/read-write serviceSempPlainTextEnabled|global/read-write serviceSempPlainTextListenPort|global/read-write serviceSempSessionIdleTimeout|global/read-write serviceSempSessionMaxLifetime|global/read-write serviceSempTlsEnabled|global/read-write serviceSempTlsListenPort|global/read-write serviceSmfCompressionListenPort|global/read-write serviceSmfEnabled|global/read-write serviceSmfEventConnectionCountThreshold.clearPercent|global/read-write serviceSmfEventConnectionCountThreshold.clearValue|global/read-write serviceSmfEventConnectionCountThreshold.setPercent|global/read-write serviceSmfEventConnectionCountThreshold.setValue|global/read-write serviceSmfPlainTextListenPort|global/read-write serviceSmfRoutingControlListenPort|global/read-write serviceSmfTlsListenPort|global/read-write serviceTlsEventConnectionCountThreshold.clearPercent|global/read-write serviceTlsEventConnectionCountThreshold.clearValue|global/read-write serviceTlsEventConnectionCountThreshold.setPercent|global/read-write serviceTlsEventConnectionCountThreshold.setValue|global/read-write serviceWebTransportEnabled|global/read-write serviceWebTransportPlainTextListenPort|global/read-write serviceWebTransportTlsListenPort|global/read-write serviceWebTransportWebUrlSuffix|global/read-write tlsBlockVersion11Enabled|global/read-write tlsCipherSuiteManagementList|global/read-write tlsCipherSuiteMsgBackboneList|global/read-write tlsCipherSuiteSecureShellList|global/read-write tlsCrimeExploitProtectionEnabled|global/read-write tlsServerCertContent|global/read-write tlsServerCertPassword|global/read-write tlsStandardDomainCertificateAuthoritiesEnabled|global/read-write tlsTicketLifetime|global/read-write webManagerAllowUnencryptedWizardsEnabled|global/read-write webManagerCustomization|vpn/read-write webManagerRedirectHttpEnabled|global/read-write webManagerRedirectHttpOverrideTlsPort|global/read-write This has been available since 2.13. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - Broker body = new Broker(); // Broker | The Broker object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - BrokerResponse result = apiInstance.updateBroker(body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateBroker"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **body** | [**Broker**](Broker.md)| The Broker object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**BrokerResponse**](BrokerResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Broker object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateCertAuthority - -> CertAuthorityResponse updateCertAuthority(certAuthorityName, body, opaquePassword, select) - -Update a Certificate Authority object. - -Update a Certificate Authority object. Any attribute missing from the request will be left unchanged. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||x| certContent|||||x| crlDayList|||||x| crlTimeList|||||x| crlUrl||||x|x| ocspNonResponderCertEnabled|||||x| ocspOverrideUrl|||||x| ocspTimeout|||||x| revocationCheckEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - CertAuthority body = new CertAuthority(); // CertAuthority | The Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - CertAuthorityResponse result = apiInstance.updateCertAuthority(certAuthorityName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **body** | [**CertAuthority**](CertAuthority.md)| The Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**CertAuthorityResponse**](CertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Authority object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateClientCertAuthority - -> ClientCertAuthorityResponse updateClientCertAuthority(certAuthorityName, body, opaquePassword, select) - -Update a Client Certificate Authority object. - -Update a Client Certificate Authority object. Any attribute missing from the request will be left unchanged. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||| crlUrl||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - ClientCertAuthority body = new ClientCertAuthority(); // ClientCertAuthority | The Client Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - ClientCertAuthorityResponse result = apiInstance.updateClientCertAuthority(certAuthorityName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateClientCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **body** | [**ClientCertAuthority**](ClientCertAuthority.md)| The Client Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**ClientCertAuthorityResponse**](ClientCertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Certificate Authority object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateDmrCluster - -> DmrClusterResponse updateDmrCluster(dmrClusterName, body, opaquePassword, select) - -Update a Cluster object. - -Update a Cluster object. Any attribute missing from the request will be left unchanged. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword|||x|x||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| directOnlyEnabled||x|||| dmrClusterName|x|x|||| nodeName||x|||| tlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - DmrCluster body = new DmrCluster(); // DmrCluster | The Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterResponse result = apiInstance.updateDmrCluster(dmrClusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateDmrCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **body** | [**DmrCluster**](DmrCluster.md)| The Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterResponse**](DmrClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cluster object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateDmrClusterCertMatchingRule - -> DmrClusterCertMatchingRuleResponse updateDmrClusterCertMatchingRule(dmrClusterName, ruleName, body, opaquePassword, select) - -Update a Certificate Matching Rule object. - -Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- dmrClusterName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - DmrClusterCertMatchingRule body = new DmrClusterCertMatchingRule(); // DmrClusterCertMatchingRule | The Certificate Matching Rule object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleResponse result = apiInstance.updateDmrClusterCertMatchingRule(dmrClusterName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateDmrClusterCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**DmrClusterCertMatchingRule**](DmrClusterCertMatchingRule.md)| The Certificate Matching Rule object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleResponse**](DmrClusterCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateDmrClusterCertMatchingRuleAttributeFilter - -> DmrClusterCertMatchingRuleAttributeFilterResponse updateDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, body, opaquePassword, select) - -Update a Certificate Matching Rule Attribute Filter object. - -Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- dmrClusterName|x|x|||| filterName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - DmrClusterCertMatchingRuleAttributeFilter body = new DmrClusterCertMatchingRuleAttributeFilter(); // DmrClusterCertMatchingRuleAttributeFilter | The Certificate Matching Rule Attribute Filter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleAttributeFilterResponse result = apiInstance.updateDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateDmrClusterCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | -| **body** | [**DmrClusterCertMatchingRuleAttributeFilter**](DmrClusterCertMatchingRuleAttributeFilter.md)| The Certificate Matching Rule Attribute Filter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleAttributeFilterResponse**](DmrClusterCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateDmrClusterLink - -> DmrClusterLinkResponse updateDmrClusterLink(dmrClusterName, remoteNodeName, body, opaquePassword, select) - -Update a Link object. - -Update a Link object. Any attribute missing from the request will be left unchanged. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword|||x|x||x authenticationScheme||||x|| dmrClusterName|x|x|||| egressFlowWindowSize||||x|| initiator||||x|| remoteNodeName|x|x|||| span||||x|| transportCompressedEnabled||||x|| transportTlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - DmrClusterLink body = new DmrClusterLink(); // DmrClusterLink | The Link object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkResponse result = apiInstance.updateDmrClusterLink(dmrClusterName, remoteNodeName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateDmrClusterLink"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **body** | [**DmrClusterLink**](DmrClusterLink.md)| The Link object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkResponse**](DmrClusterLinkResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Link object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateDomainCertAuthority - -> DomainCertAuthorityResponse updateDomainCertAuthority(certAuthorityName, body, opaquePassword, select) - -Update a Domain Certificate Authority object. - -Update a Domain Certificate Authority object. Any attribute missing from the request will be left unchanged. Certificate Authorities trusted for domain verification. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - DomainCertAuthority body = new DomainCertAuthority(); // DomainCertAuthority | The Domain Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DomainCertAuthorityResponse result = apiInstance.updateDomainCertAuthority(certAuthorityName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateDomainCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **body** | [**DomainCertAuthority**](DomainCertAuthority.md)| The Domain Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DomainCertAuthorityResponse**](DomainCertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Domain Certificate Authority object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpn - -> MsgVpnResponse updateMsgVpn(msgVpnName, body, opaquePassword, select) - -Update a Message VPN object. - -Update a Message VPN object. Any attribute missing from the request will be left unchanged. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationOauthDefaultProviderName|||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| distributedCacheManagementEnabled|||||x| msgVpnName|x|x|||| replicationBridgeAuthenticationBasicPassword|||x|||x replicationBridgeAuthenticationClientCertContent|||x|||x replicationBridgeAuthenticationClientCertPassword|||x||| replicationEnabledQueueBehavior|||x||| restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: alias|global/read-write authenticationBasicEnabled|global/read-write authenticationBasicProfileName|global/read-write authenticationBasicRadiusDomain|global/read-write authenticationBasicType|global/read-write authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write authenticationClientCertCertificateMatchingRulesEnabled|global/read-write authenticationClientCertEnabled|global/read-write authenticationClientCertMaxChainDepth|global/read-write authenticationClientCertRevocationCheckMode|global/read-write authenticationClientCertUsernameSource|global/read-write authenticationClientCertValidateDateEnabled|global/read-write authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write authenticationKerberosEnabled|global/read-write authenticationOauthEnabled|global/read-write bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write bridgingTlsServerCertMaxChainDepth|global/read-write bridgingTlsServerCertValidateDateEnabled|global/read-write bridgingTlsServerCertValidateNameEnabled|global/read-write dmrEnabled|global/read-write exportSubscriptionsEnabled|global/read-write maxConnectionCount|global/read-write maxEgressFlowCount|global/read-write maxEndpointCount|global/read-write maxIngressFlowCount|global/read-write maxMsgSpoolUsage|global/read-write maxSubscriptionCount|global/read-write maxTransactedSessionCount|global/read-write maxTransactionCount|global/read-write mqttRetainMaxMemory|global/read-write replicationBridgeAuthenticationBasicClientUsername|global/read-write replicationBridgeAuthenticationBasicPassword|global/read-write replicationBridgeAuthenticationClientCertContent|global/read-write replicationBridgeAuthenticationClientCertPassword|global/read-write replicationBridgeAuthenticationScheme|global/read-write replicationBridgeCompressedDataEnabled|global/read-write replicationBridgeEgressFlowWindowSize|global/read-write replicationBridgeRetryDelay|global/read-write replicationBridgeTlsEnabled|global/read-write replicationBridgeUnidirectionalClientProfileName|global/read-write replicationEnabled|global/read-write replicationEnabledQueueBehavior|global/read-write replicationQueueMaxMsgSpoolUsage|global/read-write replicationRole|global/read-write restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write restTlsServerCertMaxChainDepth|global/read-write restTlsServerCertValidateDateEnabled|global/read-write restTlsServerCertValidateNameEnabled|global/read-write sempOverMsgBusAdminClientEnabled|global/read-write sempOverMsgBusAdminDistributedCacheEnabled|global/read-write sempOverMsgBusAdminEnabled|global/read-write sempOverMsgBusEnabled|global/read-write sempOverMsgBusShowEnabled|global/read-write serviceAmqpMaxConnectionCount|global/read-write serviceAmqpPlainTextListenPort|global/read-write serviceAmqpTlsListenPort|global/read-write serviceMqttMaxConnectionCount|global/read-write serviceMqttPlainTextListenPort|global/read-write serviceMqttTlsListenPort|global/read-write serviceMqttTlsWebSocketListenPort|global/read-write serviceMqttWebSocketListenPort|global/read-write serviceRestIncomingMaxConnectionCount|global/read-write serviceRestIncomingPlainTextListenPort|global/read-write serviceRestIncomingTlsListenPort|global/read-write serviceRestOutgoingMaxConnectionCount|global/read-write serviceSmfMaxConnectionCount|global/read-write serviceWebMaxConnectionCount|global/read-write This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpn body = new MsgVpn(); // MsgVpn | The Message VPN object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnResponse result = apiInstance.updateMsgVpn(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpn**](MsgVpn.md)| The Message VPN object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnResponse**](MsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnAclProfile - -> MsgVpnAclProfileResponse updateMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select) - -Update an ACL Profile object. - -Update an ACL Profile object. Any attribute missing from the request will be left unchanged. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfile body = new MsgVpnAclProfile(); // MsgVpnAclProfile | The ACL Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileResponse result = apiInstance.updateMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnAclProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfile**](MsgVpnAclProfile.md)| The ACL Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileResponse**](MsgVpnAclProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The ACL Profile object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnAuthenticationOauthProfile - -> MsgVpnAuthenticationOauthProfileResponse updateMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select) - -Update an OAuth Profile object. - -Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - MsgVpnAuthenticationOauthProfile body = new MsgVpnAuthenticationOauthProfile(); // MsgVpnAuthenticationOauthProfile | The OAuth Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResponse result = apiInstance.updateMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnAuthenticationOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**MsgVpnAuthenticationOauthProfile**](MsgVpnAuthenticationOauthProfile.md)| The OAuth Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResponse**](MsgVpnAuthenticationOauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnAuthenticationOauthProvider - -> MsgVpnAuthenticationOauthProviderResponse updateMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select) - -Update an OAuth Provider object. - -Update an OAuth Provider object. Any attribute missing from the request will be left unchanged. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x|x|||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword|||x||x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProviderName = "oauthProviderName_example"; // String | The name of the OAuth Provider. - MsgVpnAuthenticationOauthProvider body = new MsgVpnAuthenticationOauthProvider(); // MsgVpnAuthenticationOauthProvider | The OAuth Provider object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProviderResponse result = apiInstance.updateMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnAuthenticationOauthProvider"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProviderName** | **String**| The name of the OAuth Provider. | | -| **body** | [**MsgVpnAuthenticationOauthProvider**](MsgVpnAuthenticationOauthProvider.md)| The OAuth Provider object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProviderResponse**](MsgVpnAuthenticationOauthProviderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Provider object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnAuthorizationGroup - -> MsgVpnAuthorizationGroupResponse updateMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select) - -Update an Authorization Group object. - -Update an Authorization Group object. Any attribute missing from the request will be left unchanged. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| authorizationGroupName|x|x|||| clientProfileName||||x|| msgVpnName|x|x|||| orderAfterAuthorizationGroupName|||x||| orderBeforeAuthorizationGroupName|||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String authorizationGroupName = "authorizationGroupName_example"; // String | The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. - MsgVpnAuthorizationGroup body = new MsgVpnAuthorizationGroup(); // MsgVpnAuthorizationGroup | The Authorization Group object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthorizationGroupResponse result = apiInstance.updateMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnAuthorizationGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **authorizationGroupName** | **String**| The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. | | -| **body** | [**MsgVpnAuthorizationGroup**](MsgVpnAuthorizationGroup.md)| The Authorization Group object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthorizationGroupResponse**](MsgVpnAuthorizationGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Group object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnBridge - -> MsgVpnBridgeResponse updateMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select) - -Update a Bridge object. - -Update a Bridge object. Any attribute missing from the request will be left unchanged. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| maxTtl||||x|| msgVpnName|x|x|||| remoteAuthenticationBasicClientUsername||||x|| remoteAuthenticationBasicPassword|||x|x||x remoteAuthenticationClientCertContent|||x|x||x remoteAuthenticationClientCertPassword|||x|x|| remoteAuthenticationScheme||||x|| remoteDeliverToOnePriority||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - MsgVpnBridge body = new MsgVpnBridge(); // MsgVpnBridge | The Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeResponse result = apiInstance.updateMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **body** | [**MsgVpnBridge**](MsgVpnBridge.md)| The Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeResponse**](MsgVpnBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Bridge object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnBridgeRemoteMsgVpn - -> MsgVpnBridgeRemoteMsgVpnResponse updateMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select) - -Update a Remote Message VPN object. - -Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| clientUsername||||x|| compressedDataEnabled||||x|| egressFlowWindowSize||||x|| msgVpnName|x|x|||| password|||x|x||x remoteMsgVpnInterface|x|x|||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteMsgVpnName = "remoteMsgVpnName_example"; // String | The name of the remote Message VPN. - String remoteMsgVpnLocation = "remoteMsgVpnLocation_example"; // String | The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). - String remoteMsgVpnInterface = "remoteMsgVpnInterface_example"; // String | The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. - MsgVpnBridgeRemoteMsgVpn body = new MsgVpnBridgeRemoteMsgVpn(); // MsgVpnBridgeRemoteMsgVpn | The Remote Message VPN object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteMsgVpnResponse result = apiInstance.updateMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnBridgeRemoteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteMsgVpnName** | **String**| The name of the remote Message VPN. | | -| **remoteMsgVpnLocation** | **String**| The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). | | -| **remoteMsgVpnInterface** | **String**| The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. | | -| **body** | [**MsgVpnBridgeRemoteMsgVpn**](MsgVpnBridgeRemoteMsgVpn.md)| The Remote Message VPN object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteMsgVpnResponse**](MsgVpnBridgeRemoteMsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Message VPN object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnCertMatchingRule - -> MsgVpnCertMatchingRuleResponse updateMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select) - -Update a Certificate Matching Rule object. - -Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - MsgVpnCertMatchingRule body = new MsgVpnCertMatchingRule(); // MsgVpnCertMatchingRule | The Certificate Matching Rule object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleResponse result = apiInstance.updateMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**MsgVpnCertMatchingRule**](MsgVpnCertMatchingRule.md)| The Certificate Matching Rule object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleResponse**](MsgVpnCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnCertMatchingRuleAttributeFilter - -> MsgVpnCertMatchingRuleAttributeFilterResponse updateMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select) - -Update a Certificate Matching Rule Attribute Filter object. - -Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- filterName|x|x|||| msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - MsgVpnCertMatchingRuleAttributeFilter body = new MsgVpnCertMatchingRuleAttributeFilter(); // MsgVpnCertMatchingRuleAttributeFilter | The Certificate Matching Rule Attribute Filter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleAttributeFilterResponse result = apiInstance.updateMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | -| **body** | [**MsgVpnCertMatchingRuleAttributeFilter**](MsgVpnCertMatchingRuleAttributeFilter.md)| The Certificate Matching Rule Attribute Filter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleAttributeFilterResponse**](MsgVpnCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnClientProfile - -> MsgVpnClientProfileResponse updateMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select) - -Update a Client Profile object. - -Update a Client Profile object. Any attribute missing from the request will be left unchanged. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientProfileName = "clientProfileName_example"; // String | The name of the Client Profile. - MsgVpnClientProfile body = new MsgVpnClientProfile(); // MsgVpnClientProfile | The Client Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientProfileResponse result = apiInstance.updateMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnClientProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientProfileName** | **String**| The name of the Client Profile. | | -| **body** | [**MsgVpnClientProfile**](MsgVpnClientProfile.md)| The Client Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientProfileResponse**](MsgVpnClientProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Profile object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnClientUsername - -> MsgVpnClientUsernameResponse updateMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select) - -Update a Client Username object. - -Update a Client Username object. Any attribute missing from the request will be left unchanged. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| clientProfileName||||x|| clientUsername|x|x|||| msgVpnName|x|x|||| password|||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - MsgVpnClientUsername body = new MsgVpnClientUsername(); // MsgVpnClientUsername | The Client Username object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameResponse result = apiInstance.updateMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnClientUsername"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **body** | [**MsgVpnClientUsername**](MsgVpnClientUsername.md)| The Client Username object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameResponse**](MsgVpnClientUsernameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnDistributedCache - -> MsgVpnDistributedCacheResponse updateMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select) - -Update a Distributed Cache object. - -Update a Distributed Cache object. Any attribute missing from the request will be left unchanged. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| cacheVirtualRouter||x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - MsgVpnDistributedCache body = new MsgVpnDistributedCache(); // MsgVpnDistributedCache | The Distributed Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheResponse result = apiInstance.updateMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnDistributedCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **body** | [**MsgVpnDistributedCache**](MsgVpnDistributedCache.md)| The Distributed Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheResponse**](MsgVpnDistributedCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Distributed Cache object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnDistributedCacheCluster - -> MsgVpnDistributedCacheClusterResponse updateMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select) - -Update a Cache Cluster object. - -Update a Cache Cluster object. Any attribute missing from the request will be left unchanged. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - MsgVpnDistributedCacheCluster body = new MsgVpnDistributedCacheCluster(); // MsgVpnDistributedCacheCluster | The Cache Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterResponse result = apiInstance.updateMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnDistributedCacheCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheCluster**](MsgVpnDistributedCacheCluster.md)| The Cache Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterResponse**](MsgVpnDistributedCacheClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Cluster object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnDistributedCacheClusterInstance - -> MsgVpnDistributedCacheClusterInstanceResponse updateMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select) - -Update a Cache Instance object. - -Update a Cache Instance object. Any attribute missing from the request will be left unchanged. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| instanceName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String instanceName = "instanceName_example"; // String | The name of the Cache Instance. - MsgVpnDistributedCacheClusterInstance body = new MsgVpnDistributedCacheClusterInstance(); // MsgVpnDistributedCacheClusterInstance | The Cache Instance object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterInstanceResponse result = apiInstance.updateMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnDistributedCacheClusterInstance"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **instanceName** | **String**| The name of the Cache Instance. | | -| **body** | [**MsgVpnDistributedCacheClusterInstance**](MsgVpnDistributedCacheClusterInstance.md)| The Cache Instance object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterInstanceResponse**](MsgVpnDistributedCacheClusterInstanceResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Instance object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnDmrBridge - -> MsgVpnDmrBridgeResponse updateMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select) - -Update a DMR Bridge object. - -Update a DMR Bridge object. Any attribute missing from the request will be left unchanged. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the DMR Bridge. - MsgVpnDmrBridge body = new MsgVpnDmrBridge(); // MsgVpnDmrBridge | The DMR Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDmrBridgeResponse result = apiInstance.updateMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnDmrBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the DMR Bridge. | | -| **body** | [**MsgVpnDmrBridge**](MsgVpnDmrBridge.md)| The DMR Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDmrBridgeResponse**](MsgVpnDmrBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The DMR Bridge object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnJndiConnectionFactory - -> MsgVpnJndiConnectionFactoryResponse updateMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select) - -Update a JNDI Connection Factory object. - -Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String connectionFactoryName = "connectionFactoryName_example"; // String | The name of the JMS Connection Factory. - MsgVpnJndiConnectionFactory body = new MsgVpnJndiConnectionFactory(); // MsgVpnJndiConnectionFactory | The JNDI Connection Factory object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiConnectionFactoryResponse result = apiInstance.updateMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnJndiConnectionFactory"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **connectionFactoryName** | **String**| The name of the JMS Connection Factory. | | -| **body** | [**MsgVpnJndiConnectionFactory**](MsgVpnJndiConnectionFactory.md)| The JNDI Connection Factory object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiConnectionFactoryResponse**](MsgVpnJndiConnectionFactoryResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Connection Factory object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnJndiQueue - -> MsgVpnJndiQueueResponse updateMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select) - -Update a JNDI Queue object. - -Update a JNDI Queue object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The JNDI name of the JMS Queue. - MsgVpnJndiQueue body = new MsgVpnJndiQueue(); // MsgVpnJndiQueue | The JNDI Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiQueueResponse result = apiInstance.updateMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnJndiQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The JNDI name of the JMS Queue. | | -| **body** | [**MsgVpnJndiQueue**](MsgVpnJndiQueue.md)| The JNDI Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiQueueResponse**](MsgVpnJndiQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Queue object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnJndiTopic - -> MsgVpnJndiTopicResponse updateMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select) - -Update a JNDI Topic object. - -Update a JNDI Topic object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicName = "topicName_example"; // String | The JNDI name of the JMS Topic. - MsgVpnJndiTopic body = new MsgVpnJndiTopic(); // MsgVpnJndiTopic | The JNDI Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiTopicResponse result = apiInstance.updateMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnJndiTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicName** | **String**| The JNDI name of the JMS Topic. | | -| **body** | [**MsgVpnJndiTopic**](MsgVpnJndiTopic.md)| The JNDI Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiTopicResponse**](MsgVpnJndiTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Topic object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnMqttRetainCache - -> MsgVpnMqttRetainCacheResponse updateMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select) - -Update an MQTT Retain Cache object. - -Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the MQTT Retain Cache. - MsgVpnMqttRetainCache body = new MsgVpnMqttRetainCache(); // MsgVpnMqttRetainCache | The MQTT Retain Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttRetainCacheResponse result = apiInstance.updateMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnMqttRetainCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the MQTT Retain Cache. | | -| **body** | [**MsgVpnMqttRetainCache**](MsgVpnMqttRetainCache.md)| The MQTT Retain Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttRetainCacheResponse**](MsgVpnMqttRetainCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Retain Cache object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnMqttSession - -> MsgVpnMqttSessionResponse updateMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select) - -Update an MQTT Session object. - -Update an MQTT Session object. Any attribute missing from the request will be left unchanged. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| owner||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - MsgVpnMqttSession body = new MsgVpnMqttSession(); // MsgVpnMqttSession | The MQTT Session object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionResponse result = apiInstance.updateMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnMqttSession"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **body** | [**MsgVpnMqttSession**](MsgVpnMqttSession.md)| The MQTT Session object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionResponse**](MsgVpnMqttSessionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Session object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnMqttSessionSubscription - -> MsgVpnMqttSessionSubscriptionResponse updateMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select) - -Update a Subscription object. - -Update a Subscription object. Any attribute missing from the request will be left unchanged. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - String subscriptionTopic = "subscriptionTopic_example"; // String | The MQTT subscription topic. - MsgVpnMqttSessionSubscription body = new MsgVpnMqttSessionSubscription(); // MsgVpnMqttSessionSubscription | The Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionSubscriptionResponse result = apiInstance.updateMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnMqttSessionSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **subscriptionTopic** | **String**| The MQTT subscription topic. | | -| **body** | [**MsgVpnMqttSessionSubscription**](MsgVpnMqttSessionSubscription.md)| The Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionSubscriptionResponse**](MsgVpnMqttSessionSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscription object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnQueue - -> MsgVpnQueueResponse updateMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select) - -Update a Queue object. - -Update a Queue object. Any attribute missing from the request will be left unchanged. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| queueName|x|x|||| respectMsgPriorityEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - MsgVpnQueue body = new MsgVpnQueue(); // MsgVpnQueue | The Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueResponse result = apiInstance.updateMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **body** | [**MsgVpnQueue**](MsgVpnQueue.md)| The Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueResponse**](MsgVpnQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnQueueTemplate - -> MsgVpnQueueTemplateResponse updateMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select) - -Update a Queue Template object. - -Update a Queue Template object. Any attribute missing from the request will be left unchanged. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueTemplateName = "queueTemplateName_example"; // String | The name of the Queue Template. - MsgVpnQueueTemplate body = new MsgVpnQueueTemplate(); // MsgVpnQueueTemplate | The Queue Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueTemplateResponse result = apiInstance.updateMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnQueueTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueTemplateName** | **String**| The name of the Queue Template. | | -| **body** | [**MsgVpnQueueTemplate**](MsgVpnQueueTemplate.md)| The Queue Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueTemplateResponse**](MsgVpnQueueTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Template object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnReplayLog - -> MsgVpnReplayLogResponse updateMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select) - -Update a Replay Log object. - -Update a Replay Log object. Any attribute missing from the request will be left unchanged. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - MsgVpnReplayLog body = new MsgVpnReplayLog(); // MsgVpnReplayLog | The Replay Log object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogResponse result = apiInstance.updateMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnReplayLog"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **body** | [**MsgVpnReplayLog**](MsgVpnReplayLog.md)| The Replay Log object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogResponse**](MsgVpnReplayLogResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replay Log object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnReplicatedTopic - -> MsgVpnReplicatedTopicResponse updateMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select) - -Update a Replicated Topic object. - -Update a Replicated Topic object. Any attribute missing from the request will be left unchanged. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replicatedTopic = "replicatedTopic_example"; // String | The topic for applying replication. Published messages matching this topic will be replicated to the standby site. - MsgVpnReplicatedTopic body = new MsgVpnReplicatedTopic(); // MsgVpnReplicatedTopic | The Replicated Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplicatedTopicResponse result = apiInstance.updateMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnReplicatedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replicatedTopic** | **String**| The topic for applying replication. Published messages matching this topic will be replicated to the standby site. | | -| **body** | [**MsgVpnReplicatedTopic**](MsgVpnReplicatedTopic.md)| The Replicated Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplicatedTopicResponse**](MsgVpnReplicatedTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replicated Topic object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnRestDeliveryPoint - -> MsgVpnRestDeliveryPointResponse updateMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select) - -Update a REST Delivery Point object. - -Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientProfileName||||x|| msgVpnName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - MsgVpnRestDeliveryPoint body = new MsgVpnRestDeliveryPoint(); // MsgVpnRestDeliveryPoint | The REST Delivery Point object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointResponse result = apiInstance.updateMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnRestDeliveryPoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **body** | [**MsgVpnRestDeliveryPoint**](MsgVpnRestDeliveryPoint.md)| The REST Delivery Point object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointResponse**](MsgVpnRestDeliveryPointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Delivery Point object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnRestDeliveryPointQueueBinding - -> MsgVpnRestDeliveryPointQueueBindingResponse updateMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select) - -Update a Queue Binding object. - -Update a Queue Binding object. Any attribute missing from the request will be left unchanged. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - MsgVpnRestDeliveryPointQueueBinding body = new MsgVpnRestDeliveryPointQueueBinding(); // MsgVpnRestDeliveryPointQueueBinding | The Queue Binding object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingResponse result = apiInstance.updateMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnRestDeliveryPointQueueBinding"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBinding**](MsgVpnRestDeliveryPointQueueBinding.md)| The Queue Binding object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingResponse**](MsgVpnRestDeliveryPointQueueBindingResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Binding object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnRestDeliveryPointQueueBindingRequestHeader - -> MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse updateMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select) - -Update a Request Header object. - -Update a Request Header object. Any attribute missing from the request will be left unchanged. A request header to be added to the HTTP request. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- headerName|x|x|||| msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - String headerName = "headerName_example"; // String | The name of the HTTP request header. - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = new MsgVpnRestDeliveryPointQueueBindingRequestHeader(); // MsgVpnRestDeliveryPointQueueBindingRequestHeader | The Request Header object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse result = apiInstance.updateMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **headerName** | **String**| The name of the HTTP request header. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBindingRequestHeader**](MsgVpnRestDeliveryPointQueueBindingRequestHeader.md)| The Request Header object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse**](MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Request Header object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnRestDeliveryPointRestConsumer - -> MsgVpnRestDeliveryPointRestConsumerResponse updateMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select) - -Update a REST Consumer object. - -Update a REST Consumer object. Any attribute missing from the request will be left unchanged. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey|||x|||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| authenticationHttpBasicPassword|||x|x||x authenticationHttpBasicUsername||||x|| authenticationHttpHeaderValue|||x|||x authenticationOauthClientId||||x|| authenticationOauthClientScope||||x|| authenticationOauthClientSecret|||x|x||x authenticationOauthClientTokenEndpoint||||x|| authenticationOauthJwtSecretKey|||x|x||x authenticationOauthJwtTokenEndpoint||||x|| authenticationScheme||||x|| msgVpnName|x|x|||| outgoingConnectionCount||||x|| remoteHost||||x|| remotePort||||x|| restConsumerName|x|x|||| restDeliveryPointName|x|x|||| tlsCipherSuiteList||||x|| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - MsgVpnRestDeliveryPointRestConsumer body = new MsgVpnRestDeliveryPointRestConsumer(); // MsgVpnRestDeliveryPointRestConsumer | The REST Consumer object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerResponse result = apiInstance.updateMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnRestDeliveryPointRestConsumer"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **body** | [**MsgVpnRestDeliveryPointRestConsumer**](MsgVpnRestDeliveryPointRestConsumer.md)| The REST Consumer object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerResponse**](MsgVpnRestDeliveryPointRestConsumerResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Consumer object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnTopicEndpoint - -> MsgVpnTopicEndpointResponse updateMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select) - -Update a Topic Endpoint object. - -Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| respectMsgPriorityEnabled||||x|| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointName = "topicEndpointName_example"; // String | The name of the Topic Endpoint. - MsgVpnTopicEndpoint body = new MsgVpnTopicEndpoint(); // MsgVpnTopicEndpoint | The Topic Endpoint object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointResponse result = apiInstance.updateMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnTopicEndpoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointName** | **String**| The name of the Topic Endpoint. | | -| **body** | [**MsgVpnTopicEndpoint**](MsgVpnTopicEndpoint.md)| The Topic Endpoint object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointResponse**](MsgVpnTopicEndpointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnTopicEndpointTemplate - -> MsgVpnTopicEndpointTemplateResponse updateMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select) - -Update a Topic Endpoint Template object. - -Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointTemplateName = "topicEndpointTemplateName_example"; // String | The name of the Topic Endpoint Template. - MsgVpnTopicEndpointTemplate body = new MsgVpnTopicEndpointTemplate(); // MsgVpnTopicEndpointTemplate | The Topic Endpoint Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointTemplateResponse result = apiInstance.updateMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateMsgVpnTopicEndpointTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointTemplateName** | **String**| The name of the Topic Endpoint Template. | | -| **body** | [**MsgVpnTopicEndpointTemplate**](MsgVpnTopicEndpointTemplate.md)| The Topic Endpoint Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointTemplateResponse**](MsgVpnTopicEndpointTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint Template object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateOauthProfile - -> OauthProfileResponse updateOauthProfile(oauthProfileName, body, opaquePassword, select) - -Update an OAuth Profile object. - -Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: accessLevelGroupsClaimName|global/admin clientId|global/admin clientRedirectUri|global/admin clientRequiredType|global/admin clientScope|global/admin clientSecret|global/admin clientValidateTypeEnabled|global/admin defaultGlobalAccessLevel|global/admin displayName|global/admin enabled|global/admin endpointAuthorization|global/admin endpointDiscovery|global/admin endpointDiscoveryRefreshInterval|global/admin endpointIntrospection|global/admin endpointIntrospectionTimeout|global/admin endpointJwks|global/admin endpointJwksRefreshInterval|global/admin endpointToken|global/admin endpointTokenTimeout|global/admin endpointUserinfo|global/admin endpointUserinfoTimeout|global/admin interactiveEnabled|global/admin interactivePromptForExpiredSession|global/admin interactivePromptForNewSession|global/admin issuer|global/admin oauthRole|global/admin resourceServerParseAccessTokenEnabled|global/admin resourceServerRequiredAudience|global/admin resourceServerRequiredIssuer|global/admin resourceServerRequiredScope|global/admin resourceServerRequiredType|global/admin resourceServerValidateAudienceEnabled|global/admin resourceServerValidateIssuerEnabled|global/admin resourceServerValidateScopeEnabled|global/admin resourceServerValidateTypeEnabled|global/admin sempEnabled|global/admin usernameClaimName|global/admin This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - OauthProfile body = new OauthProfile(); // OauthProfile | The OAuth Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileResponse result = apiInstance.updateOauthProfile(oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**OauthProfile**](OauthProfile.md)| The OAuth Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileResponse**](OauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateOauthProfileAccessLevelGroup - -> OauthProfileAccessLevelGroupResponse updateOauthProfileAccessLevelGroup(oauthProfileName, groupName, body, opaquePassword, select) - -Update a Group Access Level object. - -Update a Group Access Level object. Any attribute missing from the request will be left unchanged. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- groupName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - OauthProfileAccessLevelGroup body = new OauthProfileAccessLevelGroup(); // OauthProfileAccessLevelGroup | The Group Access Level object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupResponse result = apiInstance.updateOauthProfileAccessLevelGroup(oauthProfileName, groupName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateOauthProfileAccessLevelGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **body** | [**OauthProfileAccessLevelGroup**](OauthProfileAccessLevelGroup.md)| The Group Access Level object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupResponse**](OauthProfileAccessLevelGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Group Access Level object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException - -> OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, body, opaquePassword, select) - -Update a Message VPN Access-Level Exception object. - -Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- groupName|x|x|||| msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - String msgVpnName = "msgVpnName_example"; // String | The name of the message VPN. - OauthProfileAccessLevelGroupMsgVpnAccessLevelException body = new OauthProfileAccessLevelGroupMsgVpnAccessLevelException(); // OauthProfileAccessLevelGroupMsgVpnAccessLevelException | The Message VPN Access-Level Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse result = apiInstance.updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **msgVpnName** | **String**| The name of the message VPN. | | -| **body** | [**OauthProfileAccessLevelGroupMsgVpnAccessLevelException**](OauthProfileAccessLevelGroupMsgVpnAccessLevelException.md)| The Message VPN Access-Level Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse**](OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateOauthProfileClientAuthorizationParameter - -> OauthProfileClientAuthorizationParameterResponse updateOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, body, opaquePassword, select) - -Update an Authorization Parameter object. - -Update an Authorization Parameter object. Any attribute missing from the request will be left unchanged. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authorizationParameterName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String authorizationParameterName = "authorizationParameterName_example"; // String | The name of the authorization parameter. - OauthProfileClientAuthorizationParameter body = new OauthProfileClientAuthorizationParameter(); // OauthProfileClientAuthorizationParameter | The Authorization Parameter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientAuthorizationParameterResponse result = apiInstance.updateOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateOauthProfileClientAuthorizationParameter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **authorizationParameterName** | **String**| The name of the authorization parameter. | | -| **body** | [**OauthProfileClientAuthorizationParameter**](OauthProfileClientAuthorizationParameter.md)| The Authorization Parameter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientAuthorizationParameterResponse**](OauthProfileClientAuthorizationParameterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Parameter object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateOauthProfileDefaultMsgVpnAccessLevelException - -> OauthProfileDefaultMsgVpnAccessLevelExceptionResponse updateOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, body, opaquePassword, select) - -Update a Message VPN Access-Level Exception object. - -Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. Default message VPN access-level exceptions. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String msgVpnName = "msgVpnName_example"; // String | The name of the message VPN. - OauthProfileDefaultMsgVpnAccessLevelException body = new OauthProfileDefaultMsgVpnAccessLevelException(); // OauthProfileDefaultMsgVpnAccessLevelException | The Message VPN Access-Level Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse result = apiInstance.updateOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateOauthProfileDefaultMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **msgVpnName** | **String**| The name of the message VPN. | | -| **body** | [**OauthProfileDefaultMsgVpnAccessLevelException**](OauthProfileDefaultMsgVpnAccessLevelException.md)| The Message VPN Access-Level Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileDefaultMsgVpnAccessLevelExceptionResponse**](OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateVirtualHostname - -> VirtualHostnameResponse updateVirtualHostname(virtualHostname, body, opaquePassword, select) - -Update a Virtual Hostname object. - -Update a Virtual Hostname object. Any attribute missing from the request will be left unchanged. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- virtualHostname|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AllApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AllApi apiInstance = new AllApi(defaultClient); - String virtualHostname = "virtualHostname_example"; // String | The virtual hostname. - VirtualHostname body = new VirtualHostname(); // VirtualHostname | The Virtual Hostname object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - VirtualHostnameResponse result = apiInstance.updateVirtualHostname(virtualHostname, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AllApi#updateVirtualHostname"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **virtualHostname** | **String**| The virtual hostname. | | -| **body** | [**VirtualHostname**](VirtualHostname.md)| The Virtual Hostname object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**VirtualHostnameResponse**](VirtualHostnameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Virtual Hostname object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/AuthenticationOauthProfileApi.md b/service/solace-config-client/docs/AuthenticationOauthProfileApi.md deleted file mode 100644 index 4aac34172..000000000 --- a/service/solace-config-client/docs/AuthenticationOauthProfileApi.md +++ /dev/null @@ -1,1148 +0,0 @@ -# AuthenticationOauthProfileApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnAuthenticationOauthProfile**](AuthenticationOauthProfileApi.md#createMsgVpnAuthenticationOauthProfile) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles | Create an OAuth Profile object. | -| [**createMsgVpnAuthenticationOauthProfileClientRequiredClaim**](AuthenticationOauthProfileApi.md#createMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims | Create a Required Claim object. | -| [**createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](AuthenticationOauthProfileApi.md#createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Create a Required Claim object. | -| [**deleteMsgVpnAuthenticationOauthProfile**](AuthenticationOauthProfileApi.md#deleteMsgVpnAuthenticationOauthProfile) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Delete an OAuth Profile object. | -| [**deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim**](AuthenticationOauthProfileApi.md#deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Delete a Required Claim object. | -| [**deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](AuthenticationOauthProfileApi.md#deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Delete a Required Claim object. | -| [**getMsgVpnAuthenticationOauthProfile**](AuthenticationOauthProfileApi.md#getMsgVpnAuthenticationOauthProfile) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Get an OAuth Profile object. | -| [**getMsgVpnAuthenticationOauthProfileClientRequiredClaim**](AuthenticationOauthProfileApi.md#getMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Get a Required Claim object. | -| [**getMsgVpnAuthenticationOauthProfileClientRequiredClaims**](AuthenticationOauthProfileApi.md#getMsgVpnAuthenticationOauthProfileClientRequiredClaims) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims | Get a list of Required Claim objects. | -| [**getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](AuthenticationOauthProfileApi.md#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Get a Required Claim object. | -| [**getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims**](AuthenticationOauthProfileApi.md#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Get a list of Required Claim objects. | -| [**getMsgVpnAuthenticationOauthProfiles**](AuthenticationOauthProfileApi.md#getMsgVpnAuthenticationOauthProfiles) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles | Get a list of OAuth Profile objects. | -| [**replaceMsgVpnAuthenticationOauthProfile**](AuthenticationOauthProfileApi.md#replaceMsgVpnAuthenticationOauthProfile) | **PUT** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Replace an OAuth Profile object. | -| [**updateMsgVpnAuthenticationOauthProfile**](AuthenticationOauthProfileApi.md#updateMsgVpnAuthenticationOauthProfile) | **PATCH** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Update an OAuth Profile object. | - - - -## createMsgVpnAuthenticationOauthProfile - -> MsgVpnAuthenticationOauthProfileResponse createMsgVpnAuthenticationOauthProfile(msgVpnName, body, opaquePassword, select) - -Create an OAuth Profile object. - -Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x msgVpnName|x||x||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProfileApi apiInstance = new AuthenticationOauthProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnAuthenticationOauthProfile body = new MsgVpnAuthenticationOauthProfile(); // MsgVpnAuthenticationOauthProfile | The OAuth Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResponse result = apiInstance.createMsgVpnAuthenticationOauthProfile(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProfileApi#createMsgVpnAuthenticationOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnAuthenticationOauthProfile**](MsgVpnAuthenticationOauthProfile.md)| The OAuth Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResponse**](MsgVpnAuthenticationOauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAuthenticationOauthProfileClientRequiredClaim - -> MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse createMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select) - -Create a Required Claim object. - -Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| msgVpnName|x||x||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProfileApi apiInstance = new AuthenticationOauthProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - MsgVpnAuthenticationOauthProfileClientRequiredClaim body = new MsgVpnAuthenticationOauthProfileClientRequiredClaim(); // MsgVpnAuthenticationOauthProfileClientRequiredClaim | The Required Claim object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse result = apiInstance.createMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProfileApi#createMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**MsgVpnAuthenticationOauthProfileClientRequiredClaim**](MsgVpnAuthenticationOauthProfileClientRequiredClaim.md)| The Required Claim object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse**](MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - -> MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select) - -Create a Required Claim object. - -Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProfileApi apiInstance = new AuthenticationOauthProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim body = new MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(); // MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim | The Required Claim object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse result = apiInstance.createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProfileApi#createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.md)| The Required Claim object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse**](MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAuthenticationOauthProfile - -> SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName) - -Delete an OAuth Profile object. - -Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProfileApi apiInstance = new AuthenticationOauthProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProfileApi#deleteMsgVpnAuthenticationOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim - -> SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName) - -Delete a Required Claim object. - -Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProfileApi apiInstance = new AuthenticationOauthProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String clientRequiredClaimName = "clientRequiredClaimName_example"; // String | The name of the ID token claim to verify. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProfileApi#deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **clientRequiredClaimName** | **String**| The name of the ID token claim to verify. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - -> SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName) - -Delete a Required Claim object. - -Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProfileApi apiInstance = new AuthenticationOauthProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String resourceServerRequiredClaimName = "resourceServerRequiredClaimName_example"; // String | The name of the access token claim to verify. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProfileApi#deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **resourceServerRequiredClaimName** | **String**| The name of the access token claim to verify. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfile - -> MsgVpnAuthenticationOauthProfileResponse getMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, opaquePassword, select) - -Get an OAuth Profile object. - -Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProfileApi apiInstance = new AuthenticationOauthProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResponse result = apiInstance.getMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProfileApi#getMsgVpnAuthenticationOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResponse**](MsgVpnAuthenticationOauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfileClientRequiredClaim - -> MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse getMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName, opaquePassword, select) - -Get a Required Claim object. - -Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProfileApi apiInstance = new AuthenticationOauthProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String clientRequiredClaimName = "clientRequiredClaimName_example"; // String | The name of the ID token claim to verify. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse result = apiInstance.getMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProfileApi#getMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **clientRequiredClaimName** | **String**| The name of the ID token claim to verify. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse**](MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfileClientRequiredClaims - -> MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse getMsgVpnAuthenticationOauthProfileClientRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Required Claim objects. - -Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProfileApi apiInstance = new AuthenticationOauthProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse result = apiInstance.getMsgVpnAuthenticationOauthProfileClientRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProfileApi#getMsgVpnAuthenticationOauthProfileClientRequiredClaims"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse**](MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Required Claim objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - -> MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select) - -Get a Required Claim object. - -Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProfileApi apiInstance = new AuthenticationOauthProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String resourceServerRequiredClaimName = "resourceServerRequiredClaimName_example"; // String | The name of the access token claim to verify. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse result = apiInstance.getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProfileApi#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **resourceServerRequiredClaimName** | **String**| The name of the access token claim to verify. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse**](MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims - -> MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Required Claim objects. - -Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProfileApi apiInstance = new AuthenticationOauthProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse result = apiInstance.getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProfileApi#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse**](MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Required Claim objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfiles - -> MsgVpnAuthenticationOauthProfilesResponse getMsgVpnAuthenticationOauthProfiles(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of OAuth Profile objects. - -Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProfileApi apiInstance = new AuthenticationOauthProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfilesResponse result = apiInstance.getMsgVpnAuthenticationOauthProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProfileApi#getMsgVpnAuthenticationOauthProfiles"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfilesResponse**](MsgVpnAuthenticationOauthProfilesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of OAuth Profile objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnAuthenticationOauthProfile - -> MsgVpnAuthenticationOauthProfileResponse replaceMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select) - -Replace an OAuth Profile object. - -Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProfileApi apiInstance = new AuthenticationOauthProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - MsgVpnAuthenticationOauthProfile body = new MsgVpnAuthenticationOauthProfile(); // MsgVpnAuthenticationOauthProfile | The OAuth Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResponse result = apiInstance.replaceMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProfileApi#replaceMsgVpnAuthenticationOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**MsgVpnAuthenticationOauthProfile**](MsgVpnAuthenticationOauthProfile.md)| The OAuth Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResponse**](MsgVpnAuthenticationOauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnAuthenticationOauthProfile - -> MsgVpnAuthenticationOauthProfileResponse updateMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select) - -Update an OAuth Profile object. - -Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProfileApi apiInstance = new AuthenticationOauthProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - MsgVpnAuthenticationOauthProfile body = new MsgVpnAuthenticationOauthProfile(); // MsgVpnAuthenticationOauthProfile | The OAuth Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResponse result = apiInstance.updateMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProfileApi#updateMsgVpnAuthenticationOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**MsgVpnAuthenticationOauthProfile**](MsgVpnAuthenticationOauthProfile.md)| The OAuth Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResponse**](MsgVpnAuthenticationOauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/AuthenticationOauthProviderApi.md b/service/solace-config-client/docs/AuthenticationOauthProviderApi.md deleted file mode 100644 index e499d094e..000000000 --- a/service/solace-config-client/docs/AuthenticationOauthProviderApi.md +++ /dev/null @@ -1,492 +0,0 @@ -# AuthenticationOauthProviderApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnAuthenticationOauthProvider**](AuthenticationOauthProviderApi.md#createMsgVpnAuthenticationOauthProvider) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProviders | Create an OAuth Provider object. | -| [**deleteMsgVpnAuthenticationOauthProvider**](AuthenticationOauthProviderApi.md#deleteMsgVpnAuthenticationOauthProvider) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Delete an OAuth Provider object. | -| [**getMsgVpnAuthenticationOauthProvider**](AuthenticationOauthProviderApi.md#getMsgVpnAuthenticationOauthProvider) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Get an OAuth Provider object. | -| [**getMsgVpnAuthenticationOauthProviders**](AuthenticationOauthProviderApi.md#getMsgVpnAuthenticationOauthProviders) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProviders | Get a list of OAuth Provider objects. | -| [**replaceMsgVpnAuthenticationOauthProvider**](AuthenticationOauthProviderApi.md#replaceMsgVpnAuthenticationOauthProvider) | **PUT** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Replace an OAuth Provider object. | -| [**updateMsgVpnAuthenticationOauthProvider**](AuthenticationOauthProviderApi.md#updateMsgVpnAuthenticationOauthProvider) | **PATCH** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Update an OAuth Provider object. | - - - -## createMsgVpnAuthenticationOauthProvider - -> MsgVpnAuthenticationOauthProviderResponse createMsgVpnAuthenticationOauthProvider(msgVpnName, body, opaquePassword, select) - -Create an OAuth Provider object. - -Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x||x||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword||||x|x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProviderApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProviderApi apiInstance = new AuthenticationOauthProviderApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnAuthenticationOauthProvider body = new MsgVpnAuthenticationOauthProvider(); // MsgVpnAuthenticationOauthProvider | The OAuth Provider object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProviderResponse result = apiInstance.createMsgVpnAuthenticationOauthProvider(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProviderApi#createMsgVpnAuthenticationOauthProvider"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnAuthenticationOauthProvider**](MsgVpnAuthenticationOauthProvider.md)| The OAuth Provider object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProviderResponse**](MsgVpnAuthenticationOauthProviderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Provider object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAuthenticationOauthProvider - -> SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName) - -Delete an OAuth Provider object. - -Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProviderApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProviderApi apiInstance = new AuthenticationOauthProviderApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProviderName = "oauthProviderName_example"; // String | The name of the OAuth Provider. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProviderApi#deleteMsgVpnAuthenticationOauthProvider"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProviderName** | **String**| The name of the OAuth Provider. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProvider - -> MsgVpnAuthenticationOauthProviderResponse getMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, opaquePassword, select) - -Get an OAuth Provider object. - -Get an OAuth Provider object. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProviderApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProviderApi apiInstance = new AuthenticationOauthProviderApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProviderName = "oauthProviderName_example"; // String | The name of the OAuth Provider. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProviderResponse result = apiInstance.getMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProviderApi#getMsgVpnAuthenticationOauthProvider"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProviderName** | **String**| The name of the OAuth Provider. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProviderResponse**](MsgVpnAuthenticationOauthProviderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Provider object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProviders - -> MsgVpnAuthenticationOauthProvidersResponse getMsgVpnAuthenticationOauthProviders(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of OAuth Provider objects. - -Get a list of OAuth Provider objects. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProviderApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProviderApi apiInstance = new AuthenticationOauthProviderApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProvidersResponse result = apiInstance.getMsgVpnAuthenticationOauthProviders(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProviderApi#getMsgVpnAuthenticationOauthProviders"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProvidersResponse**](MsgVpnAuthenticationOauthProvidersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of OAuth Provider objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnAuthenticationOauthProvider - -> MsgVpnAuthenticationOauthProviderResponse replaceMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select) - -Replace an OAuth Provider object. - -Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- audienceClaimName||||||x| audienceClaimSource||||||x| audienceClaimValue||||||x| audienceValidationEnabled||||||x| authorizationGroupClaimName||||||x| authorizationGroupClaimSource||||||x| authorizationGroupEnabled||||||x| disconnectOnTokenExpirationEnabled||||||x| enabled||||||x| jwksRefreshInterval||||||x| jwksUri||||||x| msgVpnName|x||x|||x| oauthProviderName|x||x|||x| tokenIgnoreTimeLimitsEnabled||||||x| tokenIntrospectionParameterName||||||x| tokenIntrospectionPassword||||x||x|x tokenIntrospectionTimeout||||||x| tokenIntrospectionUri||||||x| tokenIntrospectionUsername||||||x| usernameClaimName||||||x| usernameClaimSource||||||x| usernameValidateEnabled||||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProviderApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProviderApi apiInstance = new AuthenticationOauthProviderApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProviderName = "oauthProviderName_example"; // String | The name of the OAuth Provider. - MsgVpnAuthenticationOauthProvider body = new MsgVpnAuthenticationOauthProvider(); // MsgVpnAuthenticationOauthProvider | The OAuth Provider object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProviderResponse result = apiInstance.replaceMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProviderApi#replaceMsgVpnAuthenticationOauthProvider"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProviderName** | **String**| The name of the OAuth Provider. | | -| **body** | [**MsgVpnAuthenticationOauthProvider**](MsgVpnAuthenticationOauthProvider.md)| The OAuth Provider object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProviderResponse**](MsgVpnAuthenticationOauthProviderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Provider object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnAuthenticationOauthProvider - -> MsgVpnAuthenticationOauthProviderResponse updateMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select) - -Update an OAuth Provider object. - -Update an OAuth Provider object. Any attribute missing from the request will be left unchanged. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x|x|||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword|||x||x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthenticationOauthProviderApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthenticationOauthProviderApi apiInstance = new AuthenticationOauthProviderApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProviderName = "oauthProviderName_example"; // String | The name of the OAuth Provider. - MsgVpnAuthenticationOauthProvider body = new MsgVpnAuthenticationOauthProvider(); // MsgVpnAuthenticationOauthProvider | The OAuth Provider object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProviderResponse result = apiInstance.updateMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthenticationOauthProviderApi#updateMsgVpnAuthenticationOauthProvider"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProviderName** | **String**| The name of the OAuth Provider. | | -| **body** | [**MsgVpnAuthenticationOauthProvider**](MsgVpnAuthenticationOauthProvider.md)| The OAuth Provider object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProviderResponse**](MsgVpnAuthenticationOauthProviderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Provider object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/AuthorizationGroupApi.md b/service/solace-config-client/docs/AuthorizationGroupApi.md deleted file mode 100644 index 4f8054df1..000000000 --- a/service/solace-config-client/docs/AuthorizationGroupApi.md +++ /dev/null @@ -1,492 +0,0 @@ -# AuthorizationGroupApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnAuthorizationGroup**](AuthorizationGroupApi.md#createMsgVpnAuthorizationGroup) | **POST** /msgVpns/{msgVpnName}/authorizationGroups | Create an Authorization Group object. | -| [**deleteMsgVpnAuthorizationGroup**](AuthorizationGroupApi.md#deleteMsgVpnAuthorizationGroup) | **DELETE** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Delete an Authorization Group object. | -| [**getMsgVpnAuthorizationGroup**](AuthorizationGroupApi.md#getMsgVpnAuthorizationGroup) | **GET** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Get an Authorization Group object. | -| [**getMsgVpnAuthorizationGroups**](AuthorizationGroupApi.md#getMsgVpnAuthorizationGroups) | **GET** /msgVpns/{msgVpnName}/authorizationGroups | Get a list of Authorization Group objects. | -| [**replaceMsgVpnAuthorizationGroup**](AuthorizationGroupApi.md#replaceMsgVpnAuthorizationGroup) | **PUT** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Replace an Authorization Group object. | -| [**updateMsgVpnAuthorizationGroup**](AuthorizationGroupApi.md#updateMsgVpnAuthorizationGroup) | **PATCH** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Update an Authorization Group object. | - - - -## createMsgVpnAuthorizationGroup - -> MsgVpnAuthorizationGroupResponse createMsgVpnAuthorizationGroup(msgVpnName, body, opaquePassword, select) - -Create an Authorization Group object. - -Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationGroupName|x|x|||| msgVpnName|x||x||| orderAfterAuthorizationGroupName||||x|| orderBeforeAuthorizationGroupName||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthorizationGroupApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthorizationGroupApi apiInstance = new AuthorizationGroupApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnAuthorizationGroup body = new MsgVpnAuthorizationGroup(); // MsgVpnAuthorizationGroup | The Authorization Group object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthorizationGroupResponse result = apiInstance.createMsgVpnAuthorizationGroup(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthorizationGroupApi#createMsgVpnAuthorizationGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnAuthorizationGroup**](MsgVpnAuthorizationGroup.md)| The Authorization Group object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthorizationGroupResponse**](MsgVpnAuthorizationGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Group object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAuthorizationGroup - -> SempMetaOnlyResponse deleteMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName) - -Delete an Authorization Group object. - -Delete an Authorization Group object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthorizationGroupApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthorizationGroupApi apiInstance = new AuthorizationGroupApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String authorizationGroupName = "authorizationGroupName_example"; // String | The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthorizationGroupApi#deleteMsgVpnAuthorizationGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **authorizationGroupName** | **String**| The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthorizationGroup - -> MsgVpnAuthorizationGroupResponse getMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, opaquePassword, select) - -Get an Authorization Group object. - -Get an Authorization Group object. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthorizationGroupApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthorizationGroupApi apiInstance = new AuthorizationGroupApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String authorizationGroupName = "authorizationGroupName_example"; // String | The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthorizationGroupResponse result = apiInstance.getMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthorizationGroupApi#getMsgVpnAuthorizationGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **authorizationGroupName** | **String**| The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthorizationGroupResponse**](MsgVpnAuthorizationGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Group object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthorizationGroups - -> MsgVpnAuthorizationGroupsResponse getMsgVpnAuthorizationGroups(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Authorization Group objects. - -Get a list of Authorization Group objects. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthorizationGroupApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthorizationGroupApi apiInstance = new AuthorizationGroupApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthorizationGroupsResponse result = apiInstance.getMsgVpnAuthorizationGroups(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthorizationGroupApi#getMsgVpnAuthorizationGroups"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthorizationGroupsResponse**](MsgVpnAuthorizationGroupsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Authorization Group objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnAuthorizationGroup - -> MsgVpnAuthorizationGroupResponse replaceMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select) - -Replace an Authorization Group object. - -Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| authorizationGroupName|x||x|||| clientProfileName|||||x|| msgVpnName|x||x|||| orderAfterAuthorizationGroupName||||x||| orderBeforeAuthorizationGroupName||||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthorizationGroupApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthorizationGroupApi apiInstance = new AuthorizationGroupApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String authorizationGroupName = "authorizationGroupName_example"; // String | The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. - MsgVpnAuthorizationGroup body = new MsgVpnAuthorizationGroup(); // MsgVpnAuthorizationGroup | The Authorization Group object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthorizationGroupResponse result = apiInstance.replaceMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthorizationGroupApi#replaceMsgVpnAuthorizationGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **authorizationGroupName** | **String**| The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. | | -| **body** | [**MsgVpnAuthorizationGroup**](MsgVpnAuthorizationGroup.md)| The Authorization Group object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthorizationGroupResponse**](MsgVpnAuthorizationGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Group object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnAuthorizationGroup - -> MsgVpnAuthorizationGroupResponse updateMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select) - -Update an Authorization Group object. - -Update an Authorization Group object. Any attribute missing from the request will be left unchanged. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| authorizationGroupName|x|x|||| clientProfileName||||x|| msgVpnName|x|x|||| orderAfterAuthorizationGroupName|||x||| orderBeforeAuthorizationGroupName|||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.AuthorizationGroupApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - AuthorizationGroupApi apiInstance = new AuthorizationGroupApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String authorizationGroupName = "authorizationGroupName_example"; // String | The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. - MsgVpnAuthorizationGroup body = new MsgVpnAuthorizationGroup(); // MsgVpnAuthorizationGroup | The Authorization Group object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthorizationGroupResponse result = apiInstance.updateMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthorizationGroupApi#updateMsgVpnAuthorizationGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **authorizationGroupName** | **String**| The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. | | -| **body** | [**MsgVpnAuthorizationGroup**](MsgVpnAuthorizationGroup.md)| The Authorization Group object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthorizationGroupResponse**](MsgVpnAuthorizationGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Group object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/BridgeApi.md b/service/solace-config-client/docs/BridgeApi.md deleted file mode 100644 index 47abca16c..000000000 --- a/service/solace-config-client/docs/BridgeApi.md +++ /dev/null @@ -1,1688 +0,0 @@ -# BridgeApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnBridge**](BridgeApi.md#createMsgVpnBridge) | **POST** /msgVpns/{msgVpnName}/bridges | Create a Bridge object. | -| [**createMsgVpnBridgeRemoteMsgVpn**](BridgeApi.md#createMsgVpnBridgeRemoteMsgVpn) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns | Create a Remote Message VPN object. | -| [**createMsgVpnBridgeRemoteSubscription**](BridgeApi.md#createMsgVpnBridgeRemoteSubscription) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions | Create a Remote Subscription object. | -| [**createMsgVpnBridgeTlsTrustedCommonName**](BridgeApi.md#createMsgVpnBridgeTlsTrustedCommonName) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames | Create a Trusted Common Name object. | -| [**deleteMsgVpnBridge**](BridgeApi.md#deleteMsgVpnBridge) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Delete a Bridge object. | -| [**deleteMsgVpnBridgeRemoteMsgVpn**](BridgeApi.md#deleteMsgVpnBridgeRemoteMsgVpn) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Delete a Remote Message VPN object. | -| [**deleteMsgVpnBridgeRemoteSubscription**](BridgeApi.md#deleteMsgVpnBridgeRemoteSubscription) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic} | Delete a Remote Subscription object. | -| [**deleteMsgVpnBridgeTlsTrustedCommonName**](BridgeApi.md#deleteMsgVpnBridgeTlsTrustedCommonName) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Delete a Trusted Common Name object. | -| [**getMsgVpnBridge**](BridgeApi.md#getMsgVpnBridge) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Get a Bridge object. | -| [**getMsgVpnBridgeRemoteMsgVpn**](BridgeApi.md#getMsgVpnBridgeRemoteMsgVpn) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Get a Remote Message VPN object. | -| [**getMsgVpnBridgeRemoteMsgVpns**](BridgeApi.md#getMsgVpnBridgeRemoteMsgVpns) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns | Get a list of Remote Message VPN objects. | -| [**getMsgVpnBridgeRemoteSubscription**](BridgeApi.md#getMsgVpnBridgeRemoteSubscription) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic} | Get a Remote Subscription object. | -| [**getMsgVpnBridgeRemoteSubscriptions**](BridgeApi.md#getMsgVpnBridgeRemoteSubscriptions) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions | Get a list of Remote Subscription objects. | -| [**getMsgVpnBridgeTlsTrustedCommonName**](BridgeApi.md#getMsgVpnBridgeTlsTrustedCommonName) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Get a Trusted Common Name object. | -| [**getMsgVpnBridgeTlsTrustedCommonNames**](BridgeApi.md#getMsgVpnBridgeTlsTrustedCommonNames) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames | Get a list of Trusted Common Name objects. | -| [**getMsgVpnBridges**](BridgeApi.md#getMsgVpnBridges) | **GET** /msgVpns/{msgVpnName}/bridges | Get a list of Bridge objects. | -| [**replaceMsgVpnBridge**](BridgeApi.md#replaceMsgVpnBridge) | **PUT** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Replace a Bridge object. | -| [**replaceMsgVpnBridgeRemoteMsgVpn**](BridgeApi.md#replaceMsgVpnBridgeRemoteMsgVpn) | **PUT** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Replace a Remote Message VPN object. | -| [**updateMsgVpnBridge**](BridgeApi.md#updateMsgVpnBridge) | **PATCH** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Update a Bridge object. | -| [**updateMsgVpnBridgeRemoteMsgVpn**](BridgeApi.md#updateMsgVpnBridgeRemoteMsgVpn) | **PATCH** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Update a Remote Message VPN object. | - - - -## createMsgVpnBridge - -> MsgVpnBridgeResponse createMsgVpnBridge(msgVpnName, body, opaquePassword, select) - -Create a Bridge object. - -Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| msgVpnName|x||x||| remoteAuthenticationBasicPassword||||x||x remoteAuthenticationClientCertContent||||x||x remoteAuthenticationClientCertPassword||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnBridge body = new MsgVpnBridge(); // MsgVpnBridge | The Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeResponse result = apiInstance.createMsgVpnBridge(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#createMsgVpnBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnBridge**](MsgVpnBridge.md)| The Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeResponse**](MsgVpnBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Bridge object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnBridgeRemoteMsgVpn - -> MsgVpnBridgeRemoteMsgVpnResponse createMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select) - -Create a Remote Message VPN object. - -Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| msgVpnName|x||x||| password||||x||x remoteMsgVpnInterface|x||||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - MsgVpnBridgeRemoteMsgVpn body = new MsgVpnBridgeRemoteMsgVpn(); // MsgVpnBridgeRemoteMsgVpn | The Remote Message VPN object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteMsgVpnResponse result = apiInstance.createMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#createMsgVpnBridgeRemoteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **body** | [**MsgVpnBridgeRemoteMsgVpn**](MsgVpnBridgeRemoteMsgVpn.md)| The Remote Message VPN object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteMsgVpnResponse**](MsgVpnBridgeRemoteMsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Message VPN object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnBridgeRemoteSubscription - -> MsgVpnBridgeRemoteSubscriptionResponse createMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select) - -Create a Remote Subscription object. - -Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| deliverAlwaysEnabled||x|||| msgVpnName|x||x||| remoteSubscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - MsgVpnBridgeRemoteSubscription body = new MsgVpnBridgeRemoteSubscription(); // MsgVpnBridgeRemoteSubscription | The Remote Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteSubscriptionResponse result = apiInstance.createMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#createMsgVpnBridgeRemoteSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **body** | [**MsgVpnBridgeRemoteSubscription**](MsgVpnBridgeRemoteSubscription.md)| The Remote Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteSubscriptionResponse**](MsgVpnBridgeRemoteSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Subscription object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnBridgeTlsTrustedCommonName - -> MsgVpnBridgeTlsTrustedCommonNameResponse createMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select) - -Create a Trusted Common Name object. - -Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||x| bridgeVirtualRouter|x||x||x| msgVpnName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - MsgVpnBridgeTlsTrustedCommonName body = new MsgVpnBridgeTlsTrustedCommonName(); // MsgVpnBridgeTlsTrustedCommonName | The Trusted Common Name object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeTlsTrustedCommonNameResponse result = apiInstance.createMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#createMsgVpnBridgeTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **body** | [**MsgVpnBridgeTlsTrustedCommonName**](MsgVpnBridgeTlsTrustedCommonName.md)| The Trusted Common Name object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeTlsTrustedCommonNameResponse**](MsgVpnBridgeTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Trusted Common Name object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnBridge - -> SempMetaOnlyResponse deleteMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter) - -Delete a Bridge object. - -Delete a Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#deleteMsgVpnBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnBridgeRemoteMsgVpn - -> SempMetaOnlyResponse deleteMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface) - -Delete a Remote Message VPN object. - -Delete a Remote Message VPN object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteMsgVpnName = "remoteMsgVpnName_example"; // String | The name of the remote Message VPN. - String remoteMsgVpnLocation = "remoteMsgVpnLocation_example"; // String | The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). - String remoteMsgVpnInterface = "remoteMsgVpnInterface_example"; // String | The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#deleteMsgVpnBridgeRemoteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteMsgVpnName** | **String**| The name of the remote Message VPN. | | -| **remoteMsgVpnLocation** | **String**| The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). | | -| **remoteMsgVpnInterface** | **String**| The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnBridgeRemoteSubscription - -> SempMetaOnlyResponse deleteMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic) - -Delete a Remote Subscription object. - -Delete a Remote Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteSubscriptionTopic = "remoteSubscriptionTopic_example"; // String | The topic of the Bridge remote subscription. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#deleteMsgVpnBridgeRemoteSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteSubscriptionTopic** | **String**| The topic of the Bridge remote subscription. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnBridgeTlsTrustedCommonName - -> SempMetaOnlyResponse deleteMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName) - -Delete a Trusted Common Name object. - -Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String tlsTrustedCommonName = "tlsTrustedCommonName_example"; // String | The expected trusted common name of the remote certificate. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#deleteMsgVpnBridgeTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **tlsTrustedCommonName** | **String**| The expected trusted common name of the remote certificate. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridge - -> MsgVpnBridgeResponse getMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, select) - -Get a Bridge object. - -Get a Bridge object. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeResponse result = apiInstance.getMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#getMsgVpnBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeResponse**](MsgVpnBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Bridge object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeRemoteMsgVpn - -> MsgVpnBridgeRemoteMsgVpnResponse getMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, opaquePassword, select) - -Get a Remote Message VPN object. - -Get a Remote Message VPN object. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteMsgVpnName = "remoteMsgVpnName_example"; // String | The name of the remote Message VPN. - String remoteMsgVpnLocation = "remoteMsgVpnLocation_example"; // String | The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). - String remoteMsgVpnInterface = "remoteMsgVpnInterface_example"; // String | The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteMsgVpnResponse result = apiInstance.getMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#getMsgVpnBridgeRemoteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteMsgVpnName** | **String**| The name of the remote Message VPN. | | -| **remoteMsgVpnLocation** | **String**| The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). | | -| **remoteMsgVpnInterface** | **String**| The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteMsgVpnResponse**](MsgVpnBridgeRemoteMsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Message VPN object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeRemoteMsgVpns - -> MsgVpnBridgeRemoteMsgVpnsResponse getMsgVpnBridgeRemoteMsgVpns(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select) - -Get a list of Remote Message VPN objects. - -Get a list of Remote Message VPN objects. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteMsgVpnsResponse result = apiInstance.getMsgVpnBridgeRemoteMsgVpns(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#getMsgVpnBridgeRemoteMsgVpns"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteMsgVpnsResponse**](MsgVpnBridgeRemoteMsgVpnsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Remote Message VPN objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeRemoteSubscription - -> MsgVpnBridgeRemoteSubscriptionResponse getMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic, opaquePassword, select) - -Get a Remote Subscription object. - -Get a Remote Subscription object. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteSubscriptionTopic = "remoteSubscriptionTopic_example"; // String | The topic of the Bridge remote subscription. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteSubscriptionResponse result = apiInstance.getMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#getMsgVpnBridgeRemoteSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteSubscriptionTopic** | **String**| The topic of the Bridge remote subscription. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteSubscriptionResponse**](MsgVpnBridgeRemoteSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Subscription object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeRemoteSubscriptions - -> MsgVpnBridgeRemoteSubscriptionsResponse getMsgVpnBridgeRemoteSubscriptions(msgVpnName, bridgeName, bridgeVirtualRouter, count, cursor, opaquePassword, where, select) - -Get a list of Remote Subscription objects. - -Get a list of Remote Subscription objects. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteSubscriptionsResponse result = apiInstance.getMsgVpnBridgeRemoteSubscriptions(msgVpnName, bridgeName, bridgeVirtualRouter, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#getMsgVpnBridgeRemoteSubscriptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteSubscriptionsResponse**](MsgVpnBridgeRemoteSubscriptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Remote Subscription objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeTlsTrustedCommonName - -> MsgVpnBridgeTlsTrustedCommonNameResponse getMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName, opaquePassword, select) - -Get a Trusted Common Name object. - -Get a Trusted Common Name object. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String tlsTrustedCommonName = "tlsTrustedCommonName_example"; // String | The expected trusted common name of the remote certificate. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeTlsTrustedCommonNameResponse result = apiInstance.getMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#getMsgVpnBridgeTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **tlsTrustedCommonName** | **String**| The expected trusted common name of the remote certificate. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeTlsTrustedCommonNameResponse**](MsgVpnBridgeTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Trusted Common Name object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeTlsTrustedCommonNames - -> MsgVpnBridgeTlsTrustedCommonNamesResponse getMsgVpnBridgeTlsTrustedCommonNames(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select) - -Get a list of Trusted Common Name objects. - -Get a list of Trusted Common Name objects. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeTlsTrustedCommonNamesResponse result = apiInstance.getMsgVpnBridgeTlsTrustedCommonNames(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#getMsgVpnBridgeTlsTrustedCommonNames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeTlsTrustedCommonNamesResponse**](MsgVpnBridgeTlsTrustedCommonNamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Trusted Common Name objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridges - -> MsgVpnBridgesResponse getMsgVpnBridges(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Bridge objects. - -Get a list of Bridge objects. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgesResponse result = apiInstance.getMsgVpnBridges(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#getMsgVpnBridges"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgesResponse**](MsgVpnBridgesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Bridge objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnBridge - -> MsgVpnBridgeResponse replaceMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select) - -Replace a Bridge object. - -Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| maxTtl|||||x|| msgVpnName|x||x|||| remoteAuthenticationBasicClientUsername|||||x|| remoteAuthenticationBasicPassword||||x|x||x remoteAuthenticationClientCertContent||||x|x||x remoteAuthenticationClientCertPassword||||x|x|| remoteAuthenticationScheme|||||x|| remoteDeliverToOnePriority|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - MsgVpnBridge body = new MsgVpnBridge(); // MsgVpnBridge | The Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeResponse result = apiInstance.replaceMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#replaceMsgVpnBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **body** | [**MsgVpnBridge**](MsgVpnBridge.md)| The Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeResponse**](MsgVpnBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Bridge object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnBridgeRemoteMsgVpn - -> MsgVpnBridgeRemoteMsgVpnResponse replaceMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select) - -Replace a Remote Message VPN object. - -Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| clientUsername|||||x|| compressedDataEnabled|||||x|| egressFlowWindowSize|||||x|| msgVpnName|x||x|||| password||||x|x||x remoteMsgVpnInterface|x||x|||| remoteMsgVpnLocation|x||x|||| remoteMsgVpnName|x||x|||| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteMsgVpnName = "remoteMsgVpnName_example"; // String | The name of the remote Message VPN. - String remoteMsgVpnLocation = "remoteMsgVpnLocation_example"; // String | The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). - String remoteMsgVpnInterface = "remoteMsgVpnInterface_example"; // String | The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. - MsgVpnBridgeRemoteMsgVpn body = new MsgVpnBridgeRemoteMsgVpn(); // MsgVpnBridgeRemoteMsgVpn | The Remote Message VPN object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteMsgVpnResponse result = apiInstance.replaceMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#replaceMsgVpnBridgeRemoteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteMsgVpnName** | **String**| The name of the remote Message VPN. | | -| **remoteMsgVpnLocation** | **String**| The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). | | -| **remoteMsgVpnInterface** | **String**| The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. | | -| **body** | [**MsgVpnBridgeRemoteMsgVpn**](MsgVpnBridgeRemoteMsgVpn.md)| The Remote Message VPN object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteMsgVpnResponse**](MsgVpnBridgeRemoteMsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Message VPN object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnBridge - -> MsgVpnBridgeResponse updateMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select) - -Update a Bridge object. - -Update a Bridge object. Any attribute missing from the request will be left unchanged. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| maxTtl||||x|| msgVpnName|x|x|||| remoteAuthenticationBasicClientUsername||||x|| remoteAuthenticationBasicPassword|||x|x||x remoteAuthenticationClientCertContent|||x|x||x remoteAuthenticationClientCertPassword|||x|x|| remoteAuthenticationScheme||||x|| remoteDeliverToOnePriority||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - MsgVpnBridge body = new MsgVpnBridge(); // MsgVpnBridge | The Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeResponse result = apiInstance.updateMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#updateMsgVpnBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **body** | [**MsgVpnBridge**](MsgVpnBridge.md)| The Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeResponse**](MsgVpnBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Bridge object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnBridgeRemoteMsgVpn - -> MsgVpnBridgeRemoteMsgVpnResponse updateMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select) - -Update a Remote Message VPN object. - -Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| clientUsername||||x|| compressedDataEnabled||||x|| egressFlowWindowSize||||x|| msgVpnName|x|x|||| password|||x|x||x remoteMsgVpnInterface|x|x|||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.BridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - BridgeApi apiInstance = new BridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteMsgVpnName = "remoteMsgVpnName_example"; // String | The name of the remote Message VPN. - String remoteMsgVpnLocation = "remoteMsgVpnLocation_example"; // String | The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). - String remoteMsgVpnInterface = "remoteMsgVpnInterface_example"; // String | The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. - MsgVpnBridgeRemoteMsgVpn body = new MsgVpnBridgeRemoteMsgVpn(); // MsgVpnBridgeRemoteMsgVpn | The Remote Message VPN object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteMsgVpnResponse result = apiInstance.updateMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling BridgeApi#updateMsgVpnBridgeRemoteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteMsgVpnName** | **String**| The name of the remote Message VPN. | | -| **remoteMsgVpnLocation** | **String**| The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). | | -| **remoteMsgVpnInterface** | **String**| The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. | | -| **body** | [**MsgVpnBridgeRemoteMsgVpn**](MsgVpnBridgeRemoteMsgVpn.md)| The Remote Message VPN object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteMsgVpnResponse**](MsgVpnBridgeRemoteMsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Message VPN object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/Broker.md b/service/solace-config-client/docs/Broker.md deleted file mode 100644 index a677a8c7c..000000000 --- a/service/solace-config-client/docs/Broker.md +++ /dev/null @@ -1,116 +0,0 @@ - - -# Broker - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**authClientCertRevocationCheckMode** | [**AuthClientCertRevocationCheckModeEnum**](#AuthClientCertRevocationCheckModeEnum) | The client certificate revocation checking mode used when a client authenticates with a client certificate. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - Do not perform any certificate revocation checking. \"ocsp\" - Use the Open Certificate Status Protcol (OCSP) for certificate revocation checking. \"crl\" - Use Certificate Revocation Lists (CRL) for certificate revocation checking. \"ocsp-crl\" - Use OCSP first, but if OCSP fails to return an unambiguous result, then check via CRL. </pre> | [optional] | -|**configSyncAuthenticationClientCertMaxChainDepth** | **Long** | The maximum depth for a client certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. The default value is `3`. Available since 2.22. | [optional] | -|**configSyncAuthenticationClientCertValidateDateEnabled** | **Boolean** | Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the authentication certificate(s). The default value is `true`. Available since 2.22. | [optional] | -|**configSyncClientProfileTcpInitialCongestionWindow** | **Long** | The TCP initial congestion window size for Config Sync clients, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. The default value is `2`. Available since 2.22. | [optional] | -|**configSyncClientProfileTcpKeepaliveCount** | **Long** | The number of TCP keepalive retransmissions to a client using the Client Profile before declaring that it is not available. The default value is `5`. Available since 2.22. | [optional] | -|**configSyncClientProfileTcpKeepaliveIdle** | **Long** | The amount of time a client connection using the Client Profile must remain idle before TCP begins sending keepalive probes, in seconds. The default value is `3`. Available since 2.22. | [optional] | -|**configSyncClientProfileTcpKeepaliveInterval** | **Long** | The amount of time between TCP keepalive retransmissions to a client using the Client Profile when no acknowledgement is received, in seconds. The default value is `1`. Available since 2.22. | [optional] | -|**configSyncClientProfileTcpMaxWindow** | **Long** | The TCP maximum window size for clients using the Client Profile, in kilobytes. Changes are applied to all existing connections. The default value is `256`. Available since 2.22. | [optional] | -|**configSyncClientProfileTcpMss** | **Long** | The TCP maximum segment size for clients using the Client Profile, in bytes. Changes are applied to all existing connections. The default value is `1460`. Available since 2.22. | [optional] | -|**configSyncEnabled** | **Boolean** | Enable or disable configuration synchronization for High Availability or Disaster Recovery. The default value is `false`. Available since 2.22. | [optional] | -|**configSyncSynchronizeUsernameEnabled** | **Boolean** | Enable or disable the synchronizing of usernames within High Availability groups. The transition from not synchronizing to synchronizing will cause the High Availability mate to fall out of sync. Recommendation: leave this as enabled. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.22. | [optional] | -|**configSyncTlsEnabled** | **Boolean** | Enable or disable the use of TLS encryption of the configuration synchronization communications between brokers in High Availability groups and/or Disaster Recovery sites. The default value is `false`. Available since 2.22. | [optional] | -|**guaranteedMsgingDefragmentationScheduleDayList** | **String** | The days of the week to schedule defragmentation runs, specified as \"daily\" or as a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri, or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. Please note \"Sun,Mon,Tue,Wed,Thu,Fri,Sat\" is not allowed, use \"daily\" instead. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"daily\"`. Available since 2.25. | [optional] | -|**guaranteedMsgingDefragmentationScheduleEnabled** | **Boolean** | Enable or disable schedule-based defragmentation of Guaranteed Messaging spool files. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.25. | [optional] | -|**guaranteedMsgingDefragmentationScheduleTimeList** | **String** | The times of the day to schedule defragmentation runs, specified as \"hourly\" or as a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"0:00\"`. Available since 2.25. | [optional] | -|**guaranteedMsgingDefragmentationThresholdEnabled** | **Boolean** | Enable or disable threshold-based defragmentation of Guaranteed Messaging spool files. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.25. | [optional] | -|**guaranteedMsgingDefragmentationThresholdFragmentationPercentage** | **Long** | Percentage of spool fragmentation needed to trigger defragmentation run. The minimum value allowed is 30%. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `50`. Available since 2.25. | [optional] | -|**guaranteedMsgingDefragmentationThresholdMinInterval** | **Long** | Minimum interval of time (in minutes) between defragmentation runs triggered by thresholds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `15`. Available since 2.25. | [optional] | -|**guaranteedMsgingDefragmentationThresholdUsagePercentage** | **Long** | Percentage of spool usage needed to trigger defragmentation run. The minimum value allowed is 30%. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `50`. Available since 2.25. | [optional] | -|**guaranteedMsgingEnabled** | **Boolean** | Enable or disable Guaranteed Messaging. The default value is `false`. Available since 2.18. | [optional] | -|**guaranteedMsgingEventCacheUsageThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**guaranteedMsgingEventDeliveredUnackedThreshold** | [**EventThresholdByPercent**](EventThresholdByPercent.md) | | [optional] | -|**guaranteedMsgingEventDiskUsageThreshold** | [**EventThresholdByPercent**](EventThresholdByPercent.md) | | [optional] | -|**guaranteedMsgingEventEgressFlowCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**guaranteedMsgingEventEndpointCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**guaranteedMsgingEventIngressFlowCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**guaranteedMsgingEventMsgCountThreshold** | [**EventThresholdByPercent**](EventThresholdByPercent.md) | | [optional] | -|**guaranteedMsgingEventMsgSpoolFileCountThreshold** | [**EventThresholdByPercent**](EventThresholdByPercent.md) | | [optional] | -|**guaranteedMsgingEventMsgSpoolUsageThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**guaranteedMsgingEventTransactedSessionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**guaranteedMsgingEventTransactedSessionResourceCountThreshold** | [**EventThresholdByPercent**](EventThresholdByPercent.md) | | [optional] | -|**guaranteedMsgingEventTransactionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**guaranteedMsgingMaxCacheUsage** | **Integer** | Guaranteed messaging cache usage limit. Expressed as a maximum percentage of the NAB's egress queueing. resources that the guaranteed message cache is allowed to use. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `10`. Available since 2.18. | [optional] | -|**guaranteedMsgingMaxMsgSpoolUsage** | **Long** | The maximum total message spool usage allowed across all VPNs on this broker, in megabytes. Recommendation: the maximum value should be less than 90% of the disk space allocated for the guaranteed message spool. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1500`. Available since 2.18. | [optional] | -|**guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout** | **Long** | The maximum time, in milliseconds, that can be tolerated for remote acknowledgement of synchronization messages before which the remote system will be considered out of sync. The default value is `10000`. Available since 2.18. | [optional] | -|**guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout** | **Long** | The maximum time, in milliseconds, that can be tolerated for remote disk writes before which the remote system will be considered out of sync. The default value is `10000`. Available since 2.18. | [optional] | -|**guaranteedMsgingTransactionReplicationCompatibilityMode** | [**GuaranteedMsgingTransactionReplicationCompatibilityModeEnum**](#GuaranteedMsgingTransactionReplicationCompatibilityModeEnum) | The replication compatibility mode for the router. The default value is `\"legacy\"`. The allowed values and their meaning are:\"legacy\" - All transactions originated by clients are replicated to the standby site without using transactions.\"transacted\" - All transactions originated by clients are replicated to the standby site using transactions. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"legacy\"`. The allowed values and their meaning are: <pre> \"legacy\" - All transactions originated by clients are replicated to the standby site without using transactions. \"transacted\" - All transactions originated by clients are replicated to the standby site using transactions. </pre> Available since 2.18. | [optional] | -|**oauthProfileDefault** | **String** | The default OAuth profile for OAuth authenticated SEMP requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Available since 2.24. | [optional] | -|**serviceAmqpEnabled** | **Boolean** | Enable or disable the AMQP service. When disabled new AMQP Clients may not connect through the global or per-VPN AMQP listen-ports, and all currently connected AMQP Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17. | [optional] | -|**serviceAmqpTlsListenPort** | **Long** | TCP port number that AMQP clients can use to connect to the broker using raw TCP over TLS. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since 2.17. | [optional] | -|**serviceEventConnectionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**serviceHealthCheckEnabled** | **Boolean** | Enable or disable the health-check service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17. | [optional] | -|**serviceHealthCheckListenPort** | **Long** | The port number for the health-check service. The port must be unique across the message backbone. The health-check service must be disabled to change the port. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5550`. Available since 2.17. | [optional] | -|**serviceMateLinkEnabled** | **Boolean** | Enable or disable the mate-link service. The default value is `true`. Available since 2.17. | [optional] | -|**serviceMateLinkListenPort** | **Long** | The port number for the mate-link service. The port must be unique across the message backbone. The mate-link service must be disabled to change the port. The default value is `8741`. Available since 2.17. | [optional] | -|**serviceMqttEnabled** | **Boolean** | Enable or disable the MQTT service. When disabled new MQTT Clients may not connect through the per-VPN MQTT listen-ports, and all currently connected MQTT Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17. | [optional] | -|**serviceMsgBackboneEnabled** | **Boolean** | Enable or disable the msg-backbone service. When disabled new Clients may not connect through global or per-VPN listen-ports, and all currently connected Clients are immediately disconnected. The default value is `true`. Available since 2.17. | [optional] | -|**serviceRedundancyEnabled** | **Boolean** | Enable or disable the redundancy service. The default value is `true`. Available since 2.17. | [optional] | -|**serviceRedundancyFirstListenPort** | **Long** | The first listen-port used for the redundancy service. Redundancy uses this port and the subsequent 2 ports. These port must be unique across the message backbone. The redundancy service must be disabled to change this port. The default value is `8300`. Available since 2.17. | [optional] | -|**serviceRestEventOutgoingConnectionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**serviceRestIncomingEnabled** | **Boolean** | Enable or disable the REST service incoming connections on the router. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17. | [optional] | -|**serviceRestOutgoingEnabled** | **Boolean** | Enable or disable the REST service outgoing connections on the router. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17. | [optional] | -|**serviceSempCorsAllowAnyHostEnabled** | **Boolean** | Enable or disable cross origin resource requests for the SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.24. | [optional] | -|**serviceSempLegacyTimeoutEnabled** | **Boolean** | Enable or disable extended SEMP timeouts for paged GETs. When a request times out, it returns the current page of content, even if the page is not full. When enabled, the timeout is 60 seconds. When disabled, the timeout is 5 seconds. The recommended setting is disabled (no legacy-timeout). This parameter is intended as a temporary workaround to be used until SEMP clients can handle short pages. This setting will be removed in a future release. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.18. | [optional] | -|**serviceSempPlainTextEnabled** | **Boolean** | Enable or disable plain-text SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.17. | [optional] | -|**serviceSempPlainTextListenPort** | **Long** | The TCP port for plain-text SEMP client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `80`. Available since 2.17. | [optional] | -|**serviceSempSessionIdleTimeout** | **Integer** | The session idle timeout, in minutes. Sessions will be invalidated if there is no activity in this period of time. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `15`. Available since 2.21. | [optional] | -|**serviceSempSessionMaxLifetime** | **Integer** | The maximum lifetime of a session, in minutes. Sessions will be invalidated after this period of time, regardless of activity. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `43200`. Available since 2.21. | [optional] | -|**serviceSempTlsEnabled** | **Boolean** | Enable or disable TLS SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.17. | [optional] | -|**serviceSempTlsListenPort** | **Long** | The TCP port for TLS SEMP client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1943`. Available since 2.17. | [optional] | -|**serviceSmfCompressionListenPort** | **Long** | TCP port number that SMF clients can use to connect to the broker using raw compression TCP. The default value is `55003`. Available since 2.17. | [optional] | -|**serviceSmfEnabled** | **Boolean** | Enable or disable the SMF service. When disabled new SMF Clients may not connect through the global listen-ports, and all currently connected SMF Clients are immediately disconnected. The default value is `true`. Available since 2.17. | [optional] | -|**serviceSmfEventConnectionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**serviceSmfPlainTextListenPort** | **Long** | TCP port number that SMF clients can use to connect to the broker using raw TCP. The default value is `55555`. Available since 2.17. | [optional] | -|**serviceSmfRoutingControlListenPort** | **Long** | TCP port number that SMF clients can use to connect to the broker using raw routing control TCP. The default value is `55556`. Available since 2.17. | [optional] | -|**serviceSmfTlsListenPort** | **Long** | TCP port number that SMF clients can use to connect to the broker using raw TCP over TLS. The default value is `55443`. Available since 2.17. | [optional] | -|**serviceTlsEventConnectionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**serviceWebTransportEnabled** | **Boolean** | Enable or disable the web-transport service. When disabled new web-transport Clients may not connect through the global listen-ports, and all currently connected web-transport Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17. | [optional] | -|**serviceWebTransportPlainTextListenPort** | **Long** | The TCP port for plain-text WEB client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `8008`. Available since 2.17. | [optional] | -|**serviceWebTransportTlsListenPort** | **Long** | The TCP port for TLS WEB client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1443`. Available since 2.17. | [optional] | -|**serviceWebTransportWebUrlSuffix** | **String** | Used to specify the Web URL suffix that will be used by Web clients when communicating with the broker. The default value is `\"\"`. Available since 2.17. | [optional] | -|**tlsBlockVersion11Enabled** | **Boolean** | Enable or disable the blocking of TLS version 1.1 connections. When blocked, all existing incoming and outgoing TLS 1.1 connections with Clients, SEMP users, and LDAP servers remain connected while new connections are blocked. Note that support for TLS 1.1 will eventually be discontinued, at which time TLS 1.1 connections will be blocked regardless of this setting. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. | [optional] | -|**tlsCipherSuiteManagementList** | **String** | The colon-separated list of cipher suites used for TLS management connections (e.g. SEMP, LDAP). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`. | [optional] | -|**tlsCipherSuiteMsgBackboneList** | **String** | The colon-separated list of cipher suites used for TLS data connections (e.g. client pub/sub). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`. | [optional] | -|**tlsCipherSuiteSecureShellList** | **String** | The colon-separated list of cipher suites used for TLS secure shell connections (e.g. SSH, SFTP, SCP). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`. | [optional] | -|**tlsCrimeExploitProtectionEnabled** | **Boolean** | Enable or disable protection against the CRIME exploit. When enabled, TLS+compressed messaging performance is degraded. This protection should only be disabled if sufficient ACL and authentication features are being employed such that a potential attacker does not have sufficient access to trigger the exploit. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. | [optional] | -|**tlsServerCertContent** | **String** | The PEM formatted content for the server certificate used for TLS connections. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. | [optional] | -|**tlsServerCertPassword** | **String** | The password for the server certificate used for TLS connections. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. | [optional] | -|**tlsStandardDomainCertificateAuthoritiesEnabled** | **Boolean** | Enable or disable the standard domain certificate authority list. The default value is `true`. Available since 2.19. | [optional] | -|**tlsTicketLifetime** | **Integer** | The TLS ticket lifetime in seconds. When a client connects with TLS, a session with a session ticket is created using the TLS ticket lifetime which determines how long the client has to resume the session. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`. | [optional] | -|**webManagerAllowUnencryptedWizardsEnabled** | **Boolean** | Enable or disable the use of unencrypted wizards in the Web-based Manager UI. This setting should be left at its default on all production systems or other systems that need to be secure. Enabling this option will permit the broker to forward plain-text data to other brokers, making important information or credentials available for snooping. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.28. | [optional] | -|**webManagerCustomization** | **String** | Reserved for internal use by Solace. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Available since 2.25. | [optional] | -|**webManagerRedirectHttpEnabled** | **Boolean** | Enable or disable redirection of HTTP requests for the broker manager to HTTPS. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.24. | [optional] | -|**webManagerRedirectHttpOverrideTlsPort** | **Integer** | The HTTPS port that HTTP requests will be redirected towards in a HTTP 301 redirect response. Zero is a special value that means use the value specified for the SEMP TLS port value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since 2.24. | [optional] | - - - -## Enum: AuthClientCertRevocationCheckModeEnum - -| Name | Value | -|---- | -----| -| NONE | "none" | -| OCSP | "ocsp" | -| CRL | "crl" | -| OCSP_CRL | "ocsp-crl" | - - - -## Enum: GuaranteedMsgingTransactionReplicationCompatibilityModeEnum - -| Name | Value | -|---- | -----| -| LEGACY | "legacy" | -| TRANSACTED | "transacted" | - - - diff --git a/service/solace-config-client/docs/BrokerLinks.md b/service/solace-config-client/docs/BrokerLinks.md deleted file mode 100644 index 5e3d530a7..000000000 --- a/service/solace-config-client/docs/BrokerLinks.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# BrokerLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**aboutUri** | **String** | The URI of this Broker's About object. | [optional] | -|**certAuthoritiesUri** | **String** | The URI of this Broker's collection of Certificate Authority objects. Deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. | [optional] | -|**clientCertAuthoritiesUri** | **String** | The URI of this Broker's collection of Client Certificate Authority objects. Available since 2.19. | [optional] | -|**dmrClustersUri** | **String** | The URI of this Broker's collection of Cluster objects. Available since 2.11. | [optional] | -|**domainCertAuthoritiesUri** | **String** | The URI of this Broker's collection of Domain Certificate Authority objects. Available since 2.19. | [optional] | -|**msgVpnsUri** | **String** | The URI of this Broker's collection of Message VPN objects. Available since 2.0. | [optional] | -|**oauthProfilesUri** | **String** | The URI of this Broker's collection of OAuth Profile objects. Available since 2.24. | [optional] | -|**systemInformationUri** | **String** | The URI of this Broker's System Information object. Deprecated since 2.2. /systemInformation was replaced by /about/api. | [optional] | -|**uri** | **String** | The URI of this Broker object. | [optional] | -|**virtualHostnamesUri** | **String** | The URI of this Broker's collection of Virtual Hostname objects. Available since 2.17. | [optional] | - - - diff --git a/service/solace-config-client/docs/BrokerResponse.md b/service/solace-config-client/docs/BrokerResponse.md deleted file mode 100644 index 43c18af7b..000000000 --- a/service/solace-config-client/docs/BrokerResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# BrokerResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**Broker**](Broker.md) | | [optional] | -|**links** | [**BrokerLinks**](BrokerLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/CertAuthoritiesResponse.md b/service/solace-config-client/docs/CertAuthoritiesResponse.md deleted file mode 100644 index c6dec2bb7..000000000 --- a/service/solace-config-client/docs/CertAuthoritiesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# CertAuthoritiesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<CertAuthority>**](CertAuthority.md) | | [optional] | -|**links** | [**List<CertAuthorityLinks>**](CertAuthorityLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/CertAuthority.md b/service/solace-config-client/docs/CertAuthority.md deleted file mode 100644 index 299dfe404..000000000 --- a/service/solace-config-client/docs/CertAuthority.md +++ /dev/null @@ -1,21 +0,0 @@ - - -# CertAuthority - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**certAuthorityName** | **String** | The name of the Certificate Authority. Deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. | [optional] | -|**certContent** | **String** | The PEM formatted content for the trusted root certificate of a Certificate Authority. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. | [optional] | -|**crlDayList** | **String** | The scheduled CRL refresh day(s), specified as \"daily\" or a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"daily\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. | [optional] | -|**crlTimeList** | **String** | The scheduled CRL refresh time(s), specified as \"hourly\" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times must be in sorted order from 0:00 to 23:59. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"3:00\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. | [optional] | -|**crlUrl** | **String** | The URL for the CRL source. This is a required attribute for CRL to be operational and the URL must be complete with http:// included. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. | [optional] | -|**ocspNonResponderCertEnabled** | **Boolean** | Enable or disable allowing a non-responder certificate to sign an OCSP response. Typically used with an OCSP override URL in cases where a single certificate is used to sign client certificates and OCSP responses. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. | [optional] | -|**ocspOverrideUrl** | **String** | The OCSP responder URL to use for overriding the one supplied in the client certificate. The URL must be complete with http:// included. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. | [optional] | -|**ocspTimeout** | **Long** | The timeout in seconds to receive a response from the OCSP responder after sending a request or making the initial connection attempt. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. | [optional] | -|**revocationCheckEnabled** | **Boolean** | Enable or disable Certificate Authority revocation checking. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. | [optional] | - - - diff --git a/service/solace-config-client/docs/CertAuthorityApi.md b/service/solace-config-client/docs/CertAuthorityApi.md deleted file mode 100644 index 1c2247411..000000000 --- a/service/solace-config-client/docs/CertAuthorityApi.md +++ /dev/null @@ -1,796 +0,0 @@ -# CertAuthorityApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createCertAuthority**](CertAuthorityApi.md#createCertAuthority) | **POST** /certAuthorities | Create a Certificate Authority object. | -| [**createCertAuthorityOcspTlsTrustedCommonName**](CertAuthorityApi.md#createCertAuthorityOcspTlsTrustedCommonName) | **POST** /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames | Create an OCSP Responder Trusted Common Name object. | -| [**deleteCertAuthority**](CertAuthorityApi.md#deleteCertAuthority) | **DELETE** /certAuthorities/{certAuthorityName} | Delete a Certificate Authority object. | -| [**deleteCertAuthorityOcspTlsTrustedCommonName**](CertAuthorityApi.md#deleteCertAuthorityOcspTlsTrustedCommonName) | **DELETE** /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName} | Delete an OCSP Responder Trusted Common Name object. | -| [**getCertAuthorities**](CertAuthorityApi.md#getCertAuthorities) | **GET** /certAuthorities | Get a list of Certificate Authority objects. | -| [**getCertAuthority**](CertAuthorityApi.md#getCertAuthority) | **GET** /certAuthorities/{certAuthorityName} | Get a Certificate Authority object. | -| [**getCertAuthorityOcspTlsTrustedCommonName**](CertAuthorityApi.md#getCertAuthorityOcspTlsTrustedCommonName) | **GET** /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName} | Get an OCSP Responder Trusted Common Name object. | -| [**getCertAuthorityOcspTlsTrustedCommonNames**](CertAuthorityApi.md#getCertAuthorityOcspTlsTrustedCommonNames) | **GET** /certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames | Get a list of OCSP Responder Trusted Common Name objects. | -| [**replaceCertAuthority**](CertAuthorityApi.md#replaceCertAuthority) | **PUT** /certAuthorities/{certAuthorityName} | Replace a Certificate Authority object. | -| [**updateCertAuthority**](CertAuthorityApi.md#updateCertAuthority) | **PATCH** /certAuthorities/{certAuthorityName} | Update a Certificate Authority object. | - - - -## createCertAuthority - -> CertAuthorityResponse createCertAuthority(body, opaquePassword, select) - -Create a Certificate Authority object. - -Create a Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||x| certContent|||||x| crlDayList|||||x| crlTimeList|||||x| crlUrl|||||x| ocspNonResponderCertEnabled|||||x| ocspOverrideUrl|||||x| ocspTimeout|||||x| revocationCheckEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertAuthorityApi apiInstance = new CertAuthorityApi(defaultClient); - CertAuthority body = new CertAuthority(); // CertAuthority | The Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - CertAuthorityResponse result = apiInstance.createCertAuthority(body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertAuthorityApi#createCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **body** | [**CertAuthority**](CertAuthority.md)| The Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**CertAuthorityResponse**](CertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Authority object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createCertAuthorityOcspTlsTrustedCommonName - -> CertAuthorityOcspTlsTrustedCommonNameResponse createCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, body, opaquePassword, select) - -Create an OCSP Responder Trusted Common Name object. - -Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x||x||x| ocspTlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertAuthorityApi apiInstance = new CertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - CertAuthorityOcspTlsTrustedCommonName body = new CertAuthorityOcspTlsTrustedCommonName(); // CertAuthorityOcspTlsTrustedCommonName | The OCSP Responder Trusted Common Name object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - CertAuthorityOcspTlsTrustedCommonNameResponse result = apiInstance.createCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertAuthorityApi#createCertAuthorityOcspTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **body** | [**CertAuthorityOcspTlsTrustedCommonName**](CertAuthorityOcspTlsTrustedCommonName.md)| The OCSP Responder Trusted Common Name object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**CertAuthorityOcspTlsTrustedCommonNameResponse**](CertAuthorityOcspTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteCertAuthority - -> SempMetaOnlyResponse deleteCertAuthority(certAuthorityName) - -Delete a Certificate Authority object. - -Delete a Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertAuthorityApi apiInstance = new CertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - try { - SempMetaOnlyResponse result = apiInstance.deleteCertAuthority(certAuthorityName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertAuthorityApi#deleteCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteCertAuthorityOcspTlsTrustedCommonName - -> SempMetaOnlyResponse deleteCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName) - -Delete an OCSP Responder Trusted Common Name object. - -Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertAuthorityApi apiInstance = new CertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String ocspTlsTrustedCommonName = "ocspTlsTrustedCommonName_example"; // String | The expected Trusted Common Name of the OCSP responder remote certificate. - try { - SempMetaOnlyResponse result = apiInstance.deleteCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertAuthorityApi#deleteCertAuthorityOcspTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **ocspTlsTrustedCommonName** | **String**| The expected Trusted Common Name of the OCSP responder remote certificate. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getCertAuthorities - -> CertAuthoritiesResponse getCertAuthorities(count, cursor, opaquePassword, where, select) - -Get a list of Certificate Authority objects. - -Get a list of Certificate Authority objects. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| certContent|||x| crlDayList|||x| crlTimeList|||x| crlUrl|||x| ocspNonResponderCertEnabled|||x| ocspOverrideUrl|||x| ocspTimeout|||x| revocationCheckEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertAuthorityApi apiInstance = new CertAuthorityApi(defaultClient); - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - CertAuthoritiesResponse result = apiInstance.getCertAuthorities(count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertAuthorityApi#getCertAuthorities"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**CertAuthoritiesResponse**](CertAuthoritiesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Authority objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getCertAuthority - -> CertAuthorityResponse getCertAuthority(certAuthorityName, opaquePassword, select) - -Get a Certificate Authority object. - -Get a Certificate Authority object. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| certContent|||x| crlDayList|||x| crlTimeList|||x| crlUrl|||x| ocspNonResponderCertEnabled|||x| ocspOverrideUrl|||x| ocspTimeout|||x| revocationCheckEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertAuthorityApi apiInstance = new CertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - CertAuthorityResponse result = apiInstance.getCertAuthority(certAuthorityName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertAuthorityApi#getCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**CertAuthorityResponse**](CertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Authority object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getCertAuthorityOcspTlsTrustedCommonName - -> CertAuthorityOcspTlsTrustedCommonNameResponse getCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName, opaquePassword, select) - -Get an OCSP Responder Trusted Common Name object. - -Get an OCSP Responder Trusted Common Name object. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| ocspTlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertAuthorityApi apiInstance = new CertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String ocspTlsTrustedCommonName = "ocspTlsTrustedCommonName_example"; // String | The expected Trusted Common Name of the OCSP responder remote certificate. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - CertAuthorityOcspTlsTrustedCommonNameResponse result = apiInstance.getCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertAuthorityApi#getCertAuthorityOcspTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **ocspTlsTrustedCommonName** | **String**| The expected Trusted Common Name of the OCSP responder remote certificate. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**CertAuthorityOcspTlsTrustedCommonNameResponse**](CertAuthorityOcspTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OCSP Responder Trusted Common Name object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getCertAuthorityOcspTlsTrustedCommonNames - -> CertAuthorityOcspTlsTrustedCommonNamesResponse getCertAuthorityOcspTlsTrustedCommonNames(certAuthorityName, opaquePassword, where, select) - -Get a list of OCSP Responder Trusted Common Name objects. - -Get a list of OCSP Responder Trusted Common Name objects. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| ocspTlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertAuthorityApi apiInstance = new CertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - CertAuthorityOcspTlsTrustedCommonNamesResponse result = apiInstance.getCertAuthorityOcspTlsTrustedCommonNames(certAuthorityName, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertAuthorityApi#getCertAuthorityOcspTlsTrustedCommonNames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**CertAuthorityOcspTlsTrustedCommonNamesResponse**](CertAuthorityOcspTlsTrustedCommonNamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceCertAuthority - -> CertAuthorityResponse replaceCertAuthority(certAuthorityName, body, opaquePassword, select) - -Replace a Certificate Authority object. - -Replace a Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||x| certContent||||||x| crlDayList||||||x| crlTimeList||||||x| crlUrl|||||x|x| ocspNonResponderCertEnabled||||||x| ocspOverrideUrl||||||x| ocspTimeout||||||x| revocationCheckEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertAuthorityApi apiInstance = new CertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - CertAuthority body = new CertAuthority(); // CertAuthority | The Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - CertAuthorityResponse result = apiInstance.replaceCertAuthority(certAuthorityName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertAuthorityApi#replaceCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **body** | [**CertAuthority**](CertAuthority.md)| The Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**CertAuthorityResponse**](CertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Authority object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateCertAuthority - -> CertAuthorityResponse updateCertAuthority(certAuthorityName, body, opaquePassword, select) - -Update a Certificate Authority object. - -Update a Certificate Authority object. Any attribute missing from the request will be left unchanged. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||x| certContent|||||x| crlDayList|||||x| crlTimeList|||||x| crlUrl||||x|x| ocspNonResponderCertEnabled|||||x| ocspOverrideUrl|||||x| ocspTimeout|||||x| revocationCheckEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertAuthorityApi apiInstance = new CertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - CertAuthority body = new CertAuthority(); // CertAuthority | The Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - CertAuthorityResponse result = apiInstance.updateCertAuthority(certAuthorityName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertAuthorityApi#updateCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **body** | [**CertAuthority**](CertAuthority.md)| The Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**CertAuthorityResponse**](CertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Authority object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/CertAuthorityLinks.md b/service/solace-config-client/docs/CertAuthorityLinks.md deleted file mode 100644 index 4819eb4fb..000000000 --- a/service/solace-config-client/docs/CertAuthorityLinks.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# CertAuthorityLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**ocspTlsTrustedCommonNamesUri** | **String** | The URI of this Certificate Authority's collection of OCSP Responder Trusted Common Name objects. Deprecated since 2.19. Replaced by clientCertAuthorities. | [optional] | -|**uri** | **String** | The URI of this Certificate Authority object. | [optional] | - - - diff --git a/service/solace-config-client/docs/CertAuthorityOcspTlsTrustedCommonName.md b/service/solace-config-client/docs/CertAuthorityOcspTlsTrustedCommonName.md deleted file mode 100644 index 9b9cf4ebf..000000000 --- a/service/solace-config-client/docs/CertAuthorityOcspTlsTrustedCommonName.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# CertAuthorityOcspTlsTrustedCommonName - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**certAuthorityName** | **String** | The name of the Certificate Authority. Deprecated since 2.19. Replaced by clientCertAuthorities. | [optional] | -|**ocspTlsTrustedCommonName** | **String** | The expected Trusted Common Name of the OCSP responder remote certificate. Deprecated since 2.19. Replaced by clientCertAuthorities. | [optional] | - - - diff --git a/service/solace-config-client/docs/CertAuthorityOcspTlsTrustedCommonNameLinks.md b/service/solace-config-client/docs/CertAuthorityOcspTlsTrustedCommonNameLinks.md deleted file mode 100644 index 496d55c46..000000000 --- a/service/solace-config-client/docs/CertAuthorityOcspTlsTrustedCommonNameLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# CertAuthorityOcspTlsTrustedCommonNameLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this OCSP Responder Trusted Common Name object. | [optional] | - - - diff --git a/service/solace-config-client/docs/CertAuthorityOcspTlsTrustedCommonNameResponse.md b/service/solace-config-client/docs/CertAuthorityOcspTlsTrustedCommonNameResponse.md deleted file mode 100644 index 28364fe4b..000000000 --- a/service/solace-config-client/docs/CertAuthorityOcspTlsTrustedCommonNameResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# CertAuthorityOcspTlsTrustedCommonNameResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**CertAuthorityOcspTlsTrustedCommonName**](CertAuthorityOcspTlsTrustedCommonName.md) | | [optional] | -|**links** | [**CertAuthorityOcspTlsTrustedCommonNameLinks**](CertAuthorityOcspTlsTrustedCommonNameLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/CertAuthorityOcspTlsTrustedCommonNamesResponse.md b/service/solace-config-client/docs/CertAuthorityOcspTlsTrustedCommonNamesResponse.md deleted file mode 100644 index fb5e7c56e..000000000 --- a/service/solace-config-client/docs/CertAuthorityOcspTlsTrustedCommonNamesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# CertAuthorityOcspTlsTrustedCommonNamesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<CertAuthorityOcspTlsTrustedCommonName>**](CertAuthorityOcspTlsTrustedCommonName.md) | | [optional] | -|**links** | [**List<CertAuthorityOcspTlsTrustedCommonNameLinks>**](CertAuthorityOcspTlsTrustedCommonNameLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/CertAuthorityResponse.md b/service/solace-config-client/docs/CertAuthorityResponse.md deleted file mode 100644 index 20c0bcffe..000000000 --- a/service/solace-config-client/docs/CertAuthorityResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# CertAuthorityResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**CertAuthority**](CertAuthority.md) | | [optional] | -|**links** | [**CertAuthorityLinks**](CertAuthorityLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/CertMatchingRuleApi.md b/service/solace-config-client/docs/CertMatchingRuleApi.md deleted file mode 100644 index 521b9d045..000000000 --- a/service/solace-config-client/docs/CertMatchingRuleApi.md +++ /dev/null @@ -1,1316 +0,0 @@ -# CertMatchingRuleApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnCertMatchingRule**](CertMatchingRuleApi.md#createMsgVpnCertMatchingRule) | **POST** /msgVpns/{msgVpnName}/certMatchingRules | Create a Certificate Matching Rule object. | -| [**createMsgVpnCertMatchingRuleAttributeFilter**](CertMatchingRuleApi.md#createMsgVpnCertMatchingRuleAttributeFilter) | **POST** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters | Create a Certificate Matching Rule Attribute Filter object. | -| [**createMsgVpnCertMatchingRuleCondition**](CertMatchingRuleApi.md#createMsgVpnCertMatchingRuleCondition) | **POST** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions | Create a Certificate Matching Rule Condition object. | -| [**deleteMsgVpnCertMatchingRule**](CertMatchingRuleApi.md#deleteMsgVpnCertMatchingRule) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Delete a Certificate Matching Rule object. | -| [**deleteMsgVpnCertMatchingRuleAttributeFilter**](CertMatchingRuleApi.md#deleteMsgVpnCertMatchingRuleAttributeFilter) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Delete a Certificate Matching Rule Attribute Filter object. | -| [**deleteMsgVpnCertMatchingRuleCondition**](CertMatchingRuleApi.md#deleteMsgVpnCertMatchingRuleCondition) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source} | Delete a Certificate Matching Rule Condition object. | -| [**getMsgVpnCertMatchingRule**](CertMatchingRuleApi.md#getMsgVpnCertMatchingRule) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Get a Certificate Matching Rule object. | -| [**getMsgVpnCertMatchingRuleAttributeFilter**](CertMatchingRuleApi.md#getMsgVpnCertMatchingRuleAttributeFilter) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Get a Certificate Matching Rule Attribute Filter object. | -| [**getMsgVpnCertMatchingRuleAttributeFilters**](CertMatchingRuleApi.md#getMsgVpnCertMatchingRuleAttributeFilters) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters | Get a list of Certificate Matching Rule Attribute Filter objects. | -| [**getMsgVpnCertMatchingRuleCondition**](CertMatchingRuleApi.md#getMsgVpnCertMatchingRuleCondition) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source} | Get a Certificate Matching Rule Condition object. | -| [**getMsgVpnCertMatchingRuleConditions**](CertMatchingRuleApi.md#getMsgVpnCertMatchingRuleConditions) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions | Get a list of Certificate Matching Rule Condition objects. | -| [**getMsgVpnCertMatchingRules**](CertMatchingRuleApi.md#getMsgVpnCertMatchingRules) | **GET** /msgVpns/{msgVpnName}/certMatchingRules | Get a list of Certificate Matching Rule objects. | -| [**replaceMsgVpnCertMatchingRule**](CertMatchingRuleApi.md#replaceMsgVpnCertMatchingRule) | **PUT** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Replace a Certificate Matching Rule object. | -| [**replaceMsgVpnCertMatchingRuleAttributeFilter**](CertMatchingRuleApi.md#replaceMsgVpnCertMatchingRuleAttributeFilter) | **PUT** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Replace a Certificate Matching Rule Attribute Filter object. | -| [**updateMsgVpnCertMatchingRule**](CertMatchingRuleApi.md#updateMsgVpnCertMatchingRule) | **PATCH** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Update a Certificate Matching Rule object. | -| [**updateMsgVpnCertMatchingRuleAttributeFilter**](CertMatchingRuleApi.md#updateMsgVpnCertMatchingRuleAttributeFilter) | **PATCH** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Update a Certificate Matching Rule Attribute Filter object. | - - - -## createMsgVpnCertMatchingRule - -> MsgVpnCertMatchingRuleResponse createMsgVpnCertMatchingRule(msgVpnName, body, opaquePassword, select) - -Create a Certificate Matching Rule object. - -Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertMatchingRuleApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertMatchingRuleApi apiInstance = new CertMatchingRuleApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnCertMatchingRule body = new MsgVpnCertMatchingRule(); // MsgVpnCertMatchingRule | The Certificate Matching Rule object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleResponse result = apiInstance.createMsgVpnCertMatchingRule(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertMatchingRuleApi#createMsgVpnCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnCertMatchingRule**](MsgVpnCertMatchingRule.md)| The Certificate Matching Rule object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleResponse**](MsgVpnCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnCertMatchingRuleAttributeFilter - -> MsgVpnCertMatchingRuleAttributeFilterResponse createMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, body, opaquePassword, select) - -Create a Certificate Matching Rule Attribute Filter object. - -Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: filterName|x|x|||| msgVpnName|x||x||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertMatchingRuleApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertMatchingRuleApi apiInstance = new CertMatchingRuleApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - MsgVpnCertMatchingRuleAttributeFilter body = new MsgVpnCertMatchingRuleAttributeFilter(); // MsgVpnCertMatchingRuleAttributeFilter | The Certificate Matching Rule Attribute Filter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleAttributeFilterResponse result = apiInstance.createMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertMatchingRuleApi#createMsgVpnCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**MsgVpnCertMatchingRuleAttributeFilter**](MsgVpnCertMatchingRuleAttributeFilter.md)| The Certificate Matching Rule Attribute Filter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleAttributeFilterResponse**](MsgVpnCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnCertMatchingRuleCondition - -> MsgVpnCertMatchingRuleConditionResponse createMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, body, opaquePassword, select) - -Create a Certificate Matching Rule Condition object. - -Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertMatchingRuleApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertMatchingRuleApi apiInstance = new CertMatchingRuleApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - MsgVpnCertMatchingRuleCondition body = new MsgVpnCertMatchingRuleCondition(); // MsgVpnCertMatchingRuleCondition | The Certificate Matching Rule Condition object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleConditionResponse result = apiInstance.createMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertMatchingRuleApi#createMsgVpnCertMatchingRuleCondition"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**MsgVpnCertMatchingRuleCondition**](MsgVpnCertMatchingRuleCondition.md)| The Certificate Matching Rule Condition object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleConditionResponse**](MsgVpnCertMatchingRuleConditionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Condition object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnCertMatchingRule - -> SempMetaOnlyResponse deleteMsgVpnCertMatchingRule(msgVpnName, ruleName) - -Delete a Certificate Matching Rule object. - -Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertMatchingRuleApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertMatchingRuleApi apiInstance = new CertMatchingRuleApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnCertMatchingRule(msgVpnName, ruleName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertMatchingRuleApi#deleteMsgVpnCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnCertMatchingRuleAttributeFilter - -> SempMetaOnlyResponse deleteMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName) - -Delete a Certificate Matching Rule Attribute Filter object. - -Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertMatchingRuleApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertMatchingRuleApi apiInstance = new CertMatchingRuleApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertMatchingRuleApi#deleteMsgVpnCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnCertMatchingRuleCondition - -> SempMetaOnlyResponse deleteMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source) - -Delete a Certificate Matching Rule Condition object. - -Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertMatchingRuleApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertMatchingRuleApi apiInstance = new CertMatchingRuleApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String source = "source_example"; // String | Certificate field to be compared with the Attribute. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertMatchingRuleApi#deleteMsgVpnCertMatchingRuleCondition"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **source** | **String**| Certificate field to be compared with the Attribute. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRule - -> MsgVpnCertMatchingRuleResponse getMsgVpnCertMatchingRule(msgVpnName, ruleName, opaquePassword, select) - -Get a Certificate Matching Rule object. - -Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertMatchingRuleApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertMatchingRuleApi apiInstance = new CertMatchingRuleApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleResponse result = apiInstance.getMsgVpnCertMatchingRule(msgVpnName, ruleName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertMatchingRuleApi#getMsgVpnCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleResponse**](MsgVpnCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRuleAttributeFilter - -> MsgVpnCertMatchingRuleAttributeFilterResponse getMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, opaquePassword, select) - -Get a Certificate Matching Rule Attribute Filter object. - -Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertMatchingRuleApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertMatchingRuleApi apiInstance = new CertMatchingRuleApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleAttributeFilterResponse result = apiInstance.getMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertMatchingRuleApi#getMsgVpnCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleAttributeFilterResponse**](MsgVpnCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRuleAttributeFilters - -> MsgVpnCertMatchingRuleAttributeFiltersResponse getMsgVpnCertMatchingRuleAttributeFilters(msgVpnName, ruleName, count, cursor, opaquePassword, where, select) - -Get a list of Certificate Matching Rule Attribute Filter objects. - -Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertMatchingRuleApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertMatchingRuleApi apiInstance = new CertMatchingRuleApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleAttributeFiltersResponse result = apiInstance.getMsgVpnCertMatchingRuleAttributeFilters(msgVpnName, ruleName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertMatchingRuleApi#getMsgVpnCertMatchingRuleAttributeFilters"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleAttributeFiltersResponse**](MsgVpnCertMatchingRuleAttributeFiltersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRuleCondition - -> MsgVpnCertMatchingRuleConditionResponse getMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source, opaquePassword, select) - -Get a Certificate Matching Rule Condition object. - -Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertMatchingRuleApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertMatchingRuleApi apiInstance = new CertMatchingRuleApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String source = "source_example"; // String | Certificate field to be compared with the Attribute. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleConditionResponse result = apiInstance.getMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertMatchingRuleApi#getMsgVpnCertMatchingRuleCondition"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **source** | **String**| Certificate field to be compared with the Attribute. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleConditionResponse**](MsgVpnCertMatchingRuleConditionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Condition object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRuleConditions - -> MsgVpnCertMatchingRuleConditionsResponse getMsgVpnCertMatchingRuleConditions(msgVpnName, ruleName, count, cursor, opaquePassword, where, select) - -Get a list of Certificate Matching Rule Condition objects. - -Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertMatchingRuleApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertMatchingRuleApi apiInstance = new CertMatchingRuleApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleConditionsResponse result = apiInstance.getMsgVpnCertMatchingRuleConditions(msgVpnName, ruleName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertMatchingRuleApi#getMsgVpnCertMatchingRuleConditions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleConditionsResponse**](MsgVpnCertMatchingRuleConditionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Matching Rule Condition objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRules - -> MsgVpnCertMatchingRulesResponse getMsgVpnCertMatchingRules(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Certificate Matching Rule objects. - -Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertMatchingRuleApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertMatchingRuleApi apiInstance = new CertMatchingRuleApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRulesResponse result = apiInstance.getMsgVpnCertMatchingRules(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertMatchingRuleApi#getMsgVpnCertMatchingRules"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRulesResponse**](MsgVpnCertMatchingRulesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Matching Rule objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnCertMatchingRule - -> MsgVpnCertMatchingRuleResponse replaceMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select) - -Replace a Certificate Matching Rule object. - -Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertMatchingRuleApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertMatchingRuleApi apiInstance = new CertMatchingRuleApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - MsgVpnCertMatchingRule body = new MsgVpnCertMatchingRule(); // MsgVpnCertMatchingRule | The Certificate Matching Rule object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleResponse result = apiInstance.replaceMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertMatchingRuleApi#replaceMsgVpnCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**MsgVpnCertMatchingRule**](MsgVpnCertMatchingRule.md)| The Certificate Matching Rule object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleResponse**](MsgVpnCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnCertMatchingRuleAttributeFilter - -> MsgVpnCertMatchingRuleAttributeFilterResponse replaceMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select) - -Replace a Certificate Matching Rule Attribute Filter object. - -Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- filterName|x||x|||| msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertMatchingRuleApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertMatchingRuleApi apiInstance = new CertMatchingRuleApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - MsgVpnCertMatchingRuleAttributeFilter body = new MsgVpnCertMatchingRuleAttributeFilter(); // MsgVpnCertMatchingRuleAttributeFilter | The Certificate Matching Rule Attribute Filter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleAttributeFilterResponse result = apiInstance.replaceMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertMatchingRuleApi#replaceMsgVpnCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | -| **body** | [**MsgVpnCertMatchingRuleAttributeFilter**](MsgVpnCertMatchingRuleAttributeFilter.md)| The Certificate Matching Rule Attribute Filter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleAttributeFilterResponse**](MsgVpnCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnCertMatchingRule - -> MsgVpnCertMatchingRuleResponse updateMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select) - -Update a Certificate Matching Rule object. - -Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertMatchingRuleApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertMatchingRuleApi apiInstance = new CertMatchingRuleApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - MsgVpnCertMatchingRule body = new MsgVpnCertMatchingRule(); // MsgVpnCertMatchingRule | The Certificate Matching Rule object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleResponse result = apiInstance.updateMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertMatchingRuleApi#updateMsgVpnCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**MsgVpnCertMatchingRule**](MsgVpnCertMatchingRule.md)| The Certificate Matching Rule object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleResponse**](MsgVpnCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnCertMatchingRuleAttributeFilter - -> MsgVpnCertMatchingRuleAttributeFilterResponse updateMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select) - -Update a Certificate Matching Rule Attribute Filter object. - -Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- filterName|x|x|||| msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.CertMatchingRuleApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - CertMatchingRuleApi apiInstance = new CertMatchingRuleApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - MsgVpnCertMatchingRuleAttributeFilter body = new MsgVpnCertMatchingRuleAttributeFilter(); // MsgVpnCertMatchingRuleAttributeFilter | The Certificate Matching Rule Attribute Filter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleAttributeFilterResponse result = apiInstance.updateMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling CertMatchingRuleApi#updateMsgVpnCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | -| **body** | [**MsgVpnCertMatchingRuleAttributeFilter**](MsgVpnCertMatchingRuleAttributeFilter.md)| The Certificate Matching Rule Attribute Filter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleAttributeFilterResponse**](MsgVpnCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/ClientCertAuthoritiesResponse.md b/service/solace-config-client/docs/ClientCertAuthoritiesResponse.md deleted file mode 100644 index aa76a29f1..000000000 --- a/service/solace-config-client/docs/ClientCertAuthoritiesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# ClientCertAuthoritiesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<ClientCertAuthority>**](ClientCertAuthority.md) | | [optional] | -|**links** | [**List<ClientCertAuthorityLinks>**](ClientCertAuthorityLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/ClientCertAuthority.md b/service/solace-config-client/docs/ClientCertAuthority.md deleted file mode 100644 index 8edf51425..000000000 --- a/service/solace-config-client/docs/ClientCertAuthority.md +++ /dev/null @@ -1,21 +0,0 @@ - - -# ClientCertAuthority - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**certAuthorityName** | **String** | The name of the Certificate Authority. | [optional] | -|**certContent** | **String** | The PEM formatted content for the trusted root certificate of a client Certificate Authority. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**crlDayList** | **String** | The scheduled CRL refresh day(s), specified as \"daily\" or a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. The empty-string (\"\") can also be specified, indicating no schedule is configured (\"crlTimeList\" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"daily\"`. | [optional] | -|**crlTimeList** | **String** | The scheduled CRL refresh time(s), specified as \"hourly\" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. The empty-string (\"\") can also be specified, indicating no schedule is configured (\"crlDayList\" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"3:00\"`. | [optional] | -|**crlUrl** | **String** | The URL for the CRL source. This is a required attribute for CRL to be operational and the URL must be complete with http:// included. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**ocspNonResponderCertEnabled** | **Boolean** | Enable or disable allowing a non-responder certificate to sign an OCSP response. Typically used with an OCSP override URL in cases where a single certificate is used to sign client certificates and OCSP responses. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. | [optional] | -|**ocspOverrideUrl** | **String** | The OCSP responder URL to use for overriding the one supplied in the client certificate. The URL must be complete with http:// included. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**ocspTimeout** | **Long** | The timeout in seconds to receive a response from the OCSP responder after sending a request or making the initial connection attempt. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`. | [optional] | -|**revocationCheckEnabled** | **Boolean** | Enable or disable Certificate Authority revocation checking. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. | [optional] | - - - diff --git a/service/solace-config-client/docs/ClientCertAuthorityApi.md b/service/solace-config-client/docs/ClientCertAuthorityApi.md deleted file mode 100644 index 0697fe942..000000000 --- a/service/solace-config-client/docs/ClientCertAuthorityApi.md +++ /dev/null @@ -1,796 +0,0 @@ -# ClientCertAuthorityApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createClientCertAuthority**](ClientCertAuthorityApi.md#createClientCertAuthority) | **POST** /clientCertAuthorities | Create a Client Certificate Authority object. | -| [**createClientCertAuthorityOcspTlsTrustedCommonName**](ClientCertAuthorityApi.md#createClientCertAuthorityOcspTlsTrustedCommonName) | **POST** /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames | Create an OCSP Responder Trusted Common Name object. | -| [**deleteClientCertAuthority**](ClientCertAuthorityApi.md#deleteClientCertAuthority) | **DELETE** /clientCertAuthorities/{certAuthorityName} | Delete a Client Certificate Authority object. | -| [**deleteClientCertAuthorityOcspTlsTrustedCommonName**](ClientCertAuthorityApi.md#deleteClientCertAuthorityOcspTlsTrustedCommonName) | **DELETE** /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName} | Delete an OCSP Responder Trusted Common Name object. | -| [**getClientCertAuthorities**](ClientCertAuthorityApi.md#getClientCertAuthorities) | **GET** /clientCertAuthorities | Get a list of Client Certificate Authority objects. | -| [**getClientCertAuthority**](ClientCertAuthorityApi.md#getClientCertAuthority) | **GET** /clientCertAuthorities/{certAuthorityName} | Get a Client Certificate Authority object. | -| [**getClientCertAuthorityOcspTlsTrustedCommonName**](ClientCertAuthorityApi.md#getClientCertAuthorityOcspTlsTrustedCommonName) | **GET** /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName} | Get an OCSP Responder Trusted Common Name object. | -| [**getClientCertAuthorityOcspTlsTrustedCommonNames**](ClientCertAuthorityApi.md#getClientCertAuthorityOcspTlsTrustedCommonNames) | **GET** /clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames | Get a list of OCSP Responder Trusted Common Name objects. | -| [**replaceClientCertAuthority**](ClientCertAuthorityApi.md#replaceClientCertAuthority) | **PUT** /clientCertAuthorities/{certAuthorityName} | Replace a Client Certificate Authority object. | -| [**updateClientCertAuthority**](ClientCertAuthorityApi.md#updateClientCertAuthority) | **PATCH** /clientCertAuthorities/{certAuthorityName} | Update a Client Certificate Authority object. | - - - -## createClientCertAuthority - -> ClientCertAuthorityResponse createClientCertAuthority(body, opaquePassword, select) - -Create a Client Certificate Authority object. - -Create a Client Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientCertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientCertAuthorityApi apiInstance = new ClientCertAuthorityApi(defaultClient); - ClientCertAuthority body = new ClientCertAuthority(); // ClientCertAuthority | The Client Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - ClientCertAuthorityResponse result = apiInstance.createClientCertAuthority(body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientCertAuthorityApi#createClientCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **body** | [**ClientCertAuthority**](ClientCertAuthority.md)| The Client Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**ClientCertAuthorityResponse**](ClientCertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Certificate Authority object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createClientCertAuthorityOcspTlsTrustedCommonName - -> ClientCertAuthorityOcspTlsTrustedCommonNameResponse createClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, body, opaquePassword, select) - -Create an OCSP Responder Trusted Common Name object. - -Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x||x||| ocspTlsTrustedCommonName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientCertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientCertAuthorityApi apiInstance = new ClientCertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - ClientCertAuthorityOcspTlsTrustedCommonName body = new ClientCertAuthorityOcspTlsTrustedCommonName(); // ClientCertAuthorityOcspTlsTrustedCommonName | The OCSP Responder Trusted Common Name object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - ClientCertAuthorityOcspTlsTrustedCommonNameResponse result = apiInstance.createClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientCertAuthorityApi#createClientCertAuthorityOcspTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **body** | [**ClientCertAuthorityOcspTlsTrustedCommonName**](ClientCertAuthorityOcspTlsTrustedCommonName.md)| The OCSP Responder Trusted Common Name object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**ClientCertAuthorityOcspTlsTrustedCommonNameResponse**](ClientCertAuthorityOcspTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteClientCertAuthority - -> SempMetaOnlyResponse deleteClientCertAuthority(certAuthorityName) - -Delete a Client Certificate Authority object. - -Delete a Client Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientCertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientCertAuthorityApi apiInstance = new ClientCertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - try { - SempMetaOnlyResponse result = apiInstance.deleteClientCertAuthority(certAuthorityName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientCertAuthorityApi#deleteClientCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteClientCertAuthorityOcspTlsTrustedCommonName - -> SempMetaOnlyResponse deleteClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName) - -Delete an OCSP Responder Trusted Common Name object. - -Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientCertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientCertAuthorityApi apiInstance = new ClientCertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String ocspTlsTrustedCommonName = "ocspTlsTrustedCommonName_example"; // String | The expected Trusted Common Name of the OCSP responder remote certificate. - try { - SempMetaOnlyResponse result = apiInstance.deleteClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientCertAuthorityApi#deleteClientCertAuthorityOcspTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **ocspTlsTrustedCommonName** | **String**| The expected Trusted Common Name of the OCSP responder remote certificate. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getClientCertAuthorities - -> ClientCertAuthoritiesResponse getClientCertAuthorities(count, cursor, opaquePassword, where, select) - -Get a list of Client Certificate Authority objects. - -Get a list of Client Certificate Authority objects. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientCertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientCertAuthorityApi apiInstance = new ClientCertAuthorityApi(defaultClient); - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - ClientCertAuthoritiesResponse result = apiInstance.getClientCertAuthorities(count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientCertAuthorityApi#getClientCertAuthorities"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**ClientCertAuthoritiesResponse**](ClientCertAuthoritiesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Client Certificate Authority objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getClientCertAuthority - -> ClientCertAuthorityResponse getClientCertAuthority(certAuthorityName, opaquePassword, select) - -Get a Client Certificate Authority object. - -Get a Client Certificate Authority object. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientCertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientCertAuthorityApi apiInstance = new ClientCertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - ClientCertAuthorityResponse result = apiInstance.getClientCertAuthority(certAuthorityName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientCertAuthorityApi#getClientCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**ClientCertAuthorityResponse**](ClientCertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Certificate Authority object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getClientCertAuthorityOcspTlsTrustedCommonName - -> ClientCertAuthorityOcspTlsTrustedCommonNameResponse getClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName, opaquePassword, select) - -Get an OCSP Responder Trusted Common Name object. - -Get an OCSP Responder Trusted Common Name object. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| ocspTlsTrustedCommonName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientCertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientCertAuthorityApi apiInstance = new ClientCertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String ocspTlsTrustedCommonName = "ocspTlsTrustedCommonName_example"; // String | The expected Trusted Common Name of the OCSP responder remote certificate. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - ClientCertAuthorityOcspTlsTrustedCommonNameResponse result = apiInstance.getClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientCertAuthorityApi#getClientCertAuthorityOcspTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **ocspTlsTrustedCommonName** | **String**| The expected Trusted Common Name of the OCSP responder remote certificate. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**ClientCertAuthorityOcspTlsTrustedCommonNameResponse**](ClientCertAuthorityOcspTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OCSP Responder Trusted Common Name object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getClientCertAuthorityOcspTlsTrustedCommonNames - -> ClientCertAuthorityOcspTlsTrustedCommonNamesResponse getClientCertAuthorityOcspTlsTrustedCommonNames(certAuthorityName, opaquePassword, where, select) - -Get a list of OCSP Responder Trusted Common Name objects. - -Get a list of OCSP Responder Trusted Common Name objects. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| ocspTlsTrustedCommonName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientCertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientCertAuthorityApi apiInstance = new ClientCertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - ClientCertAuthorityOcspTlsTrustedCommonNamesResponse result = apiInstance.getClientCertAuthorityOcspTlsTrustedCommonNames(certAuthorityName, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientCertAuthorityApi#getClientCertAuthorityOcspTlsTrustedCommonNames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**ClientCertAuthorityOcspTlsTrustedCommonNamesResponse**](ClientCertAuthorityOcspTlsTrustedCommonNamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceClientCertAuthority - -> ClientCertAuthorityResponse replaceClientCertAuthority(certAuthorityName, body, opaquePassword, select) - -Replace a Client Certificate Authority object. - -Replace a Client Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||| crlUrl|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientCertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientCertAuthorityApi apiInstance = new ClientCertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - ClientCertAuthority body = new ClientCertAuthority(); // ClientCertAuthority | The Client Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - ClientCertAuthorityResponse result = apiInstance.replaceClientCertAuthority(certAuthorityName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientCertAuthorityApi#replaceClientCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **body** | [**ClientCertAuthority**](ClientCertAuthority.md)| The Client Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**ClientCertAuthorityResponse**](ClientCertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Certificate Authority object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateClientCertAuthority - -> ClientCertAuthorityResponse updateClientCertAuthority(certAuthorityName, body, opaquePassword, select) - -Update a Client Certificate Authority object. - -Update a Client Certificate Authority object. Any attribute missing from the request will be left unchanged. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||| crlUrl||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientCertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientCertAuthorityApi apiInstance = new ClientCertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - ClientCertAuthority body = new ClientCertAuthority(); // ClientCertAuthority | The Client Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - ClientCertAuthorityResponse result = apiInstance.updateClientCertAuthority(certAuthorityName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientCertAuthorityApi#updateClientCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **body** | [**ClientCertAuthority**](ClientCertAuthority.md)| The Client Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**ClientCertAuthorityResponse**](ClientCertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Certificate Authority object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/ClientCertAuthorityLinks.md b/service/solace-config-client/docs/ClientCertAuthorityLinks.md deleted file mode 100644 index 040bbe48e..000000000 --- a/service/solace-config-client/docs/ClientCertAuthorityLinks.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# ClientCertAuthorityLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**ocspTlsTrustedCommonNamesUri** | **String** | The URI of this Client Certificate Authority's collection of OCSP Responder Trusted Common Name objects. | [optional] | -|**uri** | **String** | The URI of this Client Certificate Authority object. | [optional] | - - - diff --git a/service/solace-config-client/docs/ClientCertAuthorityOcspTlsTrustedCommonName.md b/service/solace-config-client/docs/ClientCertAuthorityOcspTlsTrustedCommonName.md deleted file mode 100644 index d8dedf5ca..000000000 --- a/service/solace-config-client/docs/ClientCertAuthorityOcspTlsTrustedCommonName.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# ClientCertAuthorityOcspTlsTrustedCommonName - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**certAuthorityName** | **String** | The name of the Certificate Authority. | [optional] | -|**ocspTlsTrustedCommonName** | **String** | The expected Trusted Common Name of the OCSP responder remote certificate. | [optional] | - - - diff --git a/service/solace-config-client/docs/ClientCertAuthorityOcspTlsTrustedCommonNameLinks.md b/service/solace-config-client/docs/ClientCertAuthorityOcspTlsTrustedCommonNameLinks.md deleted file mode 100644 index d5250cbde..000000000 --- a/service/solace-config-client/docs/ClientCertAuthorityOcspTlsTrustedCommonNameLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# ClientCertAuthorityOcspTlsTrustedCommonNameLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this OCSP Responder Trusted Common Name object. | [optional] | - - - diff --git a/service/solace-config-client/docs/ClientCertAuthorityOcspTlsTrustedCommonNameResponse.md b/service/solace-config-client/docs/ClientCertAuthorityOcspTlsTrustedCommonNameResponse.md deleted file mode 100644 index c04776687..000000000 --- a/service/solace-config-client/docs/ClientCertAuthorityOcspTlsTrustedCommonNameResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# ClientCertAuthorityOcspTlsTrustedCommonNameResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**ClientCertAuthorityOcspTlsTrustedCommonName**](ClientCertAuthorityOcspTlsTrustedCommonName.md) | | [optional] | -|**links** | [**ClientCertAuthorityOcspTlsTrustedCommonNameLinks**](ClientCertAuthorityOcspTlsTrustedCommonNameLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/ClientCertAuthorityOcspTlsTrustedCommonNamesResponse.md b/service/solace-config-client/docs/ClientCertAuthorityOcspTlsTrustedCommonNamesResponse.md deleted file mode 100644 index 7f5aa962b..000000000 --- a/service/solace-config-client/docs/ClientCertAuthorityOcspTlsTrustedCommonNamesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# ClientCertAuthorityOcspTlsTrustedCommonNamesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<ClientCertAuthorityOcspTlsTrustedCommonName>**](ClientCertAuthorityOcspTlsTrustedCommonName.md) | | [optional] | -|**links** | [**List<ClientCertAuthorityOcspTlsTrustedCommonNameLinks>**](ClientCertAuthorityOcspTlsTrustedCommonNameLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/ClientCertAuthorityResponse.md b/service/solace-config-client/docs/ClientCertAuthorityResponse.md deleted file mode 100644 index 0ffc1ddd4..000000000 --- a/service/solace-config-client/docs/ClientCertAuthorityResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# ClientCertAuthorityResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**ClientCertAuthority**](ClientCertAuthority.md) | | [optional] | -|**links** | [**ClientCertAuthorityLinks**](ClientCertAuthorityLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/ClientProfileApi.md b/service/solace-config-client/docs/ClientProfileApi.md deleted file mode 100644 index 793daa778..000000000 --- a/service/solace-config-client/docs/ClientProfileApi.md +++ /dev/null @@ -1,492 +0,0 @@ -# ClientProfileApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnClientProfile**](ClientProfileApi.md#createMsgVpnClientProfile) | **POST** /msgVpns/{msgVpnName}/clientProfiles | Create a Client Profile object. | -| [**deleteMsgVpnClientProfile**](ClientProfileApi.md#deleteMsgVpnClientProfile) | **DELETE** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Delete a Client Profile object. | -| [**getMsgVpnClientProfile**](ClientProfileApi.md#getMsgVpnClientProfile) | **GET** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Get a Client Profile object. | -| [**getMsgVpnClientProfiles**](ClientProfileApi.md#getMsgVpnClientProfiles) | **GET** /msgVpns/{msgVpnName}/clientProfiles | Get a list of Client Profile objects. | -| [**replaceMsgVpnClientProfile**](ClientProfileApi.md#replaceMsgVpnClientProfile) | **PUT** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Replace a Client Profile object. | -| [**updateMsgVpnClientProfile**](ClientProfileApi.md#updateMsgVpnClientProfile) | **PATCH** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Update a Client Profile object. | - - - -## createMsgVpnClientProfile - -> MsgVpnClientProfileResponse createMsgVpnClientProfile(msgVpnName, body, opaquePassword, select) - -Create a Client Profile object. - -Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientProfileApi apiInstance = new ClientProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnClientProfile body = new MsgVpnClientProfile(); // MsgVpnClientProfile | The Client Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientProfileResponse result = apiInstance.createMsgVpnClientProfile(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientProfileApi#createMsgVpnClientProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnClientProfile**](MsgVpnClientProfile.md)| The Client Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientProfileResponse**](MsgVpnClientProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Profile object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnClientProfile - -> SempMetaOnlyResponse deleteMsgVpnClientProfile(msgVpnName, clientProfileName) - -Delete a Client Profile object. - -Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientProfileApi apiInstance = new ClientProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientProfileName = "clientProfileName_example"; // String | The name of the Client Profile. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnClientProfile(msgVpnName, clientProfileName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientProfileApi#deleteMsgVpnClientProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientProfileName** | **String**| The name of the Client Profile. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientProfile - -> MsgVpnClientProfileResponse getMsgVpnClientProfile(msgVpnName, clientProfileName, opaquePassword, select) - -Get a Client Profile object. - -Get a Client Profile object. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientProfileApi apiInstance = new ClientProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientProfileName = "clientProfileName_example"; // String | The name of the Client Profile. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientProfileResponse result = apiInstance.getMsgVpnClientProfile(msgVpnName, clientProfileName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientProfileApi#getMsgVpnClientProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientProfileName** | **String**| The name of the Client Profile. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientProfileResponse**](MsgVpnClientProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Profile object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientProfiles - -> MsgVpnClientProfilesResponse getMsgVpnClientProfiles(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Client Profile objects. - -Get a list of Client Profile objects. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientProfileApi apiInstance = new ClientProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientProfilesResponse result = apiInstance.getMsgVpnClientProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientProfileApi#getMsgVpnClientProfiles"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientProfilesResponse**](MsgVpnClientProfilesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Client Profile objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnClientProfile - -> MsgVpnClientProfileResponse replaceMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select) - -Replace a Client Profile object. - -Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled||||||x| apiQueueManagementCopyFromOnCreateName||||||x| apiTopicEndpointManagementCopyFromOnCreateName||||||x| clientProfileName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientProfileApi apiInstance = new ClientProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientProfileName = "clientProfileName_example"; // String | The name of the Client Profile. - MsgVpnClientProfile body = new MsgVpnClientProfile(); // MsgVpnClientProfile | The Client Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientProfileResponse result = apiInstance.replaceMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientProfileApi#replaceMsgVpnClientProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientProfileName** | **String**| The name of the Client Profile. | | -| **body** | [**MsgVpnClientProfile**](MsgVpnClientProfile.md)| The Client Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientProfileResponse**](MsgVpnClientProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Profile object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnClientProfile - -> MsgVpnClientProfileResponse updateMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select) - -Update a Client Profile object. - -Update a Client Profile object. Any attribute missing from the request will be left unchanged. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientProfileApi apiInstance = new ClientProfileApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientProfileName = "clientProfileName_example"; // String | The name of the Client Profile. - MsgVpnClientProfile body = new MsgVpnClientProfile(); // MsgVpnClientProfile | The Client Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientProfileResponse result = apiInstance.updateMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientProfileApi#updateMsgVpnClientProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientProfileName** | **String**| The name of the Client Profile. | | -| **body** | [**MsgVpnClientProfile**](MsgVpnClientProfile.md)| The Client Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientProfileResponse**](MsgVpnClientProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Profile object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/ClientUsernameApi.md b/service/solace-config-client/docs/ClientUsernameApi.md deleted file mode 100644 index d347e3f79..000000000 --- a/service/solace-config-client/docs/ClientUsernameApi.md +++ /dev/null @@ -1,824 +0,0 @@ -# ClientUsernameApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnClientUsername**](ClientUsernameApi.md#createMsgVpnClientUsername) | **POST** /msgVpns/{msgVpnName}/clientUsernames | Create a Client Username object. | -| [**createMsgVpnClientUsernameAttribute**](ClientUsernameApi.md#createMsgVpnClientUsernameAttribute) | **POST** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes | Create a Client Username Attribute object. | -| [**deleteMsgVpnClientUsername**](ClientUsernameApi.md#deleteMsgVpnClientUsername) | **DELETE** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Delete a Client Username object. | -| [**deleteMsgVpnClientUsernameAttribute**](ClientUsernameApi.md#deleteMsgVpnClientUsernameAttribute) | **DELETE** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue} | Delete a Client Username Attribute object. | -| [**getMsgVpnClientUsername**](ClientUsernameApi.md#getMsgVpnClientUsername) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Get a Client Username object. | -| [**getMsgVpnClientUsernameAttribute**](ClientUsernameApi.md#getMsgVpnClientUsernameAttribute) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue} | Get a Client Username Attribute object. | -| [**getMsgVpnClientUsernameAttributes**](ClientUsernameApi.md#getMsgVpnClientUsernameAttributes) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes | Get a list of Client Username Attribute objects. | -| [**getMsgVpnClientUsernames**](ClientUsernameApi.md#getMsgVpnClientUsernames) | **GET** /msgVpns/{msgVpnName}/clientUsernames | Get a list of Client Username objects. | -| [**replaceMsgVpnClientUsername**](ClientUsernameApi.md#replaceMsgVpnClientUsername) | **PUT** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Replace a Client Username object. | -| [**updateMsgVpnClientUsername**](ClientUsernameApi.md#updateMsgVpnClientUsername) | **PATCH** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Update a Client Username object. | - - - -## createMsgVpnClientUsername - -> MsgVpnClientUsernameResponse createMsgVpnClientUsername(msgVpnName, body, opaquePassword, select) - -Create a Client Username object. - -Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientUsername|x|x|||| msgVpnName|x||x||| password||||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientUsernameApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientUsernameApi apiInstance = new ClientUsernameApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnClientUsername body = new MsgVpnClientUsername(); // MsgVpnClientUsername | The Client Username object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameResponse result = apiInstance.createMsgVpnClientUsername(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientUsernameApi#createMsgVpnClientUsername"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnClientUsername**](MsgVpnClientUsername.md)| The Client Username object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameResponse**](MsgVpnClientUsernameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnClientUsernameAttribute - -> MsgVpnClientUsernameAttributeResponse createMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, body, opaquePassword, select) - -Create a Client Username Attribute object. - -Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| clientUsername|x||x||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientUsernameApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientUsernameApi apiInstance = new ClientUsernameApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - MsgVpnClientUsernameAttribute body = new MsgVpnClientUsernameAttribute(); // MsgVpnClientUsernameAttribute | The Client Username Attribute object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameAttributeResponse result = apiInstance.createMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientUsernameApi#createMsgVpnClientUsernameAttribute"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **body** | [**MsgVpnClientUsernameAttribute**](MsgVpnClientUsernameAttribute.md)| The Client Username Attribute object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameAttributeResponse**](MsgVpnClientUsernameAttributeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username Attribute object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnClientUsername - -> SempMetaOnlyResponse deleteMsgVpnClientUsername(msgVpnName, clientUsername) - -Delete a Client Username object. - -Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientUsernameApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientUsernameApi apiInstance = new ClientUsernameApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnClientUsername(msgVpnName, clientUsername); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientUsernameApi#deleteMsgVpnClientUsername"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnClientUsernameAttribute - -> SempMetaOnlyResponse deleteMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue) - -Delete a Client Username Attribute object. - -Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientUsernameApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientUsernameApi apiInstance = new ClientUsernameApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - String attributeName = "attributeName_example"; // String | The name of the Attribute. - String attributeValue = "attributeValue_example"; // String | The value of the Attribute. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientUsernameApi#deleteMsgVpnClientUsernameAttribute"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **attributeName** | **String**| The name of the Attribute. | | -| **attributeValue** | **String**| The value of the Attribute. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientUsername - -> MsgVpnClientUsernameResponse getMsgVpnClientUsername(msgVpnName, clientUsername, opaquePassword, select) - -Get a Client Username object. - -Get a Client Username object. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientUsernameApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientUsernameApi apiInstance = new ClientUsernameApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameResponse result = apiInstance.getMsgVpnClientUsername(msgVpnName, clientUsername, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientUsernameApi#getMsgVpnClientUsername"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameResponse**](MsgVpnClientUsernameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientUsernameAttribute - -> MsgVpnClientUsernameAttributeResponse getMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue, opaquePassword, select) - -Get a Client Username Attribute object. - -Get a Client Username Attribute object. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientUsernameApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientUsernameApi apiInstance = new ClientUsernameApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - String attributeName = "attributeName_example"; // String | The name of the Attribute. - String attributeValue = "attributeValue_example"; // String | The value of the Attribute. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameAttributeResponse result = apiInstance.getMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientUsernameApi#getMsgVpnClientUsernameAttribute"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **attributeName** | **String**| The name of the Attribute. | | -| **attributeValue** | **String**| The value of the Attribute. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameAttributeResponse**](MsgVpnClientUsernameAttributeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username Attribute object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientUsernameAttributes - -> MsgVpnClientUsernameAttributesResponse getMsgVpnClientUsernameAttributes(msgVpnName, clientUsername, count, cursor, opaquePassword, where, select) - -Get a list of Client Username Attribute objects. - -Get a list of Client Username Attribute objects. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientUsernameApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientUsernameApi apiInstance = new ClientUsernameApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameAttributesResponse result = apiInstance.getMsgVpnClientUsernameAttributes(msgVpnName, clientUsername, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientUsernameApi#getMsgVpnClientUsernameAttributes"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameAttributesResponse**](MsgVpnClientUsernameAttributesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Client Username Attribute objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientUsernames - -> MsgVpnClientUsernamesResponse getMsgVpnClientUsernames(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Client Username objects. - -Get a list of Client Username objects. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientUsernameApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientUsernameApi apiInstance = new ClientUsernameApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernamesResponse result = apiInstance.getMsgVpnClientUsernames(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientUsernameApi#getMsgVpnClientUsernames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernamesResponse**](MsgVpnClientUsernamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Client Username objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnClientUsername - -> MsgVpnClientUsernameResponse replaceMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select) - -Replace a Client Username object. - -Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| clientProfileName|||||x|| clientUsername|x||x|||| msgVpnName|x||x|||| password||||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientUsernameApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientUsernameApi apiInstance = new ClientUsernameApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - MsgVpnClientUsername body = new MsgVpnClientUsername(); // MsgVpnClientUsername | The Client Username object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameResponse result = apiInstance.replaceMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientUsernameApi#replaceMsgVpnClientUsername"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **body** | [**MsgVpnClientUsername**](MsgVpnClientUsername.md)| The Client Username object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameResponse**](MsgVpnClientUsernameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnClientUsername - -> MsgVpnClientUsernameResponse updateMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select) - -Update a Client Username object. - -Update a Client Username object. Any attribute missing from the request will be left unchanged. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| clientProfileName||||x|| clientUsername|x|x|||| msgVpnName|x|x|||| password|||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ClientUsernameApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ClientUsernameApi apiInstance = new ClientUsernameApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - MsgVpnClientUsername body = new MsgVpnClientUsername(); // MsgVpnClientUsername | The Client Username object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameResponse result = apiInstance.updateMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ClientUsernameApi#updateMsgVpnClientUsername"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **body** | [**MsgVpnClientUsername**](MsgVpnClientUsername.md)| The Client Username object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameResponse**](MsgVpnClientUsernameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/DistributedCacheApi.md b/service/solace-config-client/docs/DistributedCacheApi.md deleted file mode 100644 index 3b11e755f..000000000 --- a/service/solace-config-client/docs/DistributedCacheApi.md +++ /dev/null @@ -1,2512 +0,0 @@ -# DistributedCacheApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnDistributedCache**](DistributedCacheApi.md#createMsgVpnDistributedCache) | **POST** /msgVpns/{msgVpnName}/distributedCaches | Create a Distributed Cache object. | -| [**createMsgVpnDistributedCacheCluster**](DistributedCacheApi.md#createMsgVpnDistributedCacheCluster) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters | Create a Cache Cluster object. | -| [**createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](DistributedCacheApi.md#createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters | Create a Home Cache Cluster object. | -| [**createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](DistributedCacheApi.md#createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes | Create a Topic Prefix object. | -| [**createMsgVpnDistributedCacheClusterInstance**](DistributedCacheApi.md#createMsgVpnDistributedCacheClusterInstance) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances | Create a Cache Instance object. | -| [**createMsgVpnDistributedCacheClusterTopic**](DistributedCacheApi.md#createMsgVpnDistributedCacheClusterTopic) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics | Create a Topic object. | -| [**deleteMsgVpnDistributedCache**](DistributedCacheApi.md#deleteMsgVpnDistributedCache) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Delete a Distributed Cache object. | -| [**deleteMsgVpnDistributedCacheCluster**](DistributedCacheApi.md#deleteMsgVpnDistributedCacheCluster) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Delete a Cache Cluster object. | -| [**deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](DistributedCacheApi.md#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName} | Delete a Home Cache Cluster object. | -| [**deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](DistributedCacheApi.md#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix} | Delete a Topic Prefix object. | -| [**deleteMsgVpnDistributedCacheClusterInstance**](DistributedCacheApi.md#deleteMsgVpnDistributedCacheClusterInstance) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Delete a Cache Instance object. | -| [**deleteMsgVpnDistributedCacheClusterTopic**](DistributedCacheApi.md#deleteMsgVpnDistributedCacheClusterTopic) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic} | Delete a Topic object. | -| [**getMsgVpnDistributedCache**](DistributedCacheApi.md#getMsgVpnDistributedCache) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Get a Distributed Cache object. | -| [**getMsgVpnDistributedCacheCluster**](DistributedCacheApi.md#getMsgVpnDistributedCacheCluster) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Get a Cache Cluster object. | -| [**getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](DistributedCacheApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName} | Get a Home Cache Cluster object. | -| [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](DistributedCacheApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix} | Get a Topic Prefix object. | -| [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes**](DistributedCacheApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes | Get a list of Topic Prefix objects. | -| [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters**](DistributedCacheApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters | Get a list of Home Cache Cluster objects. | -| [**getMsgVpnDistributedCacheClusterInstance**](DistributedCacheApi.md#getMsgVpnDistributedCacheClusterInstance) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Get a Cache Instance object. | -| [**getMsgVpnDistributedCacheClusterInstances**](DistributedCacheApi.md#getMsgVpnDistributedCacheClusterInstances) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances | Get a list of Cache Instance objects. | -| [**getMsgVpnDistributedCacheClusterTopic**](DistributedCacheApi.md#getMsgVpnDistributedCacheClusterTopic) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic} | Get a Topic object. | -| [**getMsgVpnDistributedCacheClusterTopics**](DistributedCacheApi.md#getMsgVpnDistributedCacheClusterTopics) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics | Get a list of Topic objects. | -| [**getMsgVpnDistributedCacheClusters**](DistributedCacheApi.md#getMsgVpnDistributedCacheClusters) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters | Get a list of Cache Cluster objects. | -| [**getMsgVpnDistributedCaches**](DistributedCacheApi.md#getMsgVpnDistributedCaches) | **GET** /msgVpns/{msgVpnName}/distributedCaches | Get a list of Distributed Cache objects. | -| [**replaceMsgVpnDistributedCache**](DistributedCacheApi.md#replaceMsgVpnDistributedCache) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Replace a Distributed Cache object. | -| [**replaceMsgVpnDistributedCacheCluster**](DistributedCacheApi.md#replaceMsgVpnDistributedCacheCluster) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Replace a Cache Cluster object. | -| [**replaceMsgVpnDistributedCacheClusterInstance**](DistributedCacheApi.md#replaceMsgVpnDistributedCacheClusterInstance) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Replace a Cache Instance object. | -| [**updateMsgVpnDistributedCache**](DistributedCacheApi.md#updateMsgVpnDistributedCache) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Update a Distributed Cache object. | -| [**updateMsgVpnDistributedCacheCluster**](DistributedCacheApi.md#updateMsgVpnDistributedCacheCluster) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Update a Cache Cluster object. | -| [**updateMsgVpnDistributedCacheClusterInstance**](DistributedCacheApi.md#updateMsgVpnDistributedCacheClusterInstance) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Update a Cache Instance object. | - - - -## createMsgVpnDistributedCache - -> MsgVpnDistributedCacheResponse createMsgVpnDistributedCache(msgVpnName, body, opaquePassword, select) - -Create a Distributed Cache object. - -Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnDistributedCache body = new MsgVpnDistributedCache(); // MsgVpnDistributedCache | The Distributed Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheResponse result = apiInstance.createMsgVpnDistributedCache(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#createMsgVpnDistributedCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnDistributedCache**](MsgVpnDistributedCache.md)| The Distributed Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheResponse**](MsgVpnDistributedCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Distributed Cache object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCacheCluster - -> MsgVpnDistributedCacheClusterResponse createMsgVpnDistributedCacheCluster(msgVpnName, cacheName, body, opaquePassword, select) - -Create a Cache Cluster object. - -Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - MsgVpnDistributedCacheCluster body = new MsgVpnDistributedCacheCluster(); // MsgVpnDistributedCacheCluster | The Cache Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterResponse result = apiInstance.createMsgVpnDistributedCacheCluster(msgVpnName, cacheName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#createMsgVpnDistributedCacheCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **body** | [**MsgVpnDistributedCacheCluster**](MsgVpnDistributedCacheCluster.md)| The Cache Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterResponse**](MsgVpnDistributedCacheClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Cluster object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select) - -Create a Home Cache Cluster object. - -Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - MsgVpnDistributedCacheClusterGlobalCachingHomeCluster body = new MsgVpnDistributedCacheClusterGlobalCachingHomeCluster(); // MsgVpnDistributedCacheClusterGlobalCachingHomeCluster | The Home Cache Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse result = apiInstance.createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.md)| The Home Cache Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Home Cache Cluster object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, body, opaquePassword, select) - -Create a Topic Prefix object. - -Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x||x||| msgVpnName|x||x||| topicPrefix|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix body = new MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(); // MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix | The Topic Prefix object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse result = apiInstance.createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.md)| The Topic Prefix object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Prefix object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCacheClusterInstance - -> MsgVpnDistributedCacheClusterInstanceResponse createMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, body, opaquePassword, select) - -Create a Cache Instance object. - -Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| instanceName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - MsgVpnDistributedCacheClusterInstance body = new MsgVpnDistributedCacheClusterInstance(); // MsgVpnDistributedCacheClusterInstance | The Cache Instance object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterInstanceResponse result = apiInstance.createMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#createMsgVpnDistributedCacheClusterInstance"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheClusterInstance**](MsgVpnDistributedCacheClusterInstance.md)| The Cache Instance object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterInstanceResponse**](MsgVpnDistributedCacheClusterInstanceResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Instance object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCacheClusterTopic - -> MsgVpnDistributedCacheClusterTopicResponse createMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, body, opaquePassword, select) - -Create a Topic object. - -Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| msgVpnName|x||x||| topic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - MsgVpnDistributedCacheClusterTopic body = new MsgVpnDistributedCacheClusterTopic(); // MsgVpnDistributedCacheClusterTopic | The Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterTopicResponse result = apiInstance.createMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#createMsgVpnDistributedCacheClusterTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheClusterTopic**](MsgVpnDistributedCacheClusterTopic.md)| The Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterTopicResponse**](MsgVpnDistributedCacheClusterTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCache - -> SempMetaOnlyResponse deleteMsgVpnDistributedCache(msgVpnName, cacheName) - -Delete a Distributed Cache object. - -Delete a Distributed Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCache(msgVpnName, cacheName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#deleteMsgVpnDistributedCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCacheCluster - -> SempMetaOnlyResponse deleteMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName) - -Delete a Cache Cluster object. - -Delete a Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#deleteMsgVpnDistributedCacheCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster - -> SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName) - -Delete a Home Cache Cluster object. - -Delete a Home Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - -> SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix) - -Delete a Topic Prefix object. - -Delete a Topic Prefix object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - String topicPrefix = "topicPrefix_example"; // String | A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | -| **topicPrefix** | **String**| A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCacheClusterInstance - -> SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName) - -Delete a Cache Instance object. - -Delete a Cache Instance object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String instanceName = "instanceName_example"; // String | The name of the Cache Instance. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#deleteMsgVpnDistributedCacheClusterInstance"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **instanceName** | **String**| The name of the Cache Instance. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCacheClusterTopic - -> SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic) - -Delete a Topic object. - -Delete a Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String topic = "topic_example"; // String | The value of the Topic in the form a/b/c. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#deleteMsgVpnDistributedCacheClusterTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **topic** | **String**| The value of the Topic in the form a/b/c. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCache - -> MsgVpnDistributedCacheResponse getMsgVpnDistributedCache(msgVpnName, cacheName, opaquePassword, select) - -Get a Distributed Cache object. - -Get a Distributed Cache object. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheResponse result = apiInstance.getMsgVpnDistributedCache(msgVpnName, cacheName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#getMsgVpnDistributedCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheResponse**](MsgVpnDistributedCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Distributed Cache object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheCluster - -> MsgVpnDistributedCacheClusterResponse getMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, opaquePassword, select) - -Get a Cache Cluster object. - -Get a Cache Cluster object. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterResponse result = apiInstance.getMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#getMsgVpnDistributedCacheCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterResponse**](MsgVpnDistributedCacheClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Cluster object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName, opaquePassword, select) - -Get a Home Cache Cluster object. - -Get a Home Cache Cluster object. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse result = apiInstance.getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Home Cache Cluster object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix, opaquePassword, select) - -Get a Topic Prefix object. - -Get a Topic Prefix object. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - String topicPrefix = "topicPrefix_example"; // String | A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse result = apiInstance.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | -| **topicPrefix** | **String**| A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Prefix object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes(msgVpnName, cacheName, clusterName, homeClusterName, count, cursor, opaquePassword, where, select) - -Get a list of Topic Prefix objects. - -Get a list of Topic Prefix objects. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse result = apiInstance.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes(msgVpnName, cacheName, clusterName, homeClusterName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Topic Prefix objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select) - -Get a list of Home Cache Cluster objects. - -Get a list of Home Cache Cluster objects. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse result = apiInstance.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Home Cache Cluster objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterInstance - -> MsgVpnDistributedCacheClusterInstanceResponse getMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, opaquePassword, select) - -Get a Cache Instance object. - -Get a Cache Instance object. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String instanceName = "instanceName_example"; // String | The name of the Cache Instance. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterInstanceResponse result = apiInstance.getMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#getMsgVpnDistributedCacheClusterInstance"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **instanceName** | **String**| The name of the Cache Instance. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterInstanceResponse**](MsgVpnDistributedCacheClusterInstanceResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Instance object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterInstances - -> MsgVpnDistributedCacheClusterInstancesResponse getMsgVpnDistributedCacheClusterInstances(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select) - -Get a list of Cache Instance objects. - -Get a list of Cache Instance objects. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterInstancesResponse result = apiInstance.getMsgVpnDistributedCacheClusterInstances(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#getMsgVpnDistributedCacheClusterInstances"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterInstancesResponse**](MsgVpnDistributedCacheClusterInstancesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Cache Instance objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterTopic - -> MsgVpnDistributedCacheClusterTopicResponse getMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic, opaquePassword, select) - -Get a Topic object. - -Get a Topic object. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String topic = "topic_example"; // String | The value of the Topic in the form a/b/c. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterTopicResponse result = apiInstance.getMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#getMsgVpnDistributedCacheClusterTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **topic** | **String**| The value of the Topic in the form a/b/c. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterTopicResponse**](MsgVpnDistributedCacheClusterTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterTopics - -> MsgVpnDistributedCacheClusterTopicsResponse getMsgVpnDistributedCacheClusterTopics(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select) - -Get a list of Topic objects. - -Get a list of Topic objects. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterTopicsResponse result = apiInstance.getMsgVpnDistributedCacheClusterTopics(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#getMsgVpnDistributedCacheClusterTopics"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterTopicsResponse**](MsgVpnDistributedCacheClusterTopicsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Topic objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusters - -> MsgVpnDistributedCacheClustersResponse getMsgVpnDistributedCacheClusters(msgVpnName, cacheName, count, cursor, opaquePassword, where, select) - -Get a list of Cache Cluster objects. - -Get a list of Cache Cluster objects. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClustersResponse result = apiInstance.getMsgVpnDistributedCacheClusters(msgVpnName, cacheName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#getMsgVpnDistributedCacheClusters"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClustersResponse**](MsgVpnDistributedCacheClustersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Cache Cluster objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCaches - -> MsgVpnDistributedCachesResponse getMsgVpnDistributedCaches(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Distributed Cache objects. - -Get a list of Distributed Cache objects. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCachesResponse result = apiInstance.getMsgVpnDistributedCaches(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#getMsgVpnDistributedCaches"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCachesResponse**](MsgVpnDistributedCachesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Distributed Cache objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnDistributedCache - -> MsgVpnDistributedCacheResponse replaceMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select) - -Replace a Distributed Cache object. - -Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| cacheVirtualRouter||x||||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - MsgVpnDistributedCache body = new MsgVpnDistributedCache(); // MsgVpnDistributedCache | The Distributed Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheResponse result = apiInstance.replaceMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#replaceMsgVpnDistributedCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **body** | [**MsgVpnDistributedCache**](MsgVpnDistributedCache.md)| The Distributed Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheResponse**](MsgVpnDistributedCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Distributed Cache object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnDistributedCacheCluster - -> MsgVpnDistributedCacheClusterResponse replaceMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select) - -Replace a Cache Cluster object. - -Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - MsgVpnDistributedCacheCluster body = new MsgVpnDistributedCacheCluster(); // MsgVpnDistributedCacheCluster | The Cache Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterResponse result = apiInstance.replaceMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#replaceMsgVpnDistributedCacheCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheCluster**](MsgVpnDistributedCacheCluster.md)| The Cache Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterResponse**](MsgVpnDistributedCacheClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Cluster object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnDistributedCacheClusterInstance - -> MsgVpnDistributedCacheClusterInstanceResponse replaceMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select) - -Replace a Cache Instance object. - -Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| instanceName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String instanceName = "instanceName_example"; // String | The name of the Cache Instance. - MsgVpnDistributedCacheClusterInstance body = new MsgVpnDistributedCacheClusterInstance(); // MsgVpnDistributedCacheClusterInstance | The Cache Instance object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterInstanceResponse result = apiInstance.replaceMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#replaceMsgVpnDistributedCacheClusterInstance"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **instanceName** | **String**| The name of the Cache Instance. | | -| **body** | [**MsgVpnDistributedCacheClusterInstance**](MsgVpnDistributedCacheClusterInstance.md)| The Cache Instance object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterInstanceResponse**](MsgVpnDistributedCacheClusterInstanceResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Instance object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnDistributedCache - -> MsgVpnDistributedCacheResponse updateMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select) - -Update a Distributed Cache object. - -Update a Distributed Cache object. Any attribute missing from the request will be left unchanged. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| cacheVirtualRouter||x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - MsgVpnDistributedCache body = new MsgVpnDistributedCache(); // MsgVpnDistributedCache | The Distributed Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheResponse result = apiInstance.updateMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#updateMsgVpnDistributedCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **body** | [**MsgVpnDistributedCache**](MsgVpnDistributedCache.md)| The Distributed Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheResponse**](MsgVpnDistributedCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Distributed Cache object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnDistributedCacheCluster - -> MsgVpnDistributedCacheClusterResponse updateMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select) - -Update a Cache Cluster object. - -Update a Cache Cluster object. Any attribute missing from the request will be left unchanged. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - MsgVpnDistributedCacheCluster body = new MsgVpnDistributedCacheCluster(); // MsgVpnDistributedCacheCluster | The Cache Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterResponse result = apiInstance.updateMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#updateMsgVpnDistributedCacheCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheCluster**](MsgVpnDistributedCacheCluster.md)| The Cache Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterResponse**](MsgVpnDistributedCacheClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Cluster object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnDistributedCacheClusterInstance - -> MsgVpnDistributedCacheClusterInstanceResponse updateMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select) - -Update a Cache Instance object. - -Update a Cache Instance object. Any attribute missing from the request will be left unchanged. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| instanceName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DistributedCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DistributedCacheApi apiInstance = new DistributedCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String instanceName = "instanceName_example"; // String | The name of the Cache Instance. - MsgVpnDistributedCacheClusterInstance body = new MsgVpnDistributedCacheClusterInstance(); // MsgVpnDistributedCacheClusterInstance | The Cache Instance object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterInstanceResponse result = apiInstance.updateMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DistributedCacheApi#updateMsgVpnDistributedCacheClusterInstance"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **instanceName** | **String**| The name of the Cache Instance. | | -| **body** | [**MsgVpnDistributedCacheClusterInstance**](MsgVpnDistributedCacheClusterInstance.md)| The Cache Instance object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterInstanceResponse**](MsgVpnDistributedCacheClusterInstanceResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Instance object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/DmrBridgeApi.md b/service/solace-config-client/docs/DmrBridgeApi.md deleted file mode 100644 index 4bfdab76f..000000000 --- a/service/solace-config-client/docs/DmrBridgeApi.md +++ /dev/null @@ -1,492 +0,0 @@ -# DmrBridgeApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnDmrBridge**](DmrBridgeApi.md#createMsgVpnDmrBridge) | **POST** /msgVpns/{msgVpnName}/dmrBridges | Create a DMR Bridge object. | -| [**deleteMsgVpnDmrBridge**](DmrBridgeApi.md#deleteMsgVpnDmrBridge) | **DELETE** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Delete a DMR Bridge object. | -| [**getMsgVpnDmrBridge**](DmrBridgeApi.md#getMsgVpnDmrBridge) | **GET** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Get a DMR Bridge object. | -| [**getMsgVpnDmrBridges**](DmrBridgeApi.md#getMsgVpnDmrBridges) | **GET** /msgVpns/{msgVpnName}/dmrBridges | Get a list of DMR Bridge objects. | -| [**replaceMsgVpnDmrBridge**](DmrBridgeApi.md#replaceMsgVpnDmrBridge) | **PUT** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Replace a DMR Bridge object. | -| [**updateMsgVpnDmrBridge**](DmrBridgeApi.md#updateMsgVpnDmrBridge) | **PATCH** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Update a DMR Bridge object. | - - - -## createMsgVpnDmrBridge - -> MsgVpnDmrBridgeResponse createMsgVpnDmrBridge(msgVpnName, body, opaquePassword, select) - -Create a DMR Bridge object. - -Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrBridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrBridgeApi apiInstance = new DmrBridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnDmrBridge body = new MsgVpnDmrBridge(); // MsgVpnDmrBridge | The DMR Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDmrBridgeResponse result = apiInstance.createMsgVpnDmrBridge(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrBridgeApi#createMsgVpnDmrBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnDmrBridge**](MsgVpnDmrBridge.md)| The DMR Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDmrBridgeResponse**](MsgVpnDmrBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The DMR Bridge object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDmrBridge - -> SempMetaOnlyResponse deleteMsgVpnDmrBridge(msgVpnName, remoteNodeName) - -Delete a DMR Bridge object. - -Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrBridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrBridgeApi apiInstance = new DmrBridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the DMR Bridge. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDmrBridge(msgVpnName, remoteNodeName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrBridgeApi#deleteMsgVpnDmrBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the DMR Bridge. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDmrBridge - -> MsgVpnDmrBridgeResponse getMsgVpnDmrBridge(msgVpnName, remoteNodeName, opaquePassword, select) - -Get a DMR Bridge object. - -Get a DMR Bridge object. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrBridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrBridgeApi apiInstance = new DmrBridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the DMR Bridge. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDmrBridgeResponse result = apiInstance.getMsgVpnDmrBridge(msgVpnName, remoteNodeName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrBridgeApi#getMsgVpnDmrBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the DMR Bridge. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDmrBridgeResponse**](MsgVpnDmrBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The DMR Bridge object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDmrBridges - -> MsgVpnDmrBridgesResponse getMsgVpnDmrBridges(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of DMR Bridge objects. - -Get a list of DMR Bridge objects. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrBridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrBridgeApi apiInstance = new DmrBridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDmrBridgesResponse result = apiInstance.getMsgVpnDmrBridges(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrBridgeApi#getMsgVpnDmrBridges"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDmrBridgesResponse**](MsgVpnDmrBridgesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of DMR Bridge objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnDmrBridge - -> MsgVpnDmrBridgeResponse replaceMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select) - -Replace a DMR Bridge object. - -Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| remoteNodeName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrBridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrBridgeApi apiInstance = new DmrBridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the DMR Bridge. - MsgVpnDmrBridge body = new MsgVpnDmrBridge(); // MsgVpnDmrBridge | The DMR Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDmrBridgeResponse result = apiInstance.replaceMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrBridgeApi#replaceMsgVpnDmrBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the DMR Bridge. | | -| **body** | [**MsgVpnDmrBridge**](MsgVpnDmrBridge.md)| The DMR Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDmrBridgeResponse**](MsgVpnDmrBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The DMR Bridge object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnDmrBridge - -> MsgVpnDmrBridgeResponse updateMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select) - -Update a DMR Bridge object. - -Update a DMR Bridge object. Any attribute missing from the request will be left unchanged. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrBridgeApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrBridgeApi apiInstance = new DmrBridgeApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the DMR Bridge. - MsgVpnDmrBridge body = new MsgVpnDmrBridge(); // MsgVpnDmrBridge | The DMR Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDmrBridgeResponse result = apiInstance.updateMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrBridgeApi#updateMsgVpnDmrBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the DMR Bridge. | | -| **body** | [**MsgVpnDmrBridge**](MsgVpnDmrBridge.md)| The DMR Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDmrBridgeResponse**](MsgVpnDmrBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The DMR Bridge object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/DmrCluster.md b/service/solace-config-client/docs/DmrCluster.md deleted file mode 100644 index 50993d722..000000000 --- a/service/solace-config-client/docs/DmrCluster.md +++ /dev/null @@ -1,35 +0,0 @@ - - -# DmrCluster - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**authenticationBasicEnabled** | **Boolean** | Enable or disable basic authentication for Cluster Links. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. | [optional] | -|**authenticationBasicPassword** | **String** | The password used to authenticate incoming Cluster Links when using basic internal authentication. The same password is also used by outgoing Cluster Links if a per-Link password is not configured. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**authenticationBasicType** | [**AuthenticationBasicTypeEnum**](#AuthenticationBasicTypeEnum) | The type of basic authentication to use for Cluster Links. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"internal\"`. The allowed values and their meaning are: <pre> \"internal\" - Use locally configured password. \"none\" - No authentication. </pre> | [optional] | -|**authenticationClientCertContent** | **String** | The PEM formatted content for the client certificate used to login to the remote node. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. | [optional] | -|**authenticationClientCertEnabled** | **Boolean** | Enable or disable client certificate authentication for Cluster Links. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. | [optional] | -|**authenticationClientCertPassword** | **String** | The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. | [optional] | -|**directOnlyEnabled** | **Boolean** | Enable or disable direct messaging only. Guaranteed messages will not be transmitted through the cluster. The default value is `false`. | [optional] | -|**dmrClusterName** | **String** | The name of the Cluster. | [optional] | -|**enabled** | **Boolean** | Enable or disable the Cluster. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. | [optional] | -|**nodeName** | **String** | The name of this node in the Cluster. This is the name that this broker (or redundant group of brokers) is know by to other nodes in the Cluster. The name is chosen automatically to be either this broker's Router Name or Mate Router Name, depending on which Active Standby Role (primary or backup) this broker plays in its redundancy group. | [optional] | -|**tlsServerCertEnforceTrustedCommonNameEnabled** | **Boolean** | Enable or disable the enforcing of the common name provided by the remote broker against the list of trusted common names configured for the Link. If enabled, the certificate's common name must match one of the trusted common names for the Link to be accepted. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. | [optional] | -|**tlsServerCertMaxChainDepth** | **Long** | The maximum allowed depth of a certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`. | [optional] | -|**tlsServerCertValidateDateEnabled** | **Boolean** | Enable or disable the validation of the \"Not Before\" and \"Not After\" validity dates in the certificate. When disabled, the certificate is accepted even if the certificate is not valid based on these dates. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. | [optional] | -|**tlsServerCertValidateNameEnabled** | **Boolean** | Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the bridge. If enabled, the name used to connect to the bridge is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.18. | [optional] | - - - -## Enum: AuthenticationBasicTypeEnum - -| Name | Value | -|---- | -----| -| INTERNAL | "internal" | -| NONE | "none" | - - - diff --git a/service/solace-config-client/docs/DmrClusterApi.md b/service/solace-config-client/docs/DmrClusterApi.md deleted file mode 100644 index e999d714b..000000000 --- a/service/solace-config-client/docs/DmrClusterApi.md +++ /dev/null @@ -1,3252 +0,0 @@ -# DmrClusterApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createDmrCluster**](DmrClusterApi.md#createDmrCluster) | **POST** /dmrClusters | Create a Cluster object. | -| [**createDmrClusterCertMatchingRule**](DmrClusterApi.md#createDmrClusterCertMatchingRule) | **POST** /dmrClusters/{dmrClusterName}/certMatchingRules | Create a Certificate Matching Rule object. | -| [**createDmrClusterCertMatchingRuleAttributeFilter**](DmrClusterApi.md#createDmrClusterCertMatchingRuleAttributeFilter) | **POST** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters | Create a Certificate Matching Rule Attribute Filter object. | -| [**createDmrClusterCertMatchingRuleCondition**](DmrClusterApi.md#createDmrClusterCertMatchingRuleCondition) | **POST** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions | Create a Certificate Matching Rule Condition object. | -| [**createDmrClusterLink**](DmrClusterApi.md#createDmrClusterLink) | **POST** /dmrClusters/{dmrClusterName}/links | Create a Link object. | -| [**createDmrClusterLinkAttribute**](DmrClusterApi.md#createDmrClusterLinkAttribute) | **POST** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes | Create a Link Attribute object. | -| [**createDmrClusterLinkRemoteAddress**](DmrClusterApi.md#createDmrClusterLinkRemoteAddress) | **POST** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses | Create a Remote Address object. | -| [**createDmrClusterLinkTlsTrustedCommonName**](DmrClusterApi.md#createDmrClusterLinkTlsTrustedCommonName) | **POST** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames | Create a Trusted Common Name object. | -| [**deleteDmrCluster**](DmrClusterApi.md#deleteDmrCluster) | **DELETE** /dmrClusters/{dmrClusterName} | Delete a Cluster object. | -| [**deleteDmrClusterCertMatchingRule**](DmrClusterApi.md#deleteDmrClusterCertMatchingRule) | **DELETE** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName} | Delete a Certificate Matching Rule object. | -| [**deleteDmrClusterCertMatchingRuleAttributeFilter**](DmrClusterApi.md#deleteDmrClusterCertMatchingRuleAttributeFilter) | **DELETE** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Delete a Certificate Matching Rule Attribute Filter object. | -| [**deleteDmrClusterCertMatchingRuleCondition**](DmrClusterApi.md#deleteDmrClusterCertMatchingRuleCondition) | **DELETE** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source} | Delete a Certificate Matching Rule Condition object. | -| [**deleteDmrClusterLink**](DmrClusterApi.md#deleteDmrClusterLink) | **DELETE** /dmrClusters/{dmrClusterName}/links/{remoteNodeName} | Delete a Link object. | -| [**deleteDmrClusterLinkAttribute**](DmrClusterApi.md#deleteDmrClusterLinkAttribute) | **DELETE** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue} | Delete a Link Attribute object. | -| [**deleteDmrClusterLinkRemoteAddress**](DmrClusterApi.md#deleteDmrClusterLinkRemoteAddress) | **DELETE** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress} | Delete a Remote Address object. | -| [**deleteDmrClusterLinkTlsTrustedCommonName**](DmrClusterApi.md#deleteDmrClusterLinkTlsTrustedCommonName) | **DELETE** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Delete a Trusted Common Name object. | -| [**getDmrCluster**](DmrClusterApi.md#getDmrCluster) | **GET** /dmrClusters/{dmrClusterName} | Get a Cluster object. | -| [**getDmrClusterCertMatchingRule**](DmrClusterApi.md#getDmrClusterCertMatchingRule) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName} | Get a Certificate Matching Rule object. | -| [**getDmrClusterCertMatchingRuleAttributeFilter**](DmrClusterApi.md#getDmrClusterCertMatchingRuleAttributeFilter) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Get a Certificate Matching Rule Attribute Filter object. | -| [**getDmrClusterCertMatchingRuleAttributeFilters**](DmrClusterApi.md#getDmrClusterCertMatchingRuleAttributeFilters) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters | Get a list of Certificate Matching Rule Attribute Filter objects. | -| [**getDmrClusterCertMatchingRuleCondition**](DmrClusterApi.md#getDmrClusterCertMatchingRuleCondition) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source} | Get a Certificate Matching Rule Condition object. | -| [**getDmrClusterCertMatchingRuleConditions**](DmrClusterApi.md#getDmrClusterCertMatchingRuleConditions) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions | Get a list of Certificate Matching Rule Condition objects. | -| [**getDmrClusterCertMatchingRules**](DmrClusterApi.md#getDmrClusterCertMatchingRules) | **GET** /dmrClusters/{dmrClusterName}/certMatchingRules | Get a list of Certificate Matching Rule objects. | -| [**getDmrClusterLink**](DmrClusterApi.md#getDmrClusterLink) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName} | Get a Link object. | -| [**getDmrClusterLinkAttribute**](DmrClusterApi.md#getDmrClusterLinkAttribute) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue} | Get a Link Attribute object. | -| [**getDmrClusterLinkAttributes**](DmrClusterApi.md#getDmrClusterLinkAttributes) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes | Get a list of Link Attribute objects. | -| [**getDmrClusterLinkRemoteAddress**](DmrClusterApi.md#getDmrClusterLinkRemoteAddress) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress} | Get a Remote Address object. | -| [**getDmrClusterLinkRemoteAddresses**](DmrClusterApi.md#getDmrClusterLinkRemoteAddresses) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses | Get a list of Remote Address objects. | -| [**getDmrClusterLinkTlsTrustedCommonName**](DmrClusterApi.md#getDmrClusterLinkTlsTrustedCommonName) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Get a Trusted Common Name object. | -| [**getDmrClusterLinkTlsTrustedCommonNames**](DmrClusterApi.md#getDmrClusterLinkTlsTrustedCommonNames) | **GET** /dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames | Get a list of Trusted Common Name objects. | -| [**getDmrClusterLinks**](DmrClusterApi.md#getDmrClusterLinks) | **GET** /dmrClusters/{dmrClusterName}/links | Get a list of Link objects. | -| [**getDmrClusters**](DmrClusterApi.md#getDmrClusters) | **GET** /dmrClusters | Get a list of Cluster objects. | -| [**replaceDmrCluster**](DmrClusterApi.md#replaceDmrCluster) | **PUT** /dmrClusters/{dmrClusterName} | Replace a Cluster object. | -| [**replaceDmrClusterCertMatchingRule**](DmrClusterApi.md#replaceDmrClusterCertMatchingRule) | **PUT** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName} | Replace a Certificate Matching Rule object. | -| [**replaceDmrClusterCertMatchingRuleAttributeFilter**](DmrClusterApi.md#replaceDmrClusterCertMatchingRuleAttributeFilter) | **PUT** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Replace a Certificate Matching Rule Attribute Filter object. | -| [**replaceDmrClusterLink**](DmrClusterApi.md#replaceDmrClusterLink) | **PUT** /dmrClusters/{dmrClusterName}/links/{remoteNodeName} | Replace a Link object. | -| [**updateDmrCluster**](DmrClusterApi.md#updateDmrCluster) | **PATCH** /dmrClusters/{dmrClusterName} | Update a Cluster object. | -| [**updateDmrClusterCertMatchingRule**](DmrClusterApi.md#updateDmrClusterCertMatchingRule) | **PATCH** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName} | Update a Certificate Matching Rule object. | -| [**updateDmrClusterCertMatchingRuleAttributeFilter**](DmrClusterApi.md#updateDmrClusterCertMatchingRuleAttributeFilter) | **PATCH** /dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Update a Certificate Matching Rule Attribute Filter object. | -| [**updateDmrClusterLink**](DmrClusterApi.md#updateDmrClusterLink) | **PATCH** /dmrClusters/{dmrClusterName}/links/{remoteNodeName} | Update a Link object. | - - - -## createDmrCluster - -> DmrClusterResponse createDmrCluster(body, opaquePassword, select) - -Create a Cluster object. - -Create a Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationBasicPassword||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| dmrClusterName|x|x|||| nodeName|||x||| tlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - DmrCluster body = new DmrCluster(); // DmrCluster | The Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterResponse result = apiInstance.createDmrCluster(body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#createDmrCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **body** | [**DmrCluster**](DmrCluster.md)| The Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterResponse**](DmrClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cluster object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createDmrClusterCertMatchingRule - -> DmrClusterCertMatchingRuleResponse createDmrClusterCertMatchingRule(dmrClusterName, body, opaquePassword, select) - -Create a Certificate Matching Rule object. - -Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - DmrClusterCertMatchingRule body = new DmrClusterCertMatchingRule(); // DmrClusterCertMatchingRule | The Certificate Matching Rule object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleResponse result = apiInstance.createDmrClusterCertMatchingRule(dmrClusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#createDmrClusterCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **body** | [**DmrClusterCertMatchingRule**](DmrClusterCertMatchingRule.md)| The Certificate Matching Rule object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleResponse**](DmrClusterCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createDmrClusterCertMatchingRuleAttributeFilter - -> DmrClusterCertMatchingRuleAttributeFilterResponse createDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, body, opaquePassword, select) - -Create a Certificate Matching Rule Attribute Filter object. - -Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| filterName|x|x|||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - DmrClusterCertMatchingRuleAttributeFilter body = new DmrClusterCertMatchingRuleAttributeFilter(); // DmrClusterCertMatchingRuleAttributeFilter | The Certificate Matching Rule Attribute Filter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleAttributeFilterResponse result = apiInstance.createDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#createDmrClusterCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**DmrClusterCertMatchingRuleAttributeFilter**](DmrClusterCertMatchingRuleAttributeFilter.md)| The Certificate Matching Rule Attribute Filter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleAttributeFilterResponse**](DmrClusterCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createDmrClusterCertMatchingRuleCondition - -> DmrClusterCertMatchingRuleConditionResponse createDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, body, opaquePassword, select) - -Create a Certificate Matching Rule Condition object. - -Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - DmrClusterCertMatchingRuleCondition body = new DmrClusterCertMatchingRuleCondition(); // DmrClusterCertMatchingRuleCondition | The Certificate Matching Rule Condition object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleConditionResponse result = apiInstance.createDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#createDmrClusterCertMatchingRuleCondition"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**DmrClusterCertMatchingRuleCondition**](DmrClusterCertMatchingRuleCondition.md)| The Certificate Matching Rule Condition object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleConditionResponse**](DmrClusterCertMatchingRuleConditionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Condition object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createDmrClusterLink - -> DmrClusterLinkResponse createDmrClusterLink(dmrClusterName, body, opaquePassword, select) - -Create a Link object. - -Create a Link object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationBasicPassword||||x||x dmrClusterName|x||x||| remoteNodeName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - DmrClusterLink body = new DmrClusterLink(); // DmrClusterLink | The Link object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkResponse result = apiInstance.createDmrClusterLink(dmrClusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#createDmrClusterLink"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **body** | [**DmrClusterLink**](DmrClusterLink.md)| The Link object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkResponse**](DmrClusterLinkResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Link object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createDmrClusterLinkAttribute - -> DmrClusterLinkAttributeResponse createDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, body, opaquePassword, select) - -Create a Link Attribute object. - -Create a Link Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| dmrClusterName|x||x||| remoteNodeName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - DmrClusterLinkAttribute body = new DmrClusterLinkAttribute(); // DmrClusterLinkAttribute | The Link Attribute object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkAttributeResponse result = apiInstance.createDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#createDmrClusterLinkAttribute"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **body** | [**DmrClusterLinkAttribute**](DmrClusterLinkAttribute.md)| The Link Attribute object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkAttributeResponse**](DmrClusterLinkAttributeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Link Attribute object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createDmrClusterLinkRemoteAddress - -> DmrClusterLinkRemoteAddressResponse createDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, body, opaquePassword, select) - -Create a Remote Address object. - -Create a Remote Address object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| remoteAddress|x|x|||| remoteNodeName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - DmrClusterLinkRemoteAddress body = new DmrClusterLinkRemoteAddress(); // DmrClusterLinkRemoteAddress | The Remote Address object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkRemoteAddressResponse result = apiInstance.createDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#createDmrClusterLinkRemoteAddress"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **body** | [**DmrClusterLinkRemoteAddress**](DmrClusterLinkRemoteAddress.md)| The Remote Address object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkRemoteAddressResponse**](DmrClusterLinkRemoteAddressResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Address object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createDmrClusterLinkTlsTrustedCommonName - -> DmrClusterLinkTlsTrustedCommonNameResponse createDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, body, opaquePassword, select) - -Create a Trusted Common Name object. - -Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||x| remoteNodeName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - DmrClusterLinkTlsTrustedCommonName body = new DmrClusterLinkTlsTrustedCommonName(); // DmrClusterLinkTlsTrustedCommonName | The Trusted Common Name object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkTlsTrustedCommonNameResponse result = apiInstance.createDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#createDmrClusterLinkTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **body** | [**DmrClusterLinkTlsTrustedCommonName**](DmrClusterLinkTlsTrustedCommonName.md)| The Trusted Common Name object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkTlsTrustedCommonNameResponse**](DmrClusterLinkTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Trusted Common Name object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteDmrCluster - -> SempMetaOnlyResponse deleteDmrCluster(dmrClusterName) - -Delete a Cluster object. - -Delete a Cluster object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - try { - SempMetaOnlyResponse result = apiInstance.deleteDmrCluster(dmrClusterName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#deleteDmrCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteDmrClusterCertMatchingRule - -> SempMetaOnlyResponse deleteDmrClusterCertMatchingRule(dmrClusterName, ruleName) - -Delete a Certificate Matching Rule object. - -Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - try { - SempMetaOnlyResponse result = apiInstance.deleteDmrClusterCertMatchingRule(dmrClusterName, ruleName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#deleteDmrClusterCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteDmrClusterCertMatchingRuleAttributeFilter - -> SempMetaOnlyResponse deleteDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName) - -Delete a Certificate Matching Rule Attribute Filter object. - -Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Attribute Filter compares a link attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - try { - SempMetaOnlyResponse result = apiInstance.deleteDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#deleteDmrClusterCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteDmrClusterCertMatchingRuleCondition - -> SempMetaOnlyResponse deleteDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, source) - -Delete a Certificate Matching Rule Condition object. - -Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - String source = "source_example"; // String | Certificate field to be compared with the Attribute. - try { - SempMetaOnlyResponse result = apiInstance.deleteDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, source); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#deleteDmrClusterCertMatchingRuleCondition"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **source** | **String**| Certificate field to be compared with the Attribute. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteDmrClusterLink - -> SempMetaOnlyResponse deleteDmrClusterLink(dmrClusterName, remoteNodeName) - -Delete a Link object. - -Delete a Link object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - try { - SempMetaOnlyResponse result = apiInstance.deleteDmrClusterLink(dmrClusterName, remoteNodeName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#deleteDmrClusterLink"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteDmrClusterLinkAttribute - -> SempMetaOnlyResponse deleteDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, attributeName, attributeValue) - -Delete a Link Attribute object. - -Delete a Link Attribute object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String attributeName = "attributeName_example"; // String | The name of the Attribute. - String attributeValue = "attributeValue_example"; // String | The value of the Attribute. - try { - SempMetaOnlyResponse result = apiInstance.deleteDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, attributeName, attributeValue); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#deleteDmrClusterLinkAttribute"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **attributeName** | **String**| The name of the Attribute. | | -| **attributeValue** | **String**| The value of the Attribute. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteDmrClusterLinkRemoteAddress - -> SempMetaOnlyResponse deleteDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, remoteAddress) - -Delete a Remote Address object. - -Delete a Remote Address object. The deletion of instances of this object are synchronized to HA mates via config-sync. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String remoteAddress = "remoteAddress_example"; // String | The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). - try { - SempMetaOnlyResponse result = apiInstance.deleteDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, remoteAddress); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#deleteDmrClusterLinkRemoteAddress"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **remoteAddress** | **String**| The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteDmrClusterLinkTlsTrustedCommonName - -> SempMetaOnlyResponse deleteDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, tlsTrustedCommonName) - -Delete a Trusted Common Name object. - -Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String tlsTrustedCommonName = "tlsTrustedCommonName_example"; // String | The expected trusted common name of the remote certificate. - try { - SempMetaOnlyResponse result = apiInstance.deleteDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, tlsTrustedCommonName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#deleteDmrClusterLinkTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **tlsTrustedCommonName** | **String**| The expected trusted common name of the remote certificate. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getDmrCluster - -> DmrClusterResponse getDmrCluster(dmrClusterName, opaquePassword, select) - -Get a Cluster object. - -Get a Cluster object. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| dmrClusterName|x||| tlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterResponse result = apiInstance.getDmrCluster(dmrClusterName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#getDmrCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterResponse**](DmrClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cluster object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterCertMatchingRule - -> DmrClusterCertMatchingRuleResponse getDmrClusterCertMatchingRule(dmrClusterName, ruleName, opaquePassword, select) - -Get a Certificate Matching Rule object. - -Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleResponse result = apiInstance.getDmrClusterCertMatchingRule(dmrClusterName, ruleName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#getDmrClusterCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleResponse**](DmrClusterCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterCertMatchingRuleAttributeFilter - -> DmrClusterCertMatchingRuleAttributeFilterResponse getDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, opaquePassword, select) - -Get a Certificate Matching Rule Attribute Filter object. - -Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| filterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleAttributeFilterResponse result = apiInstance.getDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#getDmrClusterCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleAttributeFilterResponse**](DmrClusterCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterCertMatchingRuleAttributeFilters - -> DmrClusterCertMatchingRuleAttributeFiltersResponse getDmrClusterCertMatchingRuleAttributeFilters(dmrClusterName, ruleName, count, cursor, opaquePassword, where, select) - -Get a list of Certificate Matching Rule Attribute Filter objects. - -Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| filterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleAttributeFiltersResponse result = apiInstance.getDmrClusterCertMatchingRuleAttributeFilters(dmrClusterName, ruleName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#getDmrClusterCertMatchingRuleAttributeFilters"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleAttributeFiltersResponse**](DmrClusterCertMatchingRuleAttributeFiltersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterCertMatchingRuleCondition - -> DmrClusterCertMatchingRuleConditionResponse getDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, source, opaquePassword, select) - -Get a Certificate Matching Rule Condition object. - -Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - String source = "source_example"; // String | Certificate field to be compared with the Attribute. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleConditionResponse result = apiInstance.getDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, source, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#getDmrClusterCertMatchingRuleCondition"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **source** | **String**| Certificate field to be compared with the Attribute. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleConditionResponse**](DmrClusterCertMatchingRuleConditionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Condition object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterCertMatchingRuleConditions - -> DmrClusterCertMatchingRuleConditionsResponse getDmrClusterCertMatchingRuleConditions(dmrClusterName, ruleName, count, cursor, opaquePassword, where, select) - -Get a list of Certificate Matching Rule Condition objects. - -Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleConditionsResponse result = apiInstance.getDmrClusterCertMatchingRuleConditions(dmrClusterName, ruleName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#getDmrClusterCertMatchingRuleConditions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleConditionsResponse**](DmrClusterCertMatchingRuleConditionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Matching Rule Condition objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterCertMatchingRules - -> DmrClusterCertMatchingRulesResponse getDmrClusterCertMatchingRules(dmrClusterName, count, cursor, opaquePassword, where, select) - -Get a list of Certificate Matching Rule objects. - -Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRulesResponse result = apiInstance.getDmrClusterCertMatchingRules(dmrClusterName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#getDmrClusterCertMatchingRules"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRulesResponse**](DmrClusterCertMatchingRulesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Matching Rule objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterLink - -> DmrClusterLinkResponse getDmrClusterLink(dmrClusterName, remoteNodeName, opaquePassword, select) - -Get a Link object. - -Get a Link object. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkResponse result = apiInstance.getDmrClusterLink(dmrClusterName, remoteNodeName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#getDmrClusterLink"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkResponse**](DmrClusterLinkResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Link object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterLinkAttribute - -> DmrClusterLinkAttributeResponse getDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, attributeName, attributeValue, opaquePassword, select) - -Get a Link Attribute object. - -Get a Link Attribute object. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String attributeName = "attributeName_example"; // String | The name of the Attribute. - String attributeValue = "attributeValue_example"; // String | The value of the Attribute. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkAttributeResponse result = apiInstance.getDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, attributeName, attributeValue, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#getDmrClusterLinkAttribute"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **attributeName** | **String**| The name of the Attribute. | | -| **attributeValue** | **String**| The value of the Attribute. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkAttributeResponse**](DmrClusterLinkAttributeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Link Attribute object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterLinkAttributes - -> DmrClusterLinkAttributesResponse getDmrClusterLinkAttributes(dmrClusterName, remoteNodeName, count, cursor, opaquePassword, where, select) - -Get a list of Link Attribute objects. - -Get a list of Link Attribute objects. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkAttributesResponse result = apiInstance.getDmrClusterLinkAttributes(dmrClusterName, remoteNodeName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#getDmrClusterLinkAttributes"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkAttributesResponse**](DmrClusterLinkAttributesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Link Attribute objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterLinkRemoteAddress - -> DmrClusterLinkRemoteAddressResponse getDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, remoteAddress, opaquePassword, select) - -Get a Remote Address object. - -Get a Remote Address object. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| remoteAddress|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String remoteAddress = "remoteAddress_example"; // String | The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkRemoteAddressResponse result = apiInstance.getDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, remoteAddress, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#getDmrClusterLinkRemoteAddress"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **remoteAddress** | **String**| The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkRemoteAddressResponse**](DmrClusterLinkRemoteAddressResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Address object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterLinkRemoteAddresses - -> DmrClusterLinkRemoteAddressesResponse getDmrClusterLinkRemoteAddresses(dmrClusterName, remoteNodeName, opaquePassword, where, select) - -Get a list of Remote Address objects. - -Get a list of Remote Address objects. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| remoteAddress|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkRemoteAddressesResponse result = apiInstance.getDmrClusterLinkRemoteAddresses(dmrClusterName, remoteNodeName, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#getDmrClusterLinkRemoteAddresses"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkRemoteAddressesResponse**](DmrClusterLinkRemoteAddressesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Remote Address objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterLinkTlsTrustedCommonName - -> DmrClusterLinkTlsTrustedCommonNameResponse getDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, tlsTrustedCommonName, opaquePassword, select) - -Get a Trusted Common Name object. - -Get a Trusted Common Name object. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||x| remoteNodeName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String tlsTrustedCommonName = "tlsTrustedCommonName_example"; // String | The expected trusted common name of the remote certificate. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkTlsTrustedCommonNameResponse result = apiInstance.getDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, tlsTrustedCommonName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#getDmrClusterLinkTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **tlsTrustedCommonName** | **String**| The expected trusted common name of the remote certificate. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkTlsTrustedCommonNameResponse**](DmrClusterLinkTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Trusted Common Name object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterLinkTlsTrustedCommonNames - -> DmrClusterLinkTlsTrustedCommonNamesResponse getDmrClusterLinkTlsTrustedCommonNames(dmrClusterName, remoteNodeName, opaquePassword, where, select) - -Get a list of Trusted Common Name objects. - -Get a list of Trusted Common Name objects. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||x| remoteNodeName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkTlsTrustedCommonNamesResponse result = apiInstance.getDmrClusterLinkTlsTrustedCommonNames(dmrClusterName, remoteNodeName, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#getDmrClusterLinkTlsTrustedCommonNames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkTlsTrustedCommonNamesResponse**](DmrClusterLinkTlsTrustedCommonNamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Trusted Common Name objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusterLinks - -> DmrClusterLinksResponse getDmrClusterLinks(dmrClusterName, count, cursor, opaquePassword, where, select) - -Get a list of Link objects. - -Get a list of Link objects. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinksResponse result = apiInstance.getDmrClusterLinks(dmrClusterName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#getDmrClusterLinks"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinksResponse**](DmrClusterLinksResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Link objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDmrClusters - -> DmrClustersResponse getDmrClusters(count, cursor, opaquePassword, where, select) - -Get a list of Cluster objects. - -Get a list of Cluster objects. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| dmrClusterName|x||| tlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClustersResponse result = apiInstance.getDmrClusters(count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#getDmrClusters"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClustersResponse**](DmrClustersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Cluster objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceDmrCluster - -> DmrClusterResponse replaceDmrCluster(dmrClusterName, body, opaquePassword, select) - -Replace a Cluster object. - -Replace a Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword||||x|x||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| directOnlyEnabled||x||||| dmrClusterName|x||x|||| nodeName|||x|||| tlsServerCertEnforceTrustedCommonNameEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - DmrCluster body = new DmrCluster(); // DmrCluster | The Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterResponse result = apiInstance.replaceDmrCluster(dmrClusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#replaceDmrCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **body** | [**DmrCluster**](DmrCluster.md)| The Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterResponse**](DmrClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cluster object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceDmrClusterCertMatchingRule - -> DmrClusterCertMatchingRuleResponse replaceDmrClusterCertMatchingRule(dmrClusterName, ruleName, body, opaquePassword, select) - -Replace a Certificate Matching Rule object. - -Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- dmrClusterName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - DmrClusterCertMatchingRule body = new DmrClusterCertMatchingRule(); // DmrClusterCertMatchingRule | The Certificate Matching Rule object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleResponse result = apiInstance.replaceDmrClusterCertMatchingRule(dmrClusterName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#replaceDmrClusterCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**DmrClusterCertMatchingRule**](DmrClusterCertMatchingRule.md)| The Certificate Matching Rule object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleResponse**](DmrClusterCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceDmrClusterCertMatchingRuleAttributeFilter - -> DmrClusterCertMatchingRuleAttributeFilterResponse replaceDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, body, opaquePassword, select) - -Replace a Certificate Matching Rule Attribute Filter object. - -Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- dmrClusterName|x||x|||| filterName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - DmrClusterCertMatchingRuleAttributeFilter body = new DmrClusterCertMatchingRuleAttributeFilter(); // DmrClusterCertMatchingRuleAttributeFilter | The Certificate Matching Rule Attribute Filter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleAttributeFilterResponse result = apiInstance.replaceDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#replaceDmrClusterCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | -| **body** | [**DmrClusterCertMatchingRuleAttributeFilter**](DmrClusterCertMatchingRuleAttributeFilter.md)| The Certificate Matching Rule Attribute Filter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleAttributeFilterResponse**](DmrClusterCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceDmrClusterLink - -> DmrClusterLinkResponse replaceDmrClusterLink(dmrClusterName, remoteNodeName, body, opaquePassword, select) - -Replace a Link object. - -Replace a Link object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword||||x|x||x authenticationScheme|||||x|| dmrClusterName|x||x|||| egressFlowWindowSize|||||x|| initiator|||||x|| remoteNodeName|x||x|||| span|||||x|| transportCompressedEnabled|||||x|| transportTlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - DmrClusterLink body = new DmrClusterLink(); // DmrClusterLink | The Link object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkResponse result = apiInstance.replaceDmrClusterLink(dmrClusterName, remoteNodeName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#replaceDmrClusterLink"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **body** | [**DmrClusterLink**](DmrClusterLink.md)| The Link object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkResponse**](DmrClusterLinkResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Link object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateDmrCluster - -> DmrClusterResponse updateDmrCluster(dmrClusterName, body, opaquePassword, select) - -Update a Cluster object. - -Update a Cluster object. Any attribute missing from the request will be left unchanged. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword|||x|x||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| directOnlyEnabled||x|||| dmrClusterName|x|x|||| nodeName||x|||| tlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - DmrCluster body = new DmrCluster(); // DmrCluster | The Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterResponse result = apiInstance.updateDmrCluster(dmrClusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#updateDmrCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **body** | [**DmrCluster**](DmrCluster.md)| The Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterResponse**](DmrClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cluster object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateDmrClusterCertMatchingRule - -> DmrClusterCertMatchingRuleResponse updateDmrClusterCertMatchingRule(dmrClusterName, ruleName, body, opaquePassword, select) - -Update a Certificate Matching Rule object. - -Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- dmrClusterName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - DmrClusterCertMatchingRule body = new DmrClusterCertMatchingRule(); // DmrClusterCertMatchingRule | The Certificate Matching Rule object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleResponse result = apiInstance.updateDmrClusterCertMatchingRule(dmrClusterName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#updateDmrClusterCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**DmrClusterCertMatchingRule**](DmrClusterCertMatchingRule.md)| The Certificate Matching Rule object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleResponse**](DmrClusterCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateDmrClusterCertMatchingRuleAttributeFilter - -> DmrClusterCertMatchingRuleAttributeFilterResponse updateDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, body, opaquePassword, select) - -Update a Certificate Matching Rule Attribute Filter object. - -Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- dmrClusterName|x|x|||| filterName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - DmrClusterCertMatchingRuleAttributeFilter body = new DmrClusterCertMatchingRuleAttributeFilter(); // DmrClusterCertMatchingRuleAttributeFilter | The Certificate Matching Rule Attribute Filter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterCertMatchingRuleAttributeFilterResponse result = apiInstance.updateDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#updateDmrClusterCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | -| **body** | [**DmrClusterCertMatchingRuleAttributeFilter**](DmrClusterCertMatchingRuleAttributeFilter.md)| The Certificate Matching Rule Attribute Filter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterCertMatchingRuleAttributeFilterResponse**](DmrClusterCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateDmrClusterLink - -> DmrClusterLinkResponse updateDmrClusterLink(dmrClusterName, remoteNodeName, body, opaquePassword, select) - -Update a Link object. - -Update a Link object. Any attribute missing from the request will be left unchanged. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword|||x|x||x authenticationScheme||||x|| dmrClusterName|x|x|||| egressFlowWindowSize||||x|| initiator||||x|| remoteNodeName|x|x|||| span||||x|| transportCompressedEnabled||||x|| transportTlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DmrClusterApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DmrClusterApi apiInstance = new DmrClusterApi(defaultClient); - String dmrClusterName = "dmrClusterName_example"; // String | The name of the Cluster. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the Link. - DmrClusterLink body = new DmrClusterLink(); // DmrClusterLink | The Link object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DmrClusterLinkResponse result = apiInstance.updateDmrClusterLink(dmrClusterName, remoteNodeName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DmrClusterApi#updateDmrClusterLink"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **dmrClusterName** | **String**| The name of the Cluster. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the Link. | | -| **body** | [**DmrClusterLink**](DmrClusterLink.md)| The Link object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DmrClusterLinkResponse**](DmrClusterLinkResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Link object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/DmrClusterCertMatchingRule.md b/service/solace-config-client/docs/DmrClusterCertMatchingRule.md deleted file mode 100644 index 430e35cb0..000000000 --- a/service/solace-config-client/docs/DmrClusterCertMatchingRule.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterCertMatchingRule - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**dmrClusterName** | **String** | The name of the Cluster. | [optional] | -|**enabled** | **Boolean** | Enable or disable a certificate matching rule. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. | [optional] | -|**ruleName** | **String** | The name of the rule. | [optional] | - - - diff --git a/service/solace-config-client/docs/DmrClusterCertMatchingRuleAttributeFilter.md b/service/solace-config-client/docs/DmrClusterCertMatchingRuleAttributeFilter.md deleted file mode 100644 index e4d2165da..000000000 --- a/service/solace-config-client/docs/DmrClusterCertMatchingRuleAttributeFilter.md +++ /dev/null @@ -1,17 +0,0 @@ - - -# DmrClusterCertMatchingRuleAttributeFilter - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**attributeName** | **String** | Link Attribute to be tested. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**attributeValue** | **String** | Expected attribute value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**dmrClusterName** | **String** | The name of the Cluster. | [optional] | -|**filterName** | **String** | The name of the filter. | [optional] | -|**ruleName** | **String** | The name of the rule. | [optional] | - - - diff --git a/service/solace-config-client/docs/DmrClusterCertMatchingRuleAttributeFilterLinks.md b/service/solace-config-client/docs/DmrClusterCertMatchingRuleAttributeFilterLinks.md deleted file mode 100644 index 32a65bc57..000000000 --- a/service/solace-config-client/docs/DmrClusterCertMatchingRuleAttributeFilterLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# DmrClusterCertMatchingRuleAttributeFilterLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Certificate Matching Rule Attribute Filter object. | [optional] | - - - diff --git a/service/solace-config-client/docs/DmrClusterCertMatchingRuleAttributeFilterResponse.md b/service/solace-config-client/docs/DmrClusterCertMatchingRuleAttributeFilterResponse.md deleted file mode 100644 index 681a151ac..000000000 --- a/service/solace-config-client/docs/DmrClusterCertMatchingRuleAttributeFilterResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterCertMatchingRuleAttributeFilterResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**DmrClusterCertMatchingRuleAttributeFilter**](DmrClusterCertMatchingRuleAttributeFilter.md) | | [optional] | -|**links** | [**DmrClusterCertMatchingRuleAttributeFilterLinks**](DmrClusterCertMatchingRuleAttributeFilterLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DmrClusterCertMatchingRuleAttributeFiltersResponse.md b/service/solace-config-client/docs/DmrClusterCertMatchingRuleAttributeFiltersResponse.md deleted file mode 100644 index b9cc05086..000000000 --- a/service/solace-config-client/docs/DmrClusterCertMatchingRuleAttributeFiltersResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterCertMatchingRuleAttributeFiltersResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<DmrClusterCertMatchingRuleAttributeFilter>**](DmrClusterCertMatchingRuleAttributeFilter.md) | | [optional] | -|**links** | [**List<DmrClusterCertMatchingRuleAttributeFilterLinks>**](DmrClusterCertMatchingRuleAttributeFilterLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DmrClusterCertMatchingRuleCondition.md b/service/solace-config-client/docs/DmrClusterCertMatchingRuleCondition.md deleted file mode 100644 index 6326e6cd7..000000000 --- a/service/solace-config-client/docs/DmrClusterCertMatchingRuleCondition.md +++ /dev/null @@ -1,37 +0,0 @@ - - -# DmrClusterCertMatchingRuleCondition - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**attribute** | **String** | Link Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The default value is `\"\"`. | [optional] | -|**dmrClusterName** | **String** | The name of the Cluster. | [optional] | -|**expression** | **String** | Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The default value is `\"\"`. | [optional] | -|**ruleName** | **String** | The name of the rule. | [optional] | -|**source** | [**SourceEnum**](#SourceEnum) | Certificate field to be compared with the Attribute. The allowed values and their meaning are: <pre> \"certificate-thumbprint\" - The attribute is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate. \"common-name\" - The attribute is extracted from the certificate's first instance of the Common Name attribute in the Subject DN. \"common-name-last\" - The attribute is extracted from the certificate's last instance of the Common Name attribute in the Subject DN. \"subject-alternate-name-msupn\" - The attribute is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature. \"uid\" - The attribute is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN. \"uid-last\" - The attribute is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN. \"org-unit\" - The attribute is extracted from the certificate's first instance of the Org Unit attribute in the Subject DN. \"org-unit-last\" - The attribute is extracted from the certificate's last instance of the Org Unit attribute in the Subject DN. \"issuer\" - The attribute is extracted from the certificate's Issuer DN. \"subject\" - The attribute is extracted from the certificate's Subject DN. \"serial-number\" - The attribute is extracted from the certificate's Serial Number. \"dns-name\" - The attribute is extracted from the certificate's Subject Alt Name DNSName. \"ip-address\" - The attribute is extracted from the certificate's Subject Alt Name IPAddress. </pre> | [optional] | - - - -## Enum: SourceEnum - -| Name | Value | -|---- | -----| -| CERTIFICATE_THUMBPRINT | "certificate-thumbprint" | -| COMMON_NAME | "common-name" | -| COMMON_NAME_LAST | "common-name-last" | -| SUBJECT_ALTERNATE_NAME_MSUPN | "subject-alternate-name-msupn" | -| UID | "uid" | -| UID_LAST | "uid-last" | -| ORG_UNIT | "org-unit" | -| ORG_UNIT_LAST | "org-unit-last" | -| ISSUER | "issuer" | -| SUBJECT | "subject" | -| SERIAL_NUMBER | "serial-number" | -| DNS_NAME | "dns-name" | -| IP_ADDRESS | "ip-address" | - - - diff --git a/service/solace-config-client/docs/DmrClusterCertMatchingRuleConditionLinks.md b/service/solace-config-client/docs/DmrClusterCertMatchingRuleConditionLinks.md deleted file mode 100644 index 823d11e19..000000000 --- a/service/solace-config-client/docs/DmrClusterCertMatchingRuleConditionLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# DmrClusterCertMatchingRuleConditionLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Certificate Matching Rule Condition object. | [optional] | - - - diff --git a/service/solace-config-client/docs/DmrClusterCertMatchingRuleConditionResponse.md b/service/solace-config-client/docs/DmrClusterCertMatchingRuleConditionResponse.md deleted file mode 100644 index 08cdf1e42..000000000 --- a/service/solace-config-client/docs/DmrClusterCertMatchingRuleConditionResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterCertMatchingRuleConditionResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**DmrClusterCertMatchingRuleCondition**](DmrClusterCertMatchingRuleCondition.md) | | [optional] | -|**links** | [**DmrClusterCertMatchingRuleConditionLinks**](DmrClusterCertMatchingRuleConditionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DmrClusterCertMatchingRuleConditionsResponse.md b/service/solace-config-client/docs/DmrClusterCertMatchingRuleConditionsResponse.md deleted file mode 100644 index 278369691..000000000 --- a/service/solace-config-client/docs/DmrClusterCertMatchingRuleConditionsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterCertMatchingRuleConditionsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<DmrClusterCertMatchingRuleCondition>**](DmrClusterCertMatchingRuleCondition.md) | | [optional] | -|**links** | [**List<DmrClusterCertMatchingRuleConditionLinks>**](DmrClusterCertMatchingRuleConditionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DmrClusterCertMatchingRuleLinks.md b/service/solace-config-client/docs/DmrClusterCertMatchingRuleLinks.md deleted file mode 100644 index c35f40696..000000000 --- a/service/solace-config-client/docs/DmrClusterCertMatchingRuleLinks.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterCertMatchingRuleLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**attributeFiltersUri** | **String** | The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Attribute Filter objects. | [optional] | -|**conditionsUri** | **String** | The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Condition objects. | [optional] | -|**uri** | **String** | The URI of this Certificate Matching Rule object. | [optional] | - - - diff --git a/service/solace-config-client/docs/DmrClusterCertMatchingRuleResponse.md b/service/solace-config-client/docs/DmrClusterCertMatchingRuleResponse.md deleted file mode 100644 index bd6765efe..000000000 --- a/service/solace-config-client/docs/DmrClusterCertMatchingRuleResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterCertMatchingRuleResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**DmrClusterCertMatchingRule**](DmrClusterCertMatchingRule.md) | | [optional] | -|**links** | [**DmrClusterCertMatchingRuleLinks**](DmrClusterCertMatchingRuleLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DmrClusterCertMatchingRulesResponse.md b/service/solace-config-client/docs/DmrClusterCertMatchingRulesResponse.md deleted file mode 100644 index 5660359dc..000000000 --- a/service/solace-config-client/docs/DmrClusterCertMatchingRulesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterCertMatchingRulesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<DmrClusterCertMatchingRule>**](DmrClusterCertMatchingRule.md) | | [optional] | -|**links** | [**List<DmrClusterCertMatchingRuleLinks>**](DmrClusterCertMatchingRuleLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DmrClusterLink.md b/service/solace-config-client/docs/DmrClusterLink.md deleted file mode 100644 index 10f5b9cf8..000000000 --- a/service/solace-config-client/docs/DmrClusterLink.md +++ /dev/null @@ -1,84 +0,0 @@ - - -# DmrClusterLink - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**authenticationBasicPassword** | **String** | The password used to authenticate with the remote node when using basic internal authentication. If this per-Link password is not configured, the Cluster's password is used instead. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**authenticationScheme** | [**AuthenticationSchemeEnum**](#AuthenticationSchemeEnum) | The authentication scheme to be used by the Link which initiates connections to the remote node. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"basic\"`. The allowed values and their meaning are: <pre> \"basic\" - Basic Authentication Scheme (via username and password). \"client-certificate\" - Client Certificate Authentication Scheme (via certificate file or content). </pre> | [optional] | -|**clientProfileQueueControl1MaxDepth** | **Integer** | The maximum depth of the \"Control 1\" (C-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`. | [optional] | -|**clientProfileQueueControl1MinMsgBurst** | **Integer** | The number of messages that are always allowed entry into the \"Control 1\" (C-1) priority queue, regardless of the `clientProfileQueueControl1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`. | [optional] | -|**clientProfileQueueDirect1MaxDepth** | **Integer** | The maximum depth of the \"Direct 1\" (D-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`. | [optional] | -|**clientProfileQueueDirect1MinMsgBurst** | **Integer** | The number of messages that are always allowed entry into the \"Direct 1\" (D-1) priority queue, regardless of the `clientProfileQueueDirect1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`. | [optional] | -|**clientProfileQueueDirect2MaxDepth** | **Integer** | The maximum depth of the \"Direct 2\" (D-2) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`. | [optional] | -|**clientProfileQueueDirect2MinMsgBurst** | **Integer** | The number of messages that are always allowed entry into the \"Direct 2\" (D-2) priority queue, regardless of the `clientProfileQueueDirect2MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`. | [optional] | -|**clientProfileQueueDirect3MaxDepth** | **Integer** | The maximum depth of the \"Direct 3\" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`. | [optional] | -|**clientProfileQueueDirect3MinMsgBurst** | **Integer** | The number of messages that are always allowed entry into the \"Direct 3\" (D-3) priority queue, regardless of the `clientProfileQueueDirect3MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`. | [optional] | -|**clientProfileQueueGuaranteed1MaxDepth** | **Integer** | The maximum depth of the \"Guaranteed 1\" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`. | [optional] | -|**clientProfileQueueGuaranteed1MinMsgBurst** | **Integer** | The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-3) priority queue, regardless of the `clientProfileQueueGuaranteed1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`. | [optional] | -|**clientProfileTcpCongestionWindowSize** | **Long** | The TCP initial congestion window size, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `2`. | [optional] | -|**clientProfileTcpKeepaliveCount** | **Long** | The number of TCP keepalive retransmissions to be carried out before declaring that the remote end is not available. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`. | [optional] | -|**clientProfileTcpKeepaliveIdleTime** | **Long** | The amount of time a connection must remain idle before TCP begins sending keepalive probes, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`. | [optional] | -|**clientProfileTcpKeepaliveInterval** | **Long** | The amount of time between TCP keepalive retransmissions when no acknowledgement is received, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`. | [optional] | -|**clientProfileTcpMaxSegmentSize** | **Long** | The TCP maximum segment size, in bytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1460`. | [optional] | -|**clientProfileTcpMaxWindowSize** | **Long** | The TCP maximum window size, in kilobytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `256`. | [optional] | -|**dmrClusterName** | **String** | The name of the Cluster. | [optional] | -|**egressFlowWindowSize** | **Long** | The number of outstanding guaranteed messages that can be sent over the Link before acknowledgement is received by the sender. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`. | [optional] | -|**enabled** | **Boolean** | Enable or disable the Link. When disabled, subscription sets of this and the remote node are not kept up-to-date, and messages are not exchanged with the remote node. Published guaranteed messages will be queued up for future delivery based on current subscription sets. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. | [optional] | -|**initiator** | [**InitiatorEnum**](#InitiatorEnum) | The initiator of the Link's TCP connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"lexical\"`. The allowed values and their meaning are: <pre> \"lexical\" - The \"higher\" node-name initiates. \"local\" - The local node initiates. \"remote\" - The remote node initiates. </pre> | [optional] | -|**queueDeadMsgQueue** | **String** | The name of the Dead Message Queue (DMQ) used by the Queue for discarded messages. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. | [optional] | -|**queueEventSpoolUsageThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**queueMaxDeliveredUnackedMsgsPerFlow** | **Long** | The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1000000`. | [optional] | -|**queueMaxMsgSpoolUsage** | **Long** | The maximum message spool usage by the Queue (quota), in megabytes (MB). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `800000`. | [optional] | -|**queueMaxRedeliveryCount** | **Long** | The maximum number of times the Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. | [optional] | -|**queueMaxTtl** | **Long** | The maximum time in seconds a message can stay in the Queue when `queueRespectTtlEnabled` is `true`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `queueMaxTtl` configured for the Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. | [optional] | -|**queueRejectMsgToSenderOnDiscardBehavior** | [**QueueRejectMsgToSenderOnDiscardBehaviorEnum**](#QueueRejectMsgToSenderOnDiscardBehaviorEnum) | Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"always\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-queue-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> | [optional] | -|**queueRespectTtlEnabled** | **Boolean** | Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. | [optional] | -|**remoteNodeName** | **String** | The name of the node at the remote end of the Link. | [optional] | -|**span** | [**SpanEnum**](#SpanEnum) | The span of the Link, either internal or external. Internal Links connect nodes within the same Cluster. External Links connect nodes within different Clusters. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"external\"`. The allowed values and their meaning are: <pre> \"internal\" - Link to same cluster. \"external\" - Link to other cluster. </pre> | [optional] | -|**transportCompressedEnabled** | **Boolean** | Enable or disable compression on the Link. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. | [optional] | -|**transportTlsEnabled** | **Boolean** | Enable or disable encryption (TLS) on the Link. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. | [optional] | - - - -## Enum: AuthenticationSchemeEnum - -| Name | Value | -|---- | -----| -| BASIC | "basic" | -| CLIENT_CERTIFICATE | "client-certificate" | - - - -## Enum: InitiatorEnum - -| Name | Value | -|---- | -----| -| LEXICAL | "lexical" | -| LOCAL | "local" | -| REMOTE | "remote" | - - - -## Enum: QueueRejectMsgToSenderOnDiscardBehaviorEnum - -| Name | Value | -|---- | -----| -| ALWAYS | "always" | -| WHEN_QUEUE_ENABLED | "when-queue-enabled" | -| NEVER | "never" | - - - -## Enum: SpanEnum - -| Name | Value | -|---- | -----| -| INTERNAL | "internal" | -| EXTERNAL | "external" | - - - diff --git a/service/solace-config-client/docs/DmrClusterLinkAttribute.md b/service/solace-config-client/docs/DmrClusterLinkAttribute.md deleted file mode 100644 index 2cc62bd08..000000000 --- a/service/solace-config-client/docs/DmrClusterLinkAttribute.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# DmrClusterLinkAttribute - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**attributeName** | **String** | The name of the Attribute. | [optional] | -|**attributeValue** | **String** | The value of the Attribute. | [optional] | -|**dmrClusterName** | **String** | The name of the Cluster. | [optional] | -|**remoteNodeName** | **String** | The name of the node at the remote end of the Link. | [optional] | - - - diff --git a/service/solace-config-client/docs/DmrClusterLinkAttributeLinks.md b/service/solace-config-client/docs/DmrClusterLinkAttributeLinks.md deleted file mode 100644 index e3888ca6a..000000000 --- a/service/solace-config-client/docs/DmrClusterLinkAttributeLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# DmrClusterLinkAttributeLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Link Attribute object. | [optional] | - - - diff --git a/service/solace-config-client/docs/DmrClusterLinkAttributeResponse.md b/service/solace-config-client/docs/DmrClusterLinkAttributeResponse.md deleted file mode 100644 index f9df88d6d..000000000 --- a/service/solace-config-client/docs/DmrClusterLinkAttributeResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterLinkAttributeResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**DmrClusterLinkAttribute**](DmrClusterLinkAttribute.md) | | [optional] | -|**links** | [**DmrClusterLinkAttributeLinks**](DmrClusterLinkAttributeLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DmrClusterLinkAttributesResponse.md b/service/solace-config-client/docs/DmrClusterLinkAttributesResponse.md deleted file mode 100644 index 225a60115..000000000 --- a/service/solace-config-client/docs/DmrClusterLinkAttributesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterLinkAttributesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<DmrClusterLinkAttribute>**](DmrClusterLinkAttribute.md) | | [optional] | -|**links** | [**List<DmrClusterLinkAttributeLinks>**](DmrClusterLinkAttributeLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DmrClusterLinkLinks.md b/service/solace-config-client/docs/DmrClusterLinkLinks.md deleted file mode 100644 index 871f7107e..000000000 --- a/service/solace-config-client/docs/DmrClusterLinkLinks.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# DmrClusterLinkLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**attributesUri** | **String** | The URI of this Link's collection of Link Attribute objects. Available since 2.28. | [optional] | -|**remoteAddressesUri** | **String** | The URI of this Link's collection of Remote Address objects. | [optional] | -|**tlsTrustedCommonNamesUri** | **String** | The URI of this Link's collection of Trusted Common Name objects. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. | [optional] | -|**uri** | **String** | The URI of this Link object. | [optional] | - - - diff --git a/service/solace-config-client/docs/DmrClusterLinkRemoteAddress.md b/service/solace-config-client/docs/DmrClusterLinkRemoteAddress.md deleted file mode 100644 index b9c81ec77..000000000 --- a/service/solace-config-client/docs/DmrClusterLinkRemoteAddress.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterLinkRemoteAddress - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**dmrClusterName** | **String** | The name of the Cluster. | [optional] | -|**remoteAddress** | **String** | The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). | [optional] | -|**remoteNodeName** | **String** | The name of the node at the remote end of the Link. | [optional] | - - - diff --git a/service/solace-config-client/docs/DmrClusterLinkRemoteAddressLinks.md b/service/solace-config-client/docs/DmrClusterLinkRemoteAddressLinks.md deleted file mode 100644 index 17120f156..000000000 --- a/service/solace-config-client/docs/DmrClusterLinkRemoteAddressLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# DmrClusterLinkRemoteAddressLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Remote Address object. | [optional] | - - - diff --git a/service/solace-config-client/docs/DmrClusterLinkRemoteAddressResponse.md b/service/solace-config-client/docs/DmrClusterLinkRemoteAddressResponse.md deleted file mode 100644 index c532c8f6d..000000000 --- a/service/solace-config-client/docs/DmrClusterLinkRemoteAddressResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterLinkRemoteAddressResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**DmrClusterLinkRemoteAddress**](DmrClusterLinkRemoteAddress.md) | | [optional] | -|**links** | [**DmrClusterLinkRemoteAddressLinks**](DmrClusterLinkRemoteAddressLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DmrClusterLinkRemoteAddressesResponse.md b/service/solace-config-client/docs/DmrClusterLinkRemoteAddressesResponse.md deleted file mode 100644 index 133eac59a..000000000 --- a/service/solace-config-client/docs/DmrClusterLinkRemoteAddressesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterLinkRemoteAddressesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<DmrClusterLinkRemoteAddress>**](DmrClusterLinkRemoteAddress.md) | | [optional] | -|**links** | [**List<DmrClusterLinkRemoteAddressLinks>**](DmrClusterLinkRemoteAddressLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DmrClusterLinkResponse.md b/service/solace-config-client/docs/DmrClusterLinkResponse.md deleted file mode 100644 index c6d1b262b..000000000 --- a/service/solace-config-client/docs/DmrClusterLinkResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterLinkResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**DmrClusterLink**](DmrClusterLink.md) | | [optional] | -|**links** | [**DmrClusterLinkLinks**](DmrClusterLinkLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DmrClusterLinkTlsTrustedCommonName.md b/service/solace-config-client/docs/DmrClusterLinkTlsTrustedCommonName.md deleted file mode 100644 index cbfa1dcf9..000000000 --- a/service/solace-config-client/docs/DmrClusterLinkTlsTrustedCommonName.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterLinkTlsTrustedCommonName - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**dmrClusterName** | **String** | The name of the Cluster. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. | [optional] | -|**remoteNodeName** | **String** | The name of the node at the remote end of the Link. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. | [optional] | -|**tlsTrustedCommonName** | **String** | The expected trusted common name of the remote certificate. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. | [optional] | - - - diff --git a/service/solace-config-client/docs/DmrClusterLinkTlsTrustedCommonNameLinks.md b/service/solace-config-client/docs/DmrClusterLinkTlsTrustedCommonNameLinks.md deleted file mode 100644 index 074503532..000000000 --- a/service/solace-config-client/docs/DmrClusterLinkTlsTrustedCommonNameLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# DmrClusterLinkTlsTrustedCommonNameLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Trusted Common Name object. | [optional] | - - - diff --git a/service/solace-config-client/docs/DmrClusterLinkTlsTrustedCommonNameResponse.md b/service/solace-config-client/docs/DmrClusterLinkTlsTrustedCommonNameResponse.md deleted file mode 100644 index 7360b4c9f..000000000 --- a/service/solace-config-client/docs/DmrClusterLinkTlsTrustedCommonNameResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterLinkTlsTrustedCommonNameResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**DmrClusterLinkTlsTrustedCommonName**](DmrClusterLinkTlsTrustedCommonName.md) | | [optional] | -|**links** | [**DmrClusterLinkTlsTrustedCommonNameLinks**](DmrClusterLinkTlsTrustedCommonNameLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DmrClusterLinkTlsTrustedCommonNamesResponse.md b/service/solace-config-client/docs/DmrClusterLinkTlsTrustedCommonNamesResponse.md deleted file mode 100644 index 776f6d960..000000000 --- a/service/solace-config-client/docs/DmrClusterLinkTlsTrustedCommonNamesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterLinkTlsTrustedCommonNamesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<DmrClusterLinkTlsTrustedCommonName>**](DmrClusterLinkTlsTrustedCommonName.md) | | [optional] | -|**links** | [**List<DmrClusterLinkTlsTrustedCommonNameLinks>**](DmrClusterLinkTlsTrustedCommonNameLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DmrClusterLinks.md b/service/solace-config-client/docs/DmrClusterLinks.md deleted file mode 100644 index b617fe461..000000000 --- a/service/solace-config-client/docs/DmrClusterLinks.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**certMatchingRulesUri** | **String** | The URI of this Cluster's collection of Certificate Matching Rule objects. Available since 2.28. | [optional] | -|**linksUri** | **String** | The URI of this Cluster's collection of Link objects. | [optional] | -|**uri** | **String** | The URI of this Cluster object. | [optional] | - - - diff --git a/service/solace-config-client/docs/DmrClusterLinksResponse.md b/service/solace-config-client/docs/DmrClusterLinksResponse.md deleted file mode 100644 index a7e89d33d..000000000 --- a/service/solace-config-client/docs/DmrClusterLinksResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterLinksResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<DmrClusterLink>**](DmrClusterLink.md) | | [optional] | -|**links** | [**List<DmrClusterLinkLinks>**](DmrClusterLinkLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DmrClusterResponse.md b/service/solace-config-client/docs/DmrClusterResponse.md deleted file mode 100644 index 506309ef5..000000000 --- a/service/solace-config-client/docs/DmrClusterResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClusterResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**DmrCluster**](DmrCluster.md) | | [optional] | -|**links** | [**DmrClusterLinks**](DmrClusterLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DmrClustersResponse.md b/service/solace-config-client/docs/DmrClustersResponse.md deleted file mode 100644 index c473e1b1f..000000000 --- a/service/solace-config-client/docs/DmrClustersResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DmrClustersResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<DmrCluster>**](DmrCluster.md) | | [optional] | -|**links** | [**List<DmrClusterLinks>**](DmrClusterLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DomainCertAuthoritiesResponse.md b/service/solace-config-client/docs/DomainCertAuthoritiesResponse.md deleted file mode 100644 index b1eebe71c..000000000 --- a/service/solace-config-client/docs/DomainCertAuthoritiesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DomainCertAuthoritiesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<DomainCertAuthority>**](DomainCertAuthority.md) | | [optional] | -|**links** | [**List<DomainCertAuthorityLinks>**](DomainCertAuthorityLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/DomainCertAuthority.md b/service/solace-config-client/docs/DomainCertAuthority.md deleted file mode 100644 index 8ba97aac3..000000000 --- a/service/solace-config-client/docs/DomainCertAuthority.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# DomainCertAuthority - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**certAuthorityName** | **String** | The name of the Certificate Authority. | [optional] | -|**certContent** | **String** | The PEM formatted content for the trusted root certificate of a domain Certificate Authority. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | - - - diff --git a/service/solace-config-client/docs/DomainCertAuthorityApi.md b/service/solace-config-client/docs/DomainCertAuthorityApi.md deleted file mode 100644 index 4d549aba2..000000000 --- a/service/solace-config-client/docs/DomainCertAuthorityApi.md +++ /dev/null @@ -1,480 +0,0 @@ -# DomainCertAuthorityApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createDomainCertAuthority**](DomainCertAuthorityApi.md#createDomainCertAuthority) | **POST** /domainCertAuthorities | Create a Domain Certificate Authority object. | -| [**deleteDomainCertAuthority**](DomainCertAuthorityApi.md#deleteDomainCertAuthority) | **DELETE** /domainCertAuthorities/{certAuthorityName} | Delete a Domain Certificate Authority object. | -| [**getDomainCertAuthorities**](DomainCertAuthorityApi.md#getDomainCertAuthorities) | **GET** /domainCertAuthorities | Get a list of Domain Certificate Authority objects. | -| [**getDomainCertAuthority**](DomainCertAuthorityApi.md#getDomainCertAuthority) | **GET** /domainCertAuthorities/{certAuthorityName} | Get a Domain Certificate Authority object. | -| [**replaceDomainCertAuthority**](DomainCertAuthorityApi.md#replaceDomainCertAuthority) | **PUT** /domainCertAuthorities/{certAuthorityName} | Replace a Domain Certificate Authority object. | -| [**updateDomainCertAuthority**](DomainCertAuthorityApi.md#updateDomainCertAuthority) | **PATCH** /domainCertAuthorities/{certAuthorityName} | Update a Domain Certificate Authority object. | - - - -## createDomainCertAuthority - -> DomainCertAuthorityResponse createDomainCertAuthority(body, opaquePassword, select) - -Create a Domain Certificate Authority object. - -Create a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Certificate Authorities trusted for domain verification. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DomainCertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DomainCertAuthorityApi apiInstance = new DomainCertAuthorityApi(defaultClient); - DomainCertAuthority body = new DomainCertAuthority(); // DomainCertAuthority | The Domain Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DomainCertAuthorityResponse result = apiInstance.createDomainCertAuthority(body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DomainCertAuthorityApi#createDomainCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **body** | [**DomainCertAuthority**](DomainCertAuthority.md)| The Domain Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DomainCertAuthorityResponse**](DomainCertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Domain Certificate Authority object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteDomainCertAuthority - -> SempMetaOnlyResponse deleteDomainCertAuthority(certAuthorityName) - -Delete a Domain Certificate Authority object. - -Delete a Domain Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Certificate Authorities trusted for domain verification. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DomainCertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DomainCertAuthorityApi apiInstance = new DomainCertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - try { - SempMetaOnlyResponse result = apiInstance.deleteDomainCertAuthority(certAuthorityName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DomainCertAuthorityApi#deleteDomainCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getDomainCertAuthorities - -> DomainCertAuthoritiesResponse getDomainCertAuthorities(count, cursor, opaquePassword, where, select) - -Get a list of Domain Certificate Authority objects. - -Get a list of Domain Certificate Authority objects. Certificate Authorities trusted for domain verification. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DomainCertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DomainCertAuthorityApi apiInstance = new DomainCertAuthorityApi(defaultClient); - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DomainCertAuthoritiesResponse result = apiInstance.getDomainCertAuthorities(count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DomainCertAuthorityApi#getDomainCertAuthorities"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DomainCertAuthoritiesResponse**](DomainCertAuthoritiesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Domain Certificate Authority objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getDomainCertAuthority - -> DomainCertAuthorityResponse getDomainCertAuthority(certAuthorityName, opaquePassword, select) - -Get a Domain Certificate Authority object. - -Get a Domain Certificate Authority object. Certificate Authorities trusted for domain verification. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DomainCertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DomainCertAuthorityApi apiInstance = new DomainCertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DomainCertAuthorityResponse result = apiInstance.getDomainCertAuthority(certAuthorityName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DomainCertAuthorityApi#getDomainCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DomainCertAuthorityResponse**](DomainCertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Domain Certificate Authority object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceDomainCertAuthority - -> DomainCertAuthorityResponse replaceDomainCertAuthority(certAuthorityName, body, opaquePassword, select) - -Replace a Domain Certificate Authority object. - -Replace a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Certificate Authorities trusted for domain verification. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DomainCertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DomainCertAuthorityApi apiInstance = new DomainCertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - DomainCertAuthority body = new DomainCertAuthority(); // DomainCertAuthority | The Domain Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DomainCertAuthorityResponse result = apiInstance.replaceDomainCertAuthority(certAuthorityName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DomainCertAuthorityApi#replaceDomainCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **body** | [**DomainCertAuthority**](DomainCertAuthority.md)| The Domain Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DomainCertAuthorityResponse**](DomainCertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Domain Certificate Authority object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateDomainCertAuthority - -> DomainCertAuthorityResponse updateDomainCertAuthority(certAuthorityName, body, opaquePassword, select) - -Update a Domain Certificate Authority object. - -Update a Domain Certificate Authority object. Any attribute missing from the request will be left unchanged. Certificate Authorities trusted for domain verification. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.DomainCertAuthorityApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - DomainCertAuthorityApi apiInstance = new DomainCertAuthorityApi(defaultClient); - String certAuthorityName = "certAuthorityName_example"; // String | The name of the Certificate Authority. - DomainCertAuthority body = new DomainCertAuthority(); // DomainCertAuthority | The Domain Certificate Authority object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - DomainCertAuthorityResponse result = apiInstance.updateDomainCertAuthority(certAuthorityName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling DomainCertAuthorityApi#updateDomainCertAuthority"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **certAuthorityName** | **String**| The name of the Certificate Authority. | | -| **body** | [**DomainCertAuthority**](DomainCertAuthority.md)| The Domain Certificate Authority object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**DomainCertAuthorityResponse**](DomainCertAuthorityResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Domain Certificate Authority object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/DomainCertAuthorityLinks.md b/service/solace-config-client/docs/DomainCertAuthorityLinks.md deleted file mode 100644 index ec9e36db3..000000000 --- a/service/solace-config-client/docs/DomainCertAuthorityLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# DomainCertAuthorityLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Domain Certificate Authority object. | [optional] | - - - diff --git a/service/solace-config-client/docs/DomainCertAuthorityResponse.md b/service/solace-config-client/docs/DomainCertAuthorityResponse.md deleted file mode 100644 index 9baf1c540..000000000 --- a/service/solace-config-client/docs/DomainCertAuthorityResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# DomainCertAuthorityResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**DomainCertAuthority**](DomainCertAuthority.md) | | [optional] | -|**links** | [**DomainCertAuthorityLinks**](DomainCertAuthorityLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/EventThreshold.md b/service/solace-config-client/docs/EventThreshold.md deleted file mode 100644 index 99e9c53be..000000000 --- a/service/solace-config-client/docs/EventThreshold.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# EventThreshold - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**clearPercent** | **Long** | The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET. | [optional] | -|**clearValue** | **Long** | The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET. | [optional] | -|**setPercent** | **Long** | The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET. | [optional] | -|**setValue** | **Long** | The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET. | [optional] | - - - diff --git a/service/solace-config-client/docs/EventThresholdByPercent.md b/service/solace-config-client/docs/EventThresholdByPercent.md deleted file mode 100644 index 60cc952e4..000000000 --- a/service/solace-config-client/docs/EventThresholdByPercent.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# EventThresholdByPercent - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**clearPercent** | **Long** | The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. | [optional] | -|**setPercent** | **Long** | The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. | [optional] | - - - diff --git a/service/solace-config-client/docs/EventThresholdByValue.md b/service/solace-config-client/docs/EventThresholdByValue.md deleted file mode 100644 index 05d26566b..000000000 --- a/service/solace-config-client/docs/EventThresholdByValue.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# EventThresholdByValue - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**clearValue** | **Long** | The clear threshold for the absolute value of this counter or rate. Falling below this value will trigger a corresponding event. | [optional] | -|**setValue** | **Long** | The set threshold for the absolute value of this counter or rate. Exceeding this value will trigger a corresponding event. | [optional] | - - - diff --git a/service/solace-config-client/docs/JndiApi.md b/service/solace-config-client/docs/JndiApi.md deleted file mode 100644 index 3c7a3c092..000000000 --- a/service/solace-config-client/docs/JndiApi.md +++ /dev/null @@ -1,1460 +0,0 @@ -# JndiApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnJndiConnectionFactory**](JndiApi.md#createMsgVpnJndiConnectionFactory) | **POST** /msgVpns/{msgVpnName}/jndiConnectionFactories | Create a JNDI Connection Factory object. | -| [**createMsgVpnJndiQueue**](JndiApi.md#createMsgVpnJndiQueue) | **POST** /msgVpns/{msgVpnName}/jndiQueues | Create a JNDI Queue object. | -| [**createMsgVpnJndiTopic**](JndiApi.md#createMsgVpnJndiTopic) | **POST** /msgVpns/{msgVpnName}/jndiTopics | Create a JNDI Topic object. | -| [**deleteMsgVpnJndiConnectionFactory**](JndiApi.md#deleteMsgVpnJndiConnectionFactory) | **DELETE** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Delete a JNDI Connection Factory object. | -| [**deleteMsgVpnJndiQueue**](JndiApi.md#deleteMsgVpnJndiQueue) | **DELETE** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Delete a JNDI Queue object. | -| [**deleteMsgVpnJndiTopic**](JndiApi.md#deleteMsgVpnJndiTopic) | **DELETE** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Delete a JNDI Topic object. | -| [**getMsgVpnJndiConnectionFactories**](JndiApi.md#getMsgVpnJndiConnectionFactories) | **GET** /msgVpns/{msgVpnName}/jndiConnectionFactories | Get a list of JNDI Connection Factory objects. | -| [**getMsgVpnJndiConnectionFactory**](JndiApi.md#getMsgVpnJndiConnectionFactory) | **GET** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Get a JNDI Connection Factory object. | -| [**getMsgVpnJndiQueue**](JndiApi.md#getMsgVpnJndiQueue) | **GET** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Get a JNDI Queue object. | -| [**getMsgVpnJndiQueues**](JndiApi.md#getMsgVpnJndiQueues) | **GET** /msgVpns/{msgVpnName}/jndiQueues | Get a list of JNDI Queue objects. | -| [**getMsgVpnJndiTopic**](JndiApi.md#getMsgVpnJndiTopic) | **GET** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Get a JNDI Topic object. | -| [**getMsgVpnJndiTopics**](JndiApi.md#getMsgVpnJndiTopics) | **GET** /msgVpns/{msgVpnName}/jndiTopics | Get a list of JNDI Topic objects. | -| [**replaceMsgVpnJndiConnectionFactory**](JndiApi.md#replaceMsgVpnJndiConnectionFactory) | **PUT** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Replace a JNDI Connection Factory object. | -| [**replaceMsgVpnJndiQueue**](JndiApi.md#replaceMsgVpnJndiQueue) | **PUT** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Replace a JNDI Queue object. | -| [**replaceMsgVpnJndiTopic**](JndiApi.md#replaceMsgVpnJndiTopic) | **PUT** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Replace a JNDI Topic object. | -| [**updateMsgVpnJndiConnectionFactory**](JndiApi.md#updateMsgVpnJndiConnectionFactory) | **PATCH** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Update a JNDI Connection Factory object. | -| [**updateMsgVpnJndiQueue**](JndiApi.md#updateMsgVpnJndiQueue) | **PATCH** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Update a JNDI Queue object. | -| [**updateMsgVpnJndiTopic**](JndiApi.md#updateMsgVpnJndiTopic) | **PATCH** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Update a JNDI Topic object. | - - - -## createMsgVpnJndiConnectionFactory - -> MsgVpnJndiConnectionFactoryResponse createMsgVpnJndiConnectionFactory(msgVpnName, body, opaquePassword, select) - -Create a JNDI Connection Factory object. - -Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: connectionFactoryName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnJndiConnectionFactory body = new MsgVpnJndiConnectionFactory(); // MsgVpnJndiConnectionFactory | The JNDI Connection Factory object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiConnectionFactoryResponse result = apiInstance.createMsgVpnJndiConnectionFactory(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#createMsgVpnJndiConnectionFactory"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnJndiConnectionFactory**](MsgVpnJndiConnectionFactory.md)| The JNDI Connection Factory object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiConnectionFactoryResponse**](MsgVpnJndiConnectionFactoryResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Connection Factory object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnJndiQueue - -> MsgVpnJndiQueueResponse createMsgVpnJndiQueue(msgVpnName, body, opaquePassword, select) - -Create a JNDI Queue object. - -Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnJndiQueue body = new MsgVpnJndiQueue(); // MsgVpnJndiQueue | The JNDI Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiQueueResponse result = apiInstance.createMsgVpnJndiQueue(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#createMsgVpnJndiQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnJndiQueue**](MsgVpnJndiQueue.md)| The JNDI Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiQueueResponse**](MsgVpnJndiQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Queue object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnJndiTopic - -> MsgVpnJndiTopicResponse createMsgVpnJndiTopic(msgVpnName, body, opaquePassword, select) - -Create a JNDI Topic object. - -Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnJndiTopic body = new MsgVpnJndiTopic(); // MsgVpnJndiTopic | The JNDI Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiTopicResponse result = apiInstance.createMsgVpnJndiTopic(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#createMsgVpnJndiTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnJndiTopic**](MsgVpnJndiTopic.md)| The JNDI Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiTopicResponse**](MsgVpnJndiTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Topic object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnJndiConnectionFactory - -> SempMetaOnlyResponse deleteMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName) - -Delete a JNDI Connection Factory object. - -Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String connectionFactoryName = "connectionFactoryName_example"; // String | The name of the JMS Connection Factory. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#deleteMsgVpnJndiConnectionFactory"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **connectionFactoryName** | **String**| The name of the JMS Connection Factory. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnJndiQueue - -> SempMetaOnlyResponse deleteMsgVpnJndiQueue(msgVpnName, queueName) - -Delete a JNDI Queue object. - -Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The JNDI name of the JMS Queue. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnJndiQueue(msgVpnName, queueName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#deleteMsgVpnJndiQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The JNDI name of the JMS Queue. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnJndiTopic - -> SempMetaOnlyResponse deleteMsgVpnJndiTopic(msgVpnName, topicName) - -Delete a JNDI Topic object. - -Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicName = "topicName_example"; // String | The JNDI name of the JMS Topic. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnJndiTopic(msgVpnName, topicName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#deleteMsgVpnJndiTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicName** | **String**| The JNDI name of the JMS Topic. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiConnectionFactories - -> MsgVpnJndiConnectionFactoriesResponse getMsgVpnJndiConnectionFactories(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of JNDI Connection Factory objects. - -Get a list of JNDI Connection Factory objects. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiConnectionFactoriesResponse result = apiInstance.getMsgVpnJndiConnectionFactories(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#getMsgVpnJndiConnectionFactories"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiConnectionFactoriesResponse**](MsgVpnJndiConnectionFactoriesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of JNDI Connection Factory objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiConnectionFactory - -> MsgVpnJndiConnectionFactoryResponse getMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, opaquePassword, select) - -Get a JNDI Connection Factory object. - -Get a JNDI Connection Factory object. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String connectionFactoryName = "connectionFactoryName_example"; // String | The name of the JMS Connection Factory. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiConnectionFactoryResponse result = apiInstance.getMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#getMsgVpnJndiConnectionFactory"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **connectionFactoryName** | **String**| The name of the JMS Connection Factory. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiConnectionFactoryResponse**](MsgVpnJndiConnectionFactoryResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Connection Factory object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiQueue - -> MsgVpnJndiQueueResponse getMsgVpnJndiQueue(msgVpnName, queueName, opaquePassword, select) - -Get a JNDI Queue object. - -Get a JNDI Queue object. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The JNDI name of the JMS Queue. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiQueueResponse result = apiInstance.getMsgVpnJndiQueue(msgVpnName, queueName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#getMsgVpnJndiQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The JNDI name of the JMS Queue. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiQueueResponse**](MsgVpnJndiQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Queue object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiQueues - -> MsgVpnJndiQueuesResponse getMsgVpnJndiQueues(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of JNDI Queue objects. - -Get a list of JNDI Queue objects. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiQueuesResponse result = apiInstance.getMsgVpnJndiQueues(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#getMsgVpnJndiQueues"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiQueuesResponse**](MsgVpnJndiQueuesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of JNDI Queue objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiTopic - -> MsgVpnJndiTopicResponse getMsgVpnJndiTopic(msgVpnName, topicName, opaquePassword, select) - -Get a JNDI Topic object. - -Get a JNDI Topic object. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicName = "topicName_example"; // String | The JNDI name of the JMS Topic. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiTopicResponse result = apiInstance.getMsgVpnJndiTopic(msgVpnName, topicName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#getMsgVpnJndiTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicName** | **String**| The JNDI name of the JMS Topic. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiTopicResponse**](MsgVpnJndiTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Topic object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiTopics - -> MsgVpnJndiTopicsResponse getMsgVpnJndiTopics(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of JNDI Topic objects. - -Get a list of JNDI Topic objects. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiTopicsResponse result = apiInstance.getMsgVpnJndiTopics(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#getMsgVpnJndiTopics"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiTopicsResponse**](MsgVpnJndiTopicsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of JNDI Topic objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnJndiConnectionFactory - -> MsgVpnJndiConnectionFactoryResponse replaceMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select) - -Replace a JNDI Connection Factory object. - -Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String connectionFactoryName = "connectionFactoryName_example"; // String | The name of the JMS Connection Factory. - MsgVpnJndiConnectionFactory body = new MsgVpnJndiConnectionFactory(); // MsgVpnJndiConnectionFactory | The JNDI Connection Factory object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiConnectionFactoryResponse result = apiInstance.replaceMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#replaceMsgVpnJndiConnectionFactory"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **connectionFactoryName** | **String**| The name of the JMS Connection Factory. | | -| **body** | [**MsgVpnJndiConnectionFactory**](MsgVpnJndiConnectionFactory.md)| The JNDI Connection Factory object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiConnectionFactoryResponse**](MsgVpnJndiConnectionFactoryResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Connection Factory object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnJndiQueue - -> MsgVpnJndiQueueResponse replaceMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select) - -Replace a JNDI Queue object. - -Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The JNDI name of the JMS Queue. - MsgVpnJndiQueue body = new MsgVpnJndiQueue(); // MsgVpnJndiQueue | The JNDI Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiQueueResponse result = apiInstance.replaceMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#replaceMsgVpnJndiQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The JNDI name of the JMS Queue. | | -| **body** | [**MsgVpnJndiQueue**](MsgVpnJndiQueue.md)| The JNDI Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiQueueResponse**](MsgVpnJndiQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Queue object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnJndiTopic - -> MsgVpnJndiTopicResponse replaceMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select) - -Replace a JNDI Topic object. - -Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicName = "topicName_example"; // String | The JNDI name of the JMS Topic. - MsgVpnJndiTopic body = new MsgVpnJndiTopic(); // MsgVpnJndiTopic | The JNDI Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiTopicResponse result = apiInstance.replaceMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#replaceMsgVpnJndiTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicName** | **String**| The JNDI name of the JMS Topic. | | -| **body** | [**MsgVpnJndiTopic**](MsgVpnJndiTopic.md)| The JNDI Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiTopicResponse**](MsgVpnJndiTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Topic object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnJndiConnectionFactory - -> MsgVpnJndiConnectionFactoryResponse updateMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select) - -Update a JNDI Connection Factory object. - -Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String connectionFactoryName = "connectionFactoryName_example"; // String | The name of the JMS Connection Factory. - MsgVpnJndiConnectionFactory body = new MsgVpnJndiConnectionFactory(); // MsgVpnJndiConnectionFactory | The JNDI Connection Factory object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiConnectionFactoryResponse result = apiInstance.updateMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#updateMsgVpnJndiConnectionFactory"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **connectionFactoryName** | **String**| The name of the JMS Connection Factory. | | -| **body** | [**MsgVpnJndiConnectionFactory**](MsgVpnJndiConnectionFactory.md)| The JNDI Connection Factory object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiConnectionFactoryResponse**](MsgVpnJndiConnectionFactoryResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Connection Factory object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnJndiQueue - -> MsgVpnJndiQueueResponse updateMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select) - -Update a JNDI Queue object. - -Update a JNDI Queue object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The JNDI name of the JMS Queue. - MsgVpnJndiQueue body = new MsgVpnJndiQueue(); // MsgVpnJndiQueue | The JNDI Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiQueueResponse result = apiInstance.updateMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#updateMsgVpnJndiQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The JNDI name of the JMS Queue. | | -| **body** | [**MsgVpnJndiQueue**](MsgVpnJndiQueue.md)| The JNDI Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiQueueResponse**](MsgVpnJndiQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Queue object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnJndiTopic - -> MsgVpnJndiTopicResponse updateMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select) - -Update a JNDI Topic object. - -Update a JNDI Topic object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.JndiApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - JndiApi apiInstance = new JndiApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicName = "topicName_example"; // String | The JNDI name of the JMS Topic. - MsgVpnJndiTopic body = new MsgVpnJndiTopic(); // MsgVpnJndiTopic | The JNDI Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiTopicResponse result = apiInstance.updateMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling JndiApi#updateMsgVpnJndiTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicName** | **String**| The JNDI name of the JMS Topic. | | -| **body** | [**MsgVpnJndiTopic**](MsgVpnJndiTopic.md)| The JNDI Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiTopicResponse**](MsgVpnJndiTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Topic object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/MqttRetainCacheApi.md b/service/solace-config-client/docs/MqttRetainCacheApi.md deleted file mode 100644 index 18da5bc92..000000000 --- a/service/solace-config-client/docs/MqttRetainCacheApi.md +++ /dev/null @@ -1,492 +0,0 @@ -# MqttRetainCacheApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnMqttRetainCache**](MqttRetainCacheApi.md#createMsgVpnMqttRetainCache) | **POST** /msgVpns/{msgVpnName}/mqttRetainCaches | Create an MQTT Retain Cache object. | -| [**deleteMsgVpnMqttRetainCache**](MqttRetainCacheApi.md#deleteMsgVpnMqttRetainCache) | **DELETE** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Delete an MQTT Retain Cache object. | -| [**getMsgVpnMqttRetainCache**](MqttRetainCacheApi.md#getMsgVpnMqttRetainCache) | **GET** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Get an MQTT Retain Cache object. | -| [**getMsgVpnMqttRetainCaches**](MqttRetainCacheApi.md#getMsgVpnMqttRetainCaches) | **GET** /msgVpns/{msgVpnName}/mqttRetainCaches | Get a list of MQTT Retain Cache objects. | -| [**replaceMsgVpnMqttRetainCache**](MqttRetainCacheApi.md#replaceMsgVpnMqttRetainCache) | **PUT** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Replace an MQTT Retain Cache object. | -| [**updateMsgVpnMqttRetainCache**](MqttRetainCacheApi.md#updateMsgVpnMqttRetainCache) | **PATCH** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Update an MQTT Retain Cache object. | - - - -## createMsgVpnMqttRetainCache - -> MsgVpnMqttRetainCacheResponse createMsgVpnMqttRetainCache(msgVpnName, body, opaquePassword, select) - -Create an MQTT Retain Cache object. - -Create an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttRetainCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttRetainCacheApi apiInstance = new MqttRetainCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnMqttRetainCache body = new MsgVpnMqttRetainCache(); // MsgVpnMqttRetainCache | The MQTT Retain Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttRetainCacheResponse result = apiInstance.createMsgVpnMqttRetainCache(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttRetainCacheApi#createMsgVpnMqttRetainCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnMqttRetainCache**](MsgVpnMqttRetainCache.md)| The MQTT Retain Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttRetainCacheResponse**](MsgVpnMqttRetainCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Retain Cache object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnMqttRetainCache - -> SempMetaOnlyResponse deleteMsgVpnMqttRetainCache(msgVpnName, cacheName) - -Delete an MQTT Retain Cache object. - -Delete an MQTT Retain Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttRetainCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttRetainCacheApi apiInstance = new MqttRetainCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the MQTT Retain Cache. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnMqttRetainCache(msgVpnName, cacheName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttRetainCacheApi#deleteMsgVpnMqttRetainCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the MQTT Retain Cache. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttRetainCache - -> MsgVpnMqttRetainCacheResponse getMsgVpnMqttRetainCache(msgVpnName, cacheName, opaquePassword, select) - -Get an MQTT Retain Cache object. - -Get an MQTT Retain Cache object. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttRetainCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttRetainCacheApi apiInstance = new MqttRetainCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the MQTT Retain Cache. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttRetainCacheResponse result = apiInstance.getMsgVpnMqttRetainCache(msgVpnName, cacheName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttRetainCacheApi#getMsgVpnMqttRetainCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the MQTT Retain Cache. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttRetainCacheResponse**](MsgVpnMqttRetainCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Retain Cache object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttRetainCaches - -> MsgVpnMqttRetainCachesResponse getMsgVpnMqttRetainCaches(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of MQTT Retain Cache objects. - -Get a list of MQTT Retain Cache objects. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttRetainCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttRetainCacheApi apiInstance = new MqttRetainCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttRetainCachesResponse result = apiInstance.getMsgVpnMqttRetainCaches(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttRetainCacheApi#getMsgVpnMqttRetainCaches"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttRetainCachesResponse**](MsgVpnMqttRetainCachesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of MQTT Retain Cache objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnMqttRetainCache - -> MsgVpnMqttRetainCacheResponse replaceMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select) - -Replace an MQTT Retain Cache object. - -Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttRetainCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttRetainCacheApi apiInstance = new MqttRetainCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the MQTT Retain Cache. - MsgVpnMqttRetainCache body = new MsgVpnMqttRetainCache(); // MsgVpnMqttRetainCache | The MQTT Retain Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttRetainCacheResponse result = apiInstance.replaceMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttRetainCacheApi#replaceMsgVpnMqttRetainCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the MQTT Retain Cache. | | -| **body** | [**MsgVpnMqttRetainCache**](MsgVpnMqttRetainCache.md)| The MQTT Retain Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttRetainCacheResponse**](MsgVpnMqttRetainCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Retain Cache object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnMqttRetainCache - -> MsgVpnMqttRetainCacheResponse updateMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select) - -Update an MQTT Retain Cache object. - -Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttRetainCacheApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttRetainCacheApi apiInstance = new MqttRetainCacheApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the MQTT Retain Cache. - MsgVpnMqttRetainCache body = new MsgVpnMqttRetainCache(); // MsgVpnMqttRetainCache | The MQTT Retain Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttRetainCacheResponse result = apiInstance.updateMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttRetainCacheApi#updateMsgVpnMqttRetainCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the MQTT Retain Cache. | | -| **body** | [**MsgVpnMqttRetainCache**](MsgVpnMqttRetainCache.md)| The MQTT Retain Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttRetainCacheResponse**](MsgVpnMqttRetainCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Retain Cache object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/MqttSessionApi.md b/service/solace-config-client/docs/MqttSessionApi.md deleted file mode 100644 index 0abe6afc4..000000000 --- a/service/solace-config-client/docs/MqttSessionApi.md +++ /dev/null @@ -1,1008 +0,0 @@ -# MqttSessionApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnMqttSession**](MqttSessionApi.md#createMsgVpnMqttSession) | **POST** /msgVpns/{msgVpnName}/mqttSessions | Create an MQTT Session object. | -| [**createMsgVpnMqttSessionSubscription**](MqttSessionApi.md#createMsgVpnMqttSessionSubscription) | **POST** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions | Create a Subscription object. | -| [**deleteMsgVpnMqttSession**](MqttSessionApi.md#deleteMsgVpnMqttSession) | **DELETE** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Delete an MQTT Session object. | -| [**deleteMsgVpnMqttSessionSubscription**](MqttSessionApi.md#deleteMsgVpnMqttSessionSubscription) | **DELETE** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Delete a Subscription object. | -| [**getMsgVpnMqttSession**](MqttSessionApi.md#getMsgVpnMqttSession) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Get an MQTT Session object. | -| [**getMsgVpnMqttSessionSubscription**](MqttSessionApi.md#getMsgVpnMqttSessionSubscription) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Get a Subscription object. | -| [**getMsgVpnMqttSessionSubscriptions**](MqttSessionApi.md#getMsgVpnMqttSessionSubscriptions) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions | Get a list of Subscription objects. | -| [**getMsgVpnMqttSessions**](MqttSessionApi.md#getMsgVpnMqttSessions) | **GET** /msgVpns/{msgVpnName}/mqttSessions | Get a list of MQTT Session objects. | -| [**replaceMsgVpnMqttSession**](MqttSessionApi.md#replaceMsgVpnMqttSession) | **PUT** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Replace an MQTT Session object. | -| [**replaceMsgVpnMqttSessionSubscription**](MqttSessionApi.md#replaceMsgVpnMqttSessionSubscription) | **PUT** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Replace a Subscription object. | -| [**updateMsgVpnMqttSession**](MqttSessionApi.md#updateMsgVpnMqttSession) | **PATCH** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Update an MQTT Session object. | -| [**updateMsgVpnMqttSessionSubscription**](MqttSessionApi.md#updateMsgVpnMqttSessionSubscription) | **PATCH** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Update a Subscription object. | - - - -## createMsgVpnMqttSession - -> MsgVpnMqttSessionResponse createMsgVpnMqttSession(msgVpnName, body, opaquePassword, select) - -Create an MQTT Session object. - -Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttSessionApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttSessionApi apiInstance = new MqttSessionApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnMqttSession body = new MsgVpnMqttSession(); // MsgVpnMqttSession | The MQTT Session object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionResponse result = apiInstance.createMsgVpnMqttSession(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttSessionApi#createMsgVpnMqttSession"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnMqttSession**](MsgVpnMqttSession.md)| The MQTT Session object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionResponse**](MsgVpnMqttSessionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Session object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnMqttSessionSubscription - -> MsgVpnMqttSessionSubscriptionResponse createMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select) - -Create a Subscription object. - -Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x||x||| mqttSessionVirtualRouter|x||x||| msgVpnName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttSessionApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttSessionApi apiInstance = new MqttSessionApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - MsgVpnMqttSessionSubscription body = new MsgVpnMqttSessionSubscription(); // MsgVpnMqttSessionSubscription | The Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionSubscriptionResponse result = apiInstance.createMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttSessionApi#createMsgVpnMqttSessionSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **body** | [**MsgVpnMqttSessionSubscription**](MsgVpnMqttSessionSubscription.md)| The Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionSubscriptionResponse**](MsgVpnMqttSessionSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscription object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnMqttSession - -> SempMetaOnlyResponse deleteMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter) - -Delete an MQTT Session object. - -Delete an MQTT Session object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttSessionApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttSessionApi apiInstance = new MqttSessionApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttSessionApi#deleteMsgVpnMqttSession"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnMqttSessionSubscription - -> SempMetaOnlyResponse deleteMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic) - -Delete a Subscription object. - -Delete a Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttSessionApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttSessionApi apiInstance = new MqttSessionApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - String subscriptionTopic = "subscriptionTopic_example"; // String | The MQTT subscription topic. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttSessionApi#deleteMsgVpnMqttSessionSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **subscriptionTopic** | **String**| The MQTT subscription topic. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttSession - -> MsgVpnMqttSessionResponse getMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, opaquePassword, select) - -Get an MQTT Session object. - -Get an MQTT Session object. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttSessionApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttSessionApi apiInstance = new MqttSessionApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionResponse result = apiInstance.getMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttSessionApi#getMsgVpnMqttSession"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionResponse**](MsgVpnMqttSessionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Session object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttSessionSubscription - -> MsgVpnMqttSessionSubscriptionResponse getMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, opaquePassword, select) - -Get a Subscription object. - -Get a Subscription object. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttSessionApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttSessionApi apiInstance = new MqttSessionApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - String subscriptionTopic = "subscriptionTopic_example"; // String | The MQTT subscription topic. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionSubscriptionResponse result = apiInstance.getMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttSessionApi#getMsgVpnMqttSessionSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **subscriptionTopic** | **String**| The MQTT subscription topic. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionSubscriptionResponse**](MsgVpnMqttSessionSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscription object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttSessionSubscriptions - -> MsgVpnMqttSessionSubscriptionsResponse getMsgVpnMqttSessionSubscriptions(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, count, cursor, opaquePassword, where, select) - -Get a list of Subscription objects. - -Get a list of Subscription objects. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttSessionApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttSessionApi apiInstance = new MqttSessionApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionSubscriptionsResponse result = apiInstance.getMsgVpnMqttSessionSubscriptions(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttSessionApi#getMsgVpnMqttSessionSubscriptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionSubscriptionsResponse**](MsgVpnMqttSessionSubscriptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Subscription objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttSessions - -> MsgVpnMqttSessionsResponse getMsgVpnMqttSessions(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of MQTT Session objects. - -Get a list of MQTT Session objects. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttSessionApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttSessionApi apiInstance = new MqttSessionApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionsResponse result = apiInstance.getMsgVpnMqttSessions(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttSessionApi#getMsgVpnMqttSessions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionsResponse**](MsgVpnMqttSessionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of MQTT Session objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnMqttSession - -> MsgVpnMqttSessionResponse replaceMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select) - -Replace an MQTT Session object. - -Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| owner|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttSessionApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttSessionApi apiInstance = new MqttSessionApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - MsgVpnMqttSession body = new MsgVpnMqttSession(); // MsgVpnMqttSession | The MQTT Session object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionResponse result = apiInstance.replaceMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttSessionApi#replaceMsgVpnMqttSession"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **body** | [**MsgVpnMqttSession**](MsgVpnMqttSession.md)| The MQTT Session object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionResponse**](MsgVpnMqttSessionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Session object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnMqttSessionSubscription - -> MsgVpnMqttSessionSubscriptionResponse replaceMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select) - -Replace a Subscription object. - -Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| subscriptionTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttSessionApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttSessionApi apiInstance = new MqttSessionApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - String subscriptionTopic = "subscriptionTopic_example"; // String | The MQTT subscription topic. - MsgVpnMqttSessionSubscription body = new MsgVpnMqttSessionSubscription(); // MsgVpnMqttSessionSubscription | The Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionSubscriptionResponse result = apiInstance.replaceMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttSessionApi#replaceMsgVpnMqttSessionSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **subscriptionTopic** | **String**| The MQTT subscription topic. | | -| **body** | [**MsgVpnMqttSessionSubscription**](MsgVpnMqttSessionSubscription.md)| The Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionSubscriptionResponse**](MsgVpnMqttSessionSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscription object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnMqttSession - -> MsgVpnMqttSessionResponse updateMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select) - -Update an MQTT Session object. - -Update an MQTT Session object. Any attribute missing from the request will be left unchanged. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| owner||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttSessionApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttSessionApi apiInstance = new MqttSessionApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - MsgVpnMqttSession body = new MsgVpnMqttSession(); // MsgVpnMqttSession | The MQTT Session object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionResponse result = apiInstance.updateMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttSessionApi#updateMsgVpnMqttSession"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **body** | [**MsgVpnMqttSession**](MsgVpnMqttSession.md)| The MQTT Session object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionResponse**](MsgVpnMqttSessionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Session object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnMqttSessionSubscription - -> MsgVpnMqttSessionSubscriptionResponse updateMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select) - -Update a Subscription object. - -Update a Subscription object. Any attribute missing from the request will be left unchanged. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MqttSessionApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MqttSessionApi apiInstance = new MqttSessionApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - String subscriptionTopic = "subscriptionTopic_example"; // String | The MQTT subscription topic. - MsgVpnMqttSessionSubscription body = new MsgVpnMqttSessionSubscription(); // MsgVpnMqttSessionSubscription | The Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionSubscriptionResponse result = apiInstance.updateMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MqttSessionApi#updateMsgVpnMqttSessionSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **subscriptionTopic** | **String**| The MQTT subscription topic. | | -| **body** | [**MsgVpnMqttSessionSubscription**](MsgVpnMqttSessionSubscription.md)| The Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionSubscriptionResponse**](MsgVpnMqttSessionSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscription object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/MsgVpn.md b/service/solace-config-client/docs/MsgVpn.md deleted file mode 100644 index 323c7b6df..000000000 --- a/service/solace-config-client/docs/MsgVpn.md +++ /dev/null @@ -1,274 +0,0 @@ - - -# MsgVpn - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**alias** | **String** | The name of another Message VPN which this Message VPN is an alias for. When this Message VPN is enabled, the alias has no effect. When this Message VPN is disabled, Clients (but not Bridges and routing Links) logging into this Message VPN are automatically logged in to the other Message VPN, and authentication and authorization take place in the context of the other Message VPN. Aliases may form a non-circular chain, cascading one to the next. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14. | [optional] | -|**authenticationBasicEnabled** | **Boolean** | Enable or disable basic authentication for clients connecting to the Message VPN. Basic authentication is authentication that involves the use of a username and password to prove identity. If a user provides credentials for a different authentication scheme, this setting is not applicable. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**authenticationBasicProfileName** | **String** | The name of the RADIUS or LDAP Profile to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`. | [optional] | -|**authenticationBasicRadiusDomain** | **String** | The RADIUS domain to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**authenticationBasicType** | [**AuthenticationBasicTypeEnum**](#AuthenticationBasicTypeEnum) | The type of basic authentication to use for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"radius\"`. The allowed values and their meaning are: <pre> \"internal\" - Internal database. Authentication is against Client Usernames. \"ldap\" - LDAP authentication. An LDAP profile name must be provided. \"radius\" - RADIUS authentication. A RADIUS profile name must be provided. \"none\" - No authentication. Anonymous login allowed. </pre> | [optional] | -|**authenticationClientCertAllowApiProvidedUsernameEnabled** | **Boolean** | Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the certificate CN (Common Name) is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**authenticationClientCertCertificateMatchingRulesEnabled** | **Boolean** | Enable or disable certificate matching rules. When disabled, any valid certificate is accepted. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.27. | [optional] | -|**authenticationClientCertEnabled** | **Boolean** | Enable or disable client certificate authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**authenticationClientCertMaxChainDepth** | **Long** | The maximum depth for a client certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. | [optional] | -|**authenticationClientCertRevocationCheckMode** | [**AuthenticationClientCertRevocationCheckModeEnum**](#AuthenticationClientCertRevocationCheckModeEnum) | The desired behavior for client certificate revocation checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"allow-valid\"`. The allowed values and their meaning are: <pre> \"allow-all\" - Allow the client to authenticate, the result of client certificate revocation check is ignored. \"allow-unknown\" - Allow the client to authenticate even if the revocation status of his certificate cannot be determined. \"allow-valid\" - Allow the client to authenticate only when the revocation check returned an explicit positive response. </pre> Available since 2.6. | [optional] | -|**authenticationClientCertUsernameSource** | [**AuthenticationClientCertUsernameSourceEnum**](#AuthenticationClientCertUsernameSourceEnum) | The field from the client certificate to use as the client username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"common-name\"`. The allowed values and their meaning are: <pre> \"certificate-thumbprint\" - The username is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate. \"common-name\" - The username is extracted from the certificate's first instance of the Common Name attribute in the Subject DN. \"common-name-last\" - The username is extracted from the certificate's last instance of the Common Name attribute in the Subject DN. \"subject-alternate-name-msupn\" - The username is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature. \"uid\" - The username is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN. \"uid-last\" - The username is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN. </pre> Available since 2.6. | [optional] | -|**authenticationClientCertValidateDateEnabled** | **Boolean** | Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the client certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**authenticationKerberosAllowApiProvidedUsernameEnabled** | **Boolean** | Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**authenticationKerberosEnabled** | **Boolean** | Enable or disable Kerberos authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**authenticationOauthDefaultProfileName** | **String** | The name of the profile to use when the client does not supply a profile name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.25. | [optional] | -|**authenticationOauthDefaultProviderName** | **String** | The name of the provider to use when the client does not supply a provider name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthDefaultProviderName and authenticationOauthProviders replaced by authenticationOauthDefaultProfileName and authenticationOauthProfiles. | [optional] | -|**authenticationOauthEnabled** | **Boolean** | Enable or disable OAuth authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13. | [optional] | -|**authorizationLdapGroupMembershipAttributeName** | **String** | The name of the attribute that is retrieved from the LDAP server as part of the LDAP search when authorizing a client connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"memberOf\"`. | [optional] | -|**authorizationLdapTrimClientUsernameDomainEnabled** | **Boolean** | Enable or disable client-username domain trimming for LDAP lookups of client connections. When enabled, the value of $CLIENT_USERNAME (when used for searching) will be truncated at the first occurance of the @ character. For example, if the client-username is in the form of an email address, then the domain portion will be removed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13. | [optional] | -|**authorizationProfileName** | **String** | The name of the LDAP Profile to use for client authorization. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**authorizationType** | [**AuthorizationTypeEnum**](#AuthorizationTypeEnum) | The type of authorization to use for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"internal\"`. The allowed values and their meaning are: <pre> \"ldap\" - LDAP authorization. \"internal\" - Internal authorization. </pre> | [optional] | -|**bridgingTlsServerCertEnforceTrustedCommonNameEnabled** | **Boolean** | Enable or disable validation of the Common Name (CN) in the server certificate from the remote broker. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the Bridge. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. | [optional] | -|**bridgingTlsServerCertMaxChainDepth** | **Long** | The maximum depth for a server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. | [optional] | -|**bridgingTlsServerCertValidateDateEnabled** | **Boolean** | Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the server certificate. When disabled, a certificate will be accepted even if the certificate is not valid based on these dates. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**bridgingTlsServerCertValidateNameEnabled** | **Boolean** | Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the bridge. If enabled, the name used to connect to the bridge is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18. | [optional] | -|**distributedCacheManagementEnabled** | **Boolean** | Enable or disable managing of cache instances over the message bus. The default value is `true`. Deprecated since 2.28. Distributed cache mangement is now redundancy aware and thus no longer requires administrative intervention for operational state. | [optional] | -|**dmrEnabled** | **Boolean** | Enable or disable Dynamic Message Routing (DMR) for the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.11. | [optional] | -|**enabled** | **Boolean** | Enable or disable the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**eventConnectionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventEgressFlowCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventEgressMsgRateThreshold** | [**EventThresholdByValue**](EventThresholdByValue.md) | | [optional] | -|**eventEndpointCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventIngressFlowCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventIngressMsgRateThreshold** | [**EventThresholdByValue**](EventThresholdByValue.md) | | [optional] | -|**eventLargeMsgThreshold** | **Long** | The threshold, in kilobytes, after which a message is considered to be large for the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1024`. | [optional] | -|**eventLogTag** | **String** | A prefix applied to all published Events in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**eventMsgSpoolUsageThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventPublishClientEnabled** | **Boolean** | Enable or disable Client level Event message publishing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**eventPublishMsgVpnEnabled** | **Boolean** | Enable or disable Message VPN level Event message publishing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**eventPublishSubscriptionMode** | [**EventPublishSubscriptionModeEnum**](#EventPublishSubscriptionModeEnum) | Subscription level Event message publishing mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"off\"`. The allowed values and their meaning are: <pre> \"off\" - Disable client level event message publishing. \"on-with-format-v1\" - Enable client level event message publishing with format v1. \"on-with-no-unsubscribe-events-on-disconnect-format-v1\" - As \"on-with-format-v1\", but unsubscribe events are not generated when a client disconnects. Unsubscribe events are still raised when a client explicitly unsubscribes from its subscriptions. \"on-with-format-v2\" - Enable client level event message publishing with format v2. \"on-with-no-unsubscribe-events-on-disconnect-format-v2\" - As \"on-with-format-v2\", but unsubscribe events are not generated when a client disconnects. Unsubscribe events are still raised when a client explicitly unsubscribes from its subscriptions. </pre> | [optional] | -|**eventPublishTopicFormatMqttEnabled** | **Boolean** | Enable or disable Event publish topics in MQTT format. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**eventPublishTopicFormatSmfEnabled** | **Boolean** | Enable or disable Event publish topics in SMF format. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**eventServiceAmqpConnectionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventServiceMqttConnectionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventServiceRestIncomingConnectionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventServiceSmfConnectionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventServiceWebConnectionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventSubscriptionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventTransactedSessionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventTransactionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**exportSubscriptionsEnabled** | **Boolean** | Enable or disable the export of subscriptions in the Message VPN to other routers in the network over Neighbor links. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**jndiEnabled** | **Boolean** | Enable or disable JNDI access for clients in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.2. | [optional] | -|**maxConnectionCount** | **Long** | The maximum number of client connections to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. | [optional] | -|**maxEgressFlowCount** | **Long** | The maximum number of transmit flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. | [optional] | -|**maxEndpointCount** | **Long** | The maximum number of Queues and Topic Endpoints that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. | [optional] | -|**maxIngressFlowCount** | **Long** | The maximum number of receive flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. | [optional] | -|**maxMsgSpoolUsage** | **Long** | The maximum message spool usage by the Message VPN, in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**maxSubscriptionCount** | **Long** | The maximum number of local client subscriptions that can be added to the Message VPN. This limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. | [optional] | -|**maxTransactedSessionCount** | **Long** | The maximum number of transacted sessions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. | [optional] | -|**maxTransactionCount** | **Long** | The maximum number of transactions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. | [optional] | -|**mqttRetainMaxMemory** | **Integer** | The maximum total memory usage of the MQTT Retain feature for this Message VPN, in MB. If the maximum memory is reached, any arriving retain messages that require more memory are discarded. A value of -1 indicates that the memory is bounded only by the global max memory limit. A value of 0 prevents MQTT Retain from becoming operational. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. Available since 2.11. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**replicationAckPropagationIntervalMsgCount** | **Long** | The acknowledgement (ACK) propagation interval for the replication Bridge, in number of replicated messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20`. | [optional] | -|**replicationBridgeAuthenticationBasicClientUsername** | **String** | The Client Username the replication Bridge uses to login to the remote Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**replicationBridgeAuthenticationBasicPassword** | **String** | The password for the Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**replicationBridgeAuthenticationClientCertContent** | **String** | The PEM formatted content for the client certificate used by this bridge to login to the Remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9. | [optional] | -|**replicationBridgeAuthenticationClientCertPassword** | **String** | The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9. | [optional] | -|**replicationBridgeAuthenticationScheme** | [**ReplicationBridgeAuthenticationSchemeEnum**](#ReplicationBridgeAuthenticationSchemeEnum) | The authentication scheme for the replication Bridge in the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"basic\"`. The allowed values and their meaning are: <pre> \"basic\" - Basic Authentication Scheme (via username and password). \"client-certificate\" - Client Certificate Authentication Scheme (via certificate file or content). </pre> | [optional] | -|**replicationBridgeCompressedDataEnabled** | **Boolean** | Enable or disable use of compression for the replication Bridge. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. | [optional] | -|**replicationBridgeEgressFlowWindowSize** | **Long** | The size of the window used for guaranteed messages published to the replication Bridge, in messages. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`. | [optional] | -|**replicationBridgeRetryDelay** | **Long** | The number of seconds that must pass before retrying the replication Bridge connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`. | [optional] | -|**replicationBridgeTlsEnabled** | **Boolean** | Enable or disable use of encryption (TLS) for the replication Bridge connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. | [optional] | -|**replicationBridgeUnidirectionalClientProfileName** | **String** | The Client Profile for the unidirectional replication Bridge in the Message VPN. It is used only for the TCP parameters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#client-profile\"`. | [optional] | -|**replicationEnabled** | **Boolean** | Enable or disable replication for the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. | [optional] | -|**replicationEnabledQueueBehavior** | [**ReplicationEnabledQueueBehaviorEnum**](#ReplicationEnabledQueueBehaviorEnum) | The behavior to take when enabling replication for the Message VPN, depending on the existence of the replication Queue. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"fail-on-existing-queue\"`. The allowed values and their meaning are: <pre> \"fail-on-existing-queue\" - The data replication queue must not already exist. \"force-use-existing-queue\" - The data replication queue must already exist. Any data messages on the Queue will be forwarded to interested applications. IMPORTANT: Before using this mode be certain that the messages are not stale or otherwise unsuitable to be forwarded. This mode can only be specified when the existing queue is configured the same as is currently specified under replication configuration otherwise the enabling of replication will fail. \"force-recreate-queue\" - The data replication queue must already exist. Any data messages on the Queue will be discarded. IMPORTANT: Before using this mode be certain that the messages on the existing data replication queue are not needed by interested applications. </pre> | [optional] | -|**replicationQueueMaxMsgSpoolUsage** | **Long** | The maximum message spool usage by the replication Bridge local Queue (quota), in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `60000`. | [optional] | -|**replicationQueueRejectMsgToSenderOnDiscardEnabled** | **Boolean** | Enable or disable whether messages discarded on the replication Bridge local Queue are rejected back to the sender. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**replicationRejectMsgWhenSyncIneligibleEnabled** | **Boolean** | Enable or disable whether guaranteed messages published to synchronously replicated Topics are rejected back to the sender when synchronous replication becomes ineligible. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**replicationRole** | [**ReplicationRoleEnum**](#ReplicationRoleEnum) | The replication role for the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"standby\"`. The allowed values and their meaning are: <pre> \"active\" - Assume the Active role in replication for the Message VPN. \"standby\" - Assume the Standby role in replication for the Message VPN. </pre> | [optional] | -|**replicationTransactionMode** | [**ReplicationTransactionModeEnum**](#ReplicationTransactionModeEnum) | The transaction replication mode for all transactions within the Message VPN. Changing this value during operation will not affect existing transactions; it is only used upon starting a transaction. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"async\"`. The allowed values and their meaning are: <pre> \"sync\" - Messages are acknowledged when replicated (spooled remotely). \"async\" - Messages are acknowledged when pending replication (spooled locally). </pre> | [optional] | -|**restTlsServerCertEnforceTrustedCommonNameEnabled** | **Boolean** | Enable or disable validation of the Common Name (CN) in the server certificate from the remote REST Consumer. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the REST Consumer. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation. | [optional] | -|**restTlsServerCertMaxChainDepth** | **Long** | The maximum depth for a REST Consumer server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. | [optional] | -|**restTlsServerCertValidateDateEnabled** | **Boolean** | Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the REST Consumer server certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**restTlsServerCertValidateNameEnabled** | **Boolean** | Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the remote REST Consumer. If enabled, the name used to connect to the remote REST Consumer is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.17. | [optional] | -|**sempOverMsgBusAdminClientEnabled** | **Boolean** | Enable or disable \"admin client\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**sempOverMsgBusAdminDistributedCacheEnabled** | **Boolean** | Enable or disable \"admin distributed-cache\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**sempOverMsgBusAdminEnabled** | **Boolean** | Enable or disable \"admin\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**sempOverMsgBusEnabled** | **Boolean** | Enable or disable SEMP over the message bus for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**sempOverMsgBusShowEnabled** | **Boolean** | Enable or disable \"show\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**serviceAmqpMaxConnectionCount** | **Long** | The maximum number of AMQP client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.7. | [optional] | -|**serviceAmqpPlainTextEnabled** | **Boolean** | Enable or disable the plain-text AMQP service in the Message VPN. Disabling causes clients connected to the corresponding listen-port to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.7. | [optional] | -|**serviceAmqpPlainTextListenPort** | **Long** | The port number for plain-text AMQP clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.7. | [optional] | -|**serviceAmqpTlsEnabled** | **Boolean** | Enable or disable the use of encryption (TLS) for the AMQP service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.7. | [optional] | -|**serviceAmqpTlsListenPort** | **Long** | The port number for AMQP clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.7. | [optional] | -|**serviceMqttAuthenticationClientCertRequest** | [**ServiceMqttAuthenticationClientCertRequestEnum**](#ServiceMqttAuthenticationClientCertRequestEnum) | Determines when to request a client certificate from an incoming MQTT client connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-enabled-in-message-vpn\"`. The allowed values and their meaning are: <pre> \"always\" - Always ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"never\" - Never ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"when-enabled-in-message-vpn\" - Only ask for a client-certificate if client certificate authentication is enabled under \"message-vpn > authentication > client-certificate > shutdown\". </pre> Available since 2.21. | [optional] | -|**serviceMqttMaxConnectionCount** | **Long** | The maximum number of MQTT client connections that can be simultaneously connected to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.1. | [optional] | -|**serviceMqttPlainTextEnabled** | **Boolean** | Enable or disable the plain-text MQTT service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1. | [optional] | -|**serviceMqttPlainTextListenPort** | **Long** | The port number for plain-text MQTT clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1. | [optional] | -|**serviceMqttTlsEnabled** | **Boolean** | Enable or disable the use of encryption (TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1. | [optional] | -|**serviceMqttTlsListenPort** | **Long** | The port number for MQTT clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1. | [optional] | -|**serviceMqttTlsWebSocketEnabled** | **Boolean** | Enable or disable the use of encrypted WebSocket (WebSocket over TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected by encrypted WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1. | [optional] | -|**serviceMqttTlsWebSocketListenPort** | **Long** | The port number for MQTT clients that connect to the Message VPN using WebSocket over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1. | [optional] | -|**serviceMqttWebSocketEnabled** | **Boolean** | Enable or disable the use of WebSocket for the MQTT service in the Message VPN. Disabling causes clients currently connected by WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1. | [optional] | -|**serviceMqttWebSocketListenPort** | **Long** | The port number for plain-text MQTT clients that connect to the Message VPN using WebSocket. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1. | [optional] | -|**serviceRestIncomingAuthenticationClientCertRequest** | [**ServiceRestIncomingAuthenticationClientCertRequestEnum**](#ServiceRestIncomingAuthenticationClientCertRequestEnum) | Determines when to request a client certificate from an incoming REST Producer connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-enabled-in-message-vpn\"`. The allowed values and their meaning are: <pre> \"always\" - Always ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"never\" - Never ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"when-enabled-in-message-vpn\" - Only ask for a client-certificate if client certificate authentication is enabled under \"message-vpn > authentication > client-certificate > shutdown\". </pre> Available since 2.21. | [optional] | -|**serviceRestIncomingAuthorizationHeaderHandling** | [**ServiceRestIncomingAuthorizationHeaderHandlingEnum**](#ServiceRestIncomingAuthorizationHeaderHandlingEnum) | The handling of Authorization headers for incoming REST connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"drop\"`. The allowed values and their meaning are: <pre> \"drop\" - Do not attach the Authorization header to the message as a user property. This configuration is most secure. \"forward\" - Forward the Authorization header, attaching it to the message as a user property in the same way as other headers. For best security, use the drop setting. \"legacy\" - If the Authorization header was used for authentication to the broker, do not attach it to the message. If the Authorization header was not used for authentication to the broker, attach it to the message as a user property in the same way as other headers. For best security, use the drop setting. </pre> Available since 2.19. | [optional] | -|**serviceRestIncomingMaxConnectionCount** | **Long** | The maximum number of REST incoming client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. | [optional] | -|**serviceRestIncomingPlainTextEnabled** | **Boolean** | Enable or disable the plain-text REST service for incoming clients in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**serviceRestIncomingPlainTextListenPort** | **Long** | The port number for incoming plain-text REST clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**serviceRestIncomingTlsEnabled** | **Boolean** | Enable or disable the use of encryption (TLS) for the REST service for incoming clients in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**serviceRestIncomingTlsListenPort** | **Long** | The port number for incoming REST clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**serviceRestMode** | [**ServiceRestModeEnum**](#ServiceRestModeEnum) | The REST service mode for incoming REST clients that connect to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"messaging\"`. The allowed values and their meaning are: <pre> \"gateway\" - Act as a message gateway through which REST messages are propagated. \"messaging\" - Act as a message broker on which REST messages are queued. </pre> Available since 2.6. | [optional] | -|**serviceRestOutgoingMaxConnectionCount** | **Long** | The maximum number of REST Consumer (outgoing) client connections that can be simultaneously connected to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. | [optional] | -|**serviceSmfMaxConnectionCount** | **Long** | The maximum number of SMF client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. | [optional] | -|**serviceSmfPlainTextEnabled** | **Boolean** | Enable or disable the plain-text SMF service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**serviceSmfTlsEnabled** | **Boolean** | Enable or disable the use of encryption (TLS) for the SMF service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**serviceWebAuthenticationClientCertRequest** | [**ServiceWebAuthenticationClientCertRequestEnum**](#ServiceWebAuthenticationClientCertRequestEnum) | Determines when to request a client certificate from a Web Transport client connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-enabled-in-message-vpn\"`. The allowed values and their meaning are: <pre> \"always\" - Always ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"never\" - Never ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"when-enabled-in-message-vpn\" - Only ask for a client-certificate if client certificate authentication is enabled under \"message-vpn > authentication > client-certificate > shutdown\". </pre> Available since 2.21. | [optional] | -|**serviceWebMaxConnectionCount** | **Long** | The maximum number of Web Transport client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. | [optional] | -|**serviceWebPlainTextEnabled** | **Boolean** | Enable or disable the plain-text Web Transport service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**serviceWebTlsEnabled** | **Boolean** | Enable or disable the use of TLS for the Web Transport service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**tlsAllowDowngradeToPlainTextEnabled** | **Boolean** | Enable or disable the allowing of TLS SMF clients to downgrade their connections to plain-text connections. Changing this will not affect existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | - - - -## Enum: AuthenticationBasicTypeEnum - -| Name | Value | -|---- | -----| -| INTERNAL | "internal" | -| LDAP | "ldap" | -| RADIUS | "radius" | -| NONE | "none" | - - - -## Enum: AuthenticationClientCertRevocationCheckModeEnum - -| Name | Value | -|---- | -----| -| ALL | "allow-all" | -| UNKNOWN | "allow-unknown" | -| VALID | "allow-valid" | - - - -## Enum: AuthenticationClientCertUsernameSourceEnum - -| Name | Value | -|---- | -----| -| CERTIFICATE_THUMBPRINT | "certificate-thumbprint" | -| COMMON_NAME | "common-name" | -| COMMON_NAME_LAST | "common-name-last" | -| SUBJECT_ALTERNATE_NAME_MSUPN | "subject-alternate-name-msupn" | -| UID | "uid" | -| UID_LAST | "uid-last" | - - - -## Enum: AuthorizationTypeEnum - -| Name | Value | -|---- | -----| -| LDAP | "ldap" | -| INTERNAL | "internal" | - - - -## Enum: EventPublishSubscriptionModeEnum - -| Name | Value | -|---- | -----| -| OFF | "off" | -| ON_WITH_FORMAT_V1 | "on-with-format-v1" | -| ON_WITH_NO_UNSUBSCRIBE_EVENTS_ON_DISCONNECT_FORMAT_V1 | "on-with-no-unsubscribe-events-on-disconnect-format-v1" | -| ON_WITH_FORMAT_V2 | "on-with-format-v2" | -| ON_WITH_NO_UNSUBSCRIBE_EVENTS_ON_DISCONNECT_FORMAT_V2 | "on-with-no-unsubscribe-events-on-disconnect-format-v2" | - - - -## Enum: ReplicationBridgeAuthenticationSchemeEnum - -| Name | Value | -|---- | -----| -| BASIC | "basic" | -| CLIENT_CERTIFICATE | "client-certificate" | - - - -## Enum: ReplicationEnabledQueueBehaviorEnum - -| Name | Value | -|---- | -----| -| FAIL_ON_EXISTING_QUEUE | "fail-on-existing-queue" | -| FORCE_USE_EXISTING_QUEUE | "force-use-existing-queue" | -| FORCE_RECREATE_QUEUE | "force-recreate-queue" | - - - -## Enum: ReplicationRoleEnum - -| Name | Value | -|---- | -----| -| ACTIVE | "active" | -| STANDBY | "standby" | - - - -## Enum: ReplicationTransactionModeEnum - -| Name | Value | -|---- | -----| -| SYNC | "sync" | -| ASYNC | "async" | - - - -## Enum: ServiceMqttAuthenticationClientCertRequestEnum - -| Name | Value | -|---- | -----| -| ALWAYS | "always" | -| NEVER | "never" | -| WHEN_ENABLED_IN_MESSAGE_VPN | "when-enabled-in-message-vpn" | - - - -## Enum: ServiceRestIncomingAuthenticationClientCertRequestEnum - -| Name | Value | -|---- | -----| -| ALWAYS | "always" | -| NEVER | "never" | -| WHEN_ENABLED_IN_MESSAGE_VPN | "when-enabled-in-message-vpn" | - - - -## Enum: ServiceRestIncomingAuthorizationHeaderHandlingEnum - -| Name | Value | -|---- | -----| -| DROP | "drop" | -| FORWARD | "forward" | -| LEGACY | "legacy" | - - - -## Enum: ServiceRestModeEnum - -| Name | Value | -|---- | -----| -| GATEWAY | "gateway" | -| MESSAGING | "messaging" | - - - -## Enum: ServiceWebAuthenticationClientCertRequestEnum - -| Name | Value | -|---- | -----| -| ALWAYS | "always" | -| NEVER | "never" | -| WHEN_ENABLED_IN_MESSAGE_VPN | "when-enabled-in-message-vpn" | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfile.md b/service/solace-config-client/docs/MsgVpnAclProfile.md deleted file mode 100644 index ee122a053..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfile.md +++ /dev/null @@ -1,54 +0,0 @@ - - -# MsgVpnAclProfile - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**aclProfileName** | **String** | The name of the ACL Profile. | [optional] | -|**clientConnectDefaultAction** | [**ClientConnectDefaultActionEnum**](#ClientConnectDefaultActionEnum) | The default action to take when a client using the ACL Profile connects to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"disallow\"`. The allowed values and their meaning are: <pre> \"allow\" - Allow client connection unless an exception is found for it. \"disallow\" - Disallow client connection unless an exception is found for it. </pre> | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**publishTopicDefaultAction** | [**PublishTopicDefaultActionEnum**](#PublishTopicDefaultActionEnum) | The default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"disallow\"`. The allowed values and their meaning are: <pre> \"allow\" - Allow topic unless an exception is found for it. \"disallow\" - Disallow topic unless an exception is found for it. </pre> | [optional] | -|**subscribeShareNameDefaultAction** | [**SubscribeShareNameDefaultActionEnum**](#SubscribeShareNameDefaultActionEnum) | The default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"allow\"`. The allowed values and their meaning are: <pre> \"allow\" - Allow topic unless an exception is found for it. \"disallow\" - Disallow topic unless an exception is found for it. </pre> Available since 2.14. | [optional] | -|**subscribeTopicDefaultAction** | [**SubscribeTopicDefaultActionEnum**](#SubscribeTopicDefaultActionEnum) | The default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"disallow\"`. The allowed values and their meaning are: <pre> \"allow\" - Allow topic unless an exception is found for it. \"disallow\" - Disallow topic unless an exception is found for it. </pre> | [optional] | - - - -## Enum: ClientConnectDefaultActionEnum - -| Name | Value | -|---- | -----| -| ALLOW | "allow" | -| DISALLOW | "disallow" | - - - -## Enum: PublishTopicDefaultActionEnum - -| Name | Value | -|---- | -----| -| ALLOW | "allow" | -| DISALLOW | "disallow" | - - - -## Enum: SubscribeShareNameDefaultActionEnum - -| Name | Value | -|---- | -----| -| ALLOW | "allow" | -| DISALLOW | "disallow" | - - - -## Enum: SubscribeTopicDefaultActionEnum - -| Name | Value | -|---- | -----| -| ALLOW | "allow" | -| DISALLOW | "disallow" | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileClientConnectException.md b/service/solace-config-client/docs/MsgVpnAclProfileClientConnectException.md deleted file mode 100644 index 7918250f2..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileClientConnectException.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAclProfileClientConnectException - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**aclProfileName** | **String** | The name of the ACL Profile. | [optional] | -|**clientConnectExceptionAddress** | **String** | The IP address/netmask of the client connect exception in CIDR form. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileClientConnectExceptionLinks.md b/service/solace-config-client/docs/MsgVpnAclProfileClientConnectExceptionLinks.md deleted file mode 100644 index 7ce043eea..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileClientConnectExceptionLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnAclProfileClientConnectExceptionLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Client Connect Exception object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileClientConnectExceptionResponse.md b/service/solace-config-client/docs/MsgVpnAclProfileClientConnectExceptionResponse.md deleted file mode 100644 index 1f6876849..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileClientConnectExceptionResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAclProfileClientConnectExceptionResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnAclProfileClientConnectException**](MsgVpnAclProfileClientConnectException.md) | | [optional] | -|**links** | [**MsgVpnAclProfileClientConnectExceptionLinks**](MsgVpnAclProfileClientConnectExceptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileClientConnectExceptionsResponse.md b/service/solace-config-client/docs/MsgVpnAclProfileClientConnectExceptionsResponse.md deleted file mode 100644 index 8130f0094..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileClientConnectExceptionsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAclProfileClientConnectExceptionsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnAclProfileClientConnectException>**](MsgVpnAclProfileClientConnectException.md) | | [optional] | -|**links** | [**List<MsgVpnAclProfileClientConnectExceptionLinks>**](MsgVpnAclProfileClientConnectExceptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileLinks.md b/service/solace-config-client/docs/MsgVpnAclProfileLinks.md deleted file mode 100644 index 5e8251784..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileLinks.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# MsgVpnAclProfileLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**clientConnectExceptionsUri** | **String** | The URI of this ACL Profile's collection of Client Connect Exception objects. | [optional] | -|**publishExceptionsUri** | **String** | The URI of this ACL Profile's collection of Publish Topic Exception objects. Deprecated since 2.14. Replaced by publishTopicExceptions. | [optional] | -|**publishTopicExceptionsUri** | **String** | The URI of this ACL Profile's collection of Publish Topic Exception objects. Available since 2.14. | [optional] | -|**subscribeExceptionsUri** | **String** | The URI of this ACL Profile's collection of Subscribe Topic Exception objects. Deprecated since 2.14. Replaced by subscribeTopicExceptions. | [optional] | -|**subscribeShareNameExceptionsUri** | **String** | The URI of this ACL Profile's collection of Subscribe Share Name Exception objects. Available since 2.14. | [optional] | -|**subscribeTopicExceptionsUri** | **String** | The URI of this ACL Profile's collection of Subscribe Topic Exception objects. Available since 2.14. | [optional] | -|**uri** | **String** | The URI of this ACL Profile object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfilePublishException.md b/service/solace-config-client/docs/MsgVpnAclProfilePublishException.md deleted file mode 100644 index 74d2a312e..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfilePublishException.md +++ /dev/null @@ -1,25 +0,0 @@ - - -# MsgVpnAclProfilePublishException - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**aclProfileName** | **String** | The name of the ACL Profile. Deprecated since 2.14. Replaced by publishTopicExceptions. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. Deprecated since 2.14. Replaced by publishTopicExceptions. | [optional] | -|**publishExceptionTopic** | **String** | The topic for the exception to the default action taken. May include wildcard characters. Deprecated since 2.14. Replaced by publishTopicExceptions. | [optional] | -|**topicSyntax** | [**TopicSyntaxEnum**](#TopicSyntaxEnum) | The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are: <pre> \"smf\" - Topic uses SMF syntax. \"mqtt\" - Topic uses MQTT syntax. </pre> Deprecated since 2.14. Replaced by publishTopicExceptions. | [optional] | - - - -## Enum: TopicSyntaxEnum - -| Name | Value | -|---- | -----| -| SMF | "smf" | -| MQTT | "mqtt" | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfilePublishExceptionLinks.md b/service/solace-config-client/docs/MsgVpnAclProfilePublishExceptionLinks.md deleted file mode 100644 index 3b0af1f79..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfilePublishExceptionLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnAclProfilePublishExceptionLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Publish Topic Exception object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfilePublishExceptionResponse.md b/service/solace-config-client/docs/MsgVpnAclProfilePublishExceptionResponse.md deleted file mode 100644 index d4cd6980a..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfilePublishExceptionResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAclProfilePublishExceptionResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnAclProfilePublishException**](MsgVpnAclProfilePublishException.md) | | [optional] | -|**links** | [**MsgVpnAclProfilePublishExceptionLinks**](MsgVpnAclProfilePublishExceptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfilePublishExceptionsResponse.md b/service/solace-config-client/docs/MsgVpnAclProfilePublishExceptionsResponse.md deleted file mode 100644 index 6a3a38e91..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfilePublishExceptionsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAclProfilePublishExceptionsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnAclProfilePublishException>**](MsgVpnAclProfilePublishException.md) | | [optional] | -|**links** | [**List<MsgVpnAclProfilePublishExceptionLinks>**](MsgVpnAclProfilePublishExceptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfilePublishTopicException.md b/service/solace-config-client/docs/MsgVpnAclProfilePublishTopicException.md deleted file mode 100644 index ae1bdfe03..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfilePublishTopicException.md +++ /dev/null @@ -1,25 +0,0 @@ - - -# MsgVpnAclProfilePublishTopicException - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**aclProfileName** | **String** | The name of the ACL Profile. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**publishTopicException** | **String** | The topic for the exception to the default action taken. May include wildcard characters. | [optional] | -|**publishTopicExceptionSyntax** | [**PublishTopicExceptionSyntaxEnum**](#PublishTopicExceptionSyntaxEnum) | The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are: <pre> \"smf\" - Topic uses SMF syntax. \"mqtt\" - Topic uses MQTT syntax. </pre> | [optional] | - - - -## Enum: PublishTopicExceptionSyntaxEnum - -| Name | Value | -|---- | -----| -| SMF | "smf" | -| MQTT | "mqtt" | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfilePublishTopicExceptionLinks.md b/service/solace-config-client/docs/MsgVpnAclProfilePublishTopicExceptionLinks.md deleted file mode 100644 index dbdd4dc9b..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfilePublishTopicExceptionLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnAclProfilePublishTopicExceptionLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Publish Topic Exception object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfilePublishTopicExceptionResponse.md b/service/solace-config-client/docs/MsgVpnAclProfilePublishTopicExceptionResponse.md deleted file mode 100644 index 296e3557c..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfilePublishTopicExceptionResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAclProfilePublishTopicExceptionResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnAclProfilePublishTopicException**](MsgVpnAclProfilePublishTopicException.md) | | [optional] | -|**links** | [**MsgVpnAclProfilePublishTopicExceptionLinks**](MsgVpnAclProfilePublishTopicExceptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfilePublishTopicExceptionsResponse.md b/service/solace-config-client/docs/MsgVpnAclProfilePublishTopicExceptionsResponse.md deleted file mode 100644 index e3c7bdd15..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfilePublishTopicExceptionsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAclProfilePublishTopicExceptionsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnAclProfilePublishTopicException>**](MsgVpnAclProfilePublishTopicException.md) | | [optional] | -|**links** | [**List<MsgVpnAclProfilePublishTopicExceptionLinks>**](MsgVpnAclProfilePublishTopicExceptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileResponse.md b/service/solace-config-client/docs/MsgVpnAclProfileResponse.md deleted file mode 100644 index 1d9f1288d..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAclProfileResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnAclProfile**](MsgVpnAclProfile.md) | | [optional] | -|**links** | [**MsgVpnAclProfileLinks**](MsgVpnAclProfileLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeException.md b/service/solace-config-client/docs/MsgVpnAclProfileSubscribeException.md deleted file mode 100644 index d373d7f3a..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeException.md +++ /dev/null @@ -1,25 +0,0 @@ - - -# MsgVpnAclProfileSubscribeException - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**aclProfileName** | **String** | The name of the ACL Profile. Deprecated since 2.14. Replaced by subscribeTopicExceptions. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. Deprecated since 2.14. Replaced by subscribeTopicExceptions. | [optional] | -|**subscribeExceptionTopic** | **String** | The topic for the exception to the default action taken. May include wildcard characters. Deprecated since 2.14. Replaced by subscribeTopicExceptions. | [optional] | -|**topicSyntax** | [**TopicSyntaxEnum**](#TopicSyntaxEnum) | The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are: <pre> \"smf\" - Topic uses SMF syntax. \"mqtt\" - Topic uses MQTT syntax. </pre> Deprecated since 2.14. Replaced by subscribeTopicExceptions. | [optional] | - - - -## Enum: TopicSyntaxEnum - -| Name | Value | -|---- | -----| -| SMF | "smf" | -| MQTT | "mqtt" | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeExceptionLinks.md b/service/solace-config-client/docs/MsgVpnAclProfileSubscribeExceptionLinks.md deleted file mode 100644 index 3cdd32860..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeExceptionLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnAclProfileSubscribeExceptionLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Subscribe Topic Exception object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeExceptionResponse.md b/service/solace-config-client/docs/MsgVpnAclProfileSubscribeExceptionResponse.md deleted file mode 100644 index 0fd68a85f..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeExceptionResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAclProfileSubscribeExceptionResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnAclProfileSubscribeException**](MsgVpnAclProfileSubscribeException.md) | | [optional] | -|**links** | [**MsgVpnAclProfileSubscribeExceptionLinks**](MsgVpnAclProfileSubscribeExceptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeExceptionsResponse.md b/service/solace-config-client/docs/MsgVpnAclProfileSubscribeExceptionsResponse.md deleted file mode 100644 index 20705dca4..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeExceptionsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAclProfileSubscribeExceptionsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnAclProfileSubscribeException>**](MsgVpnAclProfileSubscribeException.md) | | [optional] | -|**links** | [**List<MsgVpnAclProfileSubscribeExceptionLinks>**](MsgVpnAclProfileSubscribeExceptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeShareNameException.md b/service/solace-config-client/docs/MsgVpnAclProfileSubscribeShareNameException.md deleted file mode 100644 index 20266bce4..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeShareNameException.md +++ /dev/null @@ -1,25 +0,0 @@ - - -# MsgVpnAclProfileSubscribeShareNameException - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**aclProfileName** | **String** | The name of the ACL Profile. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**subscribeShareNameException** | **String** | The subscribe share name exception to the default action taken. May include wildcard characters. | [optional] | -|**subscribeShareNameExceptionSyntax** | [**SubscribeShareNameExceptionSyntaxEnum**](#SubscribeShareNameExceptionSyntaxEnum) | The syntax of the subscribe share name for the exception to the default action taken. The allowed values and their meaning are: <pre> \"smf\" - Topic uses SMF syntax. \"mqtt\" - Topic uses MQTT syntax. </pre> | [optional] | - - - -## Enum: SubscribeShareNameExceptionSyntaxEnum - -| Name | Value | -|---- | -----| -| SMF | "smf" | -| MQTT | "mqtt" | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeShareNameExceptionLinks.md b/service/solace-config-client/docs/MsgVpnAclProfileSubscribeShareNameExceptionLinks.md deleted file mode 100644 index dc37eeb1e..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeShareNameExceptionLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnAclProfileSubscribeShareNameExceptionLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Subscribe Share Name Exception object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeShareNameExceptionResponse.md b/service/solace-config-client/docs/MsgVpnAclProfileSubscribeShareNameExceptionResponse.md deleted file mode 100644 index 4697b87c4..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeShareNameExceptionResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAclProfileSubscribeShareNameExceptionResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnAclProfileSubscribeShareNameException**](MsgVpnAclProfileSubscribeShareNameException.md) | | [optional] | -|**links** | [**MsgVpnAclProfileSubscribeShareNameExceptionLinks**](MsgVpnAclProfileSubscribeShareNameExceptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeShareNameExceptionsResponse.md b/service/solace-config-client/docs/MsgVpnAclProfileSubscribeShareNameExceptionsResponse.md deleted file mode 100644 index dcec06650..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeShareNameExceptionsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAclProfileSubscribeShareNameExceptionsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnAclProfileSubscribeShareNameException>**](MsgVpnAclProfileSubscribeShareNameException.md) | | [optional] | -|**links** | [**List<MsgVpnAclProfileSubscribeShareNameExceptionLinks>**](MsgVpnAclProfileSubscribeShareNameExceptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeTopicException.md b/service/solace-config-client/docs/MsgVpnAclProfileSubscribeTopicException.md deleted file mode 100644 index 4a701927f..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeTopicException.md +++ /dev/null @@ -1,25 +0,0 @@ - - -# MsgVpnAclProfileSubscribeTopicException - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**aclProfileName** | **String** | The name of the ACL Profile. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**subscribeTopicException** | **String** | The topic for the exception to the default action taken. May include wildcard characters. | [optional] | -|**subscribeTopicExceptionSyntax** | [**SubscribeTopicExceptionSyntaxEnum**](#SubscribeTopicExceptionSyntaxEnum) | The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are: <pre> \"smf\" - Topic uses SMF syntax. \"mqtt\" - Topic uses MQTT syntax. </pre> | [optional] | - - - -## Enum: SubscribeTopicExceptionSyntaxEnum - -| Name | Value | -|---- | -----| -| SMF | "smf" | -| MQTT | "mqtt" | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeTopicExceptionLinks.md b/service/solace-config-client/docs/MsgVpnAclProfileSubscribeTopicExceptionLinks.md deleted file mode 100644 index dfcccd702..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeTopicExceptionLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnAclProfileSubscribeTopicExceptionLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Subscribe Topic Exception object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeTopicExceptionResponse.md b/service/solace-config-client/docs/MsgVpnAclProfileSubscribeTopicExceptionResponse.md deleted file mode 100644 index d741026fa..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeTopicExceptionResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAclProfileSubscribeTopicExceptionResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnAclProfileSubscribeTopicException**](MsgVpnAclProfileSubscribeTopicException.md) | | [optional] | -|**links** | [**MsgVpnAclProfileSubscribeTopicExceptionLinks**](MsgVpnAclProfileSubscribeTopicExceptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeTopicExceptionsResponse.md b/service/solace-config-client/docs/MsgVpnAclProfileSubscribeTopicExceptionsResponse.md deleted file mode 100644 index 59448b770..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfileSubscribeTopicExceptionsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAclProfileSubscribeTopicExceptionsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnAclProfileSubscribeTopicException>**](MsgVpnAclProfileSubscribeTopicException.md) | | [optional] | -|**links** | [**List<MsgVpnAclProfileSubscribeTopicExceptionLinks>**](MsgVpnAclProfileSubscribeTopicExceptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAclProfilesResponse.md b/service/solace-config-client/docs/MsgVpnAclProfilesResponse.md deleted file mode 100644 index b1508f93c..000000000 --- a/service/solace-config-client/docs/MsgVpnAclProfilesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAclProfilesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnAclProfile>**](MsgVpnAclProfile.md) | | [optional] | -|**links** | [**List<MsgVpnAclProfileLinks>**](MsgVpnAclProfileLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnApi.md b/service/solace-config-client/docs/MsgVpnApi.md deleted file mode 100644 index 9cfc09cf9..000000000 --- a/service/solace-config-client/docs/MsgVpnApi.md +++ /dev/null @@ -1,21804 +0,0 @@ -# MsgVpnApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpn**](MsgVpnApi.md#createMsgVpn) | **POST** /msgVpns | Create a Message VPN object. | -| [**createMsgVpnAclProfile**](MsgVpnApi.md#createMsgVpnAclProfile) | **POST** /msgVpns/{msgVpnName}/aclProfiles | Create an ACL Profile object. | -| [**createMsgVpnAclProfileClientConnectException**](MsgVpnApi.md#createMsgVpnAclProfileClientConnectException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions | Create a Client Connect Exception object. | -| [**createMsgVpnAclProfilePublishException**](MsgVpnApi.md#createMsgVpnAclProfilePublishException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions | Create a Publish Topic Exception object. | -| [**createMsgVpnAclProfilePublishTopicException**](MsgVpnApi.md#createMsgVpnAclProfilePublishTopicException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions | Create a Publish Topic Exception object. | -| [**createMsgVpnAclProfileSubscribeException**](MsgVpnApi.md#createMsgVpnAclProfileSubscribeException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions | Create a Subscribe Topic Exception object. | -| [**createMsgVpnAclProfileSubscribeShareNameException**](MsgVpnApi.md#createMsgVpnAclProfileSubscribeShareNameException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions | Create a Subscribe Share Name Exception object. | -| [**createMsgVpnAclProfileSubscribeTopicException**](MsgVpnApi.md#createMsgVpnAclProfileSubscribeTopicException) | **POST** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions | Create a Subscribe Topic Exception object. | -| [**createMsgVpnAuthenticationOauthProfile**](MsgVpnApi.md#createMsgVpnAuthenticationOauthProfile) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles | Create an OAuth Profile object. | -| [**createMsgVpnAuthenticationOauthProfileClientRequiredClaim**](MsgVpnApi.md#createMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims | Create a Required Claim object. | -| [**createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](MsgVpnApi.md#createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Create a Required Claim object. | -| [**createMsgVpnAuthenticationOauthProvider**](MsgVpnApi.md#createMsgVpnAuthenticationOauthProvider) | **POST** /msgVpns/{msgVpnName}/authenticationOauthProviders | Create an OAuth Provider object. | -| [**createMsgVpnAuthorizationGroup**](MsgVpnApi.md#createMsgVpnAuthorizationGroup) | **POST** /msgVpns/{msgVpnName}/authorizationGroups | Create an Authorization Group object. | -| [**createMsgVpnBridge**](MsgVpnApi.md#createMsgVpnBridge) | **POST** /msgVpns/{msgVpnName}/bridges | Create a Bridge object. | -| [**createMsgVpnBridgeRemoteMsgVpn**](MsgVpnApi.md#createMsgVpnBridgeRemoteMsgVpn) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns | Create a Remote Message VPN object. | -| [**createMsgVpnBridgeRemoteSubscription**](MsgVpnApi.md#createMsgVpnBridgeRemoteSubscription) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions | Create a Remote Subscription object. | -| [**createMsgVpnBridgeTlsTrustedCommonName**](MsgVpnApi.md#createMsgVpnBridgeTlsTrustedCommonName) | **POST** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames | Create a Trusted Common Name object. | -| [**createMsgVpnCertMatchingRule**](MsgVpnApi.md#createMsgVpnCertMatchingRule) | **POST** /msgVpns/{msgVpnName}/certMatchingRules | Create a Certificate Matching Rule object. | -| [**createMsgVpnCertMatchingRuleAttributeFilter**](MsgVpnApi.md#createMsgVpnCertMatchingRuleAttributeFilter) | **POST** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters | Create a Certificate Matching Rule Attribute Filter object. | -| [**createMsgVpnCertMatchingRuleCondition**](MsgVpnApi.md#createMsgVpnCertMatchingRuleCondition) | **POST** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions | Create a Certificate Matching Rule Condition object. | -| [**createMsgVpnClientProfile**](MsgVpnApi.md#createMsgVpnClientProfile) | **POST** /msgVpns/{msgVpnName}/clientProfiles | Create a Client Profile object. | -| [**createMsgVpnClientUsername**](MsgVpnApi.md#createMsgVpnClientUsername) | **POST** /msgVpns/{msgVpnName}/clientUsernames | Create a Client Username object. | -| [**createMsgVpnClientUsernameAttribute**](MsgVpnApi.md#createMsgVpnClientUsernameAttribute) | **POST** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes | Create a Client Username Attribute object. | -| [**createMsgVpnDistributedCache**](MsgVpnApi.md#createMsgVpnDistributedCache) | **POST** /msgVpns/{msgVpnName}/distributedCaches | Create a Distributed Cache object. | -| [**createMsgVpnDistributedCacheCluster**](MsgVpnApi.md#createMsgVpnDistributedCacheCluster) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters | Create a Cache Cluster object. | -| [**createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](MsgVpnApi.md#createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters | Create a Home Cache Cluster object. | -| [**createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](MsgVpnApi.md#createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes | Create a Topic Prefix object. | -| [**createMsgVpnDistributedCacheClusterInstance**](MsgVpnApi.md#createMsgVpnDistributedCacheClusterInstance) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances | Create a Cache Instance object. | -| [**createMsgVpnDistributedCacheClusterTopic**](MsgVpnApi.md#createMsgVpnDistributedCacheClusterTopic) | **POST** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics | Create a Topic object. | -| [**createMsgVpnDmrBridge**](MsgVpnApi.md#createMsgVpnDmrBridge) | **POST** /msgVpns/{msgVpnName}/dmrBridges | Create a DMR Bridge object. | -| [**createMsgVpnJndiConnectionFactory**](MsgVpnApi.md#createMsgVpnJndiConnectionFactory) | **POST** /msgVpns/{msgVpnName}/jndiConnectionFactories | Create a JNDI Connection Factory object. | -| [**createMsgVpnJndiQueue**](MsgVpnApi.md#createMsgVpnJndiQueue) | **POST** /msgVpns/{msgVpnName}/jndiQueues | Create a JNDI Queue object. | -| [**createMsgVpnJndiTopic**](MsgVpnApi.md#createMsgVpnJndiTopic) | **POST** /msgVpns/{msgVpnName}/jndiTopics | Create a JNDI Topic object. | -| [**createMsgVpnMqttRetainCache**](MsgVpnApi.md#createMsgVpnMqttRetainCache) | **POST** /msgVpns/{msgVpnName}/mqttRetainCaches | Create an MQTT Retain Cache object. | -| [**createMsgVpnMqttSession**](MsgVpnApi.md#createMsgVpnMqttSession) | **POST** /msgVpns/{msgVpnName}/mqttSessions | Create an MQTT Session object. | -| [**createMsgVpnMqttSessionSubscription**](MsgVpnApi.md#createMsgVpnMqttSessionSubscription) | **POST** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions | Create a Subscription object. | -| [**createMsgVpnQueue**](MsgVpnApi.md#createMsgVpnQueue) | **POST** /msgVpns/{msgVpnName}/queues | Create a Queue object. | -| [**createMsgVpnQueueSubscription**](MsgVpnApi.md#createMsgVpnQueueSubscription) | **POST** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions | Create a Queue Subscription object. | -| [**createMsgVpnQueueTemplate**](MsgVpnApi.md#createMsgVpnQueueTemplate) | **POST** /msgVpns/{msgVpnName}/queueTemplates | Create a Queue Template object. | -| [**createMsgVpnReplayLog**](MsgVpnApi.md#createMsgVpnReplayLog) | **POST** /msgVpns/{msgVpnName}/replayLogs | Create a Replay Log object. | -| [**createMsgVpnReplayLogTopicFilterSubscription**](MsgVpnApi.md#createMsgVpnReplayLogTopicFilterSubscription) | **POST** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions | Create a Topic Filter Subscription object. | -| [**createMsgVpnReplicatedTopic**](MsgVpnApi.md#createMsgVpnReplicatedTopic) | **POST** /msgVpns/{msgVpnName}/replicatedTopics | Create a Replicated Topic object. | -| [**createMsgVpnRestDeliveryPoint**](MsgVpnApi.md#createMsgVpnRestDeliveryPoint) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints | Create a REST Delivery Point object. | -| [**createMsgVpnRestDeliveryPointQueueBinding**](MsgVpnApi.md#createMsgVpnRestDeliveryPointQueueBinding) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings | Create a Queue Binding object. | -| [**createMsgVpnRestDeliveryPointQueueBindingRequestHeader**](MsgVpnApi.md#createMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders | Create a Request Header object. | -| [**createMsgVpnRestDeliveryPointRestConsumer**](MsgVpnApi.md#createMsgVpnRestDeliveryPointRestConsumer) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers | Create a REST Consumer object. | -| [**createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](MsgVpnApi.md#createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims | Create a Claim object. | -| [**createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](MsgVpnApi.md#createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames | Create a Trusted Common Name object. | -| [**createMsgVpnSequencedTopic**](MsgVpnApi.md#createMsgVpnSequencedTopic) | **POST** /msgVpns/{msgVpnName}/sequencedTopics | Create a Sequenced Topic object. | -| [**createMsgVpnTopicEndpoint**](MsgVpnApi.md#createMsgVpnTopicEndpoint) | **POST** /msgVpns/{msgVpnName}/topicEndpoints | Create a Topic Endpoint object. | -| [**createMsgVpnTopicEndpointTemplate**](MsgVpnApi.md#createMsgVpnTopicEndpointTemplate) | **POST** /msgVpns/{msgVpnName}/topicEndpointTemplates | Create a Topic Endpoint Template object. | -| [**deleteMsgVpn**](MsgVpnApi.md#deleteMsgVpn) | **DELETE** /msgVpns/{msgVpnName} | Delete a Message VPN object. | -| [**deleteMsgVpnAclProfile**](MsgVpnApi.md#deleteMsgVpnAclProfile) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Delete an ACL Profile object. | -| [**deleteMsgVpnAclProfileClientConnectException**](MsgVpnApi.md#deleteMsgVpnAclProfileClientConnectException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress} | Delete a Client Connect Exception object. | -| [**deleteMsgVpnAclProfilePublishException**](MsgVpnApi.md#deleteMsgVpnAclProfilePublishException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic} | Delete a Publish Topic Exception object. | -| [**deleteMsgVpnAclProfilePublishTopicException**](MsgVpnApi.md#deleteMsgVpnAclProfilePublishTopicException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException} | Delete a Publish Topic Exception object. | -| [**deleteMsgVpnAclProfileSubscribeException**](MsgVpnApi.md#deleteMsgVpnAclProfileSubscribeException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic} | Delete a Subscribe Topic Exception object. | -| [**deleteMsgVpnAclProfileSubscribeShareNameException**](MsgVpnApi.md#deleteMsgVpnAclProfileSubscribeShareNameException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException} | Delete a Subscribe Share Name Exception object. | -| [**deleteMsgVpnAclProfileSubscribeTopicException**](MsgVpnApi.md#deleteMsgVpnAclProfileSubscribeTopicException) | **DELETE** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException} | Delete a Subscribe Topic Exception object. | -| [**deleteMsgVpnAuthenticationOauthProfile**](MsgVpnApi.md#deleteMsgVpnAuthenticationOauthProfile) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Delete an OAuth Profile object. | -| [**deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim**](MsgVpnApi.md#deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Delete a Required Claim object. | -| [**deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](MsgVpnApi.md#deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Delete a Required Claim object. | -| [**deleteMsgVpnAuthenticationOauthProvider**](MsgVpnApi.md#deleteMsgVpnAuthenticationOauthProvider) | **DELETE** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Delete an OAuth Provider object. | -| [**deleteMsgVpnAuthorizationGroup**](MsgVpnApi.md#deleteMsgVpnAuthorizationGroup) | **DELETE** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Delete an Authorization Group object. | -| [**deleteMsgVpnBridge**](MsgVpnApi.md#deleteMsgVpnBridge) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Delete a Bridge object. | -| [**deleteMsgVpnBridgeRemoteMsgVpn**](MsgVpnApi.md#deleteMsgVpnBridgeRemoteMsgVpn) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Delete a Remote Message VPN object. | -| [**deleteMsgVpnBridgeRemoteSubscription**](MsgVpnApi.md#deleteMsgVpnBridgeRemoteSubscription) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic} | Delete a Remote Subscription object. | -| [**deleteMsgVpnBridgeTlsTrustedCommonName**](MsgVpnApi.md#deleteMsgVpnBridgeTlsTrustedCommonName) | **DELETE** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Delete a Trusted Common Name object. | -| [**deleteMsgVpnCertMatchingRule**](MsgVpnApi.md#deleteMsgVpnCertMatchingRule) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Delete a Certificate Matching Rule object. | -| [**deleteMsgVpnCertMatchingRuleAttributeFilter**](MsgVpnApi.md#deleteMsgVpnCertMatchingRuleAttributeFilter) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Delete a Certificate Matching Rule Attribute Filter object. | -| [**deleteMsgVpnCertMatchingRuleCondition**](MsgVpnApi.md#deleteMsgVpnCertMatchingRuleCondition) | **DELETE** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source} | Delete a Certificate Matching Rule Condition object. | -| [**deleteMsgVpnClientProfile**](MsgVpnApi.md#deleteMsgVpnClientProfile) | **DELETE** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Delete a Client Profile object. | -| [**deleteMsgVpnClientUsername**](MsgVpnApi.md#deleteMsgVpnClientUsername) | **DELETE** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Delete a Client Username object. | -| [**deleteMsgVpnClientUsernameAttribute**](MsgVpnApi.md#deleteMsgVpnClientUsernameAttribute) | **DELETE** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue} | Delete a Client Username Attribute object. | -| [**deleteMsgVpnDistributedCache**](MsgVpnApi.md#deleteMsgVpnDistributedCache) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Delete a Distributed Cache object. | -| [**deleteMsgVpnDistributedCacheCluster**](MsgVpnApi.md#deleteMsgVpnDistributedCacheCluster) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Delete a Cache Cluster object. | -| [**deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](MsgVpnApi.md#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName} | Delete a Home Cache Cluster object. | -| [**deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](MsgVpnApi.md#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix} | Delete a Topic Prefix object. | -| [**deleteMsgVpnDistributedCacheClusterInstance**](MsgVpnApi.md#deleteMsgVpnDistributedCacheClusterInstance) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Delete a Cache Instance object. | -| [**deleteMsgVpnDistributedCacheClusterTopic**](MsgVpnApi.md#deleteMsgVpnDistributedCacheClusterTopic) | **DELETE** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic} | Delete a Topic object. | -| [**deleteMsgVpnDmrBridge**](MsgVpnApi.md#deleteMsgVpnDmrBridge) | **DELETE** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Delete a DMR Bridge object. | -| [**deleteMsgVpnJndiConnectionFactory**](MsgVpnApi.md#deleteMsgVpnJndiConnectionFactory) | **DELETE** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Delete a JNDI Connection Factory object. | -| [**deleteMsgVpnJndiQueue**](MsgVpnApi.md#deleteMsgVpnJndiQueue) | **DELETE** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Delete a JNDI Queue object. | -| [**deleteMsgVpnJndiTopic**](MsgVpnApi.md#deleteMsgVpnJndiTopic) | **DELETE** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Delete a JNDI Topic object. | -| [**deleteMsgVpnMqttRetainCache**](MsgVpnApi.md#deleteMsgVpnMqttRetainCache) | **DELETE** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Delete an MQTT Retain Cache object. | -| [**deleteMsgVpnMqttSession**](MsgVpnApi.md#deleteMsgVpnMqttSession) | **DELETE** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Delete an MQTT Session object. | -| [**deleteMsgVpnMqttSessionSubscription**](MsgVpnApi.md#deleteMsgVpnMqttSessionSubscription) | **DELETE** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Delete a Subscription object. | -| [**deleteMsgVpnQueue**](MsgVpnApi.md#deleteMsgVpnQueue) | **DELETE** /msgVpns/{msgVpnName}/queues/{queueName} | Delete a Queue object. | -| [**deleteMsgVpnQueueSubscription**](MsgVpnApi.md#deleteMsgVpnQueueSubscription) | **DELETE** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic} | Delete a Queue Subscription object. | -| [**deleteMsgVpnQueueTemplate**](MsgVpnApi.md#deleteMsgVpnQueueTemplate) | **DELETE** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Delete a Queue Template object. | -| [**deleteMsgVpnReplayLog**](MsgVpnApi.md#deleteMsgVpnReplayLog) | **DELETE** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Delete a Replay Log object. | -| [**deleteMsgVpnReplayLogTopicFilterSubscription**](MsgVpnApi.md#deleteMsgVpnReplayLogTopicFilterSubscription) | **DELETE** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription} | Delete a Topic Filter Subscription object. | -| [**deleteMsgVpnReplicatedTopic**](MsgVpnApi.md#deleteMsgVpnReplicatedTopic) | **DELETE** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Delete a Replicated Topic object. | -| [**deleteMsgVpnRestDeliveryPoint**](MsgVpnApi.md#deleteMsgVpnRestDeliveryPoint) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Delete a REST Delivery Point object. | -| [**deleteMsgVpnRestDeliveryPointQueueBinding**](MsgVpnApi.md#deleteMsgVpnRestDeliveryPointQueueBinding) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Delete a Queue Binding object. | -| [**deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader**](MsgVpnApi.md#deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Delete a Request Header object. | -| [**deleteMsgVpnRestDeliveryPointRestConsumer**](MsgVpnApi.md#deleteMsgVpnRestDeliveryPointRestConsumer) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Delete a REST Consumer object. | -| [**deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](MsgVpnApi.md#deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName} | Delete a Claim object. | -| [**deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](MsgVpnApi.md#deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Delete a Trusted Common Name object. | -| [**deleteMsgVpnSequencedTopic**](MsgVpnApi.md#deleteMsgVpnSequencedTopic) | **DELETE** /msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic} | Delete a Sequenced Topic object. | -| [**deleteMsgVpnTopicEndpoint**](MsgVpnApi.md#deleteMsgVpnTopicEndpoint) | **DELETE** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Delete a Topic Endpoint object. | -| [**deleteMsgVpnTopicEndpointTemplate**](MsgVpnApi.md#deleteMsgVpnTopicEndpointTemplate) | **DELETE** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Delete a Topic Endpoint Template object. | -| [**getMsgVpn**](MsgVpnApi.md#getMsgVpn) | **GET** /msgVpns/{msgVpnName} | Get a Message VPN object. | -| [**getMsgVpnAclProfile**](MsgVpnApi.md#getMsgVpnAclProfile) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Get an ACL Profile object. | -| [**getMsgVpnAclProfileClientConnectException**](MsgVpnApi.md#getMsgVpnAclProfileClientConnectException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress} | Get a Client Connect Exception object. | -| [**getMsgVpnAclProfileClientConnectExceptions**](MsgVpnApi.md#getMsgVpnAclProfileClientConnectExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions | Get a list of Client Connect Exception objects. | -| [**getMsgVpnAclProfilePublishException**](MsgVpnApi.md#getMsgVpnAclProfilePublishException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic} | Get a Publish Topic Exception object. | -| [**getMsgVpnAclProfilePublishExceptions**](MsgVpnApi.md#getMsgVpnAclProfilePublishExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions | Get a list of Publish Topic Exception objects. | -| [**getMsgVpnAclProfilePublishTopicException**](MsgVpnApi.md#getMsgVpnAclProfilePublishTopicException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException} | Get a Publish Topic Exception object. | -| [**getMsgVpnAclProfilePublishTopicExceptions**](MsgVpnApi.md#getMsgVpnAclProfilePublishTopicExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions | Get a list of Publish Topic Exception objects. | -| [**getMsgVpnAclProfileSubscribeException**](MsgVpnApi.md#getMsgVpnAclProfileSubscribeException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic} | Get a Subscribe Topic Exception object. | -| [**getMsgVpnAclProfileSubscribeExceptions**](MsgVpnApi.md#getMsgVpnAclProfileSubscribeExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions | Get a list of Subscribe Topic Exception objects. | -| [**getMsgVpnAclProfileSubscribeShareNameException**](MsgVpnApi.md#getMsgVpnAclProfileSubscribeShareNameException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException} | Get a Subscribe Share Name Exception object. | -| [**getMsgVpnAclProfileSubscribeShareNameExceptions**](MsgVpnApi.md#getMsgVpnAclProfileSubscribeShareNameExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions | Get a list of Subscribe Share Name Exception objects. | -| [**getMsgVpnAclProfileSubscribeTopicException**](MsgVpnApi.md#getMsgVpnAclProfileSubscribeTopicException) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException} | Get a Subscribe Topic Exception object. | -| [**getMsgVpnAclProfileSubscribeTopicExceptions**](MsgVpnApi.md#getMsgVpnAclProfileSubscribeTopicExceptions) | **GET** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions | Get a list of Subscribe Topic Exception objects. | -| [**getMsgVpnAclProfiles**](MsgVpnApi.md#getMsgVpnAclProfiles) | **GET** /msgVpns/{msgVpnName}/aclProfiles | Get a list of ACL Profile objects. | -| [**getMsgVpnAuthenticationOauthProfile**](MsgVpnApi.md#getMsgVpnAuthenticationOauthProfile) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Get an OAuth Profile object. | -| [**getMsgVpnAuthenticationOauthProfileClientRequiredClaim**](MsgVpnApi.md#getMsgVpnAuthenticationOauthProfileClientRequiredClaim) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Get a Required Claim object. | -| [**getMsgVpnAuthenticationOauthProfileClientRequiredClaims**](MsgVpnApi.md#getMsgVpnAuthenticationOauthProfileClientRequiredClaims) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims | Get a list of Required Claim objects. | -| [**getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](MsgVpnApi.md#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Get a Required Claim object. | -| [**getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims**](MsgVpnApi.md#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Get a list of Required Claim objects. | -| [**getMsgVpnAuthenticationOauthProfiles**](MsgVpnApi.md#getMsgVpnAuthenticationOauthProfiles) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProfiles | Get a list of OAuth Profile objects. | -| [**getMsgVpnAuthenticationOauthProvider**](MsgVpnApi.md#getMsgVpnAuthenticationOauthProvider) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Get an OAuth Provider object. | -| [**getMsgVpnAuthenticationOauthProviders**](MsgVpnApi.md#getMsgVpnAuthenticationOauthProviders) | **GET** /msgVpns/{msgVpnName}/authenticationOauthProviders | Get a list of OAuth Provider objects. | -| [**getMsgVpnAuthorizationGroup**](MsgVpnApi.md#getMsgVpnAuthorizationGroup) | **GET** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Get an Authorization Group object. | -| [**getMsgVpnAuthorizationGroups**](MsgVpnApi.md#getMsgVpnAuthorizationGroups) | **GET** /msgVpns/{msgVpnName}/authorizationGroups | Get a list of Authorization Group objects. | -| [**getMsgVpnBridge**](MsgVpnApi.md#getMsgVpnBridge) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Get a Bridge object. | -| [**getMsgVpnBridgeRemoteMsgVpn**](MsgVpnApi.md#getMsgVpnBridgeRemoteMsgVpn) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Get a Remote Message VPN object. | -| [**getMsgVpnBridgeRemoteMsgVpns**](MsgVpnApi.md#getMsgVpnBridgeRemoteMsgVpns) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns | Get a list of Remote Message VPN objects. | -| [**getMsgVpnBridgeRemoteSubscription**](MsgVpnApi.md#getMsgVpnBridgeRemoteSubscription) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic} | Get a Remote Subscription object. | -| [**getMsgVpnBridgeRemoteSubscriptions**](MsgVpnApi.md#getMsgVpnBridgeRemoteSubscriptions) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions | Get a list of Remote Subscription objects. | -| [**getMsgVpnBridgeTlsTrustedCommonName**](MsgVpnApi.md#getMsgVpnBridgeTlsTrustedCommonName) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Get a Trusted Common Name object. | -| [**getMsgVpnBridgeTlsTrustedCommonNames**](MsgVpnApi.md#getMsgVpnBridgeTlsTrustedCommonNames) | **GET** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames | Get a list of Trusted Common Name objects. | -| [**getMsgVpnBridges**](MsgVpnApi.md#getMsgVpnBridges) | **GET** /msgVpns/{msgVpnName}/bridges | Get a list of Bridge objects. | -| [**getMsgVpnCertMatchingRule**](MsgVpnApi.md#getMsgVpnCertMatchingRule) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Get a Certificate Matching Rule object. | -| [**getMsgVpnCertMatchingRuleAttributeFilter**](MsgVpnApi.md#getMsgVpnCertMatchingRuleAttributeFilter) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Get a Certificate Matching Rule Attribute Filter object. | -| [**getMsgVpnCertMatchingRuleAttributeFilters**](MsgVpnApi.md#getMsgVpnCertMatchingRuleAttributeFilters) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters | Get a list of Certificate Matching Rule Attribute Filter objects. | -| [**getMsgVpnCertMatchingRuleCondition**](MsgVpnApi.md#getMsgVpnCertMatchingRuleCondition) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source} | Get a Certificate Matching Rule Condition object. | -| [**getMsgVpnCertMatchingRuleConditions**](MsgVpnApi.md#getMsgVpnCertMatchingRuleConditions) | **GET** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions | Get a list of Certificate Matching Rule Condition objects. | -| [**getMsgVpnCertMatchingRules**](MsgVpnApi.md#getMsgVpnCertMatchingRules) | **GET** /msgVpns/{msgVpnName}/certMatchingRules | Get a list of Certificate Matching Rule objects. | -| [**getMsgVpnClientProfile**](MsgVpnApi.md#getMsgVpnClientProfile) | **GET** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Get a Client Profile object. | -| [**getMsgVpnClientProfiles**](MsgVpnApi.md#getMsgVpnClientProfiles) | **GET** /msgVpns/{msgVpnName}/clientProfiles | Get a list of Client Profile objects. | -| [**getMsgVpnClientUsername**](MsgVpnApi.md#getMsgVpnClientUsername) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Get a Client Username object. | -| [**getMsgVpnClientUsernameAttribute**](MsgVpnApi.md#getMsgVpnClientUsernameAttribute) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue} | Get a Client Username Attribute object. | -| [**getMsgVpnClientUsernameAttributes**](MsgVpnApi.md#getMsgVpnClientUsernameAttributes) | **GET** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes | Get a list of Client Username Attribute objects. | -| [**getMsgVpnClientUsernames**](MsgVpnApi.md#getMsgVpnClientUsernames) | **GET** /msgVpns/{msgVpnName}/clientUsernames | Get a list of Client Username objects. | -| [**getMsgVpnDistributedCache**](MsgVpnApi.md#getMsgVpnDistributedCache) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Get a Distributed Cache object. | -| [**getMsgVpnDistributedCacheCluster**](MsgVpnApi.md#getMsgVpnDistributedCacheCluster) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Get a Cache Cluster object. | -| [**getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](MsgVpnApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName} | Get a Home Cache Cluster object. | -| [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](MsgVpnApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix} | Get a Topic Prefix object. | -| [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes**](MsgVpnApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes | Get a list of Topic Prefix objects. | -| [**getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters**](MsgVpnApi.md#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters | Get a list of Home Cache Cluster objects. | -| [**getMsgVpnDistributedCacheClusterInstance**](MsgVpnApi.md#getMsgVpnDistributedCacheClusterInstance) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Get a Cache Instance object. | -| [**getMsgVpnDistributedCacheClusterInstances**](MsgVpnApi.md#getMsgVpnDistributedCacheClusterInstances) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances | Get a list of Cache Instance objects. | -| [**getMsgVpnDistributedCacheClusterTopic**](MsgVpnApi.md#getMsgVpnDistributedCacheClusterTopic) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic} | Get a Topic object. | -| [**getMsgVpnDistributedCacheClusterTopics**](MsgVpnApi.md#getMsgVpnDistributedCacheClusterTopics) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics | Get a list of Topic objects. | -| [**getMsgVpnDistributedCacheClusters**](MsgVpnApi.md#getMsgVpnDistributedCacheClusters) | **GET** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters | Get a list of Cache Cluster objects. | -| [**getMsgVpnDistributedCaches**](MsgVpnApi.md#getMsgVpnDistributedCaches) | **GET** /msgVpns/{msgVpnName}/distributedCaches | Get a list of Distributed Cache objects. | -| [**getMsgVpnDmrBridge**](MsgVpnApi.md#getMsgVpnDmrBridge) | **GET** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Get a DMR Bridge object. | -| [**getMsgVpnDmrBridges**](MsgVpnApi.md#getMsgVpnDmrBridges) | **GET** /msgVpns/{msgVpnName}/dmrBridges | Get a list of DMR Bridge objects. | -| [**getMsgVpnJndiConnectionFactories**](MsgVpnApi.md#getMsgVpnJndiConnectionFactories) | **GET** /msgVpns/{msgVpnName}/jndiConnectionFactories | Get a list of JNDI Connection Factory objects. | -| [**getMsgVpnJndiConnectionFactory**](MsgVpnApi.md#getMsgVpnJndiConnectionFactory) | **GET** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Get a JNDI Connection Factory object. | -| [**getMsgVpnJndiQueue**](MsgVpnApi.md#getMsgVpnJndiQueue) | **GET** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Get a JNDI Queue object. | -| [**getMsgVpnJndiQueues**](MsgVpnApi.md#getMsgVpnJndiQueues) | **GET** /msgVpns/{msgVpnName}/jndiQueues | Get a list of JNDI Queue objects. | -| [**getMsgVpnJndiTopic**](MsgVpnApi.md#getMsgVpnJndiTopic) | **GET** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Get a JNDI Topic object. | -| [**getMsgVpnJndiTopics**](MsgVpnApi.md#getMsgVpnJndiTopics) | **GET** /msgVpns/{msgVpnName}/jndiTopics | Get a list of JNDI Topic objects. | -| [**getMsgVpnMqttRetainCache**](MsgVpnApi.md#getMsgVpnMqttRetainCache) | **GET** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Get an MQTT Retain Cache object. | -| [**getMsgVpnMqttRetainCaches**](MsgVpnApi.md#getMsgVpnMqttRetainCaches) | **GET** /msgVpns/{msgVpnName}/mqttRetainCaches | Get a list of MQTT Retain Cache objects. | -| [**getMsgVpnMqttSession**](MsgVpnApi.md#getMsgVpnMqttSession) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Get an MQTT Session object. | -| [**getMsgVpnMqttSessionSubscription**](MsgVpnApi.md#getMsgVpnMqttSessionSubscription) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Get a Subscription object. | -| [**getMsgVpnMqttSessionSubscriptions**](MsgVpnApi.md#getMsgVpnMqttSessionSubscriptions) | **GET** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions | Get a list of Subscription objects. | -| [**getMsgVpnMqttSessions**](MsgVpnApi.md#getMsgVpnMqttSessions) | **GET** /msgVpns/{msgVpnName}/mqttSessions | Get a list of MQTT Session objects. | -| [**getMsgVpnQueue**](MsgVpnApi.md#getMsgVpnQueue) | **GET** /msgVpns/{msgVpnName}/queues/{queueName} | Get a Queue object. | -| [**getMsgVpnQueueSubscription**](MsgVpnApi.md#getMsgVpnQueueSubscription) | **GET** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic} | Get a Queue Subscription object. | -| [**getMsgVpnQueueSubscriptions**](MsgVpnApi.md#getMsgVpnQueueSubscriptions) | **GET** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions | Get a list of Queue Subscription objects. | -| [**getMsgVpnQueueTemplate**](MsgVpnApi.md#getMsgVpnQueueTemplate) | **GET** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Get a Queue Template object. | -| [**getMsgVpnQueueTemplates**](MsgVpnApi.md#getMsgVpnQueueTemplates) | **GET** /msgVpns/{msgVpnName}/queueTemplates | Get a list of Queue Template objects. | -| [**getMsgVpnQueues**](MsgVpnApi.md#getMsgVpnQueues) | **GET** /msgVpns/{msgVpnName}/queues | Get a list of Queue objects. | -| [**getMsgVpnReplayLog**](MsgVpnApi.md#getMsgVpnReplayLog) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Get a Replay Log object. | -| [**getMsgVpnReplayLogTopicFilterSubscription**](MsgVpnApi.md#getMsgVpnReplayLogTopicFilterSubscription) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription} | Get a Topic Filter Subscription object. | -| [**getMsgVpnReplayLogTopicFilterSubscriptions**](MsgVpnApi.md#getMsgVpnReplayLogTopicFilterSubscriptions) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions | Get a list of Topic Filter Subscription objects. | -| [**getMsgVpnReplayLogs**](MsgVpnApi.md#getMsgVpnReplayLogs) | **GET** /msgVpns/{msgVpnName}/replayLogs | Get a list of Replay Log objects. | -| [**getMsgVpnReplicatedTopic**](MsgVpnApi.md#getMsgVpnReplicatedTopic) | **GET** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Get a Replicated Topic object. | -| [**getMsgVpnReplicatedTopics**](MsgVpnApi.md#getMsgVpnReplicatedTopics) | **GET** /msgVpns/{msgVpnName}/replicatedTopics | Get a list of Replicated Topic objects. | -| [**getMsgVpnRestDeliveryPoint**](MsgVpnApi.md#getMsgVpnRestDeliveryPoint) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Get a REST Delivery Point object. | -| [**getMsgVpnRestDeliveryPointQueueBinding**](MsgVpnApi.md#getMsgVpnRestDeliveryPointQueueBinding) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Get a Queue Binding object. | -| [**getMsgVpnRestDeliveryPointQueueBindingRequestHeader**](MsgVpnApi.md#getMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Get a Request Header object. | -| [**getMsgVpnRestDeliveryPointQueueBindingRequestHeaders**](MsgVpnApi.md#getMsgVpnRestDeliveryPointQueueBindingRequestHeaders) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders | Get a list of Request Header objects. | -| [**getMsgVpnRestDeliveryPointQueueBindings**](MsgVpnApi.md#getMsgVpnRestDeliveryPointQueueBindings) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings | Get a list of Queue Binding objects. | -| [**getMsgVpnRestDeliveryPointRestConsumer**](MsgVpnApi.md#getMsgVpnRestDeliveryPointRestConsumer) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Get a REST Consumer object. | -| [**getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](MsgVpnApi.md#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName} | Get a Claim object. | -| [**getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims**](MsgVpnApi.md#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims | Get a list of Claim objects. | -| [**getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](MsgVpnApi.md#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Get a Trusted Common Name object. | -| [**getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames**](MsgVpnApi.md#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames | Get a list of Trusted Common Name objects. | -| [**getMsgVpnRestDeliveryPointRestConsumers**](MsgVpnApi.md#getMsgVpnRestDeliveryPointRestConsumers) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers | Get a list of REST Consumer objects. | -| [**getMsgVpnRestDeliveryPoints**](MsgVpnApi.md#getMsgVpnRestDeliveryPoints) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints | Get a list of REST Delivery Point objects. | -| [**getMsgVpnSequencedTopic**](MsgVpnApi.md#getMsgVpnSequencedTopic) | **GET** /msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic} | Get a Sequenced Topic object. | -| [**getMsgVpnSequencedTopics**](MsgVpnApi.md#getMsgVpnSequencedTopics) | **GET** /msgVpns/{msgVpnName}/sequencedTopics | Get a list of Sequenced Topic objects. | -| [**getMsgVpnTopicEndpoint**](MsgVpnApi.md#getMsgVpnTopicEndpoint) | **GET** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Get a Topic Endpoint object. | -| [**getMsgVpnTopicEndpointTemplate**](MsgVpnApi.md#getMsgVpnTopicEndpointTemplate) | **GET** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Get a Topic Endpoint Template object. | -| [**getMsgVpnTopicEndpointTemplates**](MsgVpnApi.md#getMsgVpnTopicEndpointTemplates) | **GET** /msgVpns/{msgVpnName}/topicEndpointTemplates | Get a list of Topic Endpoint Template objects. | -| [**getMsgVpnTopicEndpoints**](MsgVpnApi.md#getMsgVpnTopicEndpoints) | **GET** /msgVpns/{msgVpnName}/topicEndpoints | Get a list of Topic Endpoint objects. | -| [**getMsgVpns**](MsgVpnApi.md#getMsgVpns) | **GET** /msgVpns | Get a list of Message VPN objects. | -| [**replaceMsgVpn**](MsgVpnApi.md#replaceMsgVpn) | **PUT** /msgVpns/{msgVpnName} | Replace a Message VPN object. | -| [**replaceMsgVpnAclProfile**](MsgVpnApi.md#replaceMsgVpnAclProfile) | **PUT** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Replace an ACL Profile object. | -| [**replaceMsgVpnAuthenticationOauthProfile**](MsgVpnApi.md#replaceMsgVpnAuthenticationOauthProfile) | **PUT** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Replace an OAuth Profile object. | -| [**replaceMsgVpnAuthenticationOauthProvider**](MsgVpnApi.md#replaceMsgVpnAuthenticationOauthProvider) | **PUT** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Replace an OAuth Provider object. | -| [**replaceMsgVpnAuthorizationGroup**](MsgVpnApi.md#replaceMsgVpnAuthorizationGroup) | **PUT** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Replace an Authorization Group object. | -| [**replaceMsgVpnBridge**](MsgVpnApi.md#replaceMsgVpnBridge) | **PUT** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Replace a Bridge object. | -| [**replaceMsgVpnBridgeRemoteMsgVpn**](MsgVpnApi.md#replaceMsgVpnBridgeRemoteMsgVpn) | **PUT** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Replace a Remote Message VPN object. | -| [**replaceMsgVpnCertMatchingRule**](MsgVpnApi.md#replaceMsgVpnCertMatchingRule) | **PUT** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Replace a Certificate Matching Rule object. | -| [**replaceMsgVpnCertMatchingRuleAttributeFilter**](MsgVpnApi.md#replaceMsgVpnCertMatchingRuleAttributeFilter) | **PUT** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Replace a Certificate Matching Rule Attribute Filter object. | -| [**replaceMsgVpnClientProfile**](MsgVpnApi.md#replaceMsgVpnClientProfile) | **PUT** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Replace a Client Profile object. | -| [**replaceMsgVpnClientUsername**](MsgVpnApi.md#replaceMsgVpnClientUsername) | **PUT** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Replace a Client Username object. | -| [**replaceMsgVpnDistributedCache**](MsgVpnApi.md#replaceMsgVpnDistributedCache) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Replace a Distributed Cache object. | -| [**replaceMsgVpnDistributedCacheCluster**](MsgVpnApi.md#replaceMsgVpnDistributedCacheCluster) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Replace a Cache Cluster object. | -| [**replaceMsgVpnDistributedCacheClusterInstance**](MsgVpnApi.md#replaceMsgVpnDistributedCacheClusterInstance) | **PUT** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Replace a Cache Instance object. | -| [**replaceMsgVpnDmrBridge**](MsgVpnApi.md#replaceMsgVpnDmrBridge) | **PUT** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Replace a DMR Bridge object. | -| [**replaceMsgVpnJndiConnectionFactory**](MsgVpnApi.md#replaceMsgVpnJndiConnectionFactory) | **PUT** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Replace a JNDI Connection Factory object. | -| [**replaceMsgVpnJndiQueue**](MsgVpnApi.md#replaceMsgVpnJndiQueue) | **PUT** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Replace a JNDI Queue object. | -| [**replaceMsgVpnJndiTopic**](MsgVpnApi.md#replaceMsgVpnJndiTopic) | **PUT** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Replace a JNDI Topic object. | -| [**replaceMsgVpnMqttRetainCache**](MsgVpnApi.md#replaceMsgVpnMqttRetainCache) | **PUT** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Replace an MQTT Retain Cache object. | -| [**replaceMsgVpnMqttSession**](MsgVpnApi.md#replaceMsgVpnMqttSession) | **PUT** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Replace an MQTT Session object. | -| [**replaceMsgVpnMqttSessionSubscription**](MsgVpnApi.md#replaceMsgVpnMqttSessionSubscription) | **PUT** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Replace a Subscription object. | -| [**replaceMsgVpnQueue**](MsgVpnApi.md#replaceMsgVpnQueue) | **PUT** /msgVpns/{msgVpnName}/queues/{queueName} | Replace a Queue object. | -| [**replaceMsgVpnQueueTemplate**](MsgVpnApi.md#replaceMsgVpnQueueTemplate) | **PUT** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Replace a Queue Template object. | -| [**replaceMsgVpnReplayLog**](MsgVpnApi.md#replaceMsgVpnReplayLog) | **PUT** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Replace a Replay Log object. | -| [**replaceMsgVpnReplicatedTopic**](MsgVpnApi.md#replaceMsgVpnReplicatedTopic) | **PUT** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Replace a Replicated Topic object. | -| [**replaceMsgVpnRestDeliveryPoint**](MsgVpnApi.md#replaceMsgVpnRestDeliveryPoint) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Replace a REST Delivery Point object. | -| [**replaceMsgVpnRestDeliveryPointQueueBinding**](MsgVpnApi.md#replaceMsgVpnRestDeliveryPointQueueBinding) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Replace a Queue Binding object. | -| [**replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader**](MsgVpnApi.md#replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Replace a Request Header object. | -| [**replaceMsgVpnRestDeliveryPointRestConsumer**](MsgVpnApi.md#replaceMsgVpnRestDeliveryPointRestConsumer) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Replace a REST Consumer object. | -| [**replaceMsgVpnTopicEndpoint**](MsgVpnApi.md#replaceMsgVpnTopicEndpoint) | **PUT** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Replace a Topic Endpoint object. | -| [**replaceMsgVpnTopicEndpointTemplate**](MsgVpnApi.md#replaceMsgVpnTopicEndpointTemplate) | **PUT** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Replace a Topic Endpoint Template object. | -| [**updateMsgVpn**](MsgVpnApi.md#updateMsgVpn) | **PATCH** /msgVpns/{msgVpnName} | Update a Message VPN object. | -| [**updateMsgVpnAclProfile**](MsgVpnApi.md#updateMsgVpnAclProfile) | **PATCH** /msgVpns/{msgVpnName}/aclProfiles/{aclProfileName} | Update an ACL Profile object. | -| [**updateMsgVpnAuthenticationOauthProfile**](MsgVpnApi.md#updateMsgVpnAuthenticationOauthProfile) | **PATCH** /msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName} | Update an OAuth Profile object. | -| [**updateMsgVpnAuthenticationOauthProvider**](MsgVpnApi.md#updateMsgVpnAuthenticationOauthProvider) | **PATCH** /msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName} | Update an OAuth Provider object. | -| [**updateMsgVpnAuthorizationGroup**](MsgVpnApi.md#updateMsgVpnAuthorizationGroup) | **PATCH** /msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName} | Update an Authorization Group object. | -| [**updateMsgVpnBridge**](MsgVpnApi.md#updateMsgVpnBridge) | **PATCH** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter} | Update a Bridge object. | -| [**updateMsgVpnBridgeRemoteMsgVpn**](MsgVpnApi.md#updateMsgVpnBridgeRemoteMsgVpn) | **PATCH** /msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface} | Update a Remote Message VPN object. | -| [**updateMsgVpnCertMatchingRule**](MsgVpnApi.md#updateMsgVpnCertMatchingRule) | **PATCH** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName} | Update a Certificate Matching Rule object. | -| [**updateMsgVpnCertMatchingRuleAttributeFilter**](MsgVpnApi.md#updateMsgVpnCertMatchingRuleAttributeFilter) | **PATCH** /msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName} | Update a Certificate Matching Rule Attribute Filter object. | -| [**updateMsgVpnClientProfile**](MsgVpnApi.md#updateMsgVpnClientProfile) | **PATCH** /msgVpns/{msgVpnName}/clientProfiles/{clientProfileName} | Update a Client Profile object. | -| [**updateMsgVpnClientUsername**](MsgVpnApi.md#updateMsgVpnClientUsername) | **PATCH** /msgVpns/{msgVpnName}/clientUsernames/{clientUsername} | Update a Client Username object. | -| [**updateMsgVpnDistributedCache**](MsgVpnApi.md#updateMsgVpnDistributedCache) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName} | Update a Distributed Cache object. | -| [**updateMsgVpnDistributedCacheCluster**](MsgVpnApi.md#updateMsgVpnDistributedCacheCluster) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName} | Update a Cache Cluster object. | -| [**updateMsgVpnDistributedCacheClusterInstance**](MsgVpnApi.md#updateMsgVpnDistributedCacheClusterInstance) | **PATCH** /msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName} | Update a Cache Instance object. | -| [**updateMsgVpnDmrBridge**](MsgVpnApi.md#updateMsgVpnDmrBridge) | **PATCH** /msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName} | Update a DMR Bridge object. | -| [**updateMsgVpnJndiConnectionFactory**](MsgVpnApi.md#updateMsgVpnJndiConnectionFactory) | **PATCH** /msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName} | Update a JNDI Connection Factory object. | -| [**updateMsgVpnJndiQueue**](MsgVpnApi.md#updateMsgVpnJndiQueue) | **PATCH** /msgVpns/{msgVpnName}/jndiQueues/{queueName} | Update a JNDI Queue object. | -| [**updateMsgVpnJndiTopic**](MsgVpnApi.md#updateMsgVpnJndiTopic) | **PATCH** /msgVpns/{msgVpnName}/jndiTopics/{topicName} | Update a JNDI Topic object. | -| [**updateMsgVpnMqttRetainCache**](MsgVpnApi.md#updateMsgVpnMqttRetainCache) | **PATCH** /msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName} | Update an MQTT Retain Cache object. | -| [**updateMsgVpnMqttSession**](MsgVpnApi.md#updateMsgVpnMqttSession) | **PATCH** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter} | Update an MQTT Session object. | -| [**updateMsgVpnMqttSessionSubscription**](MsgVpnApi.md#updateMsgVpnMqttSessionSubscription) | **PATCH** /msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic} | Update a Subscription object. | -| [**updateMsgVpnQueue**](MsgVpnApi.md#updateMsgVpnQueue) | **PATCH** /msgVpns/{msgVpnName}/queues/{queueName} | Update a Queue object. | -| [**updateMsgVpnQueueTemplate**](MsgVpnApi.md#updateMsgVpnQueueTemplate) | **PATCH** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Update a Queue Template object. | -| [**updateMsgVpnReplayLog**](MsgVpnApi.md#updateMsgVpnReplayLog) | **PATCH** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Update a Replay Log object. | -| [**updateMsgVpnReplicatedTopic**](MsgVpnApi.md#updateMsgVpnReplicatedTopic) | **PATCH** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Update a Replicated Topic object. | -| [**updateMsgVpnRestDeliveryPoint**](MsgVpnApi.md#updateMsgVpnRestDeliveryPoint) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Update a REST Delivery Point object. | -| [**updateMsgVpnRestDeliveryPointQueueBinding**](MsgVpnApi.md#updateMsgVpnRestDeliveryPointQueueBinding) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Update a Queue Binding object. | -| [**updateMsgVpnRestDeliveryPointQueueBindingRequestHeader**](MsgVpnApi.md#updateMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Update a Request Header object. | -| [**updateMsgVpnRestDeliveryPointRestConsumer**](MsgVpnApi.md#updateMsgVpnRestDeliveryPointRestConsumer) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Update a REST Consumer object. | -| [**updateMsgVpnTopicEndpoint**](MsgVpnApi.md#updateMsgVpnTopicEndpoint) | **PATCH** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Update a Topic Endpoint object. | -| [**updateMsgVpnTopicEndpointTemplate**](MsgVpnApi.md#updateMsgVpnTopicEndpointTemplate) | **PATCH** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Update a Topic Endpoint Template object. | - - - -## createMsgVpn - -> MsgVpnResponse createMsgVpn(body, opaquePassword, select) - -Create a Message VPN object. - -Create a Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| distributedCacheManagementEnabled|||||x| msgVpnName|x|x|||| replicationBridgeAuthenticationBasicPassword||||x||x replicationBridgeAuthenticationClientCertContent||||x||x replicationBridgeAuthenticationClientCertPassword||||x|| replicationEnabledQueueBehavior||||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - MsgVpn body = new MsgVpn(); // MsgVpn | The Message VPN object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnResponse result = apiInstance.createMsgVpn(body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **body** | [**MsgVpn**](MsgVpn.md)| The Message VPN object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnResponse**](MsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfile - -> MsgVpnAclProfileResponse createMsgVpnAclProfile(msgVpnName, body, opaquePassword, select) - -Create an ACL Profile object. - -Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnAclProfile body = new MsgVpnAclProfile(); // MsgVpnAclProfile | The ACL Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileResponse result = apiInstance.createMsgVpnAclProfile(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnAclProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnAclProfile**](MsgVpnAclProfile.md)| The ACL Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileResponse**](MsgVpnAclProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The ACL Profile object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfileClientConnectException - -> MsgVpnAclProfileClientConnectExceptionResponse createMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Client Connect Exception object. - -Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| clientConnectExceptionAddress|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfileClientConnectException body = new MsgVpnAclProfileClientConnectException(); // MsgVpnAclProfileClientConnectException | The Client Connect Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileClientConnectExceptionResponse result = apiInstance.createMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnAclProfileClientConnectException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfileClientConnectException**](MsgVpnAclProfileClientConnectException.md)| The Client Connect Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileClientConnectExceptionResponse**](MsgVpnAclProfileClientConnectExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Connect Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfilePublishException - -> MsgVpnAclProfilePublishExceptionResponse createMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Publish Topic Exception object. - -Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| publishExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfilePublishException body = new MsgVpnAclProfilePublishException(); // MsgVpnAclProfilePublishException | The Publish Topic Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishExceptionResponse result = apiInstance.createMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnAclProfilePublishException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfilePublishException**](MsgVpnAclProfilePublishException.md)| The Publish Topic Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishExceptionResponse**](MsgVpnAclProfilePublishExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Publish Topic Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfilePublishTopicException - -> MsgVpnAclProfilePublishTopicExceptionResponse createMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Publish Topic Exception object. - -Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| publishTopicException|x|x|||| publishTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfilePublishTopicException body = new MsgVpnAclProfilePublishTopicException(); // MsgVpnAclProfilePublishTopicException | The Publish Topic Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishTopicExceptionResponse result = apiInstance.createMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnAclProfilePublishTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfilePublishTopicException**](MsgVpnAclProfilePublishTopicException.md)| The Publish Topic Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishTopicExceptionResponse**](MsgVpnAclProfilePublishTopicExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Publish Topic Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfileSubscribeException - -> MsgVpnAclProfileSubscribeExceptionResponse createMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Subscribe Topic Exception object. - -Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| subscribeExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfileSubscribeException body = new MsgVpnAclProfileSubscribeException(); // MsgVpnAclProfileSubscribeException | The Subscribe Topic Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeExceptionResponse result = apiInstance.createMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnAclProfileSubscribeException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfileSubscribeException**](MsgVpnAclProfileSubscribeException.md)| The Subscribe Topic Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeExceptionResponse**](MsgVpnAclProfileSubscribeExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Topic Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfileSubscribeShareNameException - -> MsgVpnAclProfileSubscribeShareNameExceptionResponse createMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Subscribe Share Name Exception object. - -Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeShareNameException|x|x|||| subscribeShareNameExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfileSubscribeShareNameException body = new MsgVpnAclProfileSubscribeShareNameException(); // MsgVpnAclProfileSubscribeShareNameException | The Subscribe Share Name Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeShareNameExceptionResponse result = apiInstance.createMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnAclProfileSubscribeShareNameException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfileSubscribeShareNameException**](MsgVpnAclProfileSubscribeShareNameException.md)| The Subscribe Share Name Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeShareNameExceptionResponse**](MsgVpnAclProfileSubscribeShareNameExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Share Name Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAclProfileSubscribeTopicException - -> MsgVpnAclProfileSubscribeTopicExceptionResponse createMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, body, opaquePassword, select) - -Create a Subscribe Topic Exception object. - -Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeTopicException|x|x|||| subscribeTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfileSubscribeTopicException body = new MsgVpnAclProfileSubscribeTopicException(); // MsgVpnAclProfileSubscribeTopicException | The Subscribe Topic Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeTopicExceptionResponse result = apiInstance.createMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnAclProfileSubscribeTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfileSubscribeTopicException**](MsgVpnAclProfileSubscribeTopicException.md)| The Subscribe Topic Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeTopicExceptionResponse**](MsgVpnAclProfileSubscribeTopicExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Topic Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAuthenticationOauthProfile - -> MsgVpnAuthenticationOauthProfileResponse createMsgVpnAuthenticationOauthProfile(msgVpnName, body, opaquePassword, select) - -Create an OAuth Profile object. - -Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x msgVpnName|x||x||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnAuthenticationOauthProfile body = new MsgVpnAuthenticationOauthProfile(); // MsgVpnAuthenticationOauthProfile | The OAuth Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResponse result = apiInstance.createMsgVpnAuthenticationOauthProfile(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnAuthenticationOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnAuthenticationOauthProfile**](MsgVpnAuthenticationOauthProfile.md)| The OAuth Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResponse**](MsgVpnAuthenticationOauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAuthenticationOauthProfileClientRequiredClaim - -> MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse createMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select) - -Create a Required Claim object. - -Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| msgVpnName|x||x||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - MsgVpnAuthenticationOauthProfileClientRequiredClaim body = new MsgVpnAuthenticationOauthProfileClientRequiredClaim(); // MsgVpnAuthenticationOauthProfileClientRequiredClaim | The Required Claim object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse result = apiInstance.createMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**MsgVpnAuthenticationOauthProfileClientRequiredClaim**](MsgVpnAuthenticationOauthProfileClientRequiredClaim.md)| The Required Claim object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse**](MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - -> MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select) - -Create a Required Claim object. - -Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim body = new MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(); // MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim | The Required Claim object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse result = apiInstance.createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.md)| The Required Claim object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse**](MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAuthenticationOauthProvider - -> MsgVpnAuthenticationOauthProviderResponse createMsgVpnAuthenticationOauthProvider(msgVpnName, body, opaquePassword, select) - -Create an OAuth Provider object. - -Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x||x||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword||||x|x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnAuthenticationOauthProvider body = new MsgVpnAuthenticationOauthProvider(); // MsgVpnAuthenticationOauthProvider | The OAuth Provider object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProviderResponse result = apiInstance.createMsgVpnAuthenticationOauthProvider(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnAuthenticationOauthProvider"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnAuthenticationOauthProvider**](MsgVpnAuthenticationOauthProvider.md)| The OAuth Provider object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProviderResponse**](MsgVpnAuthenticationOauthProviderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Provider object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnAuthorizationGroup - -> MsgVpnAuthorizationGroupResponse createMsgVpnAuthorizationGroup(msgVpnName, body, opaquePassword, select) - -Create an Authorization Group object. - -Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationGroupName|x|x|||| msgVpnName|x||x||| orderAfterAuthorizationGroupName||||x|| orderBeforeAuthorizationGroupName||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnAuthorizationGroup body = new MsgVpnAuthorizationGroup(); // MsgVpnAuthorizationGroup | The Authorization Group object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthorizationGroupResponse result = apiInstance.createMsgVpnAuthorizationGroup(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnAuthorizationGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnAuthorizationGroup**](MsgVpnAuthorizationGroup.md)| The Authorization Group object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthorizationGroupResponse**](MsgVpnAuthorizationGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Group object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnBridge - -> MsgVpnBridgeResponse createMsgVpnBridge(msgVpnName, body, opaquePassword, select) - -Create a Bridge object. - -Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| msgVpnName|x||x||| remoteAuthenticationBasicPassword||||x||x remoteAuthenticationClientCertContent||||x||x remoteAuthenticationClientCertPassword||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnBridge body = new MsgVpnBridge(); // MsgVpnBridge | The Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeResponse result = apiInstance.createMsgVpnBridge(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnBridge**](MsgVpnBridge.md)| The Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeResponse**](MsgVpnBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Bridge object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnBridgeRemoteMsgVpn - -> MsgVpnBridgeRemoteMsgVpnResponse createMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select) - -Create a Remote Message VPN object. - -Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| msgVpnName|x||x||| password||||x||x remoteMsgVpnInterface|x||||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - MsgVpnBridgeRemoteMsgVpn body = new MsgVpnBridgeRemoteMsgVpn(); // MsgVpnBridgeRemoteMsgVpn | The Remote Message VPN object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteMsgVpnResponse result = apiInstance.createMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnBridgeRemoteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **body** | [**MsgVpnBridgeRemoteMsgVpn**](MsgVpnBridgeRemoteMsgVpn.md)| The Remote Message VPN object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteMsgVpnResponse**](MsgVpnBridgeRemoteMsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Message VPN object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnBridgeRemoteSubscription - -> MsgVpnBridgeRemoteSubscriptionResponse createMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select) - -Create a Remote Subscription object. - -Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| deliverAlwaysEnabled||x|||| msgVpnName|x||x||| remoteSubscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - MsgVpnBridgeRemoteSubscription body = new MsgVpnBridgeRemoteSubscription(); // MsgVpnBridgeRemoteSubscription | The Remote Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteSubscriptionResponse result = apiInstance.createMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnBridgeRemoteSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **body** | [**MsgVpnBridgeRemoteSubscription**](MsgVpnBridgeRemoteSubscription.md)| The Remote Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteSubscriptionResponse**](MsgVpnBridgeRemoteSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Subscription object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnBridgeTlsTrustedCommonName - -> MsgVpnBridgeTlsTrustedCommonNameResponse createMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select) - -Create a Trusted Common Name object. - -Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||x| bridgeVirtualRouter|x||x||x| msgVpnName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - MsgVpnBridgeTlsTrustedCommonName body = new MsgVpnBridgeTlsTrustedCommonName(); // MsgVpnBridgeTlsTrustedCommonName | The Trusted Common Name object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeTlsTrustedCommonNameResponse result = apiInstance.createMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnBridgeTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **body** | [**MsgVpnBridgeTlsTrustedCommonName**](MsgVpnBridgeTlsTrustedCommonName.md)| The Trusted Common Name object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeTlsTrustedCommonNameResponse**](MsgVpnBridgeTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Trusted Common Name object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnCertMatchingRule - -> MsgVpnCertMatchingRuleResponse createMsgVpnCertMatchingRule(msgVpnName, body, opaquePassword, select) - -Create a Certificate Matching Rule object. - -Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnCertMatchingRule body = new MsgVpnCertMatchingRule(); // MsgVpnCertMatchingRule | The Certificate Matching Rule object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleResponse result = apiInstance.createMsgVpnCertMatchingRule(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnCertMatchingRule**](MsgVpnCertMatchingRule.md)| The Certificate Matching Rule object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleResponse**](MsgVpnCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnCertMatchingRuleAttributeFilter - -> MsgVpnCertMatchingRuleAttributeFilterResponse createMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, body, opaquePassword, select) - -Create a Certificate Matching Rule Attribute Filter object. - -Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: filterName|x|x|||| msgVpnName|x||x||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - MsgVpnCertMatchingRuleAttributeFilter body = new MsgVpnCertMatchingRuleAttributeFilter(); // MsgVpnCertMatchingRuleAttributeFilter | The Certificate Matching Rule Attribute Filter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleAttributeFilterResponse result = apiInstance.createMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**MsgVpnCertMatchingRuleAttributeFilter**](MsgVpnCertMatchingRuleAttributeFilter.md)| The Certificate Matching Rule Attribute Filter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleAttributeFilterResponse**](MsgVpnCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnCertMatchingRuleCondition - -> MsgVpnCertMatchingRuleConditionResponse createMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, body, opaquePassword, select) - -Create a Certificate Matching Rule Condition object. - -Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - MsgVpnCertMatchingRuleCondition body = new MsgVpnCertMatchingRuleCondition(); // MsgVpnCertMatchingRuleCondition | The Certificate Matching Rule Condition object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleConditionResponse result = apiInstance.createMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnCertMatchingRuleCondition"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**MsgVpnCertMatchingRuleCondition**](MsgVpnCertMatchingRuleCondition.md)| The Certificate Matching Rule Condition object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleConditionResponse**](MsgVpnCertMatchingRuleConditionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Condition object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnClientProfile - -> MsgVpnClientProfileResponse createMsgVpnClientProfile(msgVpnName, body, opaquePassword, select) - -Create a Client Profile object. - -Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnClientProfile body = new MsgVpnClientProfile(); // MsgVpnClientProfile | The Client Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientProfileResponse result = apiInstance.createMsgVpnClientProfile(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnClientProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnClientProfile**](MsgVpnClientProfile.md)| The Client Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientProfileResponse**](MsgVpnClientProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Profile object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnClientUsername - -> MsgVpnClientUsernameResponse createMsgVpnClientUsername(msgVpnName, body, opaquePassword, select) - -Create a Client Username object. - -Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientUsername|x|x|||| msgVpnName|x||x||| password||||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnClientUsername body = new MsgVpnClientUsername(); // MsgVpnClientUsername | The Client Username object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameResponse result = apiInstance.createMsgVpnClientUsername(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnClientUsername"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnClientUsername**](MsgVpnClientUsername.md)| The Client Username object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameResponse**](MsgVpnClientUsernameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnClientUsernameAttribute - -> MsgVpnClientUsernameAttributeResponse createMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, body, opaquePassword, select) - -Create a Client Username Attribute object. - -Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| clientUsername|x||x||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - MsgVpnClientUsernameAttribute body = new MsgVpnClientUsernameAttribute(); // MsgVpnClientUsernameAttribute | The Client Username Attribute object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameAttributeResponse result = apiInstance.createMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnClientUsernameAttribute"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **body** | [**MsgVpnClientUsernameAttribute**](MsgVpnClientUsernameAttribute.md)| The Client Username Attribute object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameAttributeResponse**](MsgVpnClientUsernameAttributeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username Attribute object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCache - -> MsgVpnDistributedCacheResponse createMsgVpnDistributedCache(msgVpnName, body, opaquePassword, select) - -Create a Distributed Cache object. - -Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnDistributedCache body = new MsgVpnDistributedCache(); // MsgVpnDistributedCache | The Distributed Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheResponse result = apiInstance.createMsgVpnDistributedCache(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnDistributedCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnDistributedCache**](MsgVpnDistributedCache.md)| The Distributed Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheResponse**](MsgVpnDistributedCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Distributed Cache object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCacheCluster - -> MsgVpnDistributedCacheClusterResponse createMsgVpnDistributedCacheCluster(msgVpnName, cacheName, body, opaquePassword, select) - -Create a Cache Cluster object. - -Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - MsgVpnDistributedCacheCluster body = new MsgVpnDistributedCacheCluster(); // MsgVpnDistributedCacheCluster | The Cache Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterResponse result = apiInstance.createMsgVpnDistributedCacheCluster(msgVpnName, cacheName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnDistributedCacheCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **body** | [**MsgVpnDistributedCacheCluster**](MsgVpnDistributedCacheCluster.md)| The Cache Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterResponse**](MsgVpnDistributedCacheClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Cluster object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select) - -Create a Home Cache Cluster object. - -Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - MsgVpnDistributedCacheClusterGlobalCachingHomeCluster body = new MsgVpnDistributedCacheClusterGlobalCachingHomeCluster(); // MsgVpnDistributedCacheClusterGlobalCachingHomeCluster | The Home Cache Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse result = apiInstance.createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.md)| The Home Cache Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Home Cache Cluster object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, body, opaquePassword, select) - -Create a Topic Prefix object. - -Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x||x||| msgVpnName|x||x||| topicPrefix|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix body = new MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(); // MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix | The Topic Prefix object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse result = apiInstance.createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.md)| The Topic Prefix object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Prefix object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCacheClusterInstance - -> MsgVpnDistributedCacheClusterInstanceResponse createMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, body, opaquePassword, select) - -Create a Cache Instance object. - -Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| instanceName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - MsgVpnDistributedCacheClusterInstance body = new MsgVpnDistributedCacheClusterInstance(); // MsgVpnDistributedCacheClusterInstance | The Cache Instance object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterInstanceResponse result = apiInstance.createMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnDistributedCacheClusterInstance"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheClusterInstance**](MsgVpnDistributedCacheClusterInstance.md)| The Cache Instance object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterInstanceResponse**](MsgVpnDistributedCacheClusterInstanceResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Instance object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDistributedCacheClusterTopic - -> MsgVpnDistributedCacheClusterTopicResponse createMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, body, opaquePassword, select) - -Create a Topic object. - -Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| msgVpnName|x||x||| topic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - MsgVpnDistributedCacheClusterTopic body = new MsgVpnDistributedCacheClusterTopic(); // MsgVpnDistributedCacheClusterTopic | The Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterTopicResponse result = apiInstance.createMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnDistributedCacheClusterTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheClusterTopic**](MsgVpnDistributedCacheClusterTopic.md)| The Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterTopicResponse**](MsgVpnDistributedCacheClusterTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnDmrBridge - -> MsgVpnDmrBridgeResponse createMsgVpnDmrBridge(msgVpnName, body, opaquePassword, select) - -Create a DMR Bridge object. - -Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnDmrBridge body = new MsgVpnDmrBridge(); // MsgVpnDmrBridge | The DMR Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDmrBridgeResponse result = apiInstance.createMsgVpnDmrBridge(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnDmrBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnDmrBridge**](MsgVpnDmrBridge.md)| The DMR Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDmrBridgeResponse**](MsgVpnDmrBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The DMR Bridge object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnJndiConnectionFactory - -> MsgVpnJndiConnectionFactoryResponse createMsgVpnJndiConnectionFactory(msgVpnName, body, opaquePassword, select) - -Create a JNDI Connection Factory object. - -Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: connectionFactoryName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnJndiConnectionFactory body = new MsgVpnJndiConnectionFactory(); // MsgVpnJndiConnectionFactory | The JNDI Connection Factory object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiConnectionFactoryResponse result = apiInstance.createMsgVpnJndiConnectionFactory(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnJndiConnectionFactory"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnJndiConnectionFactory**](MsgVpnJndiConnectionFactory.md)| The JNDI Connection Factory object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiConnectionFactoryResponse**](MsgVpnJndiConnectionFactoryResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Connection Factory object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnJndiQueue - -> MsgVpnJndiQueueResponse createMsgVpnJndiQueue(msgVpnName, body, opaquePassword, select) - -Create a JNDI Queue object. - -Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnJndiQueue body = new MsgVpnJndiQueue(); // MsgVpnJndiQueue | The JNDI Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiQueueResponse result = apiInstance.createMsgVpnJndiQueue(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnJndiQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnJndiQueue**](MsgVpnJndiQueue.md)| The JNDI Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiQueueResponse**](MsgVpnJndiQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Queue object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnJndiTopic - -> MsgVpnJndiTopicResponse createMsgVpnJndiTopic(msgVpnName, body, opaquePassword, select) - -Create a JNDI Topic object. - -Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnJndiTopic body = new MsgVpnJndiTopic(); // MsgVpnJndiTopic | The JNDI Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiTopicResponse result = apiInstance.createMsgVpnJndiTopic(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnJndiTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnJndiTopic**](MsgVpnJndiTopic.md)| The JNDI Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiTopicResponse**](MsgVpnJndiTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Topic object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnMqttRetainCache - -> MsgVpnMqttRetainCacheResponse createMsgVpnMqttRetainCache(msgVpnName, body, opaquePassword, select) - -Create an MQTT Retain Cache object. - -Create an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnMqttRetainCache body = new MsgVpnMqttRetainCache(); // MsgVpnMqttRetainCache | The MQTT Retain Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttRetainCacheResponse result = apiInstance.createMsgVpnMqttRetainCache(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnMqttRetainCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnMqttRetainCache**](MsgVpnMqttRetainCache.md)| The MQTT Retain Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttRetainCacheResponse**](MsgVpnMqttRetainCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Retain Cache object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnMqttSession - -> MsgVpnMqttSessionResponse createMsgVpnMqttSession(msgVpnName, body, opaquePassword, select) - -Create an MQTT Session object. - -Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnMqttSession body = new MsgVpnMqttSession(); // MsgVpnMqttSession | The MQTT Session object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionResponse result = apiInstance.createMsgVpnMqttSession(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnMqttSession"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnMqttSession**](MsgVpnMqttSession.md)| The MQTT Session object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionResponse**](MsgVpnMqttSessionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Session object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnMqttSessionSubscription - -> MsgVpnMqttSessionSubscriptionResponse createMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select) - -Create a Subscription object. - -Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x||x||| mqttSessionVirtualRouter|x||x||| msgVpnName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - MsgVpnMqttSessionSubscription body = new MsgVpnMqttSessionSubscription(); // MsgVpnMqttSessionSubscription | The Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionSubscriptionResponse result = apiInstance.createMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnMqttSessionSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **body** | [**MsgVpnMqttSessionSubscription**](MsgVpnMqttSessionSubscription.md)| The Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionSubscriptionResponse**](MsgVpnMqttSessionSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscription object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnQueue - -> MsgVpnQueueResponse createMsgVpnQueue(msgVpnName, body, opaquePassword, select) - -Create a Queue object. - -Create a Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnQueue body = new MsgVpnQueue(); // MsgVpnQueue | The Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueResponse result = apiInstance.createMsgVpnQueue(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnQueue**](MsgVpnQueue.md)| The Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueResponse**](MsgVpnQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnQueueSubscription - -> MsgVpnQueueSubscriptionResponse createMsgVpnQueueSubscription(msgVpnName, queueName, body, opaquePassword, select) - -Create a Queue Subscription object. - -Create a Queue Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - MsgVpnQueueSubscription body = new MsgVpnQueueSubscription(); // MsgVpnQueueSubscription | The Queue Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueSubscriptionResponse result = apiInstance.createMsgVpnQueueSubscription(msgVpnName, queueName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnQueueSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **body** | [**MsgVpnQueueSubscription**](MsgVpnQueueSubscription.md)| The Queue Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueSubscriptionResponse**](MsgVpnQueueSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Subscription object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnQueueTemplate - -> MsgVpnQueueTemplateResponse createMsgVpnQueueTemplate(msgVpnName, body, opaquePassword, select) - -Create a Queue Template object. - -Create a Queue Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnQueueTemplate body = new MsgVpnQueueTemplate(); // MsgVpnQueueTemplate | The Queue Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueTemplateResponse result = apiInstance.createMsgVpnQueueTemplate(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnQueueTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnQueueTemplate**](MsgVpnQueueTemplate.md)| The Queue Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueTemplateResponse**](MsgVpnQueueTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Template object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnReplayLog - -> MsgVpnReplayLogResponse createMsgVpnReplayLog(msgVpnName, body, opaquePassword, select) - -Create a Replay Log object. - -Create a Replay Log object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnReplayLog body = new MsgVpnReplayLog(); // MsgVpnReplayLog | The Replay Log object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogResponse result = apiInstance.createMsgVpnReplayLog(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnReplayLog"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnReplayLog**](MsgVpnReplayLog.md)| The Replay Log object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogResponse**](MsgVpnReplayLogResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replay Log object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnReplayLogTopicFilterSubscription - -> MsgVpnReplayLogTopicFilterSubscriptionResponse createMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, body, opaquePassword, select) - -Create a Topic Filter Subscription object. - -Create a Topic Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x||x||| topicFilterSubscription|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - MsgVpnReplayLogTopicFilterSubscription body = new MsgVpnReplayLogTopicFilterSubscription(); // MsgVpnReplayLogTopicFilterSubscription | The Topic Filter Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogTopicFilterSubscriptionResponse result = apiInstance.createMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnReplayLogTopicFilterSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **body** | [**MsgVpnReplayLogTopicFilterSubscription**](MsgVpnReplayLogTopicFilterSubscription.md)| The Topic Filter Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogTopicFilterSubscriptionResponse**](MsgVpnReplayLogTopicFilterSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Filter Subscription object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnReplicatedTopic - -> MsgVpnReplicatedTopicResponse createMsgVpnReplicatedTopic(msgVpnName, body, opaquePassword, select) - -Create a Replicated Topic object. - -Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnReplicatedTopic body = new MsgVpnReplicatedTopic(); // MsgVpnReplicatedTopic | The Replicated Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplicatedTopicResponse result = apiInstance.createMsgVpnReplicatedTopic(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnReplicatedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnReplicatedTopic**](MsgVpnReplicatedTopic.md)| The Replicated Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplicatedTopicResponse**](MsgVpnReplicatedTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replicated Topic object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPoint - -> MsgVpnRestDeliveryPointResponse createMsgVpnRestDeliveryPoint(msgVpnName, body, opaquePassword, select) - -Create a REST Delivery Point object. - -Create a REST Delivery Point object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnRestDeliveryPoint body = new MsgVpnRestDeliveryPoint(); // MsgVpnRestDeliveryPoint | The REST Delivery Point object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointResponse result = apiInstance.createMsgVpnRestDeliveryPoint(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnRestDeliveryPoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnRestDeliveryPoint**](MsgVpnRestDeliveryPoint.md)| The REST Delivery Point object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointResponse**](MsgVpnRestDeliveryPointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Delivery Point object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPointQueueBinding - -> MsgVpnRestDeliveryPointQueueBindingResponse createMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, body, opaquePassword, select) - -Create a Queue Binding object. - -Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueBindingName|x|x|||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - MsgVpnRestDeliveryPointQueueBinding body = new MsgVpnRestDeliveryPointQueueBinding(); // MsgVpnRestDeliveryPointQueueBinding | The Queue Binding object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingResponse result = apiInstance.createMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnRestDeliveryPointQueueBinding"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBinding**](MsgVpnRestDeliveryPointQueueBinding.md)| The Queue Binding object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingResponse**](MsgVpnRestDeliveryPointQueueBindingResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Binding object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPointQueueBindingRequestHeader - -> MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse createMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select) - -Create a Request Header object. - -Create a Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: headerName|x|x|||| msgVpnName|x||x||| queueBindingName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = new MsgVpnRestDeliveryPointQueueBindingRequestHeader(); // MsgVpnRestDeliveryPointQueueBindingRequestHeader | The Request Header object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse result = apiInstance.createMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBindingRequestHeader**](MsgVpnRestDeliveryPointQueueBindingRequestHeader.md)| The Request Header object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse**](MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Request Header object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPointRestConsumer - -> MsgVpnRestDeliveryPointRestConsumerResponse createMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, body, opaquePassword, select) - -Create a REST Consumer object. - -Create a REST Consumer object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| authenticationHttpBasicPassword||||x||x authenticationHttpHeaderValue||||x||x authenticationOauthClientSecret||||x||x authenticationOauthJwtSecretKey||||x||x msgVpnName|x||x||| restConsumerName|x|x|||| restDeliveryPointName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - MsgVpnRestDeliveryPointRestConsumer body = new MsgVpnRestDeliveryPointRestConsumer(); // MsgVpnRestDeliveryPointRestConsumer | The REST Consumer object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerResponse result = apiInstance.createMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnRestDeliveryPointRestConsumer"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **body** | [**MsgVpnRestDeliveryPointRestConsumer**](MsgVpnRestDeliveryPointRestConsumer.md)| The REST Consumer object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerResponse**](MsgVpnRestDeliveryPointRestConsumerResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Consumer object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - -> MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select) - -Create a Claim object. - -Create a Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthJwtClaimName|x|x|||| oauthJwtClaimValue||x|||| restConsumerName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim body = new MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(); // MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim | The Claim object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse result = apiInstance.createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **body** | [**MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.md)| The Claim object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse**](MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Claim object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - -> MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select) - -Create a Trusted Common Name object. - -Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||x| restConsumerName|x||x||x| restDeliveryPointName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName body = new MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(); // MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName | The Trusted Common Name object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse result = apiInstance.createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **body** | [**MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.md)| The Trusted Common Name object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse**](MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Trusted Common Name object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnSequencedTopic - -> MsgVpnSequencedTopicResponse createMsgVpnSequencedTopic(msgVpnName, body, opaquePassword, select) - -Create a Sequenced Topic object. - -Create a Sequenced Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| sequencedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnSequencedTopic body = new MsgVpnSequencedTopic(); // MsgVpnSequencedTopic | The Sequenced Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnSequencedTopicResponse result = apiInstance.createMsgVpnSequencedTopic(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnSequencedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnSequencedTopic**](MsgVpnSequencedTopic.md)| The Sequenced Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnSequencedTopicResponse**](MsgVpnSequencedTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Sequenced Topic object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnTopicEndpoint - -> MsgVpnTopicEndpointResponse createMsgVpnTopicEndpoint(msgVpnName, body, opaquePassword, select) - -Create a Topic Endpoint object. - -Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnTopicEndpoint body = new MsgVpnTopicEndpoint(); // MsgVpnTopicEndpoint | The Topic Endpoint object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointResponse result = apiInstance.createMsgVpnTopicEndpoint(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnTopicEndpoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnTopicEndpoint**](MsgVpnTopicEndpoint.md)| The Topic Endpoint object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointResponse**](MsgVpnTopicEndpointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnTopicEndpointTemplate - -> MsgVpnTopicEndpointTemplateResponse createMsgVpnTopicEndpointTemplate(msgVpnName, body, opaquePassword, select) - -Create a Topic Endpoint Template object. - -Create a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnTopicEndpointTemplate body = new MsgVpnTopicEndpointTemplate(); // MsgVpnTopicEndpointTemplate | The Topic Endpoint Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointTemplateResponse result = apiInstance.createMsgVpnTopicEndpointTemplate(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#createMsgVpnTopicEndpointTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnTopicEndpointTemplate**](MsgVpnTopicEndpointTemplate.md)| The Topic Endpoint Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointTemplateResponse**](MsgVpnTopicEndpointTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint Template object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpn - -> SempMetaOnlyResponse deleteMsgVpn(msgVpnName) - -Delete a Message VPN object. - -Delete a Message VPN object. The deletion of instances of this object are synchronized to HA mates via config-sync. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpn(msgVpnName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfile - -> SempMetaOnlyResponse deleteMsgVpnAclProfile(msgVpnName, aclProfileName) - -Delete an ACL Profile object. - -Delete an ACL Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfile(msgVpnName, aclProfileName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnAclProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfileClientConnectException - -> SempMetaOnlyResponse deleteMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress) - -Delete a Client Connect Exception object. - -Delete a Client Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String clientConnectExceptionAddress = "clientConnectExceptionAddress_example"; // String | The IP address/netmask of the client connect exception in CIDR form. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnAclProfileClientConnectException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **clientConnectExceptionAddress** | **String**| The IP address/netmask of the client connect exception in CIDR form. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfilePublishException - -> SempMetaOnlyResponse deleteMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic) - -Delete a Publish Topic Exception object. - -Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String topicSyntax = "topicSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String publishExceptionTopic = "publishExceptionTopic_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnAclProfilePublishException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **topicSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **publishExceptionTopic** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfilePublishTopicException - -> SempMetaOnlyResponse deleteMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException) - -Delete a Publish Topic Exception object. - -Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String publishTopicExceptionSyntax = "publishTopicExceptionSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String publishTopicException = "publishTopicException_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnAclProfilePublishTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **publishTopicExceptionSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **publishTopicException** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfileSubscribeException - -> SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic) - -Delete a Subscribe Topic Exception object. - -Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String topicSyntax = "topicSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String subscribeExceptionTopic = "subscribeExceptionTopic_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnAclProfileSubscribeException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **topicSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **subscribeExceptionTopic** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfileSubscribeShareNameException - -> SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException) - -Delete a Subscribe Share Name Exception object. - -Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String subscribeShareNameExceptionSyntax = "subscribeShareNameExceptionSyntax_example"; // String | The syntax of the subscribe share name for the exception to the default action taken. - String subscribeShareNameException = "subscribeShareNameException_example"; // String | The subscribe share name exception to the default action taken. May include wildcard characters. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnAclProfileSubscribeShareNameException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **subscribeShareNameExceptionSyntax** | **String**| The syntax of the subscribe share name for the exception to the default action taken. | | -| **subscribeShareNameException** | **String**| The subscribe share name exception to the default action taken. May include wildcard characters. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAclProfileSubscribeTopicException - -> SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException) - -Delete a Subscribe Topic Exception object. - -Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String subscribeTopicExceptionSyntax = "subscribeTopicExceptionSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String subscribeTopicException = "subscribeTopicException_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnAclProfileSubscribeTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **subscribeTopicExceptionSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **subscribeTopicException** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAuthenticationOauthProfile - -> SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName) - -Delete an OAuth Profile object. - -Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnAuthenticationOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim - -> SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName) - -Delete a Required Claim object. - -Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String clientRequiredClaimName = "clientRequiredClaimName_example"; // String | The name of the ID token claim to verify. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **clientRequiredClaimName** | **String**| The name of the ID token claim to verify. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - -> SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName) - -Delete a Required Claim object. - -Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String resourceServerRequiredClaimName = "resourceServerRequiredClaimName_example"; // String | The name of the access token claim to verify. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **resourceServerRequiredClaimName** | **String**| The name of the access token claim to verify. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAuthenticationOauthProvider - -> SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName) - -Delete an OAuth Provider object. - -Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProviderName = "oauthProviderName_example"; // String | The name of the OAuth Provider. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnAuthenticationOauthProvider"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProviderName** | **String**| The name of the OAuth Provider. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnAuthorizationGroup - -> SempMetaOnlyResponse deleteMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName) - -Delete an Authorization Group object. - -Delete an Authorization Group object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String authorizationGroupName = "authorizationGroupName_example"; // String | The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnAuthorizationGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **authorizationGroupName** | **String**| The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnBridge - -> SempMetaOnlyResponse deleteMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter) - -Delete a Bridge object. - -Delete a Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnBridgeRemoteMsgVpn - -> SempMetaOnlyResponse deleteMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface) - -Delete a Remote Message VPN object. - -Delete a Remote Message VPN object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteMsgVpnName = "remoteMsgVpnName_example"; // String | The name of the remote Message VPN. - String remoteMsgVpnLocation = "remoteMsgVpnLocation_example"; // String | The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). - String remoteMsgVpnInterface = "remoteMsgVpnInterface_example"; // String | The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnBridgeRemoteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteMsgVpnName** | **String**| The name of the remote Message VPN. | | -| **remoteMsgVpnLocation** | **String**| The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). | | -| **remoteMsgVpnInterface** | **String**| The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnBridgeRemoteSubscription - -> SempMetaOnlyResponse deleteMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic) - -Delete a Remote Subscription object. - -Delete a Remote Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteSubscriptionTopic = "remoteSubscriptionTopic_example"; // String | The topic of the Bridge remote subscription. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnBridgeRemoteSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteSubscriptionTopic** | **String**| The topic of the Bridge remote subscription. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnBridgeTlsTrustedCommonName - -> SempMetaOnlyResponse deleteMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName) - -Delete a Trusted Common Name object. - -Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String tlsTrustedCommonName = "tlsTrustedCommonName_example"; // String | The expected trusted common name of the remote certificate. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnBridgeTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **tlsTrustedCommonName** | **String**| The expected trusted common name of the remote certificate. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnCertMatchingRule - -> SempMetaOnlyResponse deleteMsgVpnCertMatchingRule(msgVpnName, ruleName) - -Delete a Certificate Matching Rule object. - -Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnCertMatchingRule(msgVpnName, ruleName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnCertMatchingRuleAttributeFilter - -> SempMetaOnlyResponse deleteMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName) - -Delete a Certificate Matching Rule Attribute Filter object. - -Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnCertMatchingRuleCondition - -> SempMetaOnlyResponse deleteMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source) - -Delete a Certificate Matching Rule Condition object. - -Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String source = "source_example"; // String | Certificate field to be compared with the Attribute. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnCertMatchingRuleCondition"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **source** | **String**| Certificate field to be compared with the Attribute. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnClientProfile - -> SempMetaOnlyResponse deleteMsgVpnClientProfile(msgVpnName, clientProfileName) - -Delete a Client Profile object. - -Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientProfileName = "clientProfileName_example"; // String | The name of the Client Profile. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnClientProfile(msgVpnName, clientProfileName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnClientProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientProfileName** | **String**| The name of the Client Profile. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnClientUsername - -> SempMetaOnlyResponse deleteMsgVpnClientUsername(msgVpnName, clientUsername) - -Delete a Client Username object. - -Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnClientUsername(msgVpnName, clientUsername); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnClientUsername"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnClientUsernameAttribute - -> SempMetaOnlyResponse deleteMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue) - -Delete a Client Username Attribute object. - -Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - String attributeName = "attributeName_example"; // String | The name of the Attribute. - String attributeValue = "attributeValue_example"; // String | The value of the Attribute. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnClientUsernameAttribute"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **attributeName** | **String**| The name of the Attribute. | | -| **attributeValue** | **String**| The value of the Attribute. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCache - -> SempMetaOnlyResponse deleteMsgVpnDistributedCache(msgVpnName, cacheName) - -Delete a Distributed Cache object. - -Delete a Distributed Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCache(msgVpnName, cacheName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnDistributedCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCacheCluster - -> SempMetaOnlyResponse deleteMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName) - -Delete a Cache Cluster object. - -Delete a Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnDistributedCacheCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster - -> SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName) - -Delete a Home Cache Cluster object. - -Delete a Home Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - -> SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix) - -Delete a Topic Prefix object. - -Delete a Topic Prefix object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - String topicPrefix = "topicPrefix_example"; // String | A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | -| **topicPrefix** | **String**| A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCacheClusterInstance - -> SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName) - -Delete a Cache Instance object. - -Delete a Cache Instance object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String instanceName = "instanceName_example"; // String | The name of the Cache Instance. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnDistributedCacheClusterInstance"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **instanceName** | **String**| The name of the Cache Instance. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDistributedCacheClusterTopic - -> SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic) - -Delete a Topic object. - -Delete a Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String topic = "topic_example"; // String | The value of the Topic in the form a/b/c. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnDistributedCacheClusterTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **topic** | **String**| The value of the Topic in the form a/b/c. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnDmrBridge - -> SempMetaOnlyResponse deleteMsgVpnDmrBridge(msgVpnName, remoteNodeName) - -Delete a DMR Bridge object. - -Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the DMR Bridge. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnDmrBridge(msgVpnName, remoteNodeName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnDmrBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the DMR Bridge. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnJndiConnectionFactory - -> SempMetaOnlyResponse deleteMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName) - -Delete a JNDI Connection Factory object. - -Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String connectionFactoryName = "connectionFactoryName_example"; // String | The name of the JMS Connection Factory. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnJndiConnectionFactory"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **connectionFactoryName** | **String**| The name of the JMS Connection Factory. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnJndiQueue - -> SempMetaOnlyResponse deleteMsgVpnJndiQueue(msgVpnName, queueName) - -Delete a JNDI Queue object. - -Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The JNDI name of the JMS Queue. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnJndiQueue(msgVpnName, queueName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnJndiQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The JNDI name of the JMS Queue. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnJndiTopic - -> SempMetaOnlyResponse deleteMsgVpnJndiTopic(msgVpnName, topicName) - -Delete a JNDI Topic object. - -Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicName = "topicName_example"; // String | The JNDI name of the JMS Topic. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnJndiTopic(msgVpnName, topicName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnJndiTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicName** | **String**| The JNDI name of the JMS Topic. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnMqttRetainCache - -> SempMetaOnlyResponse deleteMsgVpnMqttRetainCache(msgVpnName, cacheName) - -Delete an MQTT Retain Cache object. - -Delete an MQTT Retain Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the MQTT Retain Cache. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnMqttRetainCache(msgVpnName, cacheName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnMqttRetainCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the MQTT Retain Cache. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnMqttSession - -> SempMetaOnlyResponse deleteMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter) - -Delete an MQTT Session object. - -Delete an MQTT Session object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnMqttSession"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnMqttSessionSubscription - -> SempMetaOnlyResponse deleteMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic) - -Delete a Subscription object. - -Delete a Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - String subscriptionTopic = "subscriptionTopic_example"; // String | The MQTT subscription topic. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnMqttSessionSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **subscriptionTopic** | **String**| The MQTT subscription topic. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnQueue - -> SempMetaOnlyResponse deleteMsgVpnQueue(msgVpnName, queueName) - -Delete a Queue object. - -Delete a Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnQueue(msgVpnName, queueName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnQueueSubscription - -> SempMetaOnlyResponse deleteMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic) - -Delete a Queue Subscription object. - -Delete a Queue Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - String subscriptionTopic = "subscriptionTopic_example"; // String | The topic of the Subscription. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnQueueSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **subscriptionTopic** | **String**| The topic of the Subscription. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnQueueTemplate - -> SempMetaOnlyResponse deleteMsgVpnQueueTemplate(msgVpnName, queueTemplateName) - -Delete a Queue Template object. - -Delete a Queue Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueTemplateName = "queueTemplateName_example"; // String | The name of the Queue Template. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnQueueTemplate(msgVpnName, queueTemplateName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnQueueTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueTemplateName** | **String**| The name of the Queue Template. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnReplayLog - -> SempMetaOnlyResponse deleteMsgVpnReplayLog(msgVpnName, replayLogName) - -Delete a Replay Log object. - -Delete a Replay Log object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnReplayLog(msgVpnName, replayLogName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnReplayLog"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnReplayLogTopicFilterSubscription - -> SempMetaOnlyResponse deleteMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription) - -Delete a Topic Filter Subscription object. - -Delete a Topic Filter Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - String topicFilterSubscription = "topicFilterSubscription_example"; // String | The topic of the Subscription. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnReplayLogTopicFilterSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **topicFilterSubscription** | **String**| The topic of the Subscription. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnReplicatedTopic - -> SempMetaOnlyResponse deleteMsgVpnReplicatedTopic(msgVpnName, replicatedTopic) - -Delete a Replicated Topic object. - -Delete a Replicated Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replicatedTopic = "replicatedTopic_example"; // String | The topic for applying replication. Published messages matching this topic will be replicated to the standby site. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnReplicatedTopic(msgVpnName, replicatedTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnReplicatedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replicatedTopic** | **String**| The topic for applying replication. Published messages matching this topic will be replicated to the standby site. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPoint - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName) - -Delete a REST Delivery Point object. - -Delete a REST Delivery Point object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnRestDeliveryPoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPointQueueBinding - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName) - -Delete a Queue Binding object. - -Delete a Queue Binding object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnRestDeliveryPointQueueBinding"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName) - -Delete a Request Header object. - -Delete a Request Header object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - String headerName = "headerName_example"; // String | The name of the HTTP request header. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **headerName** | **String**| The name of the HTTP request header. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPointRestConsumer - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName) - -Delete a REST Consumer object. - -Delete a REST Consumer object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnRestDeliveryPointRestConsumer"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName) - -Delete a Claim object. - -Delete a Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String oauthJwtClaimName = "oauthJwtClaimName_example"; // String | The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **oauthJwtClaimName** | **String**| The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName) - -Delete a Trusted Common Name object. - -Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String tlsTrustedCommonName = "tlsTrustedCommonName_example"; // String | The expected trusted common name of the remote certificate. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **tlsTrustedCommonName** | **String**| The expected trusted common name of the remote certificate. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnSequencedTopic - -> SempMetaOnlyResponse deleteMsgVpnSequencedTopic(msgVpnName, sequencedTopic) - -Delete a Sequenced Topic object. - -Delete a Sequenced Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String sequencedTopic = "sequencedTopic_example"; // String | Topic for applying sequence numbers. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnSequencedTopic(msgVpnName, sequencedTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnSequencedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **sequencedTopic** | **String**| Topic for applying sequence numbers. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnTopicEndpoint - -> SempMetaOnlyResponse deleteMsgVpnTopicEndpoint(msgVpnName, topicEndpointName) - -Delete a Topic Endpoint object. - -Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointName = "topicEndpointName_example"; // String | The name of the Topic Endpoint. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnTopicEndpoint(msgVpnName, topicEndpointName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnTopicEndpoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointName** | **String**| The name of the Topic Endpoint. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnTopicEndpointTemplate - -> SempMetaOnlyResponse deleteMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName) - -Delete a Topic Endpoint Template object. - -Delete a Topic Endpoint Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointTemplateName = "topicEndpointTemplateName_example"; // String | The name of the Topic Endpoint Template. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#deleteMsgVpnTopicEndpointTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointTemplateName** | **String**| The name of the Topic Endpoint Template. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpn - -> MsgVpnResponse getMsgVpn(msgVpnName, opaquePassword, select) - -Get a Message VPN object. - -Get a Message VPN object. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| distributedCacheManagementEnabled|||x| msgVpnName|x||| replicationBridgeAuthenticationBasicPassword||x||x replicationBridgeAuthenticationClientCertContent||x||x replicationBridgeAuthenticationClientCertPassword||x|| replicationEnabledQueueBehavior||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnResponse result = apiInstance.getMsgVpn(msgVpnName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnResponse**](MsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfile - -> MsgVpnAclProfileResponse getMsgVpnAclProfile(msgVpnName, aclProfileName, opaquePassword, select) - -Get an ACL Profile object. - -Get an ACL Profile object. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileResponse result = apiInstance.getMsgVpnAclProfile(msgVpnName, aclProfileName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAclProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileResponse**](MsgVpnAclProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The ACL Profile object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileClientConnectException - -> MsgVpnAclProfileClientConnectExceptionResponse getMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress, opaquePassword, select) - -Get a Client Connect Exception object. - -Get a Client Connect Exception object. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String clientConnectExceptionAddress = "clientConnectExceptionAddress_example"; // String | The IP address/netmask of the client connect exception in CIDR form. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileClientConnectExceptionResponse result = apiInstance.getMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAclProfileClientConnectException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **clientConnectExceptionAddress** | **String**| The IP address/netmask of the client connect exception in CIDR form. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileClientConnectExceptionResponse**](MsgVpnAclProfileClientConnectExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Connect Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileClientConnectExceptions - -> MsgVpnAclProfileClientConnectExceptionsResponse getMsgVpnAclProfileClientConnectExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Client Connect Exception objects. - -Get a list of Client Connect Exception objects. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileClientConnectExceptionsResponse result = apiInstance.getMsgVpnAclProfileClientConnectExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAclProfileClientConnectExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileClientConnectExceptionsResponse**](MsgVpnAclProfileClientConnectExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Client Connect Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfilePublishException - -> MsgVpnAclProfilePublishExceptionResponse getMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic, opaquePassword, select) - -Get a Publish Topic Exception object. - -Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String topicSyntax = "topicSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String publishExceptionTopic = "publishExceptionTopic_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishExceptionResponse result = apiInstance.getMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAclProfilePublishException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **topicSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **publishExceptionTopic** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishExceptionResponse**](MsgVpnAclProfilePublishExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Publish Topic Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfilePublishExceptions - -> MsgVpnAclProfilePublishExceptionsResponse getMsgVpnAclProfilePublishExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Publish Topic Exception objects. - -Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishExceptionsResponse result = apiInstance.getMsgVpnAclProfilePublishExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAclProfilePublishExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishExceptionsResponse**](MsgVpnAclProfilePublishExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Publish Topic Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfilePublishTopicException - -> MsgVpnAclProfilePublishTopicExceptionResponse getMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException, opaquePassword, select) - -Get a Publish Topic Exception object. - -Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String publishTopicExceptionSyntax = "publishTopicExceptionSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String publishTopicException = "publishTopicException_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishTopicExceptionResponse result = apiInstance.getMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAclProfilePublishTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **publishTopicExceptionSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **publishTopicException** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishTopicExceptionResponse**](MsgVpnAclProfilePublishTopicExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Publish Topic Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfilePublishTopicExceptions - -> MsgVpnAclProfilePublishTopicExceptionsResponse getMsgVpnAclProfilePublishTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Publish Topic Exception objects. - -Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilePublishTopicExceptionsResponse result = apiInstance.getMsgVpnAclProfilePublishTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAclProfilePublishTopicExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilePublishTopicExceptionsResponse**](MsgVpnAclProfilePublishTopicExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Publish Topic Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeException - -> MsgVpnAclProfileSubscribeExceptionResponse getMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic, opaquePassword, select) - -Get a Subscribe Topic Exception object. - -Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String topicSyntax = "topicSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String subscribeExceptionTopic = "subscribeExceptionTopic_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeExceptionResponse result = apiInstance.getMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAclProfileSubscribeException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **topicSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **subscribeExceptionTopic** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeExceptionResponse**](MsgVpnAclProfileSubscribeExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Topic Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeExceptions - -> MsgVpnAclProfileSubscribeExceptionsResponse getMsgVpnAclProfileSubscribeExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Subscribe Topic Exception objects. - -Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeExceptionsResponse result = apiInstance.getMsgVpnAclProfileSubscribeExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAclProfileSubscribeExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeExceptionsResponse**](MsgVpnAclProfileSubscribeExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Subscribe Topic Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeShareNameException - -> MsgVpnAclProfileSubscribeShareNameExceptionResponse getMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException, opaquePassword, select) - -Get a Subscribe Share Name Exception object. - -Get a Subscribe Share Name Exception object. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String subscribeShareNameExceptionSyntax = "subscribeShareNameExceptionSyntax_example"; // String | The syntax of the subscribe share name for the exception to the default action taken. - String subscribeShareNameException = "subscribeShareNameException_example"; // String | The subscribe share name exception to the default action taken. May include wildcard characters. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeShareNameExceptionResponse result = apiInstance.getMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAclProfileSubscribeShareNameException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **subscribeShareNameExceptionSyntax** | **String**| The syntax of the subscribe share name for the exception to the default action taken. | | -| **subscribeShareNameException** | **String**| The subscribe share name exception to the default action taken. May include wildcard characters. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeShareNameExceptionResponse**](MsgVpnAclProfileSubscribeShareNameExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Share Name Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeShareNameExceptions - -> MsgVpnAclProfileSubscribeShareNameExceptionsResponse getMsgVpnAclProfileSubscribeShareNameExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Subscribe Share Name Exception objects. - -Get a list of Subscribe Share Name Exception objects. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeShareNameExceptionsResponse result = apiInstance.getMsgVpnAclProfileSubscribeShareNameExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAclProfileSubscribeShareNameExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeShareNameExceptionsResponse**](MsgVpnAclProfileSubscribeShareNameExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Subscribe Share Name Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeTopicException - -> MsgVpnAclProfileSubscribeTopicExceptionResponse getMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException, opaquePassword, select) - -Get a Subscribe Topic Exception object. - -Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - String subscribeTopicExceptionSyntax = "subscribeTopicExceptionSyntax_example"; // String | The syntax of the topic for the exception to the default action taken. - String subscribeTopicException = "subscribeTopicException_example"; // String | The topic for the exception to the default action taken. May include wildcard characters. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeTopicExceptionResponse result = apiInstance.getMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAclProfileSubscribeTopicException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **subscribeTopicExceptionSyntax** | **String**| The syntax of the topic for the exception to the default action taken. | | -| **subscribeTopicException** | **String**| The topic for the exception to the default action taken. May include wildcard characters. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeTopicExceptionResponse**](MsgVpnAclProfileSubscribeTopicExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscribe Topic Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfileSubscribeTopicExceptions - -> MsgVpnAclProfileSubscribeTopicExceptionsResponse getMsgVpnAclProfileSubscribeTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Subscribe Topic Exception objects. - -Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileSubscribeTopicExceptionsResponse result = apiInstance.getMsgVpnAclProfileSubscribeTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAclProfileSubscribeTopicExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileSubscribeTopicExceptionsResponse**](MsgVpnAclProfileSubscribeTopicExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Subscribe Topic Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAclProfiles - -> MsgVpnAclProfilesResponse getMsgVpnAclProfiles(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of ACL Profile objects. - -Get a list of ACL Profile objects. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfilesResponse result = apiInstance.getMsgVpnAclProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAclProfiles"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfilesResponse**](MsgVpnAclProfilesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of ACL Profile objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfile - -> MsgVpnAuthenticationOauthProfileResponse getMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, opaquePassword, select) - -Get an OAuth Profile object. - -Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResponse result = apiInstance.getMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAuthenticationOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResponse**](MsgVpnAuthenticationOauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfileClientRequiredClaim - -> MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse getMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName, opaquePassword, select) - -Get a Required Claim object. - -Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String clientRequiredClaimName = "clientRequiredClaimName_example"; // String | The name of the ID token claim to verify. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse result = apiInstance.getMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **clientRequiredClaimName** | **String**| The name of the ID token claim to verify. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse**](MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfileClientRequiredClaims - -> MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse getMsgVpnAuthenticationOauthProfileClientRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Required Claim objects. - -Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse result = apiInstance.getMsgVpnAuthenticationOauthProfileClientRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAuthenticationOauthProfileClientRequiredClaims"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse**](MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Required Claim objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - -> MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select) - -Get a Required Claim object. - -Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String resourceServerRequiredClaimName = "resourceServerRequiredClaimName_example"; // String | The name of the access token claim to verify. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse result = apiInstance.getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **resourceServerRequiredClaimName** | **String**| The name of the access token claim to verify. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse**](MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims - -> MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Required Claim objects. - -Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse result = apiInstance.getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse**](MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Required Claim objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProfiles - -> MsgVpnAuthenticationOauthProfilesResponse getMsgVpnAuthenticationOauthProfiles(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of OAuth Profile objects. - -Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfilesResponse result = apiInstance.getMsgVpnAuthenticationOauthProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAuthenticationOauthProfiles"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfilesResponse**](MsgVpnAuthenticationOauthProfilesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of OAuth Profile objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProvider - -> MsgVpnAuthenticationOauthProviderResponse getMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, opaquePassword, select) - -Get an OAuth Provider object. - -Get an OAuth Provider object. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProviderName = "oauthProviderName_example"; // String | The name of the OAuth Provider. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProviderResponse result = apiInstance.getMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAuthenticationOauthProvider"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProviderName** | **String**| The name of the OAuth Provider. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProviderResponse**](MsgVpnAuthenticationOauthProviderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Provider object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthenticationOauthProviders - -> MsgVpnAuthenticationOauthProvidersResponse getMsgVpnAuthenticationOauthProviders(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of OAuth Provider objects. - -Get a list of OAuth Provider objects. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProvidersResponse result = apiInstance.getMsgVpnAuthenticationOauthProviders(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAuthenticationOauthProviders"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProvidersResponse**](MsgVpnAuthenticationOauthProvidersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of OAuth Provider objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthorizationGroup - -> MsgVpnAuthorizationGroupResponse getMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, opaquePassword, select) - -Get an Authorization Group object. - -Get an Authorization Group object. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String authorizationGroupName = "authorizationGroupName_example"; // String | The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthorizationGroupResponse result = apiInstance.getMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAuthorizationGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **authorizationGroupName** | **String**| The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthorizationGroupResponse**](MsgVpnAuthorizationGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Group object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnAuthorizationGroups - -> MsgVpnAuthorizationGroupsResponse getMsgVpnAuthorizationGroups(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Authorization Group objects. - -Get a list of Authorization Group objects. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthorizationGroupsResponse result = apiInstance.getMsgVpnAuthorizationGroups(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnAuthorizationGroups"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthorizationGroupsResponse**](MsgVpnAuthorizationGroupsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Authorization Group objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridge - -> MsgVpnBridgeResponse getMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, select) - -Get a Bridge object. - -Get a Bridge object. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeResponse result = apiInstance.getMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeResponse**](MsgVpnBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Bridge object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeRemoteMsgVpn - -> MsgVpnBridgeRemoteMsgVpnResponse getMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, opaquePassword, select) - -Get a Remote Message VPN object. - -Get a Remote Message VPN object. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteMsgVpnName = "remoteMsgVpnName_example"; // String | The name of the remote Message VPN. - String remoteMsgVpnLocation = "remoteMsgVpnLocation_example"; // String | The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). - String remoteMsgVpnInterface = "remoteMsgVpnInterface_example"; // String | The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteMsgVpnResponse result = apiInstance.getMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnBridgeRemoteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteMsgVpnName** | **String**| The name of the remote Message VPN. | | -| **remoteMsgVpnLocation** | **String**| The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). | | -| **remoteMsgVpnInterface** | **String**| The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteMsgVpnResponse**](MsgVpnBridgeRemoteMsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Message VPN object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeRemoteMsgVpns - -> MsgVpnBridgeRemoteMsgVpnsResponse getMsgVpnBridgeRemoteMsgVpns(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select) - -Get a list of Remote Message VPN objects. - -Get a list of Remote Message VPN objects. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteMsgVpnsResponse result = apiInstance.getMsgVpnBridgeRemoteMsgVpns(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnBridgeRemoteMsgVpns"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteMsgVpnsResponse**](MsgVpnBridgeRemoteMsgVpnsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Remote Message VPN objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeRemoteSubscription - -> MsgVpnBridgeRemoteSubscriptionResponse getMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic, opaquePassword, select) - -Get a Remote Subscription object. - -Get a Remote Subscription object. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteSubscriptionTopic = "remoteSubscriptionTopic_example"; // String | The topic of the Bridge remote subscription. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteSubscriptionResponse result = apiInstance.getMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnBridgeRemoteSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteSubscriptionTopic** | **String**| The topic of the Bridge remote subscription. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteSubscriptionResponse**](MsgVpnBridgeRemoteSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Subscription object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeRemoteSubscriptions - -> MsgVpnBridgeRemoteSubscriptionsResponse getMsgVpnBridgeRemoteSubscriptions(msgVpnName, bridgeName, bridgeVirtualRouter, count, cursor, opaquePassword, where, select) - -Get a list of Remote Subscription objects. - -Get a list of Remote Subscription objects. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteSubscriptionsResponse result = apiInstance.getMsgVpnBridgeRemoteSubscriptions(msgVpnName, bridgeName, bridgeVirtualRouter, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnBridgeRemoteSubscriptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteSubscriptionsResponse**](MsgVpnBridgeRemoteSubscriptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Remote Subscription objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeTlsTrustedCommonName - -> MsgVpnBridgeTlsTrustedCommonNameResponse getMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName, opaquePassword, select) - -Get a Trusted Common Name object. - -Get a Trusted Common Name object. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String tlsTrustedCommonName = "tlsTrustedCommonName_example"; // String | The expected trusted common name of the remote certificate. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeTlsTrustedCommonNameResponse result = apiInstance.getMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnBridgeTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **tlsTrustedCommonName** | **String**| The expected trusted common name of the remote certificate. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeTlsTrustedCommonNameResponse**](MsgVpnBridgeTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Trusted Common Name object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridgeTlsTrustedCommonNames - -> MsgVpnBridgeTlsTrustedCommonNamesResponse getMsgVpnBridgeTlsTrustedCommonNames(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select) - -Get a list of Trusted Common Name objects. - -Get a list of Trusted Common Name objects. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeTlsTrustedCommonNamesResponse result = apiInstance.getMsgVpnBridgeTlsTrustedCommonNames(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnBridgeTlsTrustedCommonNames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeTlsTrustedCommonNamesResponse**](MsgVpnBridgeTlsTrustedCommonNamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Trusted Common Name objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnBridges - -> MsgVpnBridgesResponse getMsgVpnBridges(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Bridge objects. - -Get a list of Bridge objects. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgesResponse result = apiInstance.getMsgVpnBridges(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnBridges"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgesResponse**](MsgVpnBridgesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Bridge objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRule - -> MsgVpnCertMatchingRuleResponse getMsgVpnCertMatchingRule(msgVpnName, ruleName, opaquePassword, select) - -Get a Certificate Matching Rule object. - -Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleResponse result = apiInstance.getMsgVpnCertMatchingRule(msgVpnName, ruleName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleResponse**](MsgVpnCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRuleAttributeFilter - -> MsgVpnCertMatchingRuleAttributeFilterResponse getMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, opaquePassword, select) - -Get a Certificate Matching Rule Attribute Filter object. - -Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleAttributeFilterResponse result = apiInstance.getMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleAttributeFilterResponse**](MsgVpnCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRuleAttributeFilters - -> MsgVpnCertMatchingRuleAttributeFiltersResponse getMsgVpnCertMatchingRuleAttributeFilters(msgVpnName, ruleName, count, cursor, opaquePassword, where, select) - -Get a list of Certificate Matching Rule Attribute Filter objects. - -Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleAttributeFiltersResponse result = apiInstance.getMsgVpnCertMatchingRuleAttributeFilters(msgVpnName, ruleName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnCertMatchingRuleAttributeFilters"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleAttributeFiltersResponse**](MsgVpnCertMatchingRuleAttributeFiltersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRuleCondition - -> MsgVpnCertMatchingRuleConditionResponse getMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source, opaquePassword, select) - -Get a Certificate Matching Rule Condition object. - -Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String source = "source_example"; // String | Certificate field to be compared with the Attribute. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleConditionResponse result = apiInstance.getMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnCertMatchingRuleCondition"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **source** | **String**| Certificate field to be compared with the Attribute. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleConditionResponse**](MsgVpnCertMatchingRuleConditionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Condition object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRuleConditions - -> MsgVpnCertMatchingRuleConditionsResponse getMsgVpnCertMatchingRuleConditions(msgVpnName, ruleName, count, cursor, opaquePassword, where, select) - -Get a list of Certificate Matching Rule Condition objects. - -Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleConditionsResponse result = apiInstance.getMsgVpnCertMatchingRuleConditions(msgVpnName, ruleName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnCertMatchingRuleConditions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleConditionsResponse**](MsgVpnCertMatchingRuleConditionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Matching Rule Condition objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnCertMatchingRules - -> MsgVpnCertMatchingRulesResponse getMsgVpnCertMatchingRules(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Certificate Matching Rule objects. - -Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRulesResponse result = apiInstance.getMsgVpnCertMatchingRules(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnCertMatchingRules"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRulesResponse**](MsgVpnCertMatchingRulesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Certificate Matching Rule objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientProfile - -> MsgVpnClientProfileResponse getMsgVpnClientProfile(msgVpnName, clientProfileName, opaquePassword, select) - -Get a Client Profile object. - -Get a Client Profile object. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientProfileName = "clientProfileName_example"; // String | The name of the Client Profile. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientProfileResponse result = apiInstance.getMsgVpnClientProfile(msgVpnName, clientProfileName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnClientProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientProfileName** | **String**| The name of the Client Profile. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientProfileResponse**](MsgVpnClientProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Profile object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientProfiles - -> MsgVpnClientProfilesResponse getMsgVpnClientProfiles(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Client Profile objects. - -Get a list of Client Profile objects. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientProfilesResponse result = apiInstance.getMsgVpnClientProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnClientProfiles"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientProfilesResponse**](MsgVpnClientProfilesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Client Profile objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientUsername - -> MsgVpnClientUsernameResponse getMsgVpnClientUsername(msgVpnName, clientUsername, opaquePassword, select) - -Get a Client Username object. - -Get a Client Username object. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameResponse result = apiInstance.getMsgVpnClientUsername(msgVpnName, clientUsername, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnClientUsername"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameResponse**](MsgVpnClientUsernameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientUsernameAttribute - -> MsgVpnClientUsernameAttributeResponse getMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue, opaquePassword, select) - -Get a Client Username Attribute object. - -Get a Client Username Attribute object. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - String attributeName = "attributeName_example"; // String | The name of the Attribute. - String attributeValue = "attributeValue_example"; // String | The value of the Attribute. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameAttributeResponse result = apiInstance.getMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnClientUsernameAttribute"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **attributeName** | **String**| The name of the Attribute. | | -| **attributeValue** | **String**| The value of the Attribute. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameAttributeResponse**](MsgVpnClientUsernameAttributeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username Attribute object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientUsernameAttributes - -> MsgVpnClientUsernameAttributesResponse getMsgVpnClientUsernameAttributes(msgVpnName, clientUsername, count, cursor, opaquePassword, where, select) - -Get a list of Client Username Attribute objects. - -Get a list of Client Username Attribute objects. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameAttributesResponse result = apiInstance.getMsgVpnClientUsernameAttributes(msgVpnName, clientUsername, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnClientUsernameAttributes"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameAttributesResponse**](MsgVpnClientUsernameAttributesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Client Username Attribute objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnClientUsernames - -> MsgVpnClientUsernamesResponse getMsgVpnClientUsernames(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Client Username objects. - -Get a list of Client Username objects. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernamesResponse result = apiInstance.getMsgVpnClientUsernames(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnClientUsernames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernamesResponse**](MsgVpnClientUsernamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Client Username objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCache - -> MsgVpnDistributedCacheResponse getMsgVpnDistributedCache(msgVpnName, cacheName, opaquePassword, select) - -Get a Distributed Cache object. - -Get a Distributed Cache object. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheResponse result = apiInstance.getMsgVpnDistributedCache(msgVpnName, cacheName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnDistributedCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheResponse**](MsgVpnDistributedCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Distributed Cache object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheCluster - -> MsgVpnDistributedCacheClusterResponse getMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, opaquePassword, select) - -Get a Cache Cluster object. - -Get a Cache Cluster object. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterResponse result = apiInstance.getMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnDistributedCacheCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterResponse**](MsgVpnDistributedCacheClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Cluster object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName, opaquePassword, select) - -Get a Home Cache Cluster object. - -Get a Home Cache Cluster object. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse result = apiInstance.getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Home Cache Cluster object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix, opaquePassword, select) - -Get a Topic Prefix object. - -Get a Topic Prefix object. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - String topicPrefix = "topicPrefix_example"; // String | A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse result = apiInstance.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | -| **topicPrefix** | **String**| A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Prefix object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes(msgVpnName, cacheName, clusterName, homeClusterName, count, cursor, opaquePassword, where, select) - -Get a list of Topic Prefix objects. - -Get a list of Topic Prefix objects. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String homeClusterName = "homeClusterName_example"; // String | The name of the remote Home Cache Cluster. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse result = apiInstance.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes(msgVpnName, cacheName, clusterName, homeClusterName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **homeClusterName** | **String**| The name of the remote Home Cache Cluster. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Topic Prefix objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters - -> MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select) - -Get a list of Home Cache Cluster objects. - -Get a list of Home Cache Cluster objects. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse result = apiInstance.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse**](MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Home Cache Cluster objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterInstance - -> MsgVpnDistributedCacheClusterInstanceResponse getMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, opaquePassword, select) - -Get a Cache Instance object. - -Get a Cache Instance object. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String instanceName = "instanceName_example"; // String | The name of the Cache Instance. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterInstanceResponse result = apiInstance.getMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnDistributedCacheClusterInstance"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **instanceName** | **String**| The name of the Cache Instance. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterInstanceResponse**](MsgVpnDistributedCacheClusterInstanceResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Instance object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterInstances - -> MsgVpnDistributedCacheClusterInstancesResponse getMsgVpnDistributedCacheClusterInstances(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select) - -Get a list of Cache Instance objects. - -Get a list of Cache Instance objects. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterInstancesResponse result = apiInstance.getMsgVpnDistributedCacheClusterInstances(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnDistributedCacheClusterInstances"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterInstancesResponse**](MsgVpnDistributedCacheClusterInstancesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Cache Instance objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterTopic - -> MsgVpnDistributedCacheClusterTopicResponse getMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic, opaquePassword, select) - -Get a Topic object. - -Get a Topic object. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String topic = "topic_example"; // String | The value of the Topic in the form a/b/c. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterTopicResponse result = apiInstance.getMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnDistributedCacheClusterTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **topic** | **String**| The value of the Topic in the form a/b/c. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterTopicResponse**](MsgVpnDistributedCacheClusterTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusterTopics - -> MsgVpnDistributedCacheClusterTopicsResponse getMsgVpnDistributedCacheClusterTopics(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select) - -Get a list of Topic objects. - -Get a list of Topic objects. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterTopicsResponse result = apiInstance.getMsgVpnDistributedCacheClusterTopics(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnDistributedCacheClusterTopics"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterTopicsResponse**](MsgVpnDistributedCacheClusterTopicsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Topic objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCacheClusters - -> MsgVpnDistributedCacheClustersResponse getMsgVpnDistributedCacheClusters(msgVpnName, cacheName, count, cursor, opaquePassword, where, select) - -Get a list of Cache Cluster objects. - -Get a list of Cache Cluster objects. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClustersResponse result = apiInstance.getMsgVpnDistributedCacheClusters(msgVpnName, cacheName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnDistributedCacheClusters"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClustersResponse**](MsgVpnDistributedCacheClustersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Cache Cluster objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDistributedCaches - -> MsgVpnDistributedCachesResponse getMsgVpnDistributedCaches(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Distributed Cache objects. - -Get a list of Distributed Cache objects. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCachesResponse result = apiInstance.getMsgVpnDistributedCaches(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnDistributedCaches"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCachesResponse**](MsgVpnDistributedCachesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Distributed Cache objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDmrBridge - -> MsgVpnDmrBridgeResponse getMsgVpnDmrBridge(msgVpnName, remoteNodeName, opaquePassword, select) - -Get a DMR Bridge object. - -Get a DMR Bridge object. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the DMR Bridge. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDmrBridgeResponse result = apiInstance.getMsgVpnDmrBridge(msgVpnName, remoteNodeName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnDmrBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the DMR Bridge. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDmrBridgeResponse**](MsgVpnDmrBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The DMR Bridge object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnDmrBridges - -> MsgVpnDmrBridgesResponse getMsgVpnDmrBridges(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of DMR Bridge objects. - -Get a list of DMR Bridge objects. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDmrBridgesResponse result = apiInstance.getMsgVpnDmrBridges(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnDmrBridges"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDmrBridgesResponse**](MsgVpnDmrBridgesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of DMR Bridge objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiConnectionFactories - -> MsgVpnJndiConnectionFactoriesResponse getMsgVpnJndiConnectionFactories(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of JNDI Connection Factory objects. - -Get a list of JNDI Connection Factory objects. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiConnectionFactoriesResponse result = apiInstance.getMsgVpnJndiConnectionFactories(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnJndiConnectionFactories"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiConnectionFactoriesResponse**](MsgVpnJndiConnectionFactoriesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of JNDI Connection Factory objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiConnectionFactory - -> MsgVpnJndiConnectionFactoryResponse getMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, opaquePassword, select) - -Get a JNDI Connection Factory object. - -Get a JNDI Connection Factory object. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String connectionFactoryName = "connectionFactoryName_example"; // String | The name of the JMS Connection Factory. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiConnectionFactoryResponse result = apiInstance.getMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnJndiConnectionFactory"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **connectionFactoryName** | **String**| The name of the JMS Connection Factory. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiConnectionFactoryResponse**](MsgVpnJndiConnectionFactoryResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Connection Factory object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiQueue - -> MsgVpnJndiQueueResponse getMsgVpnJndiQueue(msgVpnName, queueName, opaquePassword, select) - -Get a JNDI Queue object. - -Get a JNDI Queue object. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The JNDI name of the JMS Queue. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiQueueResponse result = apiInstance.getMsgVpnJndiQueue(msgVpnName, queueName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnJndiQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The JNDI name of the JMS Queue. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiQueueResponse**](MsgVpnJndiQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Queue object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiQueues - -> MsgVpnJndiQueuesResponse getMsgVpnJndiQueues(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of JNDI Queue objects. - -Get a list of JNDI Queue objects. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiQueuesResponse result = apiInstance.getMsgVpnJndiQueues(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnJndiQueues"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiQueuesResponse**](MsgVpnJndiQueuesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of JNDI Queue objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiTopic - -> MsgVpnJndiTopicResponse getMsgVpnJndiTopic(msgVpnName, topicName, opaquePassword, select) - -Get a JNDI Topic object. - -Get a JNDI Topic object. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicName = "topicName_example"; // String | The JNDI name of the JMS Topic. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiTopicResponse result = apiInstance.getMsgVpnJndiTopic(msgVpnName, topicName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnJndiTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicName** | **String**| The JNDI name of the JMS Topic. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiTopicResponse**](MsgVpnJndiTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Topic object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnJndiTopics - -> MsgVpnJndiTopicsResponse getMsgVpnJndiTopics(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of JNDI Topic objects. - -Get a list of JNDI Topic objects. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiTopicsResponse result = apiInstance.getMsgVpnJndiTopics(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnJndiTopics"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiTopicsResponse**](MsgVpnJndiTopicsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of JNDI Topic objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttRetainCache - -> MsgVpnMqttRetainCacheResponse getMsgVpnMqttRetainCache(msgVpnName, cacheName, opaquePassword, select) - -Get an MQTT Retain Cache object. - -Get an MQTT Retain Cache object. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the MQTT Retain Cache. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttRetainCacheResponse result = apiInstance.getMsgVpnMqttRetainCache(msgVpnName, cacheName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnMqttRetainCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the MQTT Retain Cache. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttRetainCacheResponse**](MsgVpnMqttRetainCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Retain Cache object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttRetainCaches - -> MsgVpnMqttRetainCachesResponse getMsgVpnMqttRetainCaches(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of MQTT Retain Cache objects. - -Get a list of MQTT Retain Cache objects. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttRetainCachesResponse result = apiInstance.getMsgVpnMqttRetainCaches(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnMqttRetainCaches"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttRetainCachesResponse**](MsgVpnMqttRetainCachesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of MQTT Retain Cache objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttSession - -> MsgVpnMqttSessionResponse getMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, opaquePassword, select) - -Get an MQTT Session object. - -Get an MQTT Session object. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionResponse result = apiInstance.getMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnMqttSession"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionResponse**](MsgVpnMqttSessionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Session object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttSessionSubscription - -> MsgVpnMqttSessionSubscriptionResponse getMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, opaquePassword, select) - -Get a Subscription object. - -Get a Subscription object. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - String subscriptionTopic = "subscriptionTopic_example"; // String | The MQTT subscription topic. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionSubscriptionResponse result = apiInstance.getMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnMqttSessionSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **subscriptionTopic** | **String**| The MQTT subscription topic. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionSubscriptionResponse**](MsgVpnMqttSessionSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscription object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttSessionSubscriptions - -> MsgVpnMqttSessionSubscriptionsResponse getMsgVpnMqttSessionSubscriptions(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, count, cursor, opaquePassword, where, select) - -Get a list of Subscription objects. - -Get a list of Subscription objects. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionSubscriptionsResponse result = apiInstance.getMsgVpnMqttSessionSubscriptions(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnMqttSessionSubscriptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionSubscriptionsResponse**](MsgVpnMqttSessionSubscriptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Subscription objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnMqttSessions - -> MsgVpnMqttSessionsResponse getMsgVpnMqttSessions(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of MQTT Session objects. - -Get a list of MQTT Session objects. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionsResponse result = apiInstance.getMsgVpnMqttSessions(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnMqttSessions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionsResponse**](MsgVpnMqttSessionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of MQTT Session objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueue - -> MsgVpnQueueResponse getMsgVpnQueue(msgVpnName, queueName, opaquePassword, select) - -Get a Queue object. - -Get a Queue object. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueResponse result = apiInstance.getMsgVpnQueue(msgVpnName, queueName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueResponse**](MsgVpnQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueueSubscription - -> MsgVpnQueueSubscriptionResponse getMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic, opaquePassword, select) - -Get a Queue Subscription object. - -Get a Queue Subscription object. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - String subscriptionTopic = "subscriptionTopic_example"; // String | The topic of the Subscription. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueSubscriptionResponse result = apiInstance.getMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnQueueSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **subscriptionTopic** | **String**| The topic of the Subscription. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueSubscriptionResponse**](MsgVpnQueueSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Subscription object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueueSubscriptions - -> MsgVpnQueueSubscriptionsResponse getMsgVpnQueueSubscriptions(msgVpnName, queueName, count, cursor, opaquePassword, where, select) - -Get a list of Queue Subscription objects. - -Get a list of Queue Subscription objects. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueSubscriptionsResponse result = apiInstance.getMsgVpnQueueSubscriptions(msgVpnName, queueName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnQueueSubscriptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueSubscriptionsResponse**](MsgVpnQueueSubscriptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Queue Subscription objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueueTemplate - -> MsgVpnQueueTemplateResponse getMsgVpnQueueTemplate(msgVpnName, queueTemplateName, opaquePassword, select) - -Get a Queue Template object. - -Get a Queue Template object. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueTemplateName = "queueTemplateName_example"; // String | The name of the Queue Template. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueTemplateResponse result = apiInstance.getMsgVpnQueueTemplate(msgVpnName, queueTemplateName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnQueueTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueTemplateName** | **String**| The name of the Queue Template. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueTemplateResponse**](MsgVpnQueueTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Template object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueueTemplates - -> MsgVpnQueueTemplatesResponse getMsgVpnQueueTemplates(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Queue Template objects. - -Get a list of Queue Template objects. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueTemplatesResponse result = apiInstance.getMsgVpnQueueTemplates(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnQueueTemplates"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueTemplatesResponse**](MsgVpnQueueTemplatesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Queue Template objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueues - -> MsgVpnQueuesResponse getMsgVpnQueues(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Queue objects. - -Get a list of Queue objects. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueuesResponse result = apiInstance.getMsgVpnQueues(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnQueues"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueuesResponse**](MsgVpnQueuesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Queue objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplayLog - -> MsgVpnReplayLogResponse getMsgVpnReplayLog(msgVpnName, replayLogName, opaquePassword, select) - -Get a Replay Log object. - -Get a Replay Log object. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogResponse result = apiInstance.getMsgVpnReplayLog(msgVpnName, replayLogName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnReplayLog"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogResponse**](MsgVpnReplayLogResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replay Log object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplayLogTopicFilterSubscription - -> MsgVpnReplayLogTopicFilterSubscriptionResponse getMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription, opaquePassword, select) - -Get a Topic Filter Subscription object. - -Get a Topic Filter Subscription object. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - String topicFilterSubscription = "topicFilterSubscription_example"; // String | The topic of the Subscription. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogTopicFilterSubscriptionResponse result = apiInstance.getMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnReplayLogTopicFilterSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **topicFilterSubscription** | **String**| The topic of the Subscription. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogTopicFilterSubscriptionResponse**](MsgVpnReplayLogTopicFilterSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Filter Subscription object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplayLogTopicFilterSubscriptions - -> MsgVpnReplayLogTopicFilterSubscriptionsResponse getMsgVpnReplayLogTopicFilterSubscriptions(msgVpnName, replayLogName, count, cursor, opaquePassword, where, select) - -Get a list of Topic Filter Subscription objects. - -Get a list of Topic Filter Subscription objects. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogTopicFilterSubscriptionsResponse result = apiInstance.getMsgVpnReplayLogTopicFilterSubscriptions(msgVpnName, replayLogName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnReplayLogTopicFilterSubscriptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogTopicFilterSubscriptionsResponse**](MsgVpnReplayLogTopicFilterSubscriptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Topic Filter Subscription objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplayLogs - -> MsgVpnReplayLogsResponse getMsgVpnReplayLogs(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Replay Log objects. - -Get a list of Replay Log objects. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogsResponse result = apiInstance.getMsgVpnReplayLogs(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnReplayLogs"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogsResponse**](MsgVpnReplayLogsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Replay Log objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplicatedTopic - -> MsgVpnReplicatedTopicResponse getMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, opaquePassword, select) - -Get a Replicated Topic object. - -Get a Replicated Topic object. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replicatedTopic = "replicatedTopic_example"; // String | The topic for applying replication. Published messages matching this topic will be replicated to the standby site. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplicatedTopicResponse result = apiInstance.getMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnReplicatedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replicatedTopic** | **String**| The topic for applying replication. Published messages matching this topic will be replicated to the standby site. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplicatedTopicResponse**](MsgVpnReplicatedTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replicated Topic object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplicatedTopics - -> MsgVpnReplicatedTopicsResponse getMsgVpnReplicatedTopics(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Replicated Topic objects. - -Get a list of Replicated Topic objects. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplicatedTopicsResponse result = apiInstance.getMsgVpnReplicatedTopics(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnReplicatedTopics"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplicatedTopicsResponse**](MsgVpnReplicatedTopicsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Replicated Topic objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPoint - -> MsgVpnRestDeliveryPointResponse getMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, opaquePassword, select) - -Get a REST Delivery Point object. - -Get a REST Delivery Point object. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointResponse result = apiInstance.getMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnRestDeliveryPoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointResponse**](MsgVpnRestDeliveryPointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Delivery Point object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointQueueBinding - -> MsgVpnRestDeliveryPointQueueBindingResponse getMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, opaquePassword, select) - -Get a Queue Binding object. - -Get a Queue Binding object. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingResponse result = apiInstance.getMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnRestDeliveryPointQueueBinding"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingResponse**](MsgVpnRestDeliveryPointQueueBindingResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Binding object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointQueueBindingRequestHeader - -> MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse getMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, opaquePassword, select) - -Get a Request Header object. - -Get a Request Header object. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - String headerName = "headerName_example"; // String | The name of the HTTP request header. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse result = apiInstance.getMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **headerName** | **String**| The name of the HTTP request header. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse**](MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Request Header object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointQueueBindingRequestHeaders - -> MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse getMsgVpnRestDeliveryPointQueueBindingRequestHeaders(msgVpnName, restDeliveryPointName, queueBindingName, count, cursor, opaquePassword, where, select) - -Get a list of Request Header objects. - -Get a list of Request Header objects. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse result = apiInstance.getMsgVpnRestDeliveryPointQueueBindingRequestHeaders(msgVpnName, restDeliveryPointName, queueBindingName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnRestDeliveryPointQueueBindingRequestHeaders"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse**](MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Request Header objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointQueueBindings - -> MsgVpnRestDeliveryPointQueueBindingsResponse getMsgVpnRestDeliveryPointQueueBindings(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select) - -Get a list of Queue Binding objects. - -Get a list of Queue Binding objects. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingsResponse result = apiInstance.getMsgVpnRestDeliveryPointQueueBindings(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnRestDeliveryPointQueueBindings"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingsResponse**](MsgVpnRestDeliveryPointQueueBindingsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Queue Binding objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumer - -> MsgVpnRestDeliveryPointRestConsumerResponse getMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, select) - -Get a REST Consumer object. - -Get a REST Consumer object. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnRestDeliveryPointRestConsumer"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerResponse**](MsgVpnRestDeliveryPointRestConsumerResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Consumer object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - -> MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName, opaquePassword, select) - -Get a Claim object. - -Get a Claim object. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String oauthJwtClaimName = "oauthJwtClaimName_example"; // String | The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **oauthJwtClaimName** | **String**| The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse**](MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Claim object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims - -> MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims(msgVpnName, restDeliveryPointName, restConsumerName, count, cursor, opaquePassword, where, select) - -Get a list of Claim objects. - -Get a list of Claim objects. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims(msgVpnName, restDeliveryPointName, restConsumerName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse**](MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Claim objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - -> MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName, opaquePassword, select) - -Get a Trusted Common Name object. - -Get a Trusted Common Name object. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String tlsTrustedCommonName = "tlsTrustedCommonName_example"; // String | The expected trusted common name of the remote certificate. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **tlsTrustedCommonName** | **String**| The expected trusted common name of the remote certificate. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse**](MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Trusted Common Name object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames - -> MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, where, select) - -Get a list of Trusted Common Name objects. - -Get a list of Trusted Common Name objects. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse**](MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Trusted Common Name objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumers - -> MsgVpnRestDeliveryPointRestConsumersResponse getMsgVpnRestDeliveryPointRestConsumers(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select) - -Get a list of REST Consumer objects. - -Get a list of REST Consumer objects. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumersResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumers(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnRestDeliveryPointRestConsumers"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumersResponse**](MsgVpnRestDeliveryPointRestConsumersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of REST Consumer objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPoints - -> MsgVpnRestDeliveryPointsResponse getMsgVpnRestDeliveryPoints(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of REST Delivery Point objects. - -Get a list of REST Delivery Point objects. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointsResponse result = apiInstance.getMsgVpnRestDeliveryPoints(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnRestDeliveryPoints"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointsResponse**](MsgVpnRestDeliveryPointsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of REST Delivery Point objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnSequencedTopic - -> MsgVpnSequencedTopicResponse getMsgVpnSequencedTopic(msgVpnName, sequencedTopic, opaquePassword, select) - -Get a Sequenced Topic object. - -Get a Sequenced Topic object. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| sequencedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String sequencedTopic = "sequencedTopic_example"; // String | Topic for applying sequence numbers. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnSequencedTopicResponse result = apiInstance.getMsgVpnSequencedTopic(msgVpnName, sequencedTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnSequencedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **sequencedTopic** | **String**| Topic for applying sequence numbers. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnSequencedTopicResponse**](MsgVpnSequencedTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Sequenced Topic object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnSequencedTopics - -> MsgVpnSequencedTopicsResponse getMsgVpnSequencedTopics(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Sequenced Topic objects. - -Get a list of Sequenced Topic objects. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| sequencedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnSequencedTopicsResponse result = apiInstance.getMsgVpnSequencedTopics(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnSequencedTopics"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnSequencedTopicsResponse**](MsgVpnSequencedTopicsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Sequenced Topic objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnTopicEndpoint - -> MsgVpnTopicEndpointResponse getMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, opaquePassword, select) - -Get a Topic Endpoint object. - -Get a Topic Endpoint object. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointName = "topicEndpointName_example"; // String | The name of the Topic Endpoint. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointResponse result = apiInstance.getMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnTopicEndpoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointName** | **String**| The name of the Topic Endpoint. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointResponse**](MsgVpnTopicEndpointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnTopicEndpointTemplate - -> MsgVpnTopicEndpointTemplateResponse getMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, opaquePassword, select) - -Get a Topic Endpoint Template object. - -Get a Topic Endpoint Template object. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointTemplateName = "topicEndpointTemplateName_example"; // String | The name of the Topic Endpoint Template. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointTemplateResponse result = apiInstance.getMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnTopicEndpointTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointTemplateName** | **String**| The name of the Topic Endpoint Template. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointTemplateResponse**](MsgVpnTopicEndpointTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint Template object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnTopicEndpointTemplates - -> MsgVpnTopicEndpointTemplatesResponse getMsgVpnTopicEndpointTemplates(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Topic Endpoint Template objects. - -Get a list of Topic Endpoint Template objects. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointTemplatesResponse result = apiInstance.getMsgVpnTopicEndpointTemplates(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnTopicEndpointTemplates"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointTemplatesResponse**](MsgVpnTopicEndpointTemplatesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Topic Endpoint Template objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnTopicEndpoints - -> MsgVpnTopicEndpointsResponse getMsgVpnTopicEndpoints(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Topic Endpoint objects. - -Get a list of Topic Endpoint objects. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointsResponse result = apiInstance.getMsgVpnTopicEndpoints(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpnTopicEndpoints"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointsResponse**](MsgVpnTopicEndpointsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Topic Endpoint objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpns - -> MsgVpnsResponse getMsgVpns(count, cursor, opaquePassword, where, select) - -Get a list of Message VPN objects. - -Get a list of Message VPN objects. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| distributedCacheManagementEnabled|||x| msgVpnName|x||| replicationBridgeAuthenticationBasicPassword||x||x replicationBridgeAuthenticationClientCertContent||x||x replicationBridgeAuthenticationClientCertPassword||x|| replicationEnabledQueueBehavior||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnsResponse result = apiInstance.getMsgVpns(count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#getMsgVpns"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnsResponse**](MsgVpnsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Message VPN objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpn - -> MsgVpnResponse replaceMsgVpn(msgVpnName, body, opaquePassword, select) - -Replace a Message VPN object. - -Replace a Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationOauthDefaultProviderName||||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled||||||x| distributedCacheManagementEnabled||||||x| msgVpnName|x||x|||| replicationBridgeAuthenticationBasicPassword||||x|||x replicationBridgeAuthenticationClientCertContent||||x|||x replicationBridgeAuthenticationClientCertPassword||||x||| replicationEnabledQueueBehavior||||x||| restTlsServerCertEnforceTrustedCommonNameEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: alias|global/read-write authenticationBasicEnabled|global/read-write authenticationBasicProfileName|global/read-write authenticationBasicRadiusDomain|global/read-write authenticationBasicType|global/read-write authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write authenticationClientCertCertificateMatchingRulesEnabled|global/read-write authenticationClientCertEnabled|global/read-write authenticationClientCertMaxChainDepth|global/read-write authenticationClientCertRevocationCheckMode|global/read-write authenticationClientCertUsernameSource|global/read-write authenticationClientCertValidateDateEnabled|global/read-write authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write authenticationKerberosEnabled|global/read-write authenticationOauthEnabled|global/read-write bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write bridgingTlsServerCertMaxChainDepth|global/read-write bridgingTlsServerCertValidateDateEnabled|global/read-write bridgingTlsServerCertValidateNameEnabled|global/read-write dmrEnabled|global/read-write exportSubscriptionsEnabled|global/read-write maxConnectionCount|global/read-write maxEgressFlowCount|global/read-write maxEndpointCount|global/read-write maxIngressFlowCount|global/read-write maxMsgSpoolUsage|global/read-write maxSubscriptionCount|global/read-write maxTransactedSessionCount|global/read-write maxTransactionCount|global/read-write mqttRetainMaxMemory|global/read-write replicationBridgeAuthenticationBasicClientUsername|global/read-write replicationBridgeAuthenticationBasicPassword|global/read-write replicationBridgeAuthenticationClientCertContent|global/read-write replicationBridgeAuthenticationClientCertPassword|global/read-write replicationBridgeAuthenticationScheme|global/read-write replicationBridgeCompressedDataEnabled|global/read-write replicationBridgeEgressFlowWindowSize|global/read-write replicationBridgeRetryDelay|global/read-write replicationBridgeTlsEnabled|global/read-write replicationBridgeUnidirectionalClientProfileName|global/read-write replicationEnabled|global/read-write replicationEnabledQueueBehavior|global/read-write replicationQueueMaxMsgSpoolUsage|global/read-write replicationRole|global/read-write restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write restTlsServerCertMaxChainDepth|global/read-write restTlsServerCertValidateDateEnabled|global/read-write restTlsServerCertValidateNameEnabled|global/read-write sempOverMsgBusAdminClientEnabled|global/read-write sempOverMsgBusAdminDistributedCacheEnabled|global/read-write sempOverMsgBusAdminEnabled|global/read-write sempOverMsgBusEnabled|global/read-write sempOverMsgBusShowEnabled|global/read-write serviceAmqpMaxConnectionCount|global/read-write serviceAmqpPlainTextListenPort|global/read-write serviceAmqpTlsListenPort|global/read-write serviceMqttMaxConnectionCount|global/read-write serviceMqttPlainTextListenPort|global/read-write serviceMqttTlsListenPort|global/read-write serviceMqttTlsWebSocketListenPort|global/read-write serviceMqttWebSocketListenPort|global/read-write serviceRestIncomingMaxConnectionCount|global/read-write serviceRestIncomingPlainTextListenPort|global/read-write serviceRestIncomingTlsListenPort|global/read-write serviceRestOutgoingMaxConnectionCount|global/read-write serviceSmfMaxConnectionCount|global/read-write serviceWebMaxConnectionCount|global/read-write This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpn body = new MsgVpn(); // MsgVpn | The Message VPN object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnResponse result = apiInstance.replaceMsgVpn(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpn**](MsgVpn.md)| The Message VPN object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnResponse**](MsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnAclProfile - -> MsgVpnAclProfileResponse replaceMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select) - -Replace an ACL Profile object. - -Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfile body = new MsgVpnAclProfile(); // MsgVpnAclProfile | The ACL Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileResponse result = apiInstance.replaceMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnAclProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfile**](MsgVpnAclProfile.md)| The ACL Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileResponse**](MsgVpnAclProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The ACL Profile object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnAuthenticationOauthProfile - -> MsgVpnAuthenticationOauthProfileResponse replaceMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select) - -Replace an OAuth Profile object. - -Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - MsgVpnAuthenticationOauthProfile body = new MsgVpnAuthenticationOauthProfile(); // MsgVpnAuthenticationOauthProfile | The OAuth Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResponse result = apiInstance.replaceMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnAuthenticationOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**MsgVpnAuthenticationOauthProfile**](MsgVpnAuthenticationOauthProfile.md)| The OAuth Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResponse**](MsgVpnAuthenticationOauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnAuthenticationOauthProvider - -> MsgVpnAuthenticationOauthProviderResponse replaceMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select) - -Replace an OAuth Provider object. - -Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- audienceClaimName||||||x| audienceClaimSource||||||x| audienceClaimValue||||||x| audienceValidationEnabled||||||x| authorizationGroupClaimName||||||x| authorizationGroupClaimSource||||||x| authorizationGroupEnabled||||||x| disconnectOnTokenExpirationEnabled||||||x| enabled||||||x| jwksRefreshInterval||||||x| jwksUri||||||x| msgVpnName|x||x|||x| oauthProviderName|x||x|||x| tokenIgnoreTimeLimitsEnabled||||||x| tokenIntrospectionParameterName||||||x| tokenIntrospectionPassword||||x||x|x tokenIntrospectionTimeout||||||x| tokenIntrospectionUri||||||x| tokenIntrospectionUsername||||||x| usernameClaimName||||||x| usernameClaimSource||||||x| usernameValidateEnabled||||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProviderName = "oauthProviderName_example"; // String | The name of the OAuth Provider. - MsgVpnAuthenticationOauthProvider body = new MsgVpnAuthenticationOauthProvider(); // MsgVpnAuthenticationOauthProvider | The OAuth Provider object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProviderResponse result = apiInstance.replaceMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnAuthenticationOauthProvider"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProviderName** | **String**| The name of the OAuth Provider. | | -| **body** | [**MsgVpnAuthenticationOauthProvider**](MsgVpnAuthenticationOauthProvider.md)| The OAuth Provider object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProviderResponse**](MsgVpnAuthenticationOauthProviderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Provider object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnAuthorizationGroup - -> MsgVpnAuthorizationGroupResponse replaceMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select) - -Replace an Authorization Group object. - -Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| authorizationGroupName|x||x|||| clientProfileName|||||x|| msgVpnName|x||x|||| orderAfterAuthorizationGroupName||||x||| orderBeforeAuthorizationGroupName||||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String authorizationGroupName = "authorizationGroupName_example"; // String | The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. - MsgVpnAuthorizationGroup body = new MsgVpnAuthorizationGroup(); // MsgVpnAuthorizationGroup | The Authorization Group object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthorizationGroupResponse result = apiInstance.replaceMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnAuthorizationGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **authorizationGroupName** | **String**| The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. | | -| **body** | [**MsgVpnAuthorizationGroup**](MsgVpnAuthorizationGroup.md)| The Authorization Group object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthorizationGroupResponse**](MsgVpnAuthorizationGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Group object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnBridge - -> MsgVpnBridgeResponse replaceMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select) - -Replace a Bridge object. - -Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| maxTtl|||||x|| msgVpnName|x||x|||| remoteAuthenticationBasicClientUsername|||||x|| remoteAuthenticationBasicPassword||||x|x||x remoteAuthenticationClientCertContent||||x|x||x remoteAuthenticationClientCertPassword||||x|x|| remoteAuthenticationScheme|||||x|| remoteDeliverToOnePriority|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - MsgVpnBridge body = new MsgVpnBridge(); // MsgVpnBridge | The Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeResponse result = apiInstance.replaceMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **body** | [**MsgVpnBridge**](MsgVpnBridge.md)| The Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeResponse**](MsgVpnBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Bridge object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnBridgeRemoteMsgVpn - -> MsgVpnBridgeRemoteMsgVpnResponse replaceMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select) - -Replace a Remote Message VPN object. - -Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| clientUsername|||||x|| compressedDataEnabled|||||x|| egressFlowWindowSize|||||x|| msgVpnName|x||x|||| password||||x|x||x remoteMsgVpnInterface|x||x|||| remoteMsgVpnLocation|x||x|||| remoteMsgVpnName|x||x|||| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteMsgVpnName = "remoteMsgVpnName_example"; // String | The name of the remote Message VPN. - String remoteMsgVpnLocation = "remoteMsgVpnLocation_example"; // String | The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). - String remoteMsgVpnInterface = "remoteMsgVpnInterface_example"; // String | The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. - MsgVpnBridgeRemoteMsgVpn body = new MsgVpnBridgeRemoteMsgVpn(); // MsgVpnBridgeRemoteMsgVpn | The Remote Message VPN object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteMsgVpnResponse result = apiInstance.replaceMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnBridgeRemoteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteMsgVpnName** | **String**| The name of the remote Message VPN. | | -| **remoteMsgVpnLocation** | **String**| The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). | | -| **remoteMsgVpnInterface** | **String**| The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. | | -| **body** | [**MsgVpnBridgeRemoteMsgVpn**](MsgVpnBridgeRemoteMsgVpn.md)| The Remote Message VPN object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteMsgVpnResponse**](MsgVpnBridgeRemoteMsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Message VPN object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnCertMatchingRule - -> MsgVpnCertMatchingRuleResponse replaceMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select) - -Replace a Certificate Matching Rule object. - -Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - MsgVpnCertMatchingRule body = new MsgVpnCertMatchingRule(); // MsgVpnCertMatchingRule | The Certificate Matching Rule object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleResponse result = apiInstance.replaceMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**MsgVpnCertMatchingRule**](MsgVpnCertMatchingRule.md)| The Certificate Matching Rule object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleResponse**](MsgVpnCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnCertMatchingRuleAttributeFilter - -> MsgVpnCertMatchingRuleAttributeFilterResponse replaceMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select) - -Replace a Certificate Matching Rule Attribute Filter object. - -Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- filterName|x||x|||| msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - MsgVpnCertMatchingRuleAttributeFilter body = new MsgVpnCertMatchingRuleAttributeFilter(); // MsgVpnCertMatchingRuleAttributeFilter | The Certificate Matching Rule Attribute Filter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleAttributeFilterResponse result = apiInstance.replaceMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | -| **body** | [**MsgVpnCertMatchingRuleAttributeFilter**](MsgVpnCertMatchingRuleAttributeFilter.md)| The Certificate Matching Rule Attribute Filter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleAttributeFilterResponse**](MsgVpnCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnClientProfile - -> MsgVpnClientProfileResponse replaceMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select) - -Replace a Client Profile object. - -Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled||||||x| apiQueueManagementCopyFromOnCreateName||||||x| apiTopicEndpointManagementCopyFromOnCreateName||||||x| clientProfileName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientProfileName = "clientProfileName_example"; // String | The name of the Client Profile. - MsgVpnClientProfile body = new MsgVpnClientProfile(); // MsgVpnClientProfile | The Client Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientProfileResponse result = apiInstance.replaceMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnClientProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientProfileName** | **String**| The name of the Client Profile. | | -| **body** | [**MsgVpnClientProfile**](MsgVpnClientProfile.md)| The Client Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientProfileResponse**](MsgVpnClientProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Profile object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnClientUsername - -> MsgVpnClientUsernameResponse replaceMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select) - -Replace a Client Username object. - -Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| clientProfileName|||||x|| clientUsername|x||x|||| msgVpnName|x||x|||| password||||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - MsgVpnClientUsername body = new MsgVpnClientUsername(); // MsgVpnClientUsername | The Client Username object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameResponse result = apiInstance.replaceMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnClientUsername"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **body** | [**MsgVpnClientUsername**](MsgVpnClientUsername.md)| The Client Username object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameResponse**](MsgVpnClientUsernameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnDistributedCache - -> MsgVpnDistributedCacheResponse replaceMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select) - -Replace a Distributed Cache object. - -Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| cacheVirtualRouter||x||||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - MsgVpnDistributedCache body = new MsgVpnDistributedCache(); // MsgVpnDistributedCache | The Distributed Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheResponse result = apiInstance.replaceMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnDistributedCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **body** | [**MsgVpnDistributedCache**](MsgVpnDistributedCache.md)| The Distributed Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheResponse**](MsgVpnDistributedCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Distributed Cache object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnDistributedCacheCluster - -> MsgVpnDistributedCacheClusterResponse replaceMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select) - -Replace a Cache Cluster object. - -Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - MsgVpnDistributedCacheCluster body = new MsgVpnDistributedCacheCluster(); // MsgVpnDistributedCacheCluster | The Cache Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterResponse result = apiInstance.replaceMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnDistributedCacheCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheCluster**](MsgVpnDistributedCacheCluster.md)| The Cache Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterResponse**](MsgVpnDistributedCacheClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Cluster object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnDistributedCacheClusterInstance - -> MsgVpnDistributedCacheClusterInstanceResponse replaceMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select) - -Replace a Cache Instance object. - -Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| instanceName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String instanceName = "instanceName_example"; // String | The name of the Cache Instance. - MsgVpnDistributedCacheClusterInstance body = new MsgVpnDistributedCacheClusterInstance(); // MsgVpnDistributedCacheClusterInstance | The Cache Instance object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterInstanceResponse result = apiInstance.replaceMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnDistributedCacheClusterInstance"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **instanceName** | **String**| The name of the Cache Instance. | | -| **body** | [**MsgVpnDistributedCacheClusterInstance**](MsgVpnDistributedCacheClusterInstance.md)| The Cache Instance object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterInstanceResponse**](MsgVpnDistributedCacheClusterInstanceResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Instance object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnDmrBridge - -> MsgVpnDmrBridgeResponse replaceMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select) - -Replace a DMR Bridge object. - -Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| remoteNodeName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the DMR Bridge. - MsgVpnDmrBridge body = new MsgVpnDmrBridge(); // MsgVpnDmrBridge | The DMR Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDmrBridgeResponse result = apiInstance.replaceMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnDmrBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the DMR Bridge. | | -| **body** | [**MsgVpnDmrBridge**](MsgVpnDmrBridge.md)| The DMR Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDmrBridgeResponse**](MsgVpnDmrBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The DMR Bridge object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnJndiConnectionFactory - -> MsgVpnJndiConnectionFactoryResponse replaceMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select) - -Replace a JNDI Connection Factory object. - -Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String connectionFactoryName = "connectionFactoryName_example"; // String | The name of the JMS Connection Factory. - MsgVpnJndiConnectionFactory body = new MsgVpnJndiConnectionFactory(); // MsgVpnJndiConnectionFactory | The JNDI Connection Factory object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiConnectionFactoryResponse result = apiInstance.replaceMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnJndiConnectionFactory"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **connectionFactoryName** | **String**| The name of the JMS Connection Factory. | | -| **body** | [**MsgVpnJndiConnectionFactory**](MsgVpnJndiConnectionFactory.md)| The JNDI Connection Factory object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiConnectionFactoryResponse**](MsgVpnJndiConnectionFactoryResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Connection Factory object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnJndiQueue - -> MsgVpnJndiQueueResponse replaceMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select) - -Replace a JNDI Queue object. - -Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The JNDI name of the JMS Queue. - MsgVpnJndiQueue body = new MsgVpnJndiQueue(); // MsgVpnJndiQueue | The JNDI Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiQueueResponse result = apiInstance.replaceMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnJndiQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The JNDI name of the JMS Queue. | | -| **body** | [**MsgVpnJndiQueue**](MsgVpnJndiQueue.md)| The JNDI Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiQueueResponse**](MsgVpnJndiQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Queue object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnJndiTopic - -> MsgVpnJndiTopicResponse replaceMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select) - -Replace a JNDI Topic object. - -Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicName = "topicName_example"; // String | The JNDI name of the JMS Topic. - MsgVpnJndiTopic body = new MsgVpnJndiTopic(); // MsgVpnJndiTopic | The JNDI Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiTopicResponse result = apiInstance.replaceMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnJndiTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicName** | **String**| The JNDI name of the JMS Topic. | | -| **body** | [**MsgVpnJndiTopic**](MsgVpnJndiTopic.md)| The JNDI Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiTopicResponse**](MsgVpnJndiTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Topic object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnMqttRetainCache - -> MsgVpnMqttRetainCacheResponse replaceMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select) - -Replace an MQTT Retain Cache object. - -Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the MQTT Retain Cache. - MsgVpnMqttRetainCache body = new MsgVpnMqttRetainCache(); // MsgVpnMqttRetainCache | The MQTT Retain Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttRetainCacheResponse result = apiInstance.replaceMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnMqttRetainCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the MQTT Retain Cache. | | -| **body** | [**MsgVpnMqttRetainCache**](MsgVpnMqttRetainCache.md)| The MQTT Retain Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttRetainCacheResponse**](MsgVpnMqttRetainCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Retain Cache object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnMqttSession - -> MsgVpnMqttSessionResponse replaceMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select) - -Replace an MQTT Session object. - -Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| owner|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - MsgVpnMqttSession body = new MsgVpnMqttSession(); // MsgVpnMqttSession | The MQTT Session object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionResponse result = apiInstance.replaceMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnMqttSession"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **body** | [**MsgVpnMqttSession**](MsgVpnMqttSession.md)| The MQTT Session object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionResponse**](MsgVpnMqttSessionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Session object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnMqttSessionSubscription - -> MsgVpnMqttSessionSubscriptionResponse replaceMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select) - -Replace a Subscription object. - -Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| subscriptionTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - String subscriptionTopic = "subscriptionTopic_example"; // String | The MQTT subscription topic. - MsgVpnMqttSessionSubscription body = new MsgVpnMqttSessionSubscription(); // MsgVpnMqttSessionSubscription | The Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionSubscriptionResponse result = apiInstance.replaceMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnMqttSessionSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **subscriptionTopic** | **String**| The MQTT subscription topic. | | -| **body** | [**MsgVpnMqttSessionSubscription**](MsgVpnMqttSessionSubscription.md)| The Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionSubscriptionResponse**](MsgVpnMqttSessionSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscription object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnQueue - -> MsgVpnQueueResponse replaceMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select) - -Replace a Queue object. - -Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| queueName|x||x|||| respectMsgPriorityEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - MsgVpnQueue body = new MsgVpnQueue(); // MsgVpnQueue | The Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueResponse result = apiInstance.replaceMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **body** | [**MsgVpnQueue**](MsgVpnQueue.md)| The Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueResponse**](MsgVpnQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnQueueTemplate - -> MsgVpnQueueTemplateResponse replaceMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select) - -Replace a Queue Template object. - -Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueTemplateName = "queueTemplateName_example"; // String | The name of the Queue Template. - MsgVpnQueueTemplate body = new MsgVpnQueueTemplate(); // MsgVpnQueueTemplate | The Queue Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueTemplateResponse result = apiInstance.replaceMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnQueueTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueTemplateName** | **String**| The name of the Queue Template. | | -| **body** | [**MsgVpnQueueTemplate**](MsgVpnQueueTemplate.md)| The Queue Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueTemplateResponse**](MsgVpnQueueTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Template object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnReplayLog - -> MsgVpnReplayLogResponse replaceMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select) - -Replace a Replay Log object. - -Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replayLogName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - MsgVpnReplayLog body = new MsgVpnReplayLog(); // MsgVpnReplayLog | The Replay Log object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogResponse result = apiInstance.replaceMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnReplayLog"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **body** | [**MsgVpnReplayLog**](MsgVpnReplayLog.md)| The Replay Log object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogResponse**](MsgVpnReplayLogResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replay Log object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnReplicatedTopic - -> MsgVpnReplicatedTopicResponse replaceMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select) - -Replace a Replicated Topic object. - -Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replicatedTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replicatedTopic = "replicatedTopic_example"; // String | The topic for applying replication. Published messages matching this topic will be replicated to the standby site. - MsgVpnReplicatedTopic body = new MsgVpnReplicatedTopic(); // MsgVpnReplicatedTopic | The Replicated Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplicatedTopicResponse result = apiInstance.replaceMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnReplicatedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replicatedTopic** | **String**| The topic for applying replication. Published messages matching this topic will be replicated to the standby site. | | -| **body** | [**MsgVpnReplicatedTopic**](MsgVpnReplicatedTopic.md)| The Replicated Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplicatedTopicResponse**](MsgVpnReplicatedTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replicated Topic object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnRestDeliveryPoint - -> MsgVpnRestDeliveryPointResponse replaceMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select) - -Replace a REST Delivery Point object. - -Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientProfileName|||||x|| msgVpnName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - MsgVpnRestDeliveryPoint body = new MsgVpnRestDeliveryPoint(); // MsgVpnRestDeliveryPoint | The REST Delivery Point object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointResponse result = apiInstance.replaceMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnRestDeliveryPoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **body** | [**MsgVpnRestDeliveryPoint**](MsgVpnRestDeliveryPoint.md)| The REST Delivery Point object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointResponse**](MsgVpnRestDeliveryPointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Delivery Point object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnRestDeliveryPointQueueBinding - -> MsgVpnRestDeliveryPointQueueBindingResponse replaceMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select) - -Replace a Queue Binding object. - -Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - MsgVpnRestDeliveryPointQueueBinding body = new MsgVpnRestDeliveryPointQueueBinding(); // MsgVpnRestDeliveryPointQueueBinding | The Queue Binding object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingResponse result = apiInstance.replaceMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnRestDeliveryPointQueueBinding"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBinding**](MsgVpnRestDeliveryPointQueueBinding.md)| The Queue Binding object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingResponse**](MsgVpnRestDeliveryPointQueueBindingResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Binding object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader - -> MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select) - -Replace a Request Header object. - -Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A request header to be added to the HTTP request. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- headerName|x||x|||| msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - String headerName = "headerName_example"; // String | The name of the HTTP request header. - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = new MsgVpnRestDeliveryPointQueueBindingRequestHeader(); // MsgVpnRestDeliveryPointQueueBindingRequestHeader | The Request Header object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse result = apiInstance.replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **headerName** | **String**| The name of the HTTP request header. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBindingRequestHeader**](MsgVpnRestDeliveryPointQueueBindingRequestHeader.md)| The Request Header object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse**](MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Request Header object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnRestDeliveryPointRestConsumer - -> MsgVpnRestDeliveryPointRestConsumerResponse replaceMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select) - -Replace a REST Consumer object. - -Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey||||x|||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| authenticationHttpBasicPassword||||x|x||x authenticationHttpBasicUsername|||||x|| authenticationHttpHeaderValue||||x|||x authenticationOauthClientId|||||x|| authenticationOauthClientScope|||||x|| authenticationOauthClientSecret||||x|x||x authenticationOauthClientTokenEndpoint|||||x|| authenticationOauthJwtSecretKey||||x|x||x authenticationOauthJwtTokenEndpoint|||||x|| authenticationScheme|||||x|| msgVpnName|x||x|||| outgoingConnectionCount|||||x|| remoteHost|||||x|| remotePort|||||x|| restConsumerName|x||x|||| restDeliveryPointName|x||x|||| tlsCipherSuiteList|||||x|| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - MsgVpnRestDeliveryPointRestConsumer body = new MsgVpnRestDeliveryPointRestConsumer(); // MsgVpnRestDeliveryPointRestConsumer | The REST Consumer object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerResponse result = apiInstance.replaceMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnRestDeliveryPointRestConsumer"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **body** | [**MsgVpnRestDeliveryPointRestConsumer**](MsgVpnRestDeliveryPointRestConsumer.md)| The REST Consumer object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerResponse**](MsgVpnRestDeliveryPointRestConsumerResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Consumer object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnTopicEndpoint - -> MsgVpnTopicEndpointResponse replaceMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select) - -Replace a Topic Endpoint object. - -Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| respectMsgPriorityEnabled|||||x|| topicEndpointName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointName = "topicEndpointName_example"; // String | The name of the Topic Endpoint. - MsgVpnTopicEndpoint body = new MsgVpnTopicEndpoint(); // MsgVpnTopicEndpoint | The Topic Endpoint object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointResponse result = apiInstance.replaceMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnTopicEndpoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointName** | **String**| The name of the Topic Endpoint. | | -| **body** | [**MsgVpnTopicEndpoint**](MsgVpnTopicEndpoint.md)| The Topic Endpoint object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointResponse**](MsgVpnTopicEndpointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnTopicEndpointTemplate - -> MsgVpnTopicEndpointTemplateResponse replaceMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select) - -Replace a Topic Endpoint Template object. - -Replace a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicEndpointTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointTemplateName = "topicEndpointTemplateName_example"; // String | The name of the Topic Endpoint Template. - MsgVpnTopicEndpointTemplate body = new MsgVpnTopicEndpointTemplate(); // MsgVpnTopicEndpointTemplate | The Topic Endpoint Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointTemplateResponse result = apiInstance.replaceMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#replaceMsgVpnTopicEndpointTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointTemplateName** | **String**| The name of the Topic Endpoint Template. | | -| **body** | [**MsgVpnTopicEndpointTemplate**](MsgVpnTopicEndpointTemplate.md)| The Topic Endpoint Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointTemplateResponse**](MsgVpnTopicEndpointTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint Template object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpn - -> MsgVpnResponse updateMsgVpn(msgVpnName, body, opaquePassword, select) - -Update a Message VPN object. - -Update a Message VPN object. Any attribute missing from the request will be left unchanged. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationOauthDefaultProviderName|||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| distributedCacheManagementEnabled|||||x| msgVpnName|x|x|||| replicationBridgeAuthenticationBasicPassword|||x|||x replicationBridgeAuthenticationClientCertContent|||x|||x replicationBridgeAuthenticationClientCertPassword|||x||| replicationEnabledQueueBehavior|||x||| restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: alias|global/read-write authenticationBasicEnabled|global/read-write authenticationBasicProfileName|global/read-write authenticationBasicRadiusDomain|global/read-write authenticationBasicType|global/read-write authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write authenticationClientCertCertificateMatchingRulesEnabled|global/read-write authenticationClientCertEnabled|global/read-write authenticationClientCertMaxChainDepth|global/read-write authenticationClientCertRevocationCheckMode|global/read-write authenticationClientCertUsernameSource|global/read-write authenticationClientCertValidateDateEnabled|global/read-write authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write authenticationKerberosEnabled|global/read-write authenticationOauthEnabled|global/read-write bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write bridgingTlsServerCertMaxChainDepth|global/read-write bridgingTlsServerCertValidateDateEnabled|global/read-write bridgingTlsServerCertValidateNameEnabled|global/read-write dmrEnabled|global/read-write exportSubscriptionsEnabled|global/read-write maxConnectionCount|global/read-write maxEgressFlowCount|global/read-write maxEndpointCount|global/read-write maxIngressFlowCount|global/read-write maxMsgSpoolUsage|global/read-write maxSubscriptionCount|global/read-write maxTransactedSessionCount|global/read-write maxTransactionCount|global/read-write mqttRetainMaxMemory|global/read-write replicationBridgeAuthenticationBasicClientUsername|global/read-write replicationBridgeAuthenticationBasicPassword|global/read-write replicationBridgeAuthenticationClientCertContent|global/read-write replicationBridgeAuthenticationClientCertPassword|global/read-write replicationBridgeAuthenticationScheme|global/read-write replicationBridgeCompressedDataEnabled|global/read-write replicationBridgeEgressFlowWindowSize|global/read-write replicationBridgeRetryDelay|global/read-write replicationBridgeTlsEnabled|global/read-write replicationBridgeUnidirectionalClientProfileName|global/read-write replicationEnabled|global/read-write replicationEnabledQueueBehavior|global/read-write replicationQueueMaxMsgSpoolUsage|global/read-write replicationRole|global/read-write restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write restTlsServerCertMaxChainDepth|global/read-write restTlsServerCertValidateDateEnabled|global/read-write restTlsServerCertValidateNameEnabled|global/read-write sempOverMsgBusAdminClientEnabled|global/read-write sempOverMsgBusAdminDistributedCacheEnabled|global/read-write sempOverMsgBusAdminEnabled|global/read-write sempOverMsgBusEnabled|global/read-write sempOverMsgBusShowEnabled|global/read-write serviceAmqpMaxConnectionCount|global/read-write serviceAmqpPlainTextListenPort|global/read-write serviceAmqpTlsListenPort|global/read-write serviceMqttMaxConnectionCount|global/read-write serviceMqttPlainTextListenPort|global/read-write serviceMqttTlsListenPort|global/read-write serviceMqttTlsWebSocketListenPort|global/read-write serviceMqttWebSocketListenPort|global/read-write serviceRestIncomingMaxConnectionCount|global/read-write serviceRestIncomingPlainTextListenPort|global/read-write serviceRestIncomingTlsListenPort|global/read-write serviceRestOutgoingMaxConnectionCount|global/read-write serviceSmfMaxConnectionCount|global/read-write serviceWebMaxConnectionCount|global/read-write This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpn body = new MsgVpn(); // MsgVpn | The Message VPN object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnResponse result = apiInstance.updateMsgVpn(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpn**](MsgVpn.md)| The Message VPN object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnResponse**](MsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnAclProfile - -> MsgVpnAclProfileResponse updateMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select) - -Update an ACL Profile object. - -Update an ACL Profile object. Any attribute missing from the request will be left unchanged. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String aclProfileName = "aclProfileName_example"; // String | The name of the ACL Profile. - MsgVpnAclProfile body = new MsgVpnAclProfile(); // MsgVpnAclProfile | The ACL Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAclProfileResponse result = apiInstance.updateMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnAclProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **aclProfileName** | **String**| The name of the ACL Profile. | | -| **body** | [**MsgVpnAclProfile**](MsgVpnAclProfile.md)| The ACL Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAclProfileResponse**](MsgVpnAclProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The ACL Profile object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnAuthenticationOauthProfile - -> MsgVpnAuthenticationOauthProfileResponse updateMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select) - -Update an OAuth Profile object. - -Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - MsgVpnAuthenticationOauthProfile body = new MsgVpnAuthenticationOauthProfile(); // MsgVpnAuthenticationOauthProfile | The OAuth Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProfileResponse result = apiInstance.updateMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnAuthenticationOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**MsgVpnAuthenticationOauthProfile**](MsgVpnAuthenticationOauthProfile.md)| The OAuth Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProfileResponse**](MsgVpnAuthenticationOauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnAuthenticationOauthProvider - -> MsgVpnAuthenticationOauthProviderResponse updateMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select) - -Update an OAuth Provider object. - -Update an OAuth Provider object. Any attribute missing from the request will be left unchanged. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x|x|||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword|||x||x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String oauthProviderName = "oauthProviderName_example"; // String | The name of the OAuth Provider. - MsgVpnAuthenticationOauthProvider body = new MsgVpnAuthenticationOauthProvider(); // MsgVpnAuthenticationOauthProvider | The OAuth Provider object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthenticationOauthProviderResponse result = apiInstance.updateMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnAuthenticationOauthProvider"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **oauthProviderName** | **String**| The name of the OAuth Provider. | | -| **body** | [**MsgVpnAuthenticationOauthProvider**](MsgVpnAuthenticationOauthProvider.md)| The OAuth Provider object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthenticationOauthProviderResponse**](MsgVpnAuthenticationOauthProviderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Provider object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnAuthorizationGroup - -> MsgVpnAuthorizationGroupResponse updateMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select) - -Update an Authorization Group object. - -Update an Authorization Group object. Any attribute missing from the request will be left unchanged. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| authorizationGroupName|x|x|||| clientProfileName||||x|| msgVpnName|x|x|||| orderAfterAuthorizationGroupName|||x||| orderBeforeAuthorizationGroupName|||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String authorizationGroupName = "authorizationGroupName_example"; // String | The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. - MsgVpnAuthorizationGroup body = new MsgVpnAuthorizationGroup(); // MsgVpnAuthorizationGroup | The Authorization Group object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnAuthorizationGroupResponse result = apiInstance.updateMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnAuthorizationGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **authorizationGroupName** | **String**| The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. | | -| **body** | [**MsgVpnAuthorizationGroup**](MsgVpnAuthorizationGroup.md)| The Authorization Group object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnAuthorizationGroupResponse**](MsgVpnAuthorizationGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Group object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnBridge - -> MsgVpnBridgeResponse updateMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select) - -Update a Bridge object. - -Update a Bridge object. Any attribute missing from the request will be left unchanged. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| maxTtl||||x|| msgVpnName|x|x|||| remoteAuthenticationBasicClientUsername||||x|| remoteAuthenticationBasicPassword|||x|x||x remoteAuthenticationClientCertContent|||x|x||x remoteAuthenticationClientCertPassword|||x|x|| remoteAuthenticationScheme||||x|| remoteDeliverToOnePriority||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - MsgVpnBridge body = new MsgVpnBridge(); // MsgVpnBridge | The Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeResponse result = apiInstance.updateMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **body** | [**MsgVpnBridge**](MsgVpnBridge.md)| The Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeResponse**](MsgVpnBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Bridge object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnBridgeRemoteMsgVpn - -> MsgVpnBridgeRemoteMsgVpnResponse updateMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select) - -Update a Remote Message VPN object. - -Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| clientUsername||||x|| compressedDataEnabled||||x|| egressFlowWindowSize||||x|| msgVpnName|x|x|||| password|||x|x||x remoteMsgVpnInterface|x|x|||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String bridgeName = "bridgeName_example"; // String | The name of the Bridge. - String bridgeVirtualRouter = "bridgeVirtualRouter_example"; // String | The virtual router of the Bridge. - String remoteMsgVpnName = "remoteMsgVpnName_example"; // String | The name of the remote Message VPN. - String remoteMsgVpnLocation = "remoteMsgVpnLocation_example"; // String | The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). - String remoteMsgVpnInterface = "remoteMsgVpnInterface_example"; // String | The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. - MsgVpnBridgeRemoteMsgVpn body = new MsgVpnBridgeRemoteMsgVpn(); // MsgVpnBridgeRemoteMsgVpn | The Remote Message VPN object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnBridgeRemoteMsgVpnResponse result = apiInstance.updateMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnBridgeRemoteMsgVpn"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **bridgeName** | **String**| The name of the Bridge. | | -| **bridgeVirtualRouter** | **String**| The virtual router of the Bridge. | | -| **remoteMsgVpnName** | **String**| The name of the remote Message VPN. | | -| **remoteMsgVpnLocation** | **String**| The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). | | -| **remoteMsgVpnInterface** | **String**| The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. | | -| **body** | [**MsgVpnBridgeRemoteMsgVpn**](MsgVpnBridgeRemoteMsgVpn.md)| The Remote Message VPN object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnBridgeRemoteMsgVpnResponse**](MsgVpnBridgeRemoteMsgVpnResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Remote Message VPN object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnCertMatchingRule - -> MsgVpnCertMatchingRuleResponse updateMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select) - -Update a Certificate Matching Rule object. - -Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - MsgVpnCertMatchingRule body = new MsgVpnCertMatchingRule(); // MsgVpnCertMatchingRule | The Certificate Matching Rule object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleResponse result = apiInstance.updateMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnCertMatchingRule"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **body** | [**MsgVpnCertMatchingRule**](MsgVpnCertMatchingRule.md)| The Certificate Matching Rule object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleResponse**](MsgVpnCertMatchingRuleResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnCertMatchingRuleAttributeFilter - -> MsgVpnCertMatchingRuleAttributeFilterResponse updateMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select) - -Update a Certificate Matching Rule Attribute Filter object. - -Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- filterName|x|x|||| msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String ruleName = "ruleName_example"; // String | The name of the rule. - String filterName = "filterName_example"; // String | The name of the filter. - MsgVpnCertMatchingRuleAttributeFilter body = new MsgVpnCertMatchingRuleAttributeFilter(); // MsgVpnCertMatchingRuleAttributeFilter | The Certificate Matching Rule Attribute Filter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnCertMatchingRuleAttributeFilterResponse result = apiInstance.updateMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnCertMatchingRuleAttributeFilter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **ruleName** | **String**| The name of the rule. | | -| **filterName** | **String**| The name of the filter. | | -| **body** | [**MsgVpnCertMatchingRuleAttributeFilter**](MsgVpnCertMatchingRuleAttributeFilter.md)| The Certificate Matching Rule Attribute Filter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnCertMatchingRuleAttributeFilterResponse**](MsgVpnCertMatchingRuleAttributeFilterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnClientProfile - -> MsgVpnClientProfileResponse updateMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select) - -Update a Client Profile object. - -Update a Client Profile object. Any attribute missing from the request will be left unchanged. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientProfileName = "clientProfileName_example"; // String | The name of the Client Profile. - MsgVpnClientProfile body = new MsgVpnClientProfile(); // MsgVpnClientProfile | The Client Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientProfileResponse result = apiInstance.updateMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnClientProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientProfileName** | **String**| The name of the Client Profile. | | -| **body** | [**MsgVpnClientProfile**](MsgVpnClientProfile.md)| The Client Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientProfileResponse**](MsgVpnClientProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Profile object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnClientUsername - -> MsgVpnClientUsernameResponse updateMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select) - -Update a Client Username object. - -Update a Client Username object. Any attribute missing from the request will be left unchanged. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| clientProfileName||||x|| clientUsername|x|x|||| msgVpnName|x|x|||| password|||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String clientUsername = "clientUsername_example"; // String | The name of the Client Username. - MsgVpnClientUsername body = new MsgVpnClientUsername(); // MsgVpnClientUsername | The Client Username object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnClientUsernameResponse result = apiInstance.updateMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnClientUsername"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **clientUsername** | **String**| The name of the Client Username. | | -| **body** | [**MsgVpnClientUsername**](MsgVpnClientUsername.md)| The Client Username object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnClientUsernameResponse**](MsgVpnClientUsernameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Client Username object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnDistributedCache - -> MsgVpnDistributedCacheResponse updateMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select) - -Update a Distributed Cache object. - -Update a Distributed Cache object. Any attribute missing from the request will be left unchanged. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| cacheVirtualRouter||x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - MsgVpnDistributedCache body = new MsgVpnDistributedCache(); // MsgVpnDistributedCache | The Distributed Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheResponse result = apiInstance.updateMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnDistributedCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **body** | [**MsgVpnDistributedCache**](MsgVpnDistributedCache.md)| The Distributed Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheResponse**](MsgVpnDistributedCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Distributed Cache object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnDistributedCacheCluster - -> MsgVpnDistributedCacheClusterResponse updateMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select) - -Update a Cache Cluster object. - -Update a Cache Cluster object. Any attribute missing from the request will be left unchanged. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - MsgVpnDistributedCacheCluster body = new MsgVpnDistributedCacheCluster(); // MsgVpnDistributedCacheCluster | The Cache Cluster object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterResponse result = apiInstance.updateMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnDistributedCacheCluster"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **body** | [**MsgVpnDistributedCacheCluster**](MsgVpnDistributedCacheCluster.md)| The Cache Cluster object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterResponse**](MsgVpnDistributedCacheClusterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Cluster object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnDistributedCacheClusterInstance - -> MsgVpnDistributedCacheClusterInstanceResponse updateMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select) - -Update a Cache Instance object. - -Update a Cache Instance object. Any attribute missing from the request will be left unchanged. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| instanceName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the Distributed Cache. - String clusterName = "clusterName_example"; // String | The name of the Cache Cluster. - String instanceName = "instanceName_example"; // String | The name of the Cache Instance. - MsgVpnDistributedCacheClusterInstance body = new MsgVpnDistributedCacheClusterInstance(); // MsgVpnDistributedCacheClusterInstance | The Cache Instance object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDistributedCacheClusterInstanceResponse result = apiInstance.updateMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnDistributedCacheClusterInstance"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the Distributed Cache. | | -| **clusterName** | **String**| The name of the Cache Cluster. | | -| **instanceName** | **String**| The name of the Cache Instance. | | -| **body** | [**MsgVpnDistributedCacheClusterInstance**](MsgVpnDistributedCacheClusterInstance.md)| The Cache Instance object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDistributedCacheClusterInstanceResponse**](MsgVpnDistributedCacheClusterInstanceResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Cache Instance object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnDmrBridge - -> MsgVpnDmrBridgeResponse updateMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select) - -Update a DMR Bridge object. - -Update a DMR Bridge object. Any attribute missing from the request will be left unchanged. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String remoteNodeName = "remoteNodeName_example"; // String | The name of the node at the remote end of the DMR Bridge. - MsgVpnDmrBridge body = new MsgVpnDmrBridge(); // MsgVpnDmrBridge | The DMR Bridge object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnDmrBridgeResponse result = apiInstance.updateMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnDmrBridge"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **remoteNodeName** | **String**| The name of the node at the remote end of the DMR Bridge. | | -| **body** | [**MsgVpnDmrBridge**](MsgVpnDmrBridge.md)| The DMR Bridge object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnDmrBridgeResponse**](MsgVpnDmrBridgeResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The DMR Bridge object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnJndiConnectionFactory - -> MsgVpnJndiConnectionFactoryResponse updateMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select) - -Update a JNDI Connection Factory object. - -Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String connectionFactoryName = "connectionFactoryName_example"; // String | The name of the JMS Connection Factory. - MsgVpnJndiConnectionFactory body = new MsgVpnJndiConnectionFactory(); // MsgVpnJndiConnectionFactory | The JNDI Connection Factory object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiConnectionFactoryResponse result = apiInstance.updateMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnJndiConnectionFactory"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **connectionFactoryName** | **String**| The name of the JMS Connection Factory. | | -| **body** | [**MsgVpnJndiConnectionFactory**](MsgVpnJndiConnectionFactory.md)| The JNDI Connection Factory object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiConnectionFactoryResponse**](MsgVpnJndiConnectionFactoryResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Connection Factory object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnJndiQueue - -> MsgVpnJndiQueueResponse updateMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select) - -Update a JNDI Queue object. - -Update a JNDI Queue object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The JNDI name of the JMS Queue. - MsgVpnJndiQueue body = new MsgVpnJndiQueue(); // MsgVpnJndiQueue | The JNDI Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiQueueResponse result = apiInstance.updateMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnJndiQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The JNDI name of the JMS Queue. | | -| **body** | [**MsgVpnJndiQueue**](MsgVpnJndiQueue.md)| The JNDI Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiQueueResponse**](MsgVpnJndiQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Queue object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnJndiTopic - -> MsgVpnJndiTopicResponse updateMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select) - -Update a JNDI Topic object. - -Update a JNDI Topic object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicName = "topicName_example"; // String | The JNDI name of the JMS Topic. - MsgVpnJndiTopic body = new MsgVpnJndiTopic(); // MsgVpnJndiTopic | The JNDI Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnJndiTopicResponse result = apiInstance.updateMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnJndiTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicName** | **String**| The JNDI name of the JMS Topic. | | -| **body** | [**MsgVpnJndiTopic**](MsgVpnJndiTopic.md)| The JNDI Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnJndiTopicResponse**](MsgVpnJndiTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The JNDI Topic object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnMqttRetainCache - -> MsgVpnMqttRetainCacheResponse updateMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select) - -Update an MQTT Retain Cache object. - -Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String cacheName = "cacheName_example"; // String | The name of the MQTT Retain Cache. - MsgVpnMqttRetainCache body = new MsgVpnMqttRetainCache(); // MsgVpnMqttRetainCache | The MQTT Retain Cache object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttRetainCacheResponse result = apiInstance.updateMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnMqttRetainCache"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **cacheName** | **String**| The name of the MQTT Retain Cache. | | -| **body** | [**MsgVpnMqttRetainCache**](MsgVpnMqttRetainCache.md)| The MQTT Retain Cache object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttRetainCacheResponse**](MsgVpnMqttRetainCacheResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Retain Cache object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnMqttSession - -> MsgVpnMqttSessionResponse updateMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select) - -Update an MQTT Session object. - -Update an MQTT Session object. Any attribute missing from the request will be left unchanged. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| owner||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - MsgVpnMqttSession body = new MsgVpnMqttSession(); // MsgVpnMqttSession | The MQTT Session object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionResponse result = apiInstance.updateMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnMqttSession"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **body** | [**MsgVpnMqttSession**](MsgVpnMqttSession.md)| The MQTT Session object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionResponse**](MsgVpnMqttSessionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The MQTT Session object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnMqttSessionSubscription - -> MsgVpnMqttSessionSubscriptionResponse updateMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select) - -Update a Subscription object. - -Update a Subscription object. Any attribute missing from the request will be left unchanged. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String mqttSessionClientId = "mqttSessionClientId_example"; // String | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - String mqttSessionVirtualRouter = "mqttSessionVirtualRouter_example"; // String | The virtual router of the MQTT Session. - String subscriptionTopic = "subscriptionTopic_example"; // String | The MQTT subscription topic. - MsgVpnMqttSessionSubscription body = new MsgVpnMqttSessionSubscription(); // MsgVpnMqttSessionSubscription | The Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnMqttSessionSubscriptionResponse result = apiInstance.updateMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnMqttSessionSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **mqttSessionClientId** | **String**| The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | | -| **mqttSessionVirtualRouter** | **String**| The virtual router of the MQTT Session. | | -| **subscriptionTopic** | **String**| The MQTT subscription topic. | | -| **body** | [**MsgVpnMqttSessionSubscription**](MsgVpnMqttSessionSubscription.md)| The Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnMqttSessionSubscriptionResponse**](MsgVpnMqttSessionSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Subscription object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnQueue - -> MsgVpnQueueResponse updateMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select) - -Update a Queue object. - -Update a Queue object. Any attribute missing from the request will be left unchanged. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| queueName|x|x|||| respectMsgPriorityEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - MsgVpnQueue body = new MsgVpnQueue(); // MsgVpnQueue | The Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueResponse result = apiInstance.updateMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **body** | [**MsgVpnQueue**](MsgVpnQueue.md)| The Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueResponse**](MsgVpnQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnQueueTemplate - -> MsgVpnQueueTemplateResponse updateMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select) - -Update a Queue Template object. - -Update a Queue Template object. Any attribute missing from the request will be left unchanged. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueTemplateName = "queueTemplateName_example"; // String | The name of the Queue Template. - MsgVpnQueueTemplate body = new MsgVpnQueueTemplate(); // MsgVpnQueueTemplate | The Queue Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueTemplateResponse result = apiInstance.updateMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnQueueTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueTemplateName** | **String**| The name of the Queue Template. | | -| **body** | [**MsgVpnQueueTemplate**](MsgVpnQueueTemplate.md)| The Queue Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueTemplateResponse**](MsgVpnQueueTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Template object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnReplayLog - -> MsgVpnReplayLogResponse updateMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select) - -Update a Replay Log object. - -Update a Replay Log object. Any attribute missing from the request will be left unchanged. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - MsgVpnReplayLog body = new MsgVpnReplayLog(); // MsgVpnReplayLog | The Replay Log object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogResponse result = apiInstance.updateMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnReplayLog"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **body** | [**MsgVpnReplayLog**](MsgVpnReplayLog.md)| The Replay Log object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogResponse**](MsgVpnReplayLogResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replay Log object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnReplicatedTopic - -> MsgVpnReplicatedTopicResponse updateMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select) - -Update a Replicated Topic object. - -Update a Replicated Topic object. Any attribute missing from the request will be left unchanged. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replicatedTopic = "replicatedTopic_example"; // String | The topic for applying replication. Published messages matching this topic will be replicated to the standby site. - MsgVpnReplicatedTopic body = new MsgVpnReplicatedTopic(); // MsgVpnReplicatedTopic | The Replicated Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplicatedTopicResponse result = apiInstance.updateMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnReplicatedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replicatedTopic** | **String**| The topic for applying replication. Published messages matching this topic will be replicated to the standby site. | | -| **body** | [**MsgVpnReplicatedTopic**](MsgVpnReplicatedTopic.md)| The Replicated Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplicatedTopicResponse**](MsgVpnReplicatedTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replicated Topic object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnRestDeliveryPoint - -> MsgVpnRestDeliveryPointResponse updateMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select) - -Update a REST Delivery Point object. - -Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientProfileName||||x|| msgVpnName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - MsgVpnRestDeliveryPoint body = new MsgVpnRestDeliveryPoint(); // MsgVpnRestDeliveryPoint | The REST Delivery Point object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointResponse result = apiInstance.updateMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnRestDeliveryPoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **body** | [**MsgVpnRestDeliveryPoint**](MsgVpnRestDeliveryPoint.md)| The REST Delivery Point object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointResponse**](MsgVpnRestDeliveryPointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Delivery Point object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnRestDeliveryPointQueueBinding - -> MsgVpnRestDeliveryPointQueueBindingResponse updateMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select) - -Update a Queue Binding object. - -Update a Queue Binding object. Any attribute missing from the request will be left unchanged. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - MsgVpnRestDeliveryPointQueueBinding body = new MsgVpnRestDeliveryPointQueueBinding(); // MsgVpnRestDeliveryPointQueueBinding | The Queue Binding object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingResponse result = apiInstance.updateMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnRestDeliveryPointQueueBinding"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBinding**](MsgVpnRestDeliveryPointQueueBinding.md)| The Queue Binding object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingResponse**](MsgVpnRestDeliveryPointQueueBindingResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Binding object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnRestDeliveryPointQueueBindingRequestHeader - -> MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse updateMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select) - -Update a Request Header object. - -Update a Request Header object. Any attribute missing from the request will be left unchanged. A request header to be added to the HTTP request. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- headerName|x|x|||| msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - String headerName = "headerName_example"; // String | The name of the HTTP request header. - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = new MsgVpnRestDeliveryPointQueueBindingRequestHeader(); // MsgVpnRestDeliveryPointQueueBindingRequestHeader | The Request Header object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse result = apiInstance.updateMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **headerName** | **String**| The name of the HTTP request header. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBindingRequestHeader**](MsgVpnRestDeliveryPointQueueBindingRequestHeader.md)| The Request Header object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse**](MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Request Header object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnRestDeliveryPointRestConsumer - -> MsgVpnRestDeliveryPointRestConsumerResponse updateMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select) - -Update a REST Consumer object. - -Update a REST Consumer object. Any attribute missing from the request will be left unchanged. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey|||x|||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| authenticationHttpBasicPassword|||x|x||x authenticationHttpBasicUsername||||x|| authenticationHttpHeaderValue|||x|||x authenticationOauthClientId||||x|| authenticationOauthClientScope||||x|| authenticationOauthClientSecret|||x|x||x authenticationOauthClientTokenEndpoint||||x|| authenticationOauthJwtSecretKey|||x|x||x authenticationOauthJwtTokenEndpoint||||x|| authenticationScheme||||x|| msgVpnName|x|x|||| outgoingConnectionCount||||x|| remoteHost||||x|| remotePort||||x|| restConsumerName|x|x|||| restDeliveryPointName|x|x|||| tlsCipherSuiteList||||x|| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - MsgVpnRestDeliveryPointRestConsumer body = new MsgVpnRestDeliveryPointRestConsumer(); // MsgVpnRestDeliveryPointRestConsumer | The REST Consumer object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerResponse result = apiInstance.updateMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnRestDeliveryPointRestConsumer"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **body** | [**MsgVpnRestDeliveryPointRestConsumer**](MsgVpnRestDeliveryPointRestConsumer.md)| The REST Consumer object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerResponse**](MsgVpnRestDeliveryPointRestConsumerResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Consumer object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnTopicEndpoint - -> MsgVpnTopicEndpointResponse updateMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select) - -Update a Topic Endpoint object. - -Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| respectMsgPriorityEnabled||||x|| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointName = "topicEndpointName_example"; // String | The name of the Topic Endpoint. - MsgVpnTopicEndpoint body = new MsgVpnTopicEndpoint(); // MsgVpnTopicEndpoint | The Topic Endpoint object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointResponse result = apiInstance.updateMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnTopicEndpoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointName** | **String**| The name of the Topic Endpoint. | | -| **body** | [**MsgVpnTopicEndpoint**](MsgVpnTopicEndpoint.md)| The Topic Endpoint object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointResponse**](MsgVpnTopicEndpointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnTopicEndpointTemplate - -> MsgVpnTopicEndpointTemplateResponse updateMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select) - -Update a Topic Endpoint Template object. - -Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.MsgVpnApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - MsgVpnApi apiInstance = new MsgVpnApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointTemplateName = "topicEndpointTemplateName_example"; // String | The name of the Topic Endpoint Template. - MsgVpnTopicEndpointTemplate body = new MsgVpnTopicEndpointTemplate(); // MsgVpnTopicEndpointTemplate | The Topic Endpoint Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointTemplateResponse result = apiInstance.updateMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling MsgVpnApi#updateMsgVpnTopicEndpointTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointTemplateName** | **String**| The name of the Topic Endpoint Template. | | -| **body** | [**MsgVpnTopicEndpointTemplate**](MsgVpnTopicEndpointTemplate.md)| The Topic Endpoint Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointTemplateResponse**](MsgVpnTopicEndpointTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint Template object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfile.md b/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfile.md deleted file mode 100644 index c55f3748e..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfile.md +++ /dev/null @@ -1,51 +0,0 @@ - - -# MsgVpnAuthenticationOauthProfile - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**authorizationGroupsClaimName** | **String** | The name of the groups claim. If non-empty, the specified claim will be used to determine groups for authorization. If empty, the authorizationType attribute of the Message VPN will be used to determine authorization. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"groups\"`. | [optional] | -|**clientId** | **String** | The OAuth client id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**clientRequiredType** | **String** | The required value for the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"JWT\"`. | [optional] | -|**clientSecret** | **String** | The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**clientValidateTypeEnabled** | **Boolean** | Enable or disable verification of the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**disconnectOnTokenExpirationEnabled** | **Boolean** | Enable or disable the disconnection of clients when their tokens expire. Changing this value does not affect existing clients, only new client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**enabled** | **Boolean** | Enable or disable the OAuth profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**endpointDiscovery** | **String** | The OpenID Connect discovery endpoint or OAuth Authorization Server Metadata endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**endpointDiscoveryRefreshInterval** | **Integer** | The number of seconds between discovery endpoint requests. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `86400`. | [optional] | -|**endpointIntrospection** | **String** | The OAuth introspection endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**endpointIntrospectionTimeout** | **Integer** | The maximum time in seconds a token introspection request is allowed to take. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. | [optional] | -|**endpointJwks** | **String** | The OAuth JWKS endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**endpointJwksRefreshInterval** | **Integer** | The number of seconds between JWKS endpoint requests. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `86400`. | [optional] | -|**endpointUserinfo** | **String** | The OpenID Connect Userinfo endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**endpointUserinfoTimeout** | **Integer** | The maximum time in seconds a userinfo request is allowed to take. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. | [optional] | -|**issuer** | **String** | The Issuer Identifier for the OAuth provider. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**mqttUsernameValidateEnabled** | **Boolean** | Enable or disable whether the API provided MQTT client username will be validated against the username calculated from the token(s). When enabled, connection attempts by MQTT clients are rejected if they differ. Note that this value only applies to MQTT clients; SMF client usernames will not be validated. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**oauthProfileName** | **String** | The name of the OAuth profile. | [optional] | -|**oauthRole** | [**OauthRoleEnum**](#OauthRoleEnum) | The OAuth role of the broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"client\"`. The allowed values and their meaning are: <pre> \"client\" - The broker is in the OAuth client role. \"resource-server\" - The broker is in the OAuth resource server role. </pre> | [optional] | -|**resourceServerParseAccessTokenEnabled** | **Boolean** | Enable or disable parsing of the access token as a JWT. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**resourceServerRequiredAudience** | **String** | The required audience value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**resourceServerRequiredIssuer** | **String** | The required issuer value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**resourceServerRequiredScope** | **String** | A space-separated list of scopes that must be present in the scope claim. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**resourceServerRequiredType** | **String** | The required TYP value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"at+jwt\"`. | [optional] | -|**resourceServerValidateAudienceEnabled** | **Boolean** | Enable or disable verification of the audience claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**resourceServerValidateIssuerEnabled** | **Boolean** | Enable or disable verification of the issuer claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**resourceServerValidateScopeEnabled** | **Boolean** | Enable or disable verification of the scope claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**resourceServerValidateTypeEnabled** | **Boolean** | Enable or disable verification of the TYP field in the access token header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**usernameClaimName** | **String** | The name of the username claim. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sub\"`. | [optional] | - - - -## Enum: OauthRoleEnum - -| Name | Value | -|---- | -----| -| CLIENT | "client" | -| RESOURCE_SERVER | "resource-server" | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileClientRequiredClaim.md b/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileClientRequiredClaim.md deleted file mode 100644 index ee85a7b96..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileClientRequiredClaim.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# MsgVpnAuthenticationOauthProfileClientRequiredClaim - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**clientRequiredClaimName** | **String** | The name of the ID token claim to verify. | [optional] | -|**clientRequiredClaimValue** | **String** | The required claim value. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**oauthProfileName** | **String** | The name of the OAuth profile. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks.md b/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks.md deleted file mode 100644 index b75c8e32b..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Required Claim object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.md b/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.md deleted file mode 100644 index 843f2ef43..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnAuthenticationOauthProfileClientRequiredClaim**](MsgVpnAuthenticationOauthProfileClientRequiredClaim.md) | | [optional] | -|**links** | [**MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks**](MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.md b/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.md deleted file mode 100644 index 01dd13c68..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnAuthenticationOauthProfileClientRequiredClaim>**](MsgVpnAuthenticationOauthProfileClientRequiredClaim.md) | | [optional] | -|**links** | [**List<MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks>**](MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileLinks.md b/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileLinks.md deleted file mode 100644 index 024943192..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileLinks.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAuthenticationOauthProfileLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**clientRequiredClaimsUri** | **String** | The URI of this OAuth Profile's collection of Required Claim objects. | [optional] | -|**resourceServerRequiredClaimsUri** | **String** | The URI of this OAuth Profile's collection of Required Claim objects. | [optional] | -|**uri** | **String** | The URI of this OAuth Profile object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.md b/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.md deleted file mode 100644 index 96b0a1661..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**oauthProfileName** | **String** | The name of the OAuth profile. | [optional] | -|**resourceServerRequiredClaimName** | **String** | The name of the access token claim to verify. | [optional] | -|**resourceServerRequiredClaimValue** | **String** | The required claim value. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks.md b/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks.md deleted file mode 100644 index 540eb9ac4..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Required Claim object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.md b/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.md deleted file mode 100644 index 25c97a093..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim**](MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.md) | | [optional] | -|**links** | [**MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks**](MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.md b/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.md deleted file mode 100644 index 621c831f4..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim>**](MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.md) | | [optional] | -|**links** | [**List<MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks>**](MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileResponse.md b/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileResponse.md deleted file mode 100644 index d18f63c3b..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfileResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAuthenticationOauthProfileResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnAuthenticationOauthProfile**](MsgVpnAuthenticationOauthProfile.md) | | [optional] | -|**links** | [**MsgVpnAuthenticationOauthProfileLinks**](MsgVpnAuthenticationOauthProfileLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfilesResponse.md b/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfilesResponse.md deleted file mode 100644 index 9dd4e5f3e..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProfilesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAuthenticationOauthProfilesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnAuthenticationOauthProfile>**](MsgVpnAuthenticationOauthProfile.md) | | [optional] | -|**links** | [**List<MsgVpnAuthenticationOauthProfileLinks>**](MsgVpnAuthenticationOauthProfileLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProvider.md b/service/solace-config-client/docs/MsgVpnAuthenticationOauthProvider.md deleted file mode 100644 index ffc91991e..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProvider.md +++ /dev/null @@ -1,64 +0,0 @@ - - -# MsgVpnAuthenticationOauthProvider - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**audienceClaimName** | **String** | The audience claim name, indicating which part of the object to use for determining the audience. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"aud\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**audienceClaimSource** | [**AudienceClaimSourceEnum**](#AudienceClaimSourceEnum) | The audience claim source, indicating where to search for the audience value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"id-token\"`. The allowed values and their meaning are: <pre> \"access-token\" - The OAuth v2 access_token. \"id-token\" - The OpenID Connect id_token. \"introspection\" - The result of introspecting the OAuth v2 access_token. </pre> Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**audienceClaimValue** | **String** | The required audience value for a token to be considered valid. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**audienceValidationEnabled** | **Boolean** | Enable or disable audience validation. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**authorizationGroupClaimName** | **String** | The authorization group claim name, indicating which part of the object to use for determining the authorization group. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"scope\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**authorizationGroupClaimSource** | [**AuthorizationGroupClaimSourceEnum**](#AuthorizationGroupClaimSourceEnum) | The authorization group claim source, indicating where to search for the authorization group name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"id-token\"`. The allowed values and their meaning are: <pre> \"access-token\" - The OAuth v2 access_token. \"id-token\" - The OpenID Connect id_token. \"introspection\" - The result of introspecting the OAuth v2 access_token. </pre> Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**authorizationGroupEnabled** | **Boolean** | Enable or disable OAuth based authorization. When enabled, the configured authorization type for OAuth clients is overridden. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**disconnectOnTokenExpirationEnabled** | **Boolean** | Enable or disable the disconnection of clients when their tokens expire. Changing this value does not affect existing clients, only new client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**enabled** | **Boolean** | Enable or disable OAuth Provider client authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**jwksRefreshInterval** | **Integer** | The number of seconds between forced JWKS public key refreshing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `86400`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**jwksUri** | **String** | The URI where the OAuth provider publishes its JWKS public keys. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. Deprecated since 2.25. Replaced by authenticationOauthProfiles. | [optional] | -|**oauthProviderName** | **String** | The name of the OAuth Provider. Deprecated since 2.25. Replaced by authenticationOauthProfiles. | [optional] | -|**tokenIgnoreTimeLimitsEnabled** | **Boolean** | Enable or disable whether to ignore time limits and accept tokens that are not yet valid or are no longer valid. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**tokenIntrospectionParameterName** | **String** | The parameter name used to identify the token during access token introspection. A standards compliant OAuth introspection server expects \"token\". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"token\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**tokenIntrospectionPassword** | **String** | The password to use when logging into the token introspection URI. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**tokenIntrospectionTimeout** | **Integer** | The maximum time in seconds a token introspection is allowed to take. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**tokenIntrospectionUri** | **String** | The token introspection URI of the OAuth authentication server. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**tokenIntrospectionUsername** | **String** | The username to use when logging into the token introspection URI. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**usernameClaimName** | **String** | The username claim name, indicating which part of the object to use for determining the username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sub\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**usernameClaimSource** | [**UsernameClaimSourceEnum**](#UsernameClaimSourceEnum) | The username claim source, indicating where to search for the username value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"id-token\"`. The allowed values and their meaning are: <pre> \"access-token\" - The OAuth v2 access_token. \"id-token\" - The OpenID Connect id_token. \"introspection\" - The result of introspecting the OAuth v2 access_token. </pre> Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | -|**usernameValidateEnabled** | **Boolean** | Enable or disable whether the API provided username will be validated against the username calculated from the token(s); the connection attempt is rejected if they differ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. | [optional] | - - - -## Enum: AudienceClaimSourceEnum - -| Name | Value | -|---- | -----| -| ACCESS_TOKEN | "access-token" | -| ID_TOKEN | "id-token" | -| INTROSPECTION | "introspection" | - - - -## Enum: AuthorizationGroupClaimSourceEnum - -| Name | Value | -|---- | -----| -| ACCESS_TOKEN | "access-token" | -| ID_TOKEN | "id-token" | -| INTROSPECTION | "introspection" | - - - -## Enum: UsernameClaimSourceEnum - -| Name | Value | -|---- | -----| -| ACCESS_TOKEN | "access-token" | -| ID_TOKEN | "id-token" | -| INTROSPECTION | "introspection" | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProviderLinks.md b/service/solace-config-client/docs/MsgVpnAuthenticationOauthProviderLinks.md deleted file mode 100644 index d4a859648..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProviderLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnAuthenticationOauthProviderLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this OAuth Provider object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProviderResponse.md b/service/solace-config-client/docs/MsgVpnAuthenticationOauthProviderResponse.md deleted file mode 100644 index a1e2fc5bd..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProviderResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAuthenticationOauthProviderResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnAuthenticationOauthProvider**](MsgVpnAuthenticationOauthProvider.md) | | [optional] | -|**links** | [**MsgVpnAuthenticationOauthProviderLinks**](MsgVpnAuthenticationOauthProviderLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProvidersResponse.md b/service/solace-config-client/docs/MsgVpnAuthenticationOauthProvidersResponse.md deleted file mode 100644 index e172b2116..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthenticationOauthProvidersResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAuthenticationOauthProvidersResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnAuthenticationOauthProvider>**](MsgVpnAuthenticationOauthProvider.md) | | [optional] | -|**links** | [**List<MsgVpnAuthenticationOauthProviderLinks>**](MsgVpnAuthenticationOauthProviderLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthorizationGroup.md b/service/solace-config-client/docs/MsgVpnAuthorizationGroup.md deleted file mode 100644 index 2305917d7..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthorizationGroup.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# MsgVpnAuthorizationGroup - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**aclProfileName** | **String** | The ACL Profile of the Authorization Group. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`. | [optional] | -|**authorizationGroupName** | **String** | The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. | [optional] | -|**clientProfileName** | **String** | The Client Profile of the Authorization Group. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`. | [optional] | -|**enabled** | **Boolean** | Enable or disable the Authorization Group in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**orderAfterAuthorizationGroupName** | **String** | Lower the priority to be less than this group. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable. | [optional] | -|**orderBeforeAuthorizationGroupName** | **String** | Raise the priority to be greater than this group. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthorizationGroupLinks.md b/service/solace-config-client/docs/MsgVpnAuthorizationGroupLinks.md deleted file mode 100644 index d85f48ead..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthorizationGroupLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnAuthorizationGroupLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Authorization Group object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthorizationGroupResponse.md b/service/solace-config-client/docs/MsgVpnAuthorizationGroupResponse.md deleted file mode 100644 index 0ad761532..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthorizationGroupResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAuthorizationGroupResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnAuthorizationGroup**](MsgVpnAuthorizationGroup.md) | | [optional] | -|**links** | [**MsgVpnAuthorizationGroupLinks**](MsgVpnAuthorizationGroupLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnAuthorizationGroupsResponse.md b/service/solace-config-client/docs/MsgVpnAuthorizationGroupsResponse.md deleted file mode 100644 index 55213bedc..000000000 --- a/service/solace-config-client/docs/MsgVpnAuthorizationGroupsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnAuthorizationGroupsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnAuthorizationGroup>**](MsgVpnAuthorizationGroup.md) | | [optional] | -|**links** | [**List<MsgVpnAuthorizationGroupLinks>**](MsgVpnAuthorizationGroupLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnBridge.md b/service/solace-config-client/docs/MsgVpnBridge.md deleted file mode 100644 index c5c78b205..000000000 --- a/service/solace-config-client/docs/MsgVpnBridge.md +++ /dev/null @@ -1,57 +0,0 @@ - - -# MsgVpnBridge - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**bridgeName** | **String** | The name of the Bridge. | [optional] | -|**bridgeVirtualRouter** | [**BridgeVirtualRouterEnum**](#BridgeVirtualRouterEnum) | The virtual router of the Bridge. The allowed values and their meaning are: <pre> \"primary\" - The Bridge is used for the primary virtual router. \"backup\" - The Bridge is used for the backup virtual router. \"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> | [optional] | -|**enabled** | **Boolean** | Enable or disable the Bridge. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**maxTtl** | **Long** | The maximum time-to-live (TTL) in hops. Messages are discarded if their TTL exceeds this value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `8`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**remoteAuthenticationBasicClientUsername** | **String** | The Client Username the Bridge uses to login to the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**remoteAuthenticationBasicPassword** | **String** | The password for the Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**remoteAuthenticationClientCertContent** | **String** | The PEM formatted content for the client certificate used by the Bridge to login to the remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9. | [optional] | -|**remoteAuthenticationClientCertPassword** | **String** | The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9. | [optional] | -|**remoteAuthenticationScheme** | [**RemoteAuthenticationSchemeEnum**](#RemoteAuthenticationSchemeEnum) | The authentication scheme for the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"basic\"`. The allowed values and their meaning are: <pre> \"basic\" - Basic Authentication Scheme (via username and password). \"client-certificate\" - Client Certificate Authentication Scheme (via certificate file or content). </pre> | [optional] | -|**remoteConnectionRetryCount** | **Long** | The maximum number of retry attempts to establish a connection to the remote Message VPN. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**remoteConnectionRetryDelay** | **Long** | The number of seconds the broker waits for the bridge connection to be established before attempting a new connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. | [optional] | -|**remoteDeliverToOnePriority** | [**RemoteDeliverToOnePriorityEnum**](#RemoteDeliverToOnePriorityEnum) | The priority for deliver-to-one (DTO) messages transmitted from the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"p1\"`. The allowed values and their meaning are: <pre> \"p1\" - The 1st or highest priority. \"p2\" - The 2nd highest priority. \"p3\" - The 3rd highest priority. \"p4\" - The 4th highest priority. \"da\" - Ignore priority and deliver always. </pre> | [optional] | -|**tlsCipherSuiteList** | **String** | The colon-separated list of cipher suites supported for TLS connections to the remote Message VPN. The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`. | [optional] | - - - -## Enum: BridgeVirtualRouterEnum - -| Name | Value | -|---- | -----| -| PRIMARY | "primary" | -| BACKUP | "backup" | -| AUTO | "auto" | - - - -## Enum: RemoteAuthenticationSchemeEnum - -| Name | Value | -|---- | -----| -| BASIC | "basic" | -| CLIENT_CERTIFICATE | "client-certificate" | - - - -## Enum: RemoteDeliverToOnePriorityEnum - -| Name | Value | -|---- | -----| -| P1 | "p1" | -| P2 | "p2" | -| P3 | "p3" | -| P4 | "p4" | -| DA | "da" | - - - diff --git a/service/solace-config-client/docs/MsgVpnBridgeLinks.md b/service/solace-config-client/docs/MsgVpnBridgeLinks.md deleted file mode 100644 index 62c27b516..000000000 --- a/service/solace-config-client/docs/MsgVpnBridgeLinks.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# MsgVpnBridgeLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**remoteMsgVpnsUri** | **String** | The URI of this Bridge's collection of Remote Message VPN objects. | [optional] | -|**remoteSubscriptionsUri** | **String** | The URI of this Bridge's collection of Remote Subscription objects. | [optional] | -|**tlsTrustedCommonNamesUri** | **String** | The URI of this Bridge's collection of Trusted Common Name objects. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. | [optional] | -|**uri** | **String** | The URI of this Bridge object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnBridgeRemoteMsgVpn.md b/service/solace-config-client/docs/MsgVpnBridgeRemoteMsgVpn.md deleted file mode 100644 index b4c3ea8a1..000000000 --- a/service/solace-config-client/docs/MsgVpnBridgeRemoteMsgVpn.md +++ /dev/null @@ -1,37 +0,0 @@ - - -# MsgVpnBridgeRemoteMsgVpn - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**bridgeName** | **String** | The name of the Bridge. | [optional] | -|**bridgeVirtualRouter** | [**BridgeVirtualRouterEnum**](#BridgeVirtualRouterEnum) | The virtual router of the Bridge. The allowed values and their meaning are: <pre> \"primary\" - The Bridge is used for the primary virtual router. \"backup\" - The Bridge is used for the backup virtual router. \"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> | [optional] | -|**clientUsername** | **String** | The Client Username the Bridge uses to login to the remote Message VPN. This per remote Message VPN value overrides the value provided for the Bridge overall. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**compressedDataEnabled** | **Boolean** | Enable or disable data compression for the remote Message VPN connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**connectOrder** | **Integer** | The preference given to incoming connections from remote Message VPN hosts, from 1 (highest priority) to 4 (lowest priority). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`. | [optional] | -|**egressFlowWindowSize** | **Long** | The number of outstanding guaranteed messages that can be transmitted over the remote Message VPN connection before an acknowledgement is received. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`. | [optional] | -|**enabled** | **Boolean** | Enable or disable the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**password** | **String** | The password for the Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**queueBinding** | **String** | The queue binding of the Bridge in the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**remoteMsgVpnInterface** | **String** | The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. | [optional] | -|**remoteMsgVpnLocation** | **String** | The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). | [optional] | -|**remoteMsgVpnName** | **String** | The name of the remote Message VPN. | [optional] | -|**tlsEnabled** | **Boolean** | Enable or disable encryption (TLS) for the remote Message VPN connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**unidirectionalClientProfile** | **String** | The Client Profile for the unidirectional Bridge of the remote Message VPN. The Client Profile must exist in the local Message VPN, and it is used only for the TCP parameters. Note that the default client profile has a TCP maximum window size of 2MB. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#client-profile\"`. | [optional] | - - - -## Enum: BridgeVirtualRouterEnum - -| Name | Value | -|---- | -----| -| PRIMARY | "primary" | -| BACKUP | "backup" | -| AUTO | "auto" | - - - diff --git a/service/solace-config-client/docs/MsgVpnBridgeRemoteMsgVpnLinks.md b/service/solace-config-client/docs/MsgVpnBridgeRemoteMsgVpnLinks.md deleted file mode 100644 index 699b73920..000000000 --- a/service/solace-config-client/docs/MsgVpnBridgeRemoteMsgVpnLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnBridgeRemoteMsgVpnLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Remote Message VPN object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnBridgeRemoteMsgVpnResponse.md b/service/solace-config-client/docs/MsgVpnBridgeRemoteMsgVpnResponse.md deleted file mode 100644 index 7b03b2c14..000000000 --- a/service/solace-config-client/docs/MsgVpnBridgeRemoteMsgVpnResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnBridgeRemoteMsgVpnResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnBridgeRemoteMsgVpn**](MsgVpnBridgeRemoteMsgVpn.md) | | [optional] | -|**links** | [**MsgVpnBridgeRemoteMsgVpnLinks**](MsgVpnBridgeRemoteMsgVpnLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnBridgeRemoteMsgVpnsResponse.md b/service/solace-config-client/docs/MsgVpnBridgeRemoteMsgVpnsResponse.md deleted file mode 100644 index 8cb31d478..000000000 --- a/service/solace-config-client/docs/MsgVpnBridgeRemoteMsgVpnsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnBridgeRemoteMsgVpnsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnBridgeRemoteMsgVpn>**](MsgVpnBridgeRemoteMsgVpn.md) | | [optional] | -|**links** | [**List<MsgVpnBridgeRemoteMsgVpnLinks>**](MsgVpnBridgeRemoteMsgVpnLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnBridgeRemoteSubscription.md b/service/solace-config-client/docs/MsgVpnBridgeRemoteSubscription.md deleted file mode 100644 index 9299296d7..000000000 --- a/service/solace-config-client/docs/MsgVpnBridgeRemoteSubscription.md +++ /dev/null @@ -1,27 +0,0 @@ - - -# MsgVpnBridgeRemoteSubscription - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**bridgeName** | **String** | The name of the Bridge. | [optional] | -|**bridgeVirtualRouter** | [**BridgeVirtualRouterEnum**](#BridgeVirtualRouterEnum) | The virtual router of the Bridge. The allowed values and their meaning are: <pre> \"primary\" - The Bridge is used for the primary virtual router. \"backup\" - The Bridge is used for the backup virtual router. \"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> | [optional] | -|**deliverAlwaysEnabled** | **Boolean** | Enable or disable deliver-always for the Bridge remote subscription topic instead of a deliver-to-one remote priority. A given topic for the Bridge may be deliver-to-one or deliver-always but not both. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**remoteSubscriptionTopic** | **String** | The topic of the Bridge remote subscription. | [optional] | - - - -## Enum: BridgeVirtualRouterEnum - -| Name | Value | -|---- | -----| -| PRIMARY | "primary" | -| BACKUP | "backup" | -| AUTO | "auto" | - - - diff --git a/service/solace-config-client/docs/MsgVpnBridgeRemoteSubscriptionLinks.md b/service/solace-config-client/docs/MsgVpnBridgeRemoteSubscriptionLinks.md deleted file mode 100644 index 2d1f44361..000000000 --- a/service/solace-config-client/docs/MsgVpnBridgeRemoteSubscriptionLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnBridgeRemoteSubscriptionLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Remote Subscription object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnBridgeRemoteSubscriptionResponse.md b/service/solace-config-client/docs/MsgVpnBridgeRemoteSubscriptionResponse.md deleted file mode 100644 index 0737682d9..000000000 --- a/service/solace-config-client/docs/MsgVpnBridgeRemoteSubscriptionResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnBridgeRemoteSubscriptionResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnBridgeRemoteSubscription**](MsgVpnBridgeRemoteSubscription.md) | | [optional] | -|**links** | [**MsgVpnBridgeRemoteSubscriptionLinks**](MsgVpnBridgeRemoteSubscriptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnBridgeRemoteSubscriptionsResponse.md b/service/solace-config-client/docs/MsgVpnBridgeRemoteSubscriptionsResponse.md deleted file mode 100644 index f7b1fac39..000000000 --- a/service/solace-config-client/docs/MsgVpnBridgeRemoteSubscriptionsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnBridgeRemoteSubscriptionsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnBridgeRemoteSubscription>**](MsgVpnBridgeRemoteSubscription.md) | | [optional] | -|**links** | [**List<MsgVpnBridgeRemoteSubscriptionLinks>**](MsgVpnBridgeRemoteSubscriptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnBridgeResponse.md b/service/solace-config-client/docs/MsgVpnBridgeResponse.md deleted file mode 100644 index 89ae36620..000000000 --- a/service/solace-config-client/docs/MsgVpnBridgeResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnBridgeResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnBridge**](MsgVpnBridge.md) | | [optional] | -|**links** | [**MsgVpnBridgeLinks**](MsgVpnBridgeLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnBridgeTlsTrustedCommonName.md b/service/solace-config-client/docs/MsgVpnBridgeTlsTrustedCommonName.md deleted file mode 100644 index 1fbdf5376..000000000 --- a/service/solace-config-client/docs/MsgVpnBridgeTlsTrustedCommonName.md +++ /dev/null @@ -1,26 +0,0 @@ - - -# MsgVpnBridgeTlsTrustedCommonName - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**bridgeName** | **String** | The name of the Bridge. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. | [optional] | -|**bridgeVirtualRouter** | [**BridgeVirtualRouterEnum**](#BridgeVirtualRouterEnum) | The virtual router of the Bridge. The allowed values and their meaning are: <pre> \"primary\" - The Bridge is used for the primary virtual router. \"backup\" - The Bridge is used for the backup virtual router. \"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. | [optional] | -|**tlsTrustedCommonName** | **String** | The expected trusted common name of the remote certificate. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. | [optional] | - - - -## Enum: BridgeVirtualRouterEnum - -| Name | Value | -|---- | -----| -| PRIMARY | "primary" | -| BACKUP | "backup" | -| AUTO | "auto" | - - - diff --git a/service/solace-config-client/docs/MsgVpnBridgeTlsTrustedCommonNameLinks.md b/service/solace-config-client/docs/MsgVpnBridgeTlsTrustedCommonNameLinks.md deleted file mode 100644 index 1012f0007..000000000 --- a/service/solace-config-client/docs/MsgVpnBridgeTlsTrustedCommonNameLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnBridgeTlsTrustedCommonNameLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Trusted Common Name object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnBridgeTlsTrustedCommonNameResponse.md b/service/solace-config-client/docs/MsgVpnBridgeTlsTrustedCommonNameResponse.md deleted file mode 100644 index 35489dd1f..000000000 --- a/service/solace-config-client/docs/MsgVpnBridgeTlsTrustedCommonNameResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnBridgeTlsTrustedCommonNameResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnBridgeTlsTrustedCommonName**](MsgVpnBridgeTlsTrustedCommonName.md) | | [optional] | -|**links** | [**MsgVpnBridgeTlsTrustedCommonNameLinks**](MsgVpnBridgeTlsTrustedCommonNameLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnBridgeTlsTrustedCommonNamesResponse.md b/service/solace-config-client/docs/MsgVpnBridgeTlsTrustedCommonNamesResponse.md deleted file mode 100644 index 3b8fd67ef..000000000 --- a/service/solace-config-client/docs/MsgVpnBridgeTlsTrustedCommonNamesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnBridgeTlsTrustedCommonNamesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnBridgeTlsTrustedCommonName>**](MsgVpnBridgeTlsTrustedCommonName.md) | | [optional] | -|**links** | [**List<MsgVpnBridgeTlsTrustedCommonNameLinks>**](MsgVpnBridgeTlsTrustedCommonNameLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnBridgesResponse.md b/service/solace-config-client/docs/MsgVpnBridgesResponse.md deleted file mode 100644 index 7556448d6..000000000 --- a/service/solace-config-client/docs/MsgVpnBridgesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnBridgesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnBridge>**](MsgVpnBridge.md) | | [optional] | -|**links** | [**List<MsgVpnBridgeLinks>**](MsgVpnBridgeLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnCertMatchingRule.md b/service/solace-config-client/docs/MsgVpnCertMatchingRule.md deleted file mode 100644 index 626738022..000000000 --- a/service/solace-config-client/docs/MsgVpnCertMatchingRule.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnCertMatchingRule - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**enabled** | **Boolean** | Enable or disable a certificate matching rule. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**ruleName** | **String** | The name of the rule. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnCertMatchingRuleAttributeFilter.md b/service/solace-config-client/docs/MsgVpnCertMatchingRuleAttributeFilter.md deleted file mode 100644 index d57e58c0c..000000000 --- a/service/solace-config-client/docs/MsgVpnCertMatchingRuleAttributeFilter.md +++ /dev/null @@ -1,17 +0,0 @@ - - -# MsgVpnCertMatchingRuleAttributeFilter - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**attributeName** | **String** | Client Username Attribute to be tested. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**attributeValue** | **String** | Expected attribute value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**filterName** | **String** | The name of the filter. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**ruleName** | **String** | The name of the rule. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnCertMatchingRuleAttributeFilterLinks.md b/service/solace-config-client/docs/MsgVpnCertMatchingRuleAttributeFilterLinks.md deleted file mode 100644 index e6470259b..000000000 --- a/service/solace-config-client/docs/MsgVpnCertMatchingRuleAttributeFilterLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnCertMatchingRuleAttributeFilterLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Certificate Matching Rule Attribute Filter object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnCertMatchingRuleAttributeFilterResponse.md b/service/solace-config-client/docs/MsgVpnCertMatchingRuleAttributeFilterResponse.md deleted file mode 100644 index cd92d930c..000000000 --- a/service/solace-config-client/docs/MsgVpnCertMatchingRuleAttributeFilterResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnCertMatchingRuleAttributeFilterResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnCertMatchingRuleAttributeFilter**](MsgVpnCertMatchingRuleAttributeFilter.md) | | [optional] | -|**links** | [**MsgVpnCertMatchingRuleAttributeFilterLinks**](MsgVpnCertMatchingRuleAttributeFilterLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnCertMatchingRuleAttributeFiltersResponse.md b/service/solace-config-client/docs/MsgVpnCertMatchingRuleAttributeFiltersResponse.md deleted file mode 100644 index b396def7b..000000000 --- a/service/solace-config-client/docs/MsgVpnCertMatchingRuleAttributeFiltersResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnCertMatchingRuleAttributeFiltersResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnCertMatchingRuleAttributeFilter>**](MsgVpnCertMatchingRuleAttributeFilter.md) | | [optional] | -|**links** | [**List<MsgVpnCertMatchingRuleAttributeFilterLinks>**](MsgVpnCertMatchingRuleAttributeFilterLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnCertMatchingRuleCondition.md b/service/solace-config-client/docs/MsgVpnCertMatchingRuleCondition.md deleted file mode 100644 index 4fc75ee8d..000000000 --- a/service/solace-config-client/docs/MsgVpnCertMatchingRuleCondition.md +++ /dev/null @@ -1,37 +0,0 @@ - - -# MsgVpnCertMatchingRuleCondition - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**attribute** | **String** | Client Username Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The default value is `\"\"`. | [optional] | -|**expression** | **String** | Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The default value is `\"\"`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**ruleName** | **String** | The name of the rule. | [optional] | -|**source** | [**SourceEnum**](#SourceEnum) | Certificate field to be compared with the Attribute. The allowed values and their meaning are: <pre> \"certificate-thumbprint\" - The attribute is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate. \"common-name\" - The attribute is extracted from the certificate's first instance of the Common Name attribute in the Subject DN. \"common-name-last\" - The attribute is extracted from the certificate's last instance of the Common Name attribute in the Subject DN. \"subject-alternate-name-msupn\" - The attribute is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature. \"uid\" - The attribute is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN. \"uid-last\" - The attribute is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN. \"org-unit\" - The attribute is extracted from the certificate's first instance of the Org Unit attribute in the Subject DN. \"org-unit-last\" - The attribute is extracted from the certificate's last instance of the Org Unit attribute in the Subject DN. \"issuer\" - The attribute is extracted from the certificate's Issuer DN. \"subject\" - The attribute is extracted from the certificate's Subject DN. \"serial-number\" - The attribute is extracted from the certificate's Serial Number. \"dns-name\" - The attribute is extracted from the certificate's Subject Alt Name DNSName. \"ip-address\" - The attribute is extracted from the certificate's Subject Alt Name IPAddress. </pre> | [optional] | - - - -## Enum: SourceEnum - -| Name | Value | -|---- | -----| -| CERTIFICATE_THUMBPRINT | "certificate-thumbprint" | -| COMMON_NAME | "common-name" | -| COMMON_NAME_LAST | "common-name-last" | -| SUBJECT_ALTERNATE_NAME_MSUPN | "subject-alternate-name-msupn" | -| UID | "uid" | -| UID_LAST | "uid-last" | -| ORG_UNIT | "org-unit" | -| ORG_UNIT_LAST | "org-unit-last" | -| ISSUER | "issuer" | -| SUBJECT | "subject" | -| SERIAL_NUMBER | "serial-number" | -| DNS_NAME | "dns-name" | -| IP_ADDRESS | "ip-address" | - - - diff --git a/service/solace-config-client/docs/MsgVpnCertMatchingRuleConditionLinks.md b/service/solace-config-client/docs/MsgVpnCertMatchingRuleConditionLinks.md deleted file mode 100644 index a49cd81bf..000000000 --- a/service/solace-config-client/docs/MsgVpnCertMatchingRuleConditionLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnCertMatchingRuleConditionLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Certificate Matching Rule Condition object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnCertMatchingRuleConditionResponse.md b/service/solace-config-client/docs/MsgVpnCertMatchingRuleConditionResponse.md deleted file mode 100644 index e77d58896..000000000 --- a/service/solace-config-client/docs/MsgVpnCertMatchingRuleConditionResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnCertMatchingRuleConditionResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnCertMatchingRuleCondition**](MsgVpnCertMatchingRuleCondition.md) | | [optional] | -|**links** | [**MsgVpnCertMatchingRuleConditionLinks**](MsgVpnCertMatchingRuleConditionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnCertMatchingRuleConditionsResponse.md b/service/solace-config-client/docs/MsgVpnCertMatchingRuleConditionsResponse.md deleted file mode 100644 index 23cf7ed4d..000000000 --- a/service/solace-config-client/docs/MsgVpnCertMatchingRuleConditionsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnCertMatchingRuleConditionsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnCertMatchingRuleCondition>**](MsgVpnCertMatchingRuleCondition.md) | | [optional] | -|**links** | [**List<MsgVpnCertMatchingRuleConditionLinks>**](MsgVpnCertMatchingRuleConditionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnCertMatchingRuleLinks.md b/service/solace-config-client/docs/MsgVpnCertMatchingRuleLinks.md deleted file mode 100644 index 9b9907a4b..000000000 --- a/service/solace-config-client/docs/MsgVpnCertMatchingRuleLinks.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnCertMatchingRuleLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**attributeFiltersUri** | **String** | The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Attribute Filter objects. Available since 2.28. | [optional] | -|**conditionsUri** | **String** | The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Condition objects. | [optional] | -|**uri** | **String** | The URI of this Certificate Matching Rule object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnCertMatchingRuleResponse.md b/service/solace-config-client/docs/MsgVpnCertMatchingRuleResponse.md deleted file mode 100644 index a3fb8d583..000000000 --- a/service/solace-config-client/docs/MsgVpnCertMatchingRuleResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnCertMatchingRuleResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnCertMatchingRule**](MsgVpnCertMatchingRule.md) | | [optional] | -|**links** | [**MsgVpnCertMatchingRuleLinks**](MsgVpnCertMatchingRuleLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnCertMatchingRulesResponse.md b/service/solace-config-client/docs/MsgVpnCertMatchingRulesResponse.md deleted file mode 100644 index d06d17131..000000000 --- a/service/solace-config-client/docs/MsgVpnCertMatchingRulesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnCertMatchingRulesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnCertMatchingRule>**](MsgVpnCertMatchingRule.md) | | [optional] | -|**links** | [**List<MsgVpnCertMatchingRuleLinks>**](MsgVpnCertMatchingRuleLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnClientProfile.md b/service/solace-config-client/docs/MsgVpnClientProfile.md deleted file mode 100644 index bbe3c5ea7..000000000 --- a/service/solace-config-client/docs/MsgVpnClientProfile.md +++ /dev/null @@ -1,83 +0,0 @@ - - -# MsgVpnClientProfile - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**allowBridgeConnectionsEnabled** | **Boolean** | Enable or disable allowing Bridge clients using the Client Profile to connect. Changing this setting does not affect existing Bridge client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**allowCutThroughForwardingEnabled** | **Boolean** | Enable or disable allowing clients using the Client Profile to bind to endpoints with the cut-through forwarding delivery mode. Changing this value does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.22. This attribute has been deprecated. Please visit the Solace Product Lifecycle Policy web page for details on deprecated features. | [optional] | -|**allowGuaranteedEndpointCreateDurability** | [**AllowGuaranteedEndpointCreateDurabilityEnum**](#AllowGuaranteedEndpointCreateDurabilityEnum) | The types of Queues and Topic Endpoints that clients using the client-profile can create. Changing this value does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"all\"`. The allowed values and their meaning are: <pre> \"all\" - Client can create any type of endpoint. \"durable\" - Client can create only durable endpoints. \"non-durable\" - Client can create only non-durable endpoints. </pre> Available since 2.14. | [optional] | -|**allowGuaranteedEndpointCreateEnabled** | **Boolean** | Enable or disable allowing clients using the Client Profile to create topic endponts or queues. Changing this value does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**allowGuaranteedMsgReceiveEnabled** | **Boolean** | Enable or disable allowing clients using the Client Profile to receive guaranteed messages. Changing this setting does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**allowGuaranteedMsgSendEnabled** | **Boolean** | Enable or disable allowing clients using the Client Profile to send guaranteed messages. Changing this setting does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**allowSharedSubscriptionsEnabled** | **Boolean** | Enable or disable allowing shared subscriptions. Changing this setting does not affect existing subscriptions. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.11. | [optional] | -|**allowTransactedSessionsEnabled** | **Boolean** | Enable or disable allowing clients using the Client Profile to establish transacted sessions. Changing this setting does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**apiQueueManagementCopyFromOnCreateName** | **String** | The name of a queue to copy settings from when a new queue is created by a client using the Client Profile. The referenced queue must exist in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.14. This attribute has been replaced with `apiQueueManagementCopyFromOnCreateTemplateName`. | [optional] | -|**apiQueueManagementCopyFromOnCreateTemplateName** | **String** | The name of a queue template to copy settings from when a new queue is created by a client using the Client Profile. If the referenced queue template does not exist, queue creation will fail when it tries to resolve this template. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14. | [optional] | -|**apiTopicEndpointManagementCopyFromOnCreateName** | **String** | The name of a topic endpoint to copy settings from when a new topic endpoint is created by a client using the Client Profile. The referenced topic endpoint must exist in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.14. This attribute has been replaced with `apiTopicEndpointManagementCopyFromOnCreateTemplateName`. | [optional] | -|**apiTopicEndpointManagementCopyFromOnCreateTemplateName** | **String** | The name of a topic endpoint template to copy settings from when a new topic endpoint is created by a client using the Client Profile. If the referenced topic endpoint template does not exist, topic endpoint creation will fail when it tries to resolve this template. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14. | [optional] | -|**clientProfileName** | **String** | The name of the Client Profile. | [optional] | -|**compressionEnabled** | **Boolean** | Enable or disable allowing clients using the Client Profile to use compression. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.10. | [optional] | -|**elidingDelay** | **Long** | The amount of time to delay the delivery of messages to clients using the Client Profile after the initial message has been delivered (the eliding delay interval), in milliseconds. A value of 0 means there is no delay in delivering messages to clients. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**elidingEnabled** | **Boolean** | Enable or disable message eliding for clients using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**elidingMaxTopicCount** | **Long** | The maximum number of topics tracked for message eliding per client connection using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `256`. | [optional] | -|**eventClientProvisionedEndpointSpoolUsageThreshold** | [**EventThresholdByPercent**](EventThresholdByPercent.md) | | [optional] | -|**eventConnectionCountPerClientUsernameThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventEgressFlowCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventEndpointCountPerClientUsernameThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventIngressFlowCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventServiceSmfConnectionCountPerClientUsernameThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventServiceWebConnectionCountPerClientUsernameThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventSubscriptionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventTransactedSessionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventTransactionCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**maxConnectionCountPerClientUsername** | **Long** | The maximum number of client connections per Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. | [optional] | -|**maxEgressFlowCount** | **Long** | The maximum number of transmit flows that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. | [optional] | -|**maxEndpointCountPerClientUsername** | **Long** | The maximum number of queues and topic endpoints that can be created by clients with the same Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. | [optional] | -|**maxIngressFlowCount** | **Long** | The maximum number of receive flows that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. | [optional] | -|**maxMsgsPerTransaction** | **Integer** | The maximum number of publisher and consumer messages combined that is allowed within a transaction for each client associated with this client-profile. Exceeding this limit will result in a transaction prepare or commit failure. Changing this value during operation will not affect existing sessions. It is only validated at transaction creation time. Large transactions consume more resources and are more likely to require retrieving messages from the ADB or from disk to process the transaction prepare or commit requests. The transaction processing rate may diminish if a large number of messages must be retrieved from the ADB or from disk. Care should be taken to not use excessively large transactions needlessly to avoid exceeding resource limits and to avoid reducing the overall broker performance. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `256`. Available since 2.20. | [optional] | -|**maxSubscriptionCount** | **Long** | The maximum number of subscriptions per client using the Client Profile. This limit is not enforced when a client adds a subscription to an endpoint, except for MQTT QoS 1 subscriptions. In addition, this limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. | [optional] | -|**maxTransactedSessionCount** | **Long** | The maximum number of transacted sessions that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10`. | [optional] | -|**maxTransactionCount** | **Long** | The maximum number of transactions that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**queueControl1MaxDepth** | **Integer** | The maximum depth of the \"Control 1\" (C-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`. | [optional] | -|**queueControl1MinMsgBurst** | **Integer** | The number of messages that are always allowed entry into the \"Control 1\" (C-1) priority queue, regardless of the `queueControl1MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`. | [optional] | -|**queueDirect1MaxDepth** | **Integer** | The maximum depth of the \"Direct 1\" (D-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`. | [optional] | -|**queueDirect1MinMsgBurst** | **Integer** | The number of messages that are always allowed entry into the \"Direct 1\" (D-1) priority queue, regardless of the `queueDirect1MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`. | [optional] | -|**queueDirect2MaxDepth** | **Integer** | The maximum depth of the \"Direct 2\" (D-2) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`. | [optional] | -|**queueDirect2MinMsgBurst** | **Integer** | The number of messages that are always allowed entry into the \"Direct 2\" (D-2) priority queue, regardless of the `queueDirect2MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`. | [optional] | -|**queueDirect3MaxDepth** | **Integer** | The maximum depth of the \"Direct 3\" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`. | [optional] | -|**queueDirect3MinMsgBurst** | **Integer** | The number of messages that are always allowed entry into the \"Direct 3\" (D-3) priority queue, regardless of the `queueDirect3MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`. | [optional] | -|**queueGuaranteed1MaxDepth** | **Integer** | The maximum depth of the \"Guaranteed 1\" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`. | [optional] | -|**queueGuaranteed1MinMsgBurst** | **Integer** | The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-3) priority queue, regardless of the `queueGuaranteed1MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`. | [optional] | -|**rejectMsgToSenderOnNoSubscriptionMatchEnabled** | **Boolean** | Enable or disable the sending of a negative acknowledgement (NACK) to a client using the Client Profile when discarding a guaranteed message due to no matching subscription found. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.2. | [optional] | -|**replicationAllowClientConnectWhenStandbyEnabled** | **Boolean** | Enable or disable allowing clients using the Client Profile to connect to the Message VPN when its replication state is standby. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**serviceMinKeepaliveTimeout** | **Integer** | The minimum client keepalive timeout which will be enforced for client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30`. Available since 2.19. | [optional] | -|**serviceSmfMaxConnectionCountPerClientUsername** | **Long** | The maximum number of SMF client connections per Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. | [optional] | -|**serviceSmfMinKeepaliveEnabled** | **Boolean** | Enable or disable the enforcement of a minimum keepalive timeout for SMF clients. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.19. | [optional] | -|**serviceWebInactiveTimeout** | **Long** | The timeout for inactive Web Transport client sessions using the Client Profile, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30`. | [optional] | -|**serviceWebMaxConnectionCountPerClientUsername** | **Long** | The maximum number of Web Transport client connections per Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. | [optional] | -|**serviceWebMaxPayload** | **Long** | The maximum Web Transport payload size before fragmentation occurs for clients using the Client Profile, in bytes. The size of the header is not included. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000000`. | [optional] | -|**tcpCongestionWindowSize** | **Long** | The TCP initial congestion window size for clients using the Client Profile, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2`. | [optional] | -|**tcpKeepaliveCount** | **Long** | The number of TCP keepalive retransmissions to a client using the Client Profile before declaring that it is not available. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`. | [optional] | -|**tcpKeepaliveIdleTime** | **Long** | The amount of time a client connection using the Client Profile must remain idle before TCP begins sending keepalive probes, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. | [optional] | -|**tcpKeepaliveInterval** | **Long** | The amount of time between TCP keepalive retransmissions to a client using the Client Profile when no acknowledgement is received, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. | [optional] | -|**tcpMaxSegmentSize** | **Long** | The TCP maximum segment size for clients using the Client Profile, in bytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1460`. | [optional] | -|**tcpMaxWindowSize** | **Long** | The TCP maximum window size for clients using the Client Profile, in kilobytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `256`. | [optional] | -|**tlsAllowDowngradeToPlainTextEnabled** | **Boolean** | Enable or disable allowing a client using the Client Profile to downgrade an encrypted connection to plain text. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.8. | [optional] | - - - -## Enum: AllowGuaranteedEndpointCreateDurabilityEnum - -| Name | Value | -|---- | -----| -| ALL | "all" | -| DURABLE | "durable" | -| NON_DURABLE | "non-durable" | - - - diff --git a/service/solace-config-client/docs/MsgVpnClientProfileLinks.md b/service/solace-config-client/docs/MsgVpnClientProfileLinks.md deleted file mode 100644 index 55d81e531..000000000 --- a/service/solace-config-client/docs/MsgVpnClientProfileLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnClientProfileLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Client Profile object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnClientProfileResponse.md b/service/solace-config-client/docs/MsgVpnClientProfileResponse.md deleted file mode 100644 index cd4e16ad6..000000000 --- a/service/solace-config-client/docs/MsgVpnClientProfileResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnClientProfileResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnClientProfile**](MsgVpnClientProfile.md) | | [optional] | -|**links** | [**MsgVpnClientProfileLinks**](MsgVpnClientProfileLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnClientProfilesResponse.md b/service/solace-config-client/docs/MsgVpnClientProfilesResponse.md deleted file mode 100644 index c4f610b1d..000000000 --- a/service/solace-config-client/docs/MsgVpnClientProfilesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnClientProfilesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnClientProfile>**](MsgVpnClientProfile.md) | | [optional] | -|**links** | [**List<MsgVpnClientProfileLinks>**](MsgVpnClientProfileLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnClientUsername.md b/service/solace-config-client/docs/MsgVpnClientUsername.md deleted file mode 100644 index 2eab39c7e..000000000 --- a/service/solace-config-client/docs/MsgVpnClientUsername.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# MsgVpnClientUsername - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**aclProfileName** | **String** | The ACL Profile of the Client Username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`. | [optional] | -|**clientProfileName** | **String** | The Client Profile of the Client Username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`. | [optional] | -|**clientUsername** | **String** | The name of the Client Username. | [optional] | -|**enabled** | **Boolean** | Enable or disable the Client Username. When disabled, all clients currently connected as the Client Username are disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**guaranteedEndpointPermissionOverrideEnabled** | **Boolean** | Enable or disable guaranteed endpoint permission override for the Client Username. When enabled all guaranteed endpoints may be accessed, modified or deleted with the same permission as the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**password** | **String** | The password for the Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**subscriptionManagerEnabled** | **Boolean** | Enable or disable the subscription management capability of the Client Username. This is the ability to manage subscriptions on behalf of other Client Usernames. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnClientUsernameAttribute.md b/service/solace-config-client/docs/MsgVpnClientUsernameAttribute.md deleted file mode 100644 index 25de7966c..000000000 --- a/service/solace-config-client/docs/MsgVpnClientUsernameAttribute.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# MsgVpnClientUsernameAttribute - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**attributeName** | **String** | The name of the Attribute. | [optional] | -|**attributeValue** | **String** | The value of the Attribute. | [optional] | -|**clientUsername** | **String** | The name of the Client Username. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnClientUsernameAttributeLinks.md b/service/solace-config-client/docs/MsgVpnClientUsernameAttributeLinks.md deleted file mode 100644 index 3b9789e2e..000000000 --- a/service/solace-config-client/docs/MsgVpnClientUsernameAttributeLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnClientUsernameAttributeLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Client Username Attribute object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnClientUsernameAttributeResponse.md b/service/solace-config-client/docs/MsgVpnClientUsernameAttributeResponse.md deleted file mode 100644 index 2fa9fa45c..000000000 --- a/service/solace-config-client/docs/MsgVpnClientUsernameAttributeResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnClientUsernameAttributeResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnClientUsernameAttribute**](MsgVpnClientUsernameAttribute.md) | | [optional] | -|**links** | [**MsgVpnClientUsernameAttributeLinks**](MsgVpnClientUsernameAttributeLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnClientUsernameAttributesResponse.md b/service/solace-config-client/docs/MsgVpnClientUsernameAttributesResponse.md deleted file mode 100644 index 2fd39921d..000000000 --- a/service/solace-config-client/docs/MsgVpnClientUsernameAttributesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnClientUsernameAttributesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnClientUsernameAttribute>**](MsgVpnClientUsernameAttribute.md) | | [optional] | -|**links** | [**List<MsgVpnClientUsernameAttributeLinks>**](MsgVpnClientUsernameAttributeLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnClientUsernameLinks.md b/service/solace-config-client/docs/MsgVpnClientUsernameLinks.md deleted file mode 100644 index fec2ab3f6..000000000 --- a/service/solace-config-client/docs/MsgVpnClientUsernameLinks.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# MsgVpnClientUsernameLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**attributesUri** | **String** | The URI of this Client Username's collection of Client Username Attribute objects. Available since 2.27. | [optional] | -|**uri** | **String** | The URI of this Client Username object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnClientUsernameResponse.md b/service/solace-config-client/docs/MsgVpnClientUsernameResponse.md deleted file mode 100644 index 32fb46419..000000000 --- a/service/solace-config-client/docs/MsgVpnClientUsernameResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnClientUsernameResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnClientUsername**](MsgVpnClientUsername.md) | | [optional] | -|**links** | [**MsgVpnClientUsernameLinks**](MsgVpnClientUsernameLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnClientUsernamesResponse.md b/service/solace-config-client/docs/MsgVpnClientUsernamesResponse.md deleted file mode 100644 index 4cf218f88..000000000 --- a/service/solace-config-client/docs/MsgVpnClientUsernamesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnClientUsernamesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnClientUsername>**](MsgVpnClientUsername.md) | | [optional] | -|**links** | [**List<MsgVpnClientUsernameLinks>**](MsgVpnClientUsernameLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCache.md b/service/solace-config-client/docs/MsgVpnDistributedCache.md deleted file mode 100644 index b03e4d71b..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCache.md +++ /dev/null @@ -1,27 +0,0 @@ - - -# MsgVpnDistributedCache - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**cacheName** | **String** | The name of the Distributed Cache. | [optional] | -|**cacheVirtualRouter** | [**CacheVirtualRouterEnum**](#CacheVirtualRouterEnum) | The virtual router of the Distributed Cache. The default value is `\"auto\"`. The allowed values and their meaning are: <pre> \"auto\" - The Distributed Cache is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> Available since 2.28. | [optional] | -|**enabled** | **Boolean** | Enable or disable the Distributed Cache. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**heartbeat** | **Long** | The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the message broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**scheduledDeleteMsgDayList** | **String** | The scheduled delete message day(s), specified as \"daily\" or a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. The empty-string (\"\") can also be specified, indicating no schedule is configured (\"scheduledDeleteMsgTimeList\" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**scheduledDeleteMsgTimeList** | **String** | The scheduled delete message time(s), specified as \"hourly\" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. The empty-string (\"\") can also be specified, indicating no schedule is configured (\"scheduledDeleteMsgDayList\" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | - - - -## Enum: CacheVirtualRouterEnum - -| Name | Value | -|---- | -----| -| AUTO | "auto" | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheCluster.md b/service/solace-config-client/docs/MsgVpnDistributedCacheCluster.md deleted file mode 100644 index f63f662ca..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheCluster.md +++ /dev/null @@ -1,33 +0,0 @@ - - -# MsgVpnDistributedCacheCluster - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**cacheName** | **String** | The name of the Distributed Cache. | [optional] | -|**clusterName** | **String** | The name of the Cache Cluster. | [optional] | -|**deliverToOneOverrideEnabled** | **Boolean** | Enable or disable deliver-to-one override for the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**enabled** | **Boolean** | Enable or disable the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**eventDataByteRateThreshold** | [**EventThresholdByValue**](EventThresholdByValue.md) | | [optional] | -|**eventDataMsgRateThreshold** | [**EventThresholdByValue**](EventThresholdByValue.md) | | [optional] | -|**eventMaxMemoryThreshold** | [**EventThresholdByPercent**](EventThresholdByPercent.md) | | [optional] | -|**eventMaxTopicsThreshold** | [**EventThresholdByPercent**](EventThresholdByPercent.md) | | [optional] | -|**eventRequestQueueDepthThreshold** | [**EventThresholdByPercent**](EventThresholdByPercent.md) | | [optional] | -|**eventRequestRateThreshold** | [**EventThresholdByValue**](EventThresholdByValue.md) | | [optional] | -|**eventResponseRateThreshold** | [**EventThresholdByValue**](EventThresholdByValue.md) | | [optional] | -|**globalCachingEnabled** | **Boolean** | Enable or disable global caching for the Cache Cluster. When enabled, the Cache Instances will fetch topics from remote Home Cache Clusters when requested, and subscribe to those topics to cache them locally. When disabled, the Cache Instances will remove all subscriptions and cached messages for topics from remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**globalCachingHeartbeat** | **Long** | The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. | [optional] | -|**globalCachingTopicLifetime** | **Long** | The topic lifetime, in seconds. If no client requests are received for a given global topic over the duration of the topic lifetime, then the Cache Instance will remove the subscription and cached messages for that topic. A value of 0 disables aging. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3600`. | [optional] | -|**maxMemory** | **Long** | The maximum memory usage, in megabytes (MB), for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2048`. | [optional] | -|**maxMsgsPerTopic** | **Long** | The maximum number of messages per topic for each Cache Instance in the Cache Cluster. When at the maximum, old messages are removed as new messages arrive. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. | [optional] | -|**maxRequestQueueDepth** | **Long** | The maximum queue depth for cache requests received by the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `100000`. | [optional] | -|**maxTopicCount** | **Long** | The maximum number of topics for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2000000`. | [optional] | -|**msgLifetime** | **Long** | The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the Cache Instance will remove the message. A lifetime of 0 results in the message being retained indefinitely. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**newTopicAdvertisementEnabled** | **Boolean** | Enable or disable the advertising, onto the message bus, of new topics learned by each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.md deleted file mode 100644 index 1c38f0fd8..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# MsgVpnDistributedCacheClusterGlobalCachingHomeCluster - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**cacheName** | **String** | The name of the Distributed Cache. | [optional] | -|**clusterName** | **String** | The name of the Cache Cluster. | [optional] | -|**homeClusterName** | **String** | The name of the remote Home Cache Cluster. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks.md deleted file mode 100644 index 2b896eab9..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**topicPrefixesUri** | **String** | The URI of this Home Cache Cluster's collection of Topic Prefix objects. | [optional] | -|**uri** | **String** | The URI of this Home Cache Cluster object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.md deleted file mode 100644 index 5127d6e48..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnDistributedCacheClusterGlobalCachingHomeCluster**](MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.md) | | [optional] | -|**links** | [**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.md deleted file mode 100644 index 431f5bd6d..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.md +++ /dev/null @@ -1,17 +0,0 @@ - - -# MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**cacheName** | **String** | The name of the Distributed Cache. | [optional] | -|**clusterName** | **String** | The name of the Cache Cluster. | [optional] | -|**homeClusterName** | **String** | The name of the remote Home Cache Cluster. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**topicPrefix** | **String** | A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks.md deleted file mode 100644 index 8a203551b..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Topic Prefix object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.md deleted file mode 100644 index d360924b5..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.md) | | [optional] | -|**links** | [**MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.md deleted file mode 100644 index 06e478796..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix>**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.md) | | [optional] | -|**links** | [**List<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks>**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.md deleted file mode 100644 index 922cba240..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnDistributedCacheClusterGlobalCachingHomeCluster>**](MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.md) | | [optional] | -|**links** | [**List<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks>**](MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterInstance.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterInstance.md deleted file mode 100644 index 0af2641a4..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterInstance.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# MsgVpnDistributedCacheClusterInstance - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**autoStartEnabled** | **Boolean** | Enable or disable auto-start for the Cache Instance. When enabled, the Cache Instance will automatically attempt to transition from the Stopped operational state to Up whenever it restarts or reconnects to the message broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**cacheName** | **String** | The name of the Distributed Cache. | [optional] | -|**clusterName** | **String** | The name of the Cache Cluster. | [optional] | -|**enabled** | **Boolean** | Enable or disable the Cache Instance. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**instanceName** | **String** | The name of the Cache Instance. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**stopOnLostMsgEnabled** | **Boolean** | Enable or disable stop-on-lost-message for the Cache Instance. When enabled, the Cache Instance will transition to the stopped operational state upon losing a message. When stopped, it cannot accept or respond to cache requests, but continues to cache messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterInstanceLinks.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterInstanceLinks.md deleted file mode 100644 index 59421408b..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterInstanceLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnDistributedCacheClusterInstanceLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Cache Instance object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterInstanceResponse.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterInstanceResponse.md deleted file mode 100644 index 3ca0dbab7..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterInstanceResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnDistributedCacheClusterInstanceResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnDistributedCacheClusterInstance**](MsgVpnDistributedCacheClusterInstance.md) | | [optional] | -|**links** | [**MsgVpnDistributedCacheClusterInstanceLinks**](MsgVpnDistributedCacheClusterInstanceLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterInstancesResponse.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterInstancesResponse.md deleted file mode 100644 index f2a5e5dcc..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterInstancesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnDistributedCacheClusterInstancesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnDistributedCacheClusterInstance>**](MsgVpnDistributedCacheClusterInstance.md) | | [optional] | -|**links** | [**List<MsgVpnDistributedCacheClusterInstanceLinks>**](MsgVpnDistributedCacheClusterInstanceLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterLinks.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterLinks.md deleted file mode 100644 index fd9dc560b..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterLinks.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# MsgVpnDistributedCacheClusterLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**globalCachingHomeClustersUri** | **String** | The URI of this Cache Cluster's collection of Home Cache Cluster objects. | [optional] | -|**instancesUri** | **String** | The URI of this Cache Cluster's collection of Cache Instance objects. | [optional] | -|**topicsUri** | **String** | The URI of this Cache Cluster's collection of Topic objects. | [optional] | -|**uri** | **String** | The URI of this Cache Cluster object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterResponse.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterResponse.md deleted file mode 100644 index de188b7bc..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnDistributedCacheClusterResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnDistributedCacheCluster**](MsgVpnDistributedCacheCluster.md) | | [optional] | -|**links** | [**MsgVpnDistributedCacheClusterLinks**](MsgVpnDistributedCacheClusterLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterTopic.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterTopic.md deleted file mode 100644 index bc2077db1..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterTopic.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# MsgVpnDistributedCacheClusterTopic - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**cacheName** | **String** | The name of the Distributed Cache. | [optional] | -|**clusterName** | **String** | The name of the Cache Cluster. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**topic** | **String** | The value of the Topic in the form a/b/c. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterTopicLinks.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterTopicLinks.md deleted file mode 100644 index 0db5f031d..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterTopicLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnDistributedCacheClusterTopicLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Topic object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterTopicResponse.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterTopicResponse.md deleted file mode 100644 index 61e66849f..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterTopicResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnDistributedCacheClusterTopicResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnDistributedCacheClusterTopic**](MsgVpnDistributedCacheClusterTopic.md) | | [optional] | -|**links** | [**MsgVpnDistributedCacheClusterTopicLinks**](MsgVpnDistributedCacheClusterTopicLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterTopicsResponse.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClusterTopicsResponse.md deleted file mode 100644 index 6f3e84b68..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClusterTopicsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnDistributedCacheClusterTopicsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnDistributedCacheClusterTopic>**](MsgVpnDistributedCacheClusterTopic.md) | | [optional] | -|**links** | [**List<MsgVpnDistributedCacheClusterTopicLinks>**](MsgVpnDistributedCacheClusterTopicLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheClustersResponse.md b/service/solace-config-client/docs/MsgVpnDistributedCacheClustersResponse.md deleted file mode 100644 index c8caa4e62..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheClustersResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnDistributedCacheClustersResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnDistributedCacheCluster>**](MsgVpnDistributedCacheCluster.md) | | [optional] | -|**links** | [**List<MsgVpnDistributedCacheClusterLinks>**](MsgVpnDistributedCacheClusterLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheLinks.md b/service/solace-config-client/docs/MsgVpnDistributedCacheLinks.md deleted file mode 100644 index 1116f3697..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheLinks.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# MsgVpnDistributedCacheLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**clustersUri** | **String** | The URI of this Distributed Cache's collection of Cache Cluster objects. | [optional] | -|**uri** | **String** | The URI of this Distributed Cache object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCacheResponse.md b/service/solace-config-client/docs/MsgVpnDistributedCacheResponse.md deleted file mode 100644 index f32c086f3..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCacheResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnDistributedCacheResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnDistributedCache**](MsgVpnDistributedCache.md) | | [optional] | -|**links** | [**MsgVpnDistributedCacheLinks**](MsgVpnDistributedCacheLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnDistributedCachesResponse.md b/service/solace-config-client/docs/MsgVpnDistributedCachesResponse.md deleted file mode 100644 index bf694b302..000000000 --- a/service/solace-config-client/docs/MsgVpnDistributedCachesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnDistributedCachesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnDistributedCache>**](MsgVpnDistributedCache.md) | | [optional] | -|**links** | [**List<MsgVpnDistributedCacheLinks>**](MsgVpnDistributedCacheLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnDmrBridge.md b/service/solace-config-client/docs/MsgVpnDmrBridge.md deleted file mode 100644 index 4d808df8a..000000000 --- a/service/solace-config-client/docs/MsgVpnDmrBridge.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnDmrBridge - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**remoteMsgVpnName** | **String** | The remote Message VPN of the DMR Bridge. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**remoteNodeName** | **String** | The name of the node at the remote end of the DMR Bridge. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnDmrBridgeLinks.md b/service/solace-config-client/docs/MsgVpnDmrBridgeLinks.md deleted file mode 100644 index b1cb88459..000000000 --- a/service/solace-config-client/docs/MsgVpnDmrBridgeLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnDmrBridgeLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this DMR Bridge object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnDmrBridgeResponse.md b/service/solace-config-client/docs/MsgVpnDmrBridgeResponse.md deleted file mode 100644 index c44dc2dd9..000000000 --- a/service/solace-config-client/docs/MsgVpnDmrBridgeResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnDmrBridgeResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnDmrBridge**](MsgVpnDmrBridge.md) | | [optional] | -|**links** | [**MsgVpnDmrBridgeLinks**](MsgVpnDmrBridgeLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnDmrBridgesResponse.md b/service/solace-config-client/docs/MsgVpnDmrBridgesResponse.md deleted file mode 100644 index af5092a64..000000000 --- a/service/solace-config-client/docs/MsgVpnDmrBridgesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnDmrBridgesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnDmrBridge>**](MsgVpnDmrBridge.md) | | [optional] | -|**links** | [**List<MsgVpnDmrBridgeLinks>**](MsgVpnDmrBridgeLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnJndiConnectionFactoriesResponse.md b/service/solace-config-client/docs/MsgVpnJndiConnectionFactoriesResponse.md deleted file mode 100644 index 6690f00f7..000000000 --- a/service/solace-config-client/docs/MsgVpnJndiConnectionFactoriesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnJndiConnectionFactoriesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnJndiConnectionFactory>**](MsgVpnJndiConnectionFactory.md) | | [optional] | -|**links** | [**List<MsgVpnJndiConnectionFactoryLinks>**](MsgVpnJndiConnectionFactoryLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnJndiConnectionFactory.md b/service/solace-config-client/docs/MsgVpnJndiConnectionFactory.md deleted file mode 100644 index 42fa6b2f7..000000000 --- a/service/solace-config-client/docs/MsgVpnJndiConnectionFactory.md +++ /dev/null @@ -1,62 +0,0 @@ - - -# MsgVpnJndiConnectionFactory - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**allowDuplicateClientIdEnabled** | **Boolean** | Enable or disable whether new JMS connections can use the same Client identifier (ID) as an existing connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.3. | [optional] | -|**clientDescription** | **String** | The description of the Client. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**clientId** | **String** | The Client identifier (ID). If not specified, a unique value for it will be generated. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**connectionFactoryName** | **String** | The name of the JMS Connection Factory. | [optional] | -|**dtoReceiveOverrideEnabled** | **Boolean** | Enable or disable overriding by the Subscriber (Consumer) of the deliver-to-one (DTO) property on messages. When enabled, the Subscriber can receive all DTO tagged messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**dtoReceiveSubscriberLocalPriority** | **Integer** | The priority for receiving deliver-to-one (DTO) messages by the Subscriber (Consumer) if the messages are published on the local broker that the Subscriber is directly connected to. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. | [optional] | -|**dtoReceiveSubscriberNetworkPriority** | **Integer** | The priority for receiving deliver-to-one (DTO) messages by the Subscriber (Consumer) if the messages are published on a remote broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. | [optional] | -|**dtoSendEnabled** | **Boolean** | Enable or disable the deliver-to-one (DTO) property on messages sent by the Publisher (Producer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**dynamicEndpointCreateDurableEnabled** | **Boolean** | Enable or disable whether a durable endpoint will be dynamically created on the broker when the client calls \"Session.createDurableSubscriber()\" or \"Session.createQueue()\". The created endpoint respects the message time-to-live (TTL) according to the \"dynamicEndpointRespectTtlEnabled\" property. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**dynamicEndpointRespectTtlEnabled** | **Boolean** | Enable or disable whether dynamically created durable and non-durable endpoints respect the message time-to-live (TTL) property. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**guaranteedReceiveAckTimeout** | **Integer** | The timeout for sending the acknowledgement (ACK) for guaranteed messages received by the Subscriber (Consumer), in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. | [optional] | -|**guaranteedReceiveReconnectRetryCount** | **Integer** | The maximum number of attempts to reconnect to the host or list of hosts after the guaranteed messaging connection has been lost. The value \"-1\" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. Available since 2.14. | [optional] | -|**guaranteedReceiveReconnectRetryWait** | **Integer** | The amount of time to wait before making another attempt to connect or reconnect to the host after the guaranteed messaging connection has been lost, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`. Available since 2.14. | [optional] | -|**guaranteedReceiveWindowSize** | **Integer** | The size of the window for guaranteed messages received by the Subscriber (Consumer), in messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `18`. | [optional] | -|**guaranteedReceiveWindowSizeAckThreshold** | **Integer** | The threshold for sending the acknowledgement (ACK) for guaranteed messages received by the Subscriber (Consumer) as a percentage of `guaranteedReceiveWindowSize`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `60`. | [optional] | -|**guaranteedSendAckTimeout** | **Integer** | The timeout for receiving the acknowledgement (ACK) for guaranteed messages sent by the Publisher (Producer), in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2000`. | [optional] | -|**guaranteedSendWindowSize** | **Integer** | The size of the window for non-persistent guaranteed messages sent by the Publisher (Producer), in messages. For persistent messages the window size is fixed at 1. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`. | [optional] | -|**messagingDefaultDeliveryMode** | [**MessagingDefaultDeliveryModeEnum**](#MessagingDefaultDeliveryModeEnum) | The default delivery mode for messages sent by the Publisher (Producer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"persistent\"`. The allowed values and their meaning are: <pre> \"persistent\" - The broker spools messages (persists in the Message Spool) as part of the send operation. \"non-persistent\" - The broker does not spool messages (does not persist in the Message Spool) as part of the send operation. </pre> | [optional] | -|**messagingDefaultDmqEligibleEnabled** | **Boolean** | Enable or disable whether messages sent by the Publisher (Producer) are Dead Message Queue (DMQ) eligible by default. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**messagingDefaultElidingEligibleEnabled** | **Boolean** | Enable or disable whether messages sent by the Publisher (Producer) are Eliding eligible by default. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**messagingJmsxUserIdEnabled** | **Boolean** | Enable or disable inclusion (adding or replacing) of the JMSXUserID property in messages sent by the Publisher (Producer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**messagingTextInXmlPayloadEnabled** | **Boolean** | Enable or disable encoding of JMS text messages in Publisher (Producer) messages as XML payload. When disabled, JMS text messages are encoded as a binary attachment. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**transportCompressionLevel** | **Integer** | The ZLIB compression level for the connection to the broker. The value \"0\" means no compression, and the value \"-1\" means the compression level is specified in the JNDI Properties file. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. | [optional] | -|**transportConnectRetryCount** | **Integer** | The maximum number of retry attempts to establish an initial connection to the host or list of hosts. The value \"0\" means a single attempt (no retries), and the value \"-1\" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**transportConnectRetryPerHostCount** | **Integer** | The maximum number of retry attempts to establish an initial connection to each host on the list of hosts. The value \"0\" means a single attempt (no retries), and the value \"-1\" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**transportConnectTimeout** | **Integer** | The timeout for establishing an initial connection to the broker, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30000`. | [optional] | -|**transportDirectTransportEnabled** | **Boolean** | Enable or disable usage of the Direct Transport mode for sending non-persistent messages. When disabled, the Guaranteed Transport mode is used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**transportKeepaliveCount** | **Integer** | The maximum number of consecutive application-level keepalive messages sent without the broker response before the connection to the broker is closed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. | [optional] | -|**transportKeepaliveEnabled** | **Boolean** | Enable or disable usage of application-level keepalive messages to maintain a connection with the broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**transportKeepaliveInterval** | **Integer** | The interval between application-level keepalive messages, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`. | [optional] | -|**transportMsgCallbackOnIoThreadEnabled** | **Boolean** | Enable or disable delivery of asynchronous messages directly from the I/O thread. Contact support before enabling this property. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**transportOptimizeDirectEnabled** | **Boolean** | Enable or disable optimization for the Direct Transport delivery mode. If enabled, the client application is limited to one Publisher (Producer) and one non-durable Subscriber (Consumer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**transportPort** | **Integer** | The connection port number on the broker for SMF clients. The value \"-1\" means the port is specified in the JNDI Properties file. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. | [optional] | -|**transportReadTimeout** | **Integer** | The timeout for reading a reply from the broker, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. | [optional] | -|**transportReceiveBufferSize** | **Integer** | The size of the receive socket buffer, in bytes. It corresponds to the SO_RCVBUF socket option. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `65536`. | [optional] | -|**transportReconnectRetryCount** | **Integer** | The maximum number of attempts to reconnect to the host or list of hosts after the connection has been lost. The value \"-1\" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. | [optional] | -|**transportReconnectRetryWait** | **Integer** | The amount of time before making another attempt to connect or reconnect to the host after the connection has been lost, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`. | [optional] | -|**transportSendBufferSize** | **Integer** | The size of the send socket buffer, in bytes. It corresponds to the SO_SNDBUF socket option. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `65536`. | [optional] | -|**transportTcpNoDelayEnabled** | **Boolean** | Enable or disable the TCP_NODELAY option. When enabled, Nagle's algorithm for TCP/IP congestion control (RFC 896) is disabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**xaEnabled** | **Boolean** | Enable or disable this as an XA Connection Factory. When enabled, the Connection Factory can be cast to \"XAConnectionFactory\", \"XAQueueConnectionFactory\" or \"XATopicConnectionFactory\". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | - - - -## Enum: MessagingDefaultDeliveryModeEnum - -| Name | Value | -|---- | -----| -| PERSISTENT | "persistent" | -| NON_PERSISTENT | "non-persistent" | - - - diff --git a/service/solace-config-client/docs/MsgVpnJndiConnectionFactoryLinks.md b/service/solace-config-client/docs/MsgVpnJndiConnectionFactoryLinks.md deleted file mode 100644 index 5c07ebc1a..000000000 --- a/service/solace-config-client/docs/MsgVpnJndiConnectionFactoryLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnJndiConnectionFactoryLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this JNDI Connection Factory object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnJndiConnectionFactoryResponse.md b/service/solace-config-client/docs/MsgVpnJndiConnectionFactoryResponse.md deleted file mode 100644 index b3073af96..000000000 --- a/service/solace-config-client/docs/MsgVpnJndiConnectionFactoryResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnJndiConnectionFactoryResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnJndiConnectionFactory**](MsgVpnJndiConnectionFactory.md) | | [optional] | -|**links** | [**MsgVpnJndiConnectionFactoryLinks**](MsgVpnJndiConnectionFactoryLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnJndiQueue.md b/service/solace-config-client/docs/MsgVpnJndiQueue.md deleted file mode 100644 index f12b9f995..000000000 --- a/service/solace-config-client/docs/MsgVpnJndiQueue.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnJndiQueue - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**physicalName** | **String** | The physical name of the JMS Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**queueName** | **String** | The JNDI name of the JMS Queue. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnJndiQueueLinks.md b/service/solace-config-client/docs/MsgVpnJndiQueueLinks.md deleted file mode 100644 index 0b3350308..000000000 --- a/service/solace-config-client/docs/MsgVpnJndiQueueLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnJndiQueueLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this JNDI Queue object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnJndiQueueResponse.md b/service/solace-config-client/docs/MsgVpnJndiQueueResponse.md deleted file mode 100644 index 0b50257bb..000000000 --- a/service/solace-config-client/docs/MsgVpnJndiQueueResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnJndiQueueResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnJndiQueue**](MsgVpnJndiQueue.md) | | [optional] | -|**links** | [**MsgVpnJndiQueueLinks**](MsgVpnJndiQueueLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnJndiQueuesResponse.md b/service/solace-config-client/docs/MsgVpnJndiQueuesResponse.md deleted file mode 100644 index d9c297310..000000000 --- a/service/solace-config-client/docs/MsgVpnJndiQueuesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnJndiQueuesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnJndiQueue>**](MsgVpnJndiQueue.md) | | [optional] | -|**links** | [**List<MsgVpnJndiQueueLinks>**](MsgVpnJndiQueueLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnJndiTopic.md b/service/solace-config-client/docs/MsgVpnJndiTopic.md deleted file mode 100644 index 76b95d512..000000000 --- a/service/solace-config-client/docs/MsgVpnJndiTopic.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnJndiTopic - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**physicalName** | **String** | The physical name of the JMS Topic. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**topicName** | **String** | The JNDI name of the JMS Topic. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnJndiTopicLinks.md b/service/solace-config-client/docs/MsgVpnJndiTopicLinks.md deleted file mode 100644 index 69b3c79f3..000000000 --- a/service/solace-config-client/docs/MsgVpnJndiTopicLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnJndiTopicLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this JNDI Topic object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnJndiTopicResponse.md b/service/solace-config-client/docs/MsgVpnJndiTopicResponse.md deleted file mode 100644 index efb9eaa1c..000000000 --- a/service/solace-config-client/docs/MsgVpnJndiTopicResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnJndiTopicResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnJndiTopic**](MsgVpnJndiTopic.md) | | [optional] | -|**links** | [**MsgVpnJndiTopicLinks**](MsgVpnJndiTopicLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnJndiTopicsResponse.md b/service/solace-config-client/docs/MsgVpnJndiTopicsResponse.md deleted file mode 100644 index 592ad6fab..000000000 --- a/service/solace-config-client/docs/MsgVpnJndiTopicsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnJndiTopicsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnJndiTopic>**](MsgVpnJndiTopic.md) | | [optional] | -|**links** | [**List<MsgVpnJndiTopicLinks>**](MsgVpnJndiTopicLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnLinks.md b/service/solace-config-client/docs/MsgVpnLinks.md deleted file mode 100644 index 0ce59bc92..000000000 --- a/service/solace-config-client/docs/MsgVpnLinks.md +++ /dev/null @@ -1,36 +0,0 @@ - - -# MsgVpnLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**aclProfilesUri** | **String** | The URI of this Message VPN's collection of ACL Profile objects. | [optional] | -|**authenticationOauthProfilesUri** | **String** | The URI of this Message VPN's collection of OAuth Profile objects. Available since 2.25. | [optional] | -|**authenticationOauthProvidersUri** | **String** | The URI of this Message VPN's collection of OAuth Provider objects. Deprecated since 2.25. Replaced by authenticationOauthProfiles. | [optional] | -|**authorizationGroupsUri** | **String** | The URI of this Message VPN's collection of Authorization Group objects. | [optional] | -|**bridgesUri** | **String** | The URI of this Message VPN's collection of Bridge objects. | [optional] | -|**certMatchingRulesUri** | **String** | The URI of this Message VPN's collection of Certificate Matching Rule objects. Available since 2.27. | [optional] | -|**clientProfilesUri** | **String** | The URI of this Message VPN's collection of Client Profile objects. | [optional] | -|**clientUsernamesUri** | **String** | The URI of this Message VPN's collection of Client Username objects. | [optional] | -|**distributedCachesUri** | **String** | The URI of this Message VPN's collection of Distributed Cache objects. Available since 2.11. | [optional] | -|**dmrBridgesUri** | **String** | The URI of this Message VPN's collection of DMR Bridge objects. Available since 2.11. | [optional] | -|**jndiConnectionFactoriesUri** | **String** | The URI of this Message VPN's collection of JNDI Connection Factory objects. Available since 2.2. | [optional] | -|**jndiQueuesUri** | **String** | The URI of this Message VPN's collection of JNDI Queue objects. Available since 2.2. | [optional] | -|**jndiTopicsUri** | **String** | The URI of this Message VPN's collection of JNDI Topic objects. Available since 2.2. | [optional] | -|**mqttRetainCachesUri** | **String** | The URI of this Message VPN's collection of MQTT Retain Cache objects. Available since 2.11. | [optional] | -|**mqttSessionsUri** | **String** | The URI of this Message VPN's collection of MQTT Session objects. Available since 2.1. | [optional] | -|**queueTemplatesUri** | **String** | The URI of this Message VPN's collection of Queue Template objects. Available since 2.14. | [optional] | -|**queuesUri** | **String** | The URI of this Message VPN's collection of Queue objects. | [optional] | -|**replayLogsUri** | **String** | The URI of this Message VPN's collection of Replay Log objects. Available since 2.10. | [optional] | -|**replicatedTopicsUri** | **String** | The URI of this Message VPN's collection of Replicated Topic objects. Available since 2.1. | [optional] | -|**restDeliveryPointsUri** | **String** | The URI of this Message VPN's collection of REST Delivery Point objects. | [optional] | -|**sequencedTopicsUri** | **String** | The URI of this Message VPN's collection of Sequenced Topic objects. | [optional] | -|**topicEndpointTemplatesUri** | **String** | The URI of this Message VPN's collection of Topic Endpoint Template objects. Available since 2.14. | [optional] | -|**topicEndpointsUri** | **String** | The URI of this Message VPN's collection of Topic Endpoint objects. Available since 2.1. | [optional] | -|**uri** | **String** | The URI of this Message VPN object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnMqttRetainCache.md b/service/solace-config-client/docs/MsgVpnMqttRetainCache.md deleted file mode 100644 index 8fb05c594..000000000 --- a/service/solace-config-client/docs/MsgVpnMqttRetainCache.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# MsgVpnMqttRetainCache - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**cacheName** | **String** | The name of the MQTT Retain Cache. | [optional] | -|**enabled** | **Boolean** | Enable or disable this MQTT Retain Cache. When the cache is disabled, neither retain messages nor retain requests will be delivered by the cache. However, live retain messages will continue to be delivered to currently connected MQTT clients. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**msgLifetime** | **Long** | The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the cache will remove the message. A lifetime of 0 results in the message being retained indefinitely, otherwise it must be 3 seconds or more. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnMqttRetainCacheLinks.md b/service/solace-config-client/docs/MsgVpnMqttRetainCacheLinks.md deleted file mode 100644 index d0f4e566b..000000000 --- a/service/solace-config-client/docs/MsgVpnMqttRetainCacheLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnMqttRetainCacheLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this MQTT Retain Cache object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnMqttRetainCacheResponse.md b/service/solace-config-client/docs/MsgVpnMqttRetainCacheResponse.md deleted file mode 100644 index cc317c8b8..000000000 --- a/service/solace-config-client/docs/MsgVpnMqttRetainCacheResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnMqttRetainCacheResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnMqttRetainCache**](MsgVpnMqttRetainCache.md) | | [optional] | -|**links** | [**MsgVpnMqttRetainCacheLinks**](MsgVpnMqttRetainCacheLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnMqttRetainCachesResponse.md b/service/solace-config-client/docs/MsgVpnMqttRetainCachesResponse.md deleted file mode 100644 index 0bde809d0..000000000 --- a/service/solace-config-client/docs/MsgVpnMqttRetainCachesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnMqttRetainCachesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnMqttRetainCache>**](MsgVpnMqttRetainCache.md) | | [optional] | -|**links** | [**List<MsgVpnMqttRetainCacheLinks>**](MsgVpnMqttRetainCacheLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnMqttSession.md b/service/solace-config-client/docs/MsgVpnMqttSession.md deleted file mode 100644 index 3acc52bb2..000000000 --- a/service/solace-config-client/docs/MsgVpnMqttSession.md +++ /dev/null @@ -1,52 +0,0 @@ - - -# MsgVpnMqttSession - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**enabled** | **Boolean** | Enable or disable the MQTT Session. When disabled, the client is disconnected, new messages matching QoS 0 subscriptions are discarded, and new messages matching QoS 1 subscriptions are stored for future delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**mqttSessionClientId** | **String** | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | [optional] | -|**mqttSessionVirtualRouter** | [**MqttSessionVirtualRouterEnum**](#MqttSessionVirtualRouterEnum) | The virtual router of the MQTT Session. The allowed values and their meaning are: <pre> \"primary\" - The MQTT Session belongs to the primary virtual router. \"backup\" - The MQTT Session belongs to the backup virtual router. \"auto\" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**owner** | **String** | The owner of the MQTT Session. For externally-created sessions this defaults to the Client Username of the connecting client. For management-created sessions this defaults to empty. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**queueConsumerAckPropagationEnabled** | **Boolean** | Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.14. | [optional] | -|**queueDeadMsgQueue** | **String** | The name of the Dead Message Queue (DMQ) used by the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.14. | [optional] | -|**queueEventBindCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**queueEventMsgSpoolUsageThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**queueEventRejectLowPriorityMsgLimitThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**queueMaxBindCount** | **Long** | The maximum number of consumer flows that can bind to the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since 2.14. | [optional] | -|**queueMaxDeliveredUnackedMsgsPerFlow** | **Long** | The maximum number of messages delivered but not acknowledged per flow for the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. Available since 2.14. | [optional] | -|**queueMaxMsgSize** | **Integer** | The maximum message size allowed in the MQTT Session Queue, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. Available since 2.14. | [optional] | -|**queueMaxMsgSpoolUsage** | **Long** | The maximum message spool usage allowed by the MQTT Session Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`. Available since 2.14. | [optional] | -|**queueMaxRedeliveryCount** | **Long** | The maximum number of times the MQTT Session Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14. | [optional] | -|**queueMaxTtl** | **Long** | The maximum time in seconds a message can stay in the MQTT Session Queue when `queueRespectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `queueMaxTtl` configured for the MQTT Session Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14. | [optional] | -|**queueRejectLowPriorityMsgEnabled** | **Boolean** | Enable or disable the checking of low priority messages against the `queueRejectLowPriorityMsgLimit`. This may only be enabled if `queueRejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.14. | [optional] | -|**queueRejectLowPriorityMsgLimit** | **Long** | The number of messages of any priority in the MQTT Session Queue above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14. | [optional] | -|**queueRejectMsgToSenderOnDiscardBehavior** | [**QueueRejectMsgToSenderOnDiscardBehaviorEnum**](#QueueRejectMsgToSenderOnDiscardBehaviorEnum) | Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-queue-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> Available since 2.14. | [optional] | -|**queueRespectTtlEnabled** | **Boolean** | Enable or disable the respecting of the time-to-live (TTL) for messages in the MQTT Session Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.14. | [optional] | - - - -## Enum: MqttSessionVirtualRouterEnum - -| Name | Value | -|---- | -----| -| PRIMARY | "primary" | -| BACKUP | "backup" | -| AUTO | "auto" | - - - -## Enum: QueueRejectMsgToSenderOnDiscardBehaviorEnum - -| Name | Value | -|---- | -----| -| ALWAYS | "always" | -| WHEN_QUEUE_ENABLED | "when-queue-enabled" | -| NEVER | "never" | - - - diff --git a/service/solace-config-client/docs/MsgVpnMqttSessionLinks.md b/service/solace-config-client/docs/MsgVpnMqttSessionLinks.md deleted file mode 100644 index b92995b70..000000000 --- a/service/solace-config-client/docs/MsgVpnMqttSessionLinks.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# MsgVpnMqttSessionLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**subscriptionsUri** | **String** | The URI of this MQTT Session's collection of Subscription objects. | [optional] | -|**uri** | **String** | The URI of this MQTT Session object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnMqttSessionResponse.md b/service/solace-config-client/docs/MsgVpnMqttSessionResponse.md deleted file mode 100644 index 373b8ed38..000000000 --- a/service/solace-config-client/docs/MsgVpnMqttSessionResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnMqttSessionResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnMqttSession**](MsgVpnMqttSession.md) | | [optional] | -|**links** | [**MsgVpnMqttSessionLinks**](MsgVpnMqttSessionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnMqttSessionSubscription.md b/service/solace-config-client/docs/MsgVpnMqttSessionSubscription.md deleted file mode 100644 index 1e5ad56bc..000000000 --- a/service/solace-config-client/docs/MsgVpnMqttSessionSubscription.md +++ /dev/null @@ -1,27 +0,0 @@ - - -# MsgVpnMqttSessionSubscription - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**mqttSessionClientId** | **String** | The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. | [optional] | -|**mqttSessionVirtualRouter** | [**MqttSessionVirtualRouterEnum**](#MqttSessionVirtualRouterEnum) | The virtual router of the MQTT Session. The allowed values and their meaning are: <pre> \"primary\" - The MQTT Session belongs to the primary virtual router. \"backup\" - The MQTT Session belongs to the backup virtual router. \"auto\" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**subscriptionQos** | **Long** | The quality of service (QoS) for the subscription as either 0 (deliver at most once) or 1 (deliver at least once). QoS 2 is not supported, but QoS 2 messages attracted by QoS 0 or QoS 1 subscriptions are accepted and delivered accordingly. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**subscriptionTopic** | **String** | The MQTT subscription topic. | [optional] | - - - -## Enum: MqttSessionVirtualRouterEnum - -| Name | Value | -|---- | -----| -| PRIMARY | "primary" | -| BACKUP | "backup" | -| AUTO | "auto" | - - - diff --git a/service/solace-config-client/docs/MsgVpnMqttSessionSubscriptionLinks.md b/service/solace-config-client/docs/MsgVpnMqttSessionSubscriptionLinks.md deleted file mode 100644 index 4c57ca5e0..000000000 --- a/service/solace-config-client/docs/MsgVpnMqttSessionSubscriptionLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnMqttSessionSubscriptionLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Subscription object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnMqttSessionSubscriptionResponse.md b/service/solace-config-client/docs/MsgVpnMqttSessionSubscriptionResponse.md deleted file mode 100644 index b6db3d0c8..000000000 --- a/service/solace-config-client/docs/MsgVpnMqttSessionSubscriptionResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnMqttSessionSubscriptionResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnMqttSessionSubscription**](MsgVpnMqttSessionSubscription.md) | | [optional] | -|**links** | [**MsgVpnMqttSessionSubscriptionLinks**](MsgVpnMqttSessionSubscriptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnMqttSessionSubscriptionsResponse.md b/service/solace-config-client/docs/MsgVpnMqttSessionSubscriptionsResponse.md deleted file mode 100644 index df992584a..000000000 --- a/service/solace-config-client/docs/MsgVpnMqttSessionSubscriptionsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnMqttSessionSubscriptionsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnMqttSessionSubscription>**](MsgVpnMqttSessionSubscription.md) | | [optional] | -|**links** | [**List<MsgVpnMqttSessionSubscriptionLinks>**](MsgVpnMqttSessionSubscriptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnMqttSessionsResponse.md b/service/solace-config-client/docs/MsgVpnMqttSessionsResponse.md deleted file mode 100644 index cd1214908..000000000 --- a/service/solace-config-client/docs/MsgVpnMqttSessionsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnMqttSessionsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnMqttSession>**](MsgVpnMqttSession.md) | | [optional] | -|**links** | [**List<MsgVpnMqttSessionLinks>**](MsgVpnMqttSessionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnQueue.md b/service/solace-config-client/docs/MsgVpnQueue.md deleted file mode 100644 index 456050a8e..000000000 --- a/service/solace-config-client/docs/MsgVpnQueue.md +++ /dev/null @@ -1,69 +0,0 @@ - - -# MsgVpnQueue - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**accessType** | [**AccessTypeEnum**](#AccessTypeEnum) | The access type for delivering messages to consumer flows bound to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are: <pre> \"exclusive\" - Exclusive delivery of messages to the first bound consumer flow. \"non-exclusive\" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion. </pre> | [optional] | -|**consumerAckPropagationEnabled** | **Boolean** | Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**deadMsgQueue** | **String** | The name of the Dead Message Queue (DMQ) used by the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.2. | [optional] | -|**deliveryCountEnabled** | **Boolean** | Enable or disable the ability for client applications to query the message delivery count of messages received from the Queue. This is a controlled availability feature. Please contact support to find out if this feature is supported for your use case. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.19. | [optional] | -|**deliveryDelay** | **Long** | The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22. | [optional] | -|**egressEnabled** | **Boolean** | Enable or disable the transmission of messages from the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**eventBindCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventMsgSpoolUsageThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventRejectLowPriorityMsgLimitThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**ingressEnabled** | **Boolean** | Enable or disable the reception of messages to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**maxBindCount** | **Long** | The maximum number of consumer flows that can bind to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. | [optional] | -|**maxDeliveredUnackedMsgsPerFlow** | **Long** | The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. | [optional] | -|**maxMsgSize** | **Integer** | The maximum message size allowed in the Queue, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. | [optional] | -|**maxMsgSpoolUsage** | **Long** | The maximum message spool usage allowed by the Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`. | [optional] | -|**maxRedeliveryCount** | **Long** | The maximum number of times the Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**maxTtl** | **Long** | The maximum time in seconds a message can stay in the Queue when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**owner** | **String** | The Client Username that owns the Queue and has permission equivalent to `\"delete\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**permission** | [**PermissionEnum**](#PermissionEnum) | The permission level for all consumers of the Queue, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are: <pre> \"no-access\" - Disallows all access. \"read-only\" - Read-only access to the messages. \"consume\" - Consume (read and remove) messages. \"modify-topic\" - Consume messages or modify the topic/selector. \"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. </pre> | [optional] | -|**queueName** | **String** | The name of the Queue. | [optional] | -|**redeliveryEnabled** | **Boolean** | Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the queue more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18. | [optional] | -|**rejectLowPriorityMsgEnabled** | **Boolean** | Enable or disable the checking of low priority messages against the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**rejectLowPriorityMsgLimit** | **Long** | The number of messages of any priority in the Queue above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**rejectMsgToSenderOnDiscardBehavior** | [**RejectMsgToSenderOnDiscardBehaviorEnum**](#RejectMsgToSenderOnDiscardBehaviorEnum) | Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-queue-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> Available since 2.1. | [optional] | -|**respectMsgPriorityEnabled** | **Boolean** | Enable or disable the respecting of message priority. When enabled, messages contained in the Queue are delivered in priority order, from 9 (highest) to 0 (lowest). MQTT queues do not support enabling message priority. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.8. | [optional] | -|**respectTtlEnabled** | **Boolean** | Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | - - - -## Enum: AccessTypeEnum - -| Name | Value | -|---- | -----| -| EXCLUSIVE | "exclusive" | -| NON_EXCLUSIVE | "non-exclusive" | - - - -## Enum: PermissionEnum - -| Name | Value | -|---- | -----| -| NO_ACCESS | "no-access" | -| READ_ONLY | "read-only" | -| CONSUME | "consume" | -| MODIFY_TOPIC | "modify-topic" | -| DELETE | "delete" | - - - -## Enum: RejectMsgToSenderOnDiscardBehaviorEnum - -| Name | Value | -|---- | -----| -| ALWAYS | "always" | -| WHEN_QUEUE_ENABLED | "when-queue-enabled" | -| NEVER | "never" | - - - diff --git a/service/solace-config-client/docs/MsgVpnQueueLinks.md b/service/solace-config-client/docs/MsgVpnQueueLinks.md deleted file mode 100644 index 42c7511df..000000000 --- a/service/solace-config-client/docs/MsgVpnQueueLinks.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# MsgVpnQueueLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**subscriptionsUri** | **String** | The URI of this Queue's collection of Queue Subscription objects. | [optional] | -|**uri** | **String** | The URI of this Queue object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnQueueResponse.md b/service/solace-config-client/docs/MsgVpnQueueResponse.md deleted file mode 100644 index f21a304a2..000000000 --- a/service/solace-config-client/docs/MsgVpnQueueResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnQueueResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnQueue**](MsgVpnQueue.md) | | [optional] | -|**links** | [**MsgVpnQueueLinks**](MsgVpnQueueLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnQueueSubscription.md b/service/solace-config-client/docs/MsgVpnQueueSubscription.md deleted file mode 100644 index 6423cecbb..000000000 --- a/service/solace-config-client/docs/MsgVpnQueueSubscription.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnQueueSubscription - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**queueName** | **String** | The name of the Queue. | [optional] | -|**subscriptionTopic** | **String** | The topic of the Subscription. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnQueueSubscriptionLinks.md b/service/solace-config-client/docs/MsgVpnQueueSubscriptionLinks.md deleted file mode 100644 index d525d20cb..000000000 --- a/service/solace-config-client/docs/MsgVpnQueueSubscriptionLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnQueueSubscriptionLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Queue Subscription object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnQueueSubscriptionResponse.md b/service/solace-config-client/docs/MsgVpnQueueSubscriptionResponse.md deleted file mode 100644 index 13157a5ce..000000000 --- a/service/solace-config-client/docs/MsgVpnQueueSubscriptionResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnQueueSubscriptionResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnQueueSubscription**](MsgVpnQueueSubscription.md) | | [optional] | -|**links** | [**MsgVpnQueueSubscriptionLinks**](MsgVpnQueueSubscriptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnQueueSubscriptionsResponse.md b/service/solace-config-client/docs/MsgVpnQueueSubscriptionsResponse.md deleted file mode 100644 index 8c5b42d69..000000000 --- a/service/solace-config-client/docs/MsgVpnQueueSubscriptionsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnQueueSubscriptionsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnQueueSubscription>**](MsgVpnQueueSubscription.md) | | [optional] | -|**links** | [**List<MsgVpnQueueSubscriptionLinks>**](MsgVpnQueueSubscriptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnQueueTemplate.md b/service/solace-config-client/docs/MsgVpnQueueTemplate.md deleted file mode 100644 index 74b035575..000000000 --- a/service/solace-config-client/docs/MsgVpnQueueTemplate.md +++ /dev/null @@ -1,76 +0,0 @@ - - -# MsgVpnQueueTemplate - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**accessType** | [**AccessTypeEnum**](#AccessTypeEnum) | The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are: <pre> \"exclusive\" - Exclusive delivery of messages to the first bound consumer flow. \"non-exclusive\" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion. </pre> | [optional] | -|**consumerAckPropagationEnabled** | **Boolean** | Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**deadMsgQueue** | **String** | The name of the Dead Message Queue (DMQ). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. | [optional] | -|**deliveryDelay** | **Long** | The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. This attribute does not apply to MQTT queues created from this template, but it may apply in future releases. Therefore, to maintain forward compatibility, do not set this value on templates that might be used for MQTT queues. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22. | [optional] | -|**durabilityOverride** | [**DurabilityOverrideEnum**](#DurabilityOverrideEnum) | Controls the durability of queues created from this template. If non-durable, the created queue will be non-durable, regardless of the specified durability. If none, the created queue will have the requested durability. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - The durability of the endpoint will be as requested on create. \"non-durable\" - The durability of the created queue will be non-durable, regardless of what was requested. </pre> | [optional] | -|**eventBindCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventMsgSpoolUsageThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventRejectLowPriorityMsgLimitThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**maxBindCount** | **Long** | The maximum number of consumer flows that can bind. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. | [optional] | -|**maxDeliveredUnackedMsgsPerFlow** | **Long** | The maximum number of messages delivered but not acknowledged per flow. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. | [optional] | -|**maxMsgSize** | **Integer** | The maximum message size allowed, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. | [optional] | -|**maxMsgSpoolUsage** | **Long** | The maximum message spool usage allowed, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`. | [optional] | -|**maxRedeliveryCount** | **Long** | The maximum number of message redelivery attempts that will occur prior to the message being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**maxTtl** | **Long** | The maximum time in seconds a message can stay in a Queue when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**permission** | [**PermissionEnum**](#PermissionEnum) | The permission level for all consumers, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are: <pre> \"no-access\" - Disallows all access. \"read-only\" - Read-only access to the messages. \"consume\" - Consume (read and remove) messages. \"modify-topic\" - Consume messages or modify the topic/selector. \"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. </pre> | [optional] | -|**queueNameFilter** | **String** | A wildcardable pattern used to determine which Queues use settings from this Template. Two different wildcards are supported: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**queueTemplateName** | **String** | The name of the Queue Template. | [optional] | -|**redeliveryEnabled** | **Boolean** | Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the queue more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18. | [optional] | -|**rejectLowPriorityMsgEnabled** | **Boolean** | Enable or disable the checking of low priority messages against the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**rejectLowPriorityMsgLimit** | **Long** | The number of messages of any priority above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**rejectMsgToSenderOnDiscardBehavior** | [**RejectMsgToSenderOnDiscardBehaviorEnum**](#RejectMsgToSenderOnDiscardBehaviorEnum) | Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs prevent the message from being delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-queue-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> | [optional] | -|**respectMsgPriorityEnabled** | **Boolean** | Enable or disable the respecting of message priority. When enabled, messages are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**respectTtlEnabled** | **Boolean** | Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | - - - -## Enum: AccessTypeEnum - -| Name | Value | -|---- | -----| -| EXCLUSIVE | "exclusive" | -| NON_EXCLUSIVE | "non-exclusive" | - - - -## Enum: DurabilityOverrideEnum - -| Name | Value | -|---- | -----| -| NONE | "none" | -| NON_DURABLE | "non-durable" | - - - -## Enum: PermissionEnum - -| Name | Value | -|---- | -----| -| NO_ACCESS | "no-access" | -| READ_ONLY | "read-only" | -| CONSUME | "consume" | -| MODIFY_TOPIC | "modify-topic" | -| DELETE | "delete" | - - - -## Enum: RejectMsgToSenderOnDiscardBehaviorEnum - -| Name | Value | -|---- | -----| -| ALWAYS | "always" | -| WHEN_QUEUE_ENABLED | "when-queue-enabled" | -| NEVER | "never" | - - - diff --git a/service/solace-config-client/docs/MsgVpnQueueTemplateLinks.md b/service/solace-config-client/docs/MsgVpnQueueTemplateLinks.md deleted file mode 100644 index 1196898a7..000000000 --- a/service/solace-config-client/docs/MsgVpnQueueTemplateLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnQueueTemplateLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Queue Template object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnQueueTemplateResponse.md b/service/solace-config-client/docs/MsgVpnQueueTemplateResponse.md deleted file mode 100644 index e17869d96..000000000 --- a/service/solace-config-client/docs/MsgVpnQueueTemplateResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnQueueTemplateResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnQueueTemplate**](MsgVpnQueueTemplate.md) | | [optional] | -|**links** | [**MsgVpnQueueTemplateLinks**](MsgVpnQueueTemplateLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnQueueTemplatesResponse.md b/service/solace-config-client/docs/MsgVpnQueueTemplatesResponse.md deleted file mode 100644 index 0096e3eb3..000000000 --- a/service/solace-config-client/docs/MsgVpnQueueTemplatesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnQueueTemplatesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnQueueTemplate>**](MsgVpnQueueTemplate.md) | | [optional] | -|**links** | [**List<MsgVpnQueueTemplateLinks>**](MsgVpnQueueTemplateLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnQueuesResponse.md b/service/solace-config-client/docs/MsgVpnQueuesResponse.md deleted file mode 100644 index 7a6c39acf..000000000 --- a/service/solace-config-client/docs/MsgVpnQueuesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnQueuesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnQueue>**](MsgVpnQueue.md) | | [optional] | -|**links** | [**List<MsgVpnQueueLinks>**](MsgVpnQueueLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnReplayLog.md b/service/solace-config-client/docs/MsgVpnReplayLog.md deleted file mode 100644 index 9b8cf77fe..000000000 --- a/service/solace-config-client/docs/MsgVpnReplayLog.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# MsgVpnReplayLog - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**egressEnabled** | **Boolean** | Enable or disable the transmission of messages from the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**ingressEnabled** | **Boolean** | Enable or disable the reception of messages to the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**maxSpoolUsage** | **Long** | The maximum spool usage allowed by the Replay Log, in megabytes (MB). If this limit is exceeded, old messages will be trimmed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**replayLogName** | **String** | The name of the Replay Log. | [optional] | -|**topicFilterEnabled** | **Boolean** | Enable or disable topic filtering for the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.27. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnReplayLogLinks.md b/service/solace-config-client/docs/MsgVpnReplayLogLinks.md deleted file mode 100644 index 55166afa2..000000000 --- a/service/solace-config-client/docs/MsgVpnReplayLogLinks.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# MsgVpnReplayLogLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**topicFilterSubscriptionsUri** | **String** | The URI of this Replay Log's collection of Topic Filter Subscription objects. Available since 2.27. | [optional] | -|**uri** | **String** | The URI of this Replay Log object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnReplayLogResponse.md b/service/solace-config-client/docs/MsgVpnReplayLogResponse.md deleted file mode 100644 index 209eb591a..000000000 --- a/service/solace-config-client/docs/MsgVpnReplayLogResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnReplayLogResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnReplayLog**](MsgVpnReplayLog.md) | | [optional] | -|**links** | [**MsgVpnReplayLogLinks**](MsgVpnReplayLogLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnReplayLogTopicFilterSubscription.md b/service/solace-config-client/docs/MsgVpnReplayLogTopicFilterSubscription.md deleted file mode 100644 index 7c64f7b8f..000000000 --- a/service/solace-config-client/docs/MsgVpnReplayLogTopicFilterSubscription.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnReplayLogTopicFilterSubscription - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**replayLogName** | **String** | The name of the Replay Log. | [optional] | -|**topicFilterSubscription** | **String** | The topic of the Subscription. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnReplayLogTopicFilterSubscriptionLinks.md b/service/solace-config-client/docs/MsgVpnReplayLogTopicFilterSubscriptionLinks.md deleted file mode 100644 index 90815b6ed..000000000 --- a/service/solace-config-client/docs/MsgVpnReplayLogTopicFilterSubscriptionLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnReplayLogTopicFilterSubscriptionLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Topic Filter Subscription object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnReplayLogTopicFilterSubscriptionResponse.md b/service/solace-config-client/docs/MsgVpnReplayLogTopicFilterSubscriptionResponse.md deleted file mode 100644 index b7b69ccde..000000000 --- a/service/solace-config-client/docs/MsgVpnReplayLogTopicFilterSubscriptionResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnReplayLogTopicFilterSubscriptionResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnReplayLogTopicFilterSubscription**](MsgVpnReplayLogTopicFilterSubscription.md) | | [optional] | -|**links** | [**MsgVpnReplayLogTopicFilterSubscriptionLinks**](MsgVpnReplayLogTopicFilterSubscriptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnReplayLogTopicFilterSubscriptionsResponse.md b/service/solace-config-client/docs/MsgVpnReplayLogTopicFilterSubscriptionsResponse.md deleted file mode 100644 index 7aa0104b4..000000000 --- a/service/solace-config-client/docs/MsgVpnReplayLogTopicFilterSubscriptionsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnReplayLogTopicFilterSubscriptionsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnReplayLogTopicFilterSubscription>**](MsgVpnReplayLogTopicFilterSubscription.md) | | [optional] | -|**links** | [**List<MsgVpnReplayLogTopicFilterSubscriptionLinks>**](MsgVpnReplayLogTopicFilterSubscriptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnReplayLogsResponse.md b/service/solace-config-client/docs/MsgVpnReplayLogsResponse.md deleted file mode 100644 index 4b8a52a16..000000000 --- a/service/solace-config-client/docs/MsgVpnReplayLogsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnReplayLogsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnReplayLog>**](MsgVpnReplayLog.md) | | [optional] | -|**links** | [**List<MsgVpnReplayLogLinks>**](MsgVpnReplayLogLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnReplicatedTopic.md b/service/solace-config-client/docs/MsgVpnReplicatedTopic.md deleted file mode 100644 index 546b8403f..000000000 --- a/service/solace-config-client/docs/MsgVpnReplicatedTopic.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# MsgVpnReplicatedTopic - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**replicatedTopic** | **String** | The topic for applying replication. Published messages matching this topic will be replicated to the standby site. | [optional] | -|**replicationMode** | [**ReplicationModeEnum**](#ReplicationModeEnum) | The replication mode for the Replicated Topic. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"async\"`. The allowed values and their meaning are: <pre> \"sync\" - Messages are acknowledged when replicated (spooled remotely). \"async\" - Messages are acknowledged when pending replication (spooled locally). </pre> | [optional] | - - - -## Enum: ReplicationModeEnum - -| Name | Value | -|---- | -----| -| SYNC | "sync" | -| ASYNC | "async" | - - - diff --git a/service/solace-config-client/docs/MsgVpnReplicatedTopicLinks.md b/service/solace-config-client/docs/MsgVpnReplicatedTopicLinks.md deleted file mode 100644 index 4eb3c60c5..000000000 --- a/service/solace-config-client/docs/MsgVpnReplicatedTopicLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnReplicatedTopicLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Replicated Topic object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnReplicatedTopicResponse.md b/service/solace-config-client/docs/MsgVpnReplicatedTopicResponse.md deleted file mode 100644 index c92b25358..000000000 --- a/service/solace-config-client/docs/MsgVpnReplicatedTopicResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnReplicatedTopicResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnReplicatedTopic**](MsgVpnReplicatedTopic.md) | | [optional] | -|**links** | [**MsgVpnReplicatedTopicLinks**](MsgVpnReplicatedTopicLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnReplicatedTopicsResponse.md b/service/solace-config-client/docs/MsgVpnReplicatedTopicsResponse.md deleted file mode 100644 index bdc2ee7b4..000000000 --- a/service/solace-config-client/docs/MsgVpnReplicatedTopicsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnReplicatedTopicsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnReplicatedTopic>**](MsgVpnReplicatedTopic.md) | | [optional] | -|**links** | [**List<MsgVpnReplicatedTopicLinks>**](MsgVpnReplicatedTopicLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnResponse.md b/service/solace-config-client/docs/MsgVpnResponse.md deleted file mode 100644 index 2004aa930..000000000 --- a/service/solace-config-client/docs/MsgVpnResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpn**](MsgVpn.md) | | [optional] | -|**links** | [**MsgVpnLinks**](MsgVpnLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPoint.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPoint.md deleted file mode 100644 index b1ad0bdb4..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPoint.md +++ /dev/null @@ -1,18 +0,0 @@ - - -# MsgVpnRestDeliveryPoint - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**clientProfileName** | **String** | The Client Profile of the REST Delivery Point. It must exist in the local Message VPN. Its TCP parameters are used for all REST Consumers in this RDP. Its queue properties are used by the RDP client. The Client Profile is used inside the auto-generated Client Username for this RDP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`. | [optional] | -|**enabled** | **Boolean** | Enable or disable the REST Delivery Point. When disabled, no connections are initiated or messages delivered to any of the contained REST Consumers. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**restDeliveryPointName** | **String** | The name of the REST Delivery Point. | [optional] | -|**service** | **String** | The name of the service that this REST Delivery Point connects to. Internally the broker does not use this value; it is informational only. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19. | [optional] | -|**vendor** | **String** | The name of the vendor that this REST Delivery Point connects to. Internally the broker does not use this value; it is informational only. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointLinks.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointLinks.md deleted file mode 100644 index d9f8339ff..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointLinks.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnRestDeliveryPointLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**queueBindingsUri** | **String** | The URI of this REST Delivery Point's collection of Queue Binding objects. | [optional] | -|**restConsumersUri** | **String** | The URI of this REST Delivery Point's collection of REST Consumer objects. | [optional] | -|**uri** | **String** | The URI of this REST Delivery Point object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBinding.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBinding.md deleted file mode 100644 index 0b908312c..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBinding.md +++ /dev/null @@ -1,27 +0,0 @@ - - -# MsgVpnRestDeliveryPointQueueBinding - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**gatewayReplaceTargetAuthorityEnabled** | **Boolean** | Enable or disable whether the authority for the request-target is replaced with that configured for the REST Consumer remote. When enabled, the broker sends HTTP requests in absolute-form, with the request-target's authority taken from the REST Consumer's remote host and port configuration. When disabled, the broker sends HTTP requests whose request-target matches that of the original request message, including whether to use absolute-form or origin-form. This configuration is applicable only when the Message VPN is in REST gateway mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.6. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**postRequestTarget** | **String** | The request-target string to use when sending requests. It identifies the target resource on the far-end REST Consumer upon which to apply the request. There are generally two common forms for the request-target. The origin-form is most often used in practice and contains the path and query components of the target URI. If the path component is empty then the client must generally send a \"/\" as the path. When making a request to a proxy, most often the absolute-form is required. This configuration is only applicable when the Message VPN is in REST messaging mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**queueBindingName** | **String** | The name of a queue in the Message VPN. | [optional] | -|**requestTargetEvaluation** | [**RequestTargetEvaluationEnum**](#RequestTargetEvaluationEnum) | The type of evaluation to perform on the request target. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - Do not evaluate substitution expressions on the request target. \"substitution-expressions\" - Evaluate substitution expressions on the request target. </pre> Available since 2.23. | [optional] | -|**restDeliveryPointName** | **String** | The name of the REST Delivery Point. | [optional] | - - - -## Enum: RequestTargetEvaluationEnum - -| Name | Value | -|---- | -----| -| NONE | "none" | -| SUBSTITUTION_EXPRESSIONS | "substitution-expressions" | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingLinks.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingLinks.md deleted file mode 100644 index f9fd5e7fc..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingLinks.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# MsgVpnRestDeliveryPointQueueBindingLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**requestHeadersUri** | **String** | The URI of this Queue Binding's collection of Request Header objects. Available since 2.23. | [optional] | -|**uri** | **String** | The URI of this Queue Binding object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingRequestHeader.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingRequestHeader.md deleted file mode 100644 index a3ee1340a..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingRequestHeader.md +++ /dev/null @@ -1,17 +0,0 @@ - - -# MsgVpnRestDeliveryPointQueueBindingRequestHeader - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**headerName** | **String** | The name of the HTTP request header. | [optional] | -|**headerValue** | **String** | A substitution expression for the value of the HTTP request header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**queueBindingName** | **String** | The name of a queue in the Message VPN. | [optional] | -|**restDeliveryPointName** | **String** | The name of the REST Delivery Point. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks.md deleted file mode 100644 index ddc445116..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Request Header object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md deleted file mode 100644 index 1ec51fc68..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnRestDeliveryPointQueueBindingRequestHeader**](MsgVpnRestDeliveryPointQueueBindingRequestHeader.md) | | [optional] | -|**links** | [**MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks**](MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.md deleted file mode 100644 index e759c2755..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnRestDeliveryPointQueueBindingRequestHeader>**](MsgVpnRestDeliveryPointQueueBindingRequestHeader.md) | | [optional] | -|**links** | [**List<MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks>**](MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingResponse.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingResponse.md deleted file mode 100644 index c414ac536..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnRestDeliveryPointQueueBindingResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnRestDeliveryPointQueueBinding**](MsgVpnRestDeliveryPointQueueBinding.md) | | [optional] | -|**links** | [**MsgVpnRestDeliveryPointQueueBindingLinks**](MsgVpnRestDeliveryPointQueueBindingLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingsResponse.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingsResponse.md deleted file mode 100644 index 2d3fbef50..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointQueueBindingsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnRestDeliveryPointQueueBindingsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnRestDeliveryPointQueueBinding>**](MsgVpnRestDeliveryPointQueueBinding.md) | | [optional] | -|**links** | [**List<MsgVpnRestDeliveryPointQueueBindingLinks>**](MsgVpnRestDeliveryPointQueueBindingLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointResponse.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointResponse.md deleted file mode 100644 index 27de43746..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnRestDeliveryPointResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnRestDeliveryPoint**](MsgVpnRestDeliveryPoint.md) | | [optional] | -|**links** | [**MsgVpnRestDeliveryPointLinks**](MsgVpnRestDeliveryPointLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumer.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumer.md deleted file mode 100644 index b4b413614..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumer.md +++ /dev/null @@ -1,66 +0,0 @@ - - -# MsgVpnRestDeliveryPointRestConsumer - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**authenticationAwsAccessKeyId** | **String** | The AWS access key id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26. | [optional] | -|**authenticationAwsRegion** | **String** | The AWS region id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26. | [optional] | -|**authenticationAwsSecretAccessKey** | **String** | The AWS secret access key. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26. | [optional] | -|**authenticationAwsService** | **String** | The AWS service id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26. | [optional] | -|**authenticationClientCertContent** | **String** | The PEM formatted content for the client certificate that the REST Consumer will present to the REST host. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9. | [optional] | -|**authenticationClientCertPassword** | **String** | The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9. | [optional] | -|**authenticationHttpBasicPassword** | **String** | The password for the username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**authenticationHttpBasicUsername** | **String** | The username that the REST Consumer will use to login to the REST host. Normally a username is only configured when basic authentication is selected for the REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**authenticationHttpHeaderName** | **String** | The authentication header name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.15. | [optional] | -|**authenticationHttpHeaderValue** | **String** | The authentication header value. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.15. | [optional] | -|**authenticationOauthClientId** | **String** | The OAuth client ID. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19. | [optional] | -|**authenticationOauthClientScope** | **String** | The OAuth scope. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19. | [optional] | -|**authenticationOauthClientSecret** | **String** | The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19. | [optional] | -|**authenticationOauthClientTokenEndpoint** | **String** | The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. Must begin with \"https\". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19. | [optional] | -|**authenticationOauthJwtSecretKey** | **String** | The OAuth secret key used to sign the token request JWT. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.21. | [optional] | -|**authenticationOauthJwtTokenEndpoint** | **String** | The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.21. | [optional] | -|**authenticationScheme** | [**AuthenticationSchemeEnum**](#AuthenticationSchemeEnum) | The authentication scheme used by the REST Consumer to login to the REST host. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - Login with no authentication. This may be useful for anonymous connections or when a REST Consumer does not require authentication. \"http-basic\" - Login with a username and optional password according to HTTP Basic authentication as per RFC2616. \"client-certificate\" - Login with a client TLS certificate as per RFC5246. Client certificate authentication is only available on TLS connections. \"http-header\" - Login with a specified HTTP header. \"oauth-client\" - Login with OAuth 2.0 client credentials. \"oauth-jwt\" - Login with OAuth (RFC 7523 JWT Profile). \"transparent\" - Login using the Authorization header from the message properties, if present. Transparent authentication passes along existing Authorization header metadata instead of discarding it. Note that if the message is coming from a REST producer, the REST service must be configured to forward the Authorization header. \"aws\" - Login using AWS Signature Version 4 authentication (AWS4-HMAC-SHA256). </pre> | [optional] | -|**enabled** | **Boolean** | Enable or disable the REST Consumer. When disabled, no connections are initiated or messages delivered to this particular REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**httpMethod** | [**HttpMethodEnum**](#HttpMethodEnum) | The HTTP method to use (POST or PUT). This is used only when operating in the REST service \"messaging\" mode and is ignored in \"gateway\" mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"post\"`. The allowed values and their meaning are: <pre> \"post\" - Use the POST HTTP method. \"put\" - Use the PUT HTTP method. </pre> Available since 2.17. | [optional] | -|**localInterface** | **String** | The interface that will be used for all outgoing connections associated with the REST Consumer. When unspecified, an interface is automatically chosen. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**maxPostWaitTime** | **Integer** | The maximum amount of time (in seconds) to wait for an HTTP POST response from the REST Consumer. Once this time is exceeded, the TCP connection is reset. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**outgoingConnectionCount** | **Integer** | The number of concurrent TCP connections open to the REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. | [optional] | -|**remoteHost** | **String** | The IP address or DNS name to which the broker is to connect to deliver messages for the REST Consumer. A host value must be configured for the REST Consumer to be operationally up. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**remotePort** | **Long** | The port associated with the host of the REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `8080`. | [optional] | -|**restConsumerName** | **String** | The name of the REST Consumer. | [optional] | -|**restDeliveryPointName** | **String** | The name of the REST Delivery Point. | [optional] | -|**retryDelay** | **Integer** | The number of seconds that must pass before retrying the remote REST Consumer connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. | [optional] | -|**tlsCipherSuiteList** | **String** | The colon-separated list of cipher suites the REST Consumer uses in its encrypted connection. The value `\"default\"` implies all supported suites ordered from most secure to least secure. The list of default cipher suites is available in the `tlsCipherSuiteMsgBackboneDefaultList` attribute of the Broker object in the Monitoring API. The REST Consumer should choose the first suite from this list that it supports. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`. | [optional] | -|**tlsEnabled** | **Boolean** | Enable or disable encryption (TLS) for the REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | - - - -## Enum: AuthenticationSchemeEnum - -| Name | Value | -|---- | -----| -| NONE | "none" | -| HTTP_BASIC | "http-basic" | -| CLIENT_CERTIFICATE | "client-certificate" | -| HTTP_HEADER | "http-header" | -| OAUTH_CLIENT | "oauth-client" | -| OAUTH_JWT | "oauth-jwt" | -| TRANSPARENT | "transparent" | -| AWS | "aws" | - - - -## Enum: HttpMethodEnum - -| Name | Value | -|---- | -----| -| POST | "post" | -| PUT | "put" | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerLinks.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerLinks.md deleted file mode 100644 index 7f8ee95dd..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerLinks.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnRestDeliveryPointRestConsumerLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**oauthJwtClaimsUri** | **String** | The URI of this REST Consumer's collection of Claim objects. Available since 2.21. | [optional] | -|**tlsTrustedCommonNamesUri** | **String** | The URI of this REST Consumer's collection of Trusted Common Name objects. Deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. | [optional] | -|**uri** | **String** | The URI of this REST Consumer object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.md deleted file mode 100644 index 528c50cca..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.md +++ /dev/null @@ -1,17 +0,0 @@ - - -# MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**oauthJwtClaimName** | **String** | The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". | [optional] | -|**oauthJwtClaimValue** | **String** | The value of the additional claim, which must be a string containing a valid JSON value. | [optional] | -|**restConsumerName** | **String** | The name of the REST Consumer. | [optional] | -|**restDeliveryPointName** | **String** | The name of the REST Delivery Point. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks.md deleted file mode 100644 index 2c270074b..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Claim object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.md deleted file mode 100644 index c667f896d..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.md) | | [optional] | -|**links** | [**MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks**](MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.md deleted file mode 100644 index f67e5eeb4..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim>**](MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.md) | | [optional] | -|**links** | [**List<MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks>**](MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerResponse.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerResponse.md deleted file mode 100644 index 0fdbd9c4f..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnRestDeliveryPointRestConsumerResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnRestDeliveryPointRestConsumer**](MsgVpnRestDeliveryPointRestConsumer.md) | | [optional] | -|**links** | [**MsgVpnRestDeliveryPointRestConsumerLinks**](MsgVpnRestDeliveryPointRestConsumerLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.md deleted file mode 100644 index 267dab548..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**msgVpnName** | **String** | The name of the Message VPN. Deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. | [optional] | -|**restConsumerName** | **String** | The name of the REST Consumer. Deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. | [optional] | -|**restDeliveryPointName** | **String** | The name of the REST Delivery Point. Deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. | [optional] | -|**tlsTrustedCommonName** | **String** | The expected trusted common name of the remote certificate. Deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks.md deleted file mode 100644 index b4c49f09b..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Trusted Common Name object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.md deleted file mode 100644 index 278ef169e..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.md) | | [optional] | -|**links** | [**MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks**](MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.md deleted file mode 100644 index c7f411027..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName>**](MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.md) | | [optional] | -|**links** | [**List<MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks>**](MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumersResponse.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumersResponse.md deleted file mode 100644 index 9c2f36bc5..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointRestConsumersResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnRestDeliveryPointRestConsumersResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnRestDeliveryPointRestConsumer>**](MsgVpnRestDeliveryPointRestConsumer.md) | | [optional] | -|**links** | [**List<MsgVpnRestDeliveryPointRestConsumerLinks>**](MsgVpnRestDeliveryPointRestConsumerLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnRestDeliveryPointsResponse.md b/service/solace-config-client/docs/MsgVpnRestDeliveryPointsResponse.md deleted file mode 100644 index 54a03f82f..000000000 --- a/service/solace-config-client/docs/MsgVpnRestDeliveryPointsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnRestDeliveryPointsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnRestDeliveryPoint>**](MsgVpnRestDeliveryPoint.md) | | [optional] | -|**links** | [**List<MsgVpnRestDeliveryPointLinks>**](MsgVpnRestDeliveryPointLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnSequencedTopic.md b/service/solace-config-client/docs/MsgVpnSequencedTopic.md deleted file mode 100644 index 2fa4840c7..000000000 --- a/service/solace-config-client/docs/MsgVpnSequencedTopic.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# MsgVpnSequencedTopic - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**sequencedTopic** | **String** | Topic for applying sequence numbers. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnSequencedTopicLinks.md b/service/solace-config-client/docs/MsgVpnSequencedTopicLinks.md deleted file mode 100644 index 74bd6c234..000000000 --- a/service/solace-config-client/docs/MsgVpnSequencedTopicLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnSequencedTopicLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Sequenced Topic object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnSequencedTopicResponse.md b/service/solace-config-client/docs/MsgVpnSequencedTopicResponse.md deleted file mode 100644 index 074b48f6d..000000000 --- a/service/solace-config-client/docs/MsgVpnSequencedTopicResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnSequencedTopicResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnSequencedTopic**](MsgVpnSequencedTopic.md) | | [optional] | -|**links** | [**MsgVpnSequencedTopicLinks**](MsgVpnSequencedTopicLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnSequencedTopicsResponse.md b/service/solace-config-client/docs/MsgVpnSequencedTopicsResponse.md deleted file mode 100644 index 1b57fe966..000000000 --- a/service/solace-config-client/docs/MsgVpnSequencedTopicsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnSequencedTopicsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnSequencedTopic>**](MsgVpnSequencedTopic.md) | | [optional] | -|**links** | [**List<MsgVpnSequencedTopicLinks>**](MsgVpnSequencedTopicLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnTopicEndpoint.md b/service/solace-config-client/docs/MsgVpnTopicEndpoint.md deleted file mode 100644 index 1600ebb5b..000000000 --- a/service/solace-config-client/docs/MsgVpnTopicEndpoint.md +++ /dev/null @@ -1,69 +0,0 @@ - - -# MsgVpnTopicEndpoint - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**accessType** | [**AccessTypeEnum**](#AccessTypeEnum) | The access type for delivering messages to consumer flows bound to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are: <pre> \"exclusive\" - Exclusive delivery of messages to the first bound consumer flow. \"non-exclusive\" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion. </pre> Available since 2.4. | [optional] | -|**consumerAckPropagationEnabled** | **Boolean** | Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**deadMsgQueue** | **String** | The name of the Dead Message Queue (DMQ) used by the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.2. | [optional] | -|**deliveryCountEnabled** | **Boolean** | Enable or disable the ability for client applications to query the message delivery count of messages received from the Topic Endpoint. This is a controlled availability feature. Please contact support to find out if this feature is supported for your use case. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.19. | [optional] | -|**deliveryDelay** | **Long** | The delay, in seconds, to apply to messages arriving on the Topic Endpoint before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22. | [optional] | -|**egressEnabled** | **Boolean** | Enable or disable the transmission of messages from the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**eventBindCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventRejectLowPriorityMsgLimitThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventSpoolUsageThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**ingressEnabled** | **Boolean** | Enable or disable the reception of messages to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**maxBindCount** | **Long** | The maximum number of consumer flows that can bind to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. Available since 2.4. | [optional] | -|**maxDeliveredUnackedMsgsPerFlow** | **Long** | The maximum number of messages delivered but not acknowledged per flow for the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. | [optional] | -|**maxMsgSize** | **Integer** | The maximum message size allowed in the Topic Endpoint, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. | [optional] | -|**maxRedeliveryCount** | **Long** | The maximum number of times the Topic Endpoint will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**maxSpoolUsage** | **Long** | The maximum message spool usage allowed by the Topic Endpoint, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`. | [optional] | -|**maxTtl** | **Long** | The maximum time in seconds a message can stay in the Topic Endpoint when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Topic Endpoint, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**owner** | **String** | The Client Username that owns the Topic Endpoint and has permission equivalent to `\"delete\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**permission** | [**PermissionEnum**](#PermissionEnum) | The permission level for all consumers of the Topic Endpoint, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are: <pre> \"no-access\" - Disallows all access. \"read-only\" - Read-only access to the messages. \"consume\" - Consume (read and remove) messages. \"modify-topic\" - Consume messages or modify the topic/selector. \"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. </pre> | [optional] | -|**redeliveryEnabled** | **Boolean** | Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the topic-endpoint more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18. | [optional] | -|**rejectLowPriorityMsgEnabled** | **Boolean** | Enable or disable the checking of low priority messages against the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**rejectLowPriorityMsgLimit** | **Long** | The number of messages of any priority in the Topic Endpoint above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**rejectMsgToSenderOnDiscardBehavior** | [**RejectMsgToSenderOnDiscardBehaviorEnum**](#RejectMsgToSenderOnDiscardBehaviorEnum) | Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"never\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-topic-endpoint-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Topic Endpoint is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> | [optional] | -|**respectMsgPriorityEnabled** | **Boolean** | Enable or disable the respecting of message priority. When enabled, messages contained in the Topic Endpoint are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.8. | [optional] | -|**respectTtlEnabled** | **Boolean** | Enable or disable the respecting of the time-to-live (TTL) for messages in the Topic Endpoint. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**topicEndpointName** | **String** | The name of the Topic Endpoint. | [optional] | - - - -## Enum: AccessTypeEnum - -| Name | Value | -|---- | -----| -| EXCLUSIVE | "exclusive" | -| NON_EXCLUSIVE | "non-exclusive" | - - - -## Enum: PermissionEnum - -| Name | Value | -|---- | -----| -| NO_ACCESS | "no-access" | -| READ_ONLY | "read-only" | -| CONSUME | "consume" | -| MODIFY_TOPIC | "modify-topic" | -| DELETE | "delete" | - - - -## Enum: RejectMsgToSenderOnDiscardBehaviorEnum - -| Name | Value | -|---- | -----| -| ALWAYS | "always" | -| WHEN_TOPIC_ENDPOINT_ENABLED | "when-topic-endpoint-enabled" | -| NEVER | "never" | - - - diff --git a/service/solace-config-client/docs/MsgVpnTopicEndpointLinks.md b/service/solace-config-client/docs/MsgVpnTopicEndpointLinks.md deleted file mode 100644 index b233f587d..000000000 --- a/service/solace-config-client/docs/MsgVpnTopicEndpointLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnTopicEndpointLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Topic Endpoint object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnTopicEndpointResponse.md b/service/solace-config-client/docs/MsgVpnTopicEndpointResponse.md deleted file mode 100644 index bddf1101d..000000000 --- a/service/solace-config-client/docs/MsgVpnTopicEndpointResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnTopicEndpointResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnTopicEndpoint**](MsgVpnTopicEndpoint.md) | | [optional] | -|**links** | [**MsgVpnTopicEndpointLinks**](MsgVpnTopicEndpointLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnTopicEndpointTemplate.md b/service/solace-config-client/docs/MsgVpnTopicEndpointTemplate.md deleted file mode 100644 index af9c16ee6..000000000 --- a/service/solace-config-client/docs/MsgVpnTopicEndpointTemplate.md +++ /dev/null @@ -1,66 +0,0 @@ - - -# MsgVpnTopicEndpointTemplate - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**accessType** | [**AccessTypeEnum**](#AccessTypeEnum) | The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are: <pre> \"exclusive\" - Exclusive delivery of messages to the first bound consumer flow. \"non-exclusive\" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion. </pre> | [optional] | -|**consumerAckPropagationEnabled** | **Boolean** | Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. | [optional] | -|**deadMsgQueue** | **String** | The name of the Dead Message Queue (DMQ). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. | [optional] | -|**deliveryDelay** | **Long** | The delay, in seconds, to apply to messages arriving on the Topic Endpoint before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22. | [optional] | -|**eventBindCountThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventMsgSpoolUsageThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**eventRejectLowPriorityMsgLimitThreshold** | [**EventThreshold**](EventThreshold.md) | | [optional] | -|**maxBindCount** | **Long** | The maximum number of consumer flows that can bind. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. | [optional] | -|**maxDeliveredUnackedMsgsPerFlow** | **Long** | The maximum number of messages delivered but not acknowledged per flow. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. | [optional] | -|**maxMsgSize** | **Integer** | The maximum message size allowed, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. | [optional] | -|**maxMsgSpoolUsage** | **Long** | The maximum message spool usage allowed, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`. | [optional] | -|**maxRedeliveryCount** | **Long** | The maximum number of message redelivery attempts that will occur prior to the message being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**maxTtl** | **Long** | The maximum time in seconds a message can stay in the Topic Endpoint when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Topic Endpoint, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**msgVpnName** | **String** | The name of the Message VPN. | [optional] | -|**permission** | [**PermissionEnum**](#PermissionEnum) | The permission level for all consumers, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are: <pre> \"no-access\" - Disallows all access. \"read-only\" - Read-only access to the messages. \"consume\" - Consume (read and remove) messages. \"modify-topic\" - Consume messages or modify the topic/selector. \"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. </pre> | [optional] | -|**redeliveryEnabled** | **Boolean** | Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the topic-endpoint more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18. | [optional] | -|**rejectLowPriorityMsgEnabled** | **Boolean** | Enable or disable the checking of low priority messages against the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**rejectLowPriorityMsgLimit** | **Long** | The number of messages that are permitted before low priority messages are rejected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. | [optional] | -|**rejectMsgToSenderOnDiscardBehavior** | [**RejectMsgToSenderOnDiscardBehaviorEnum**](#RejectMsgToSenderOnDiscardBehaviorEnum) | Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"never\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-topic-endpoint-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Topic Endpoint is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> | [optional] | -|**respectMsgPriorityEnabled** | **Boolean** | Enable or disable the respecting of message priority. When enabled, messages are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**respectTtlEnabled** | **Boolean** | Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. | [optional] | -|**topicEndpointNameFilter** | **String** | A wildcardable pattern used to determine which Topic Endpoints use settings from this Template. Two different wildcards are supported: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. | [optional] | -|**topicEndpointTemplateName** | **String** | The name of the Topic Endpoint Template. | [optional] | - - - -## Enum: AccessTypeEnum - -| Name | Value | -|---- | -----| -| EXCLUSIVE | "exclusive" | -| NON_EXCLUSIVE | "non-exclusive" | - - - -## Enum: PermissionEnum - -| Name | Value | -|---- | -----| -| NO_ACCESS | "no-access" | -| READ_ONLY | "read-only" | -| CONSUME | "consume" | -| MODIFY_TOPIC | "modify-topic" | -| DELETE | "delete" | - - - -## Enum: RejectMsgToSenderOnDiscardBehaviorEnum - -| Name | Value | -|---- | -----| -| ALWAYS | "always" | -| WHEN_TOPIC_ENDPOINT_ENABLED | "when-topic-endpoint-enabled" | -| NEVER | "never" | - - - diff --git a/service/solace-config-client/docs/MsgVpnTopicEndpointTemplateLinks.md b/service/solace-config-client/docs/MsgVpnTopicEndpointTemplateLinks.md deleted file mode 100644 index cb7a99577..000000000 --- a/service/solace-config-client/docs/MsgVpnTopicEndpointTemplateLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# MsgVpnTopicEndpointTemplateLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Topic Endpoint Template object. | [optional] | - - - diff --git a/service/solace-config-client/docs/MsgVpnTopicEndpointTemplateResponse.md b/service/solace-config-client/docs/MsgVpnTopicEndpointTemplateResponse.md deleted file mode 100644 index 79f44312c..000000000 --- a/service/solace-config-client/docs/MsgVpnTopicEndpointTemplateResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnTopicEndpointTemplateResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**MsgVpnTopicEndpointTemplate**](MsgVpnTopicEndpointTemplate.md) | | [optional] | -|**links** | [**MsgVpnTopicEndpointTemplateLinks**](MsgVpnTopicEndpointTemplateLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnTopicEndpointTemplatesResponse.md b/service/solace-config-client/docs/MsgVpnTopicEndpointTemplatesResponse.md deleted file mode 100644 index 7e882c8b3..000000000 --- a/service/solace-config-client/docs/MsgVpnTopicEndpointTemplatesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnTopicEndpointTemplatesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnTopicEndpointTemplate>**](MsgVpnTopicEndpointTemplate.md) | | [optional] | -|**links** | [**List<MsgVpnTopicEndpointTemplateLinks>**](MsgVpnTopicEndpointTemplateLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnTopicEndpointsResponse.md b/service/solace-config-client/docs/MsgVpnTopicEndpointsResponse.md deleted file mode 100644 index 0a0ae8aa5..000000000 --- a/service/solace-config-client/docs/MsgVpnTopicEndpointsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnTopicEndpointsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpnTopicEndpoint>**](MsgVpnTopicEndpoint.md) | | [optional] | -|**links** | [**List<MsgVpnTopicEndpointLinks>**](MsgVpnTopicEndpointLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/MsgVpnsResponse.md b/service/solace-config-client/docs/MsgVpnsResponse.md deleted file mode 100644 index 6c46d7797..000000000 --- a/service/solace-config-client/docs/MsgVpnsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# MsgVpnsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<MsgVpn>**](MsgVpn.md) | | [optional] | -|**links** | [**List<MsgVpnLinks>**](MsgVpnLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/OauthProfile.md b/service/solace-config-client/docs/OauthProfile.md deleted file mode 100644 index 33c892d6e..000000000 --- a/service/solace-config-client/docs/OauthProfile.md +++ /dev/null @@ -1,81 +0,0 @@ - - -# OauthProfile - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**accessLevelGroupsClaimName** | **String** | The name of the groups claim. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"groups\"`. | [optional] | -|**clientId** | **String** | The OAuth client id. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**clientRedirectUri** | **String** | The OAuth redirect URI. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**clientRequiredType** | **String** | The required value for the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"JWT\"`. | [optional] | -|**clientScope** | **String** | The OAuth scope. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"openid email\"`. | [optional] | -|**clientSecret** | **String** | The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**clientValidateTypeEnabled** | **Boolean** | Enable or disable verification of the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. | [optional] | -|**defaultGlobalAccessLevel** | [**DefaultGlobalAccessLevelEnum**](#DefaultGlobalAccessLevelEnum) | The default global access level for this OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to global data. \"read-only\" - User has read-only access to global data. \"read-write\" - User has read-write access to most global data. \"admin\" - User has read-write access to all global data. </pre> | [optional] | -|**defaultMsgVpnAccessLevel** | [**DefaultMsgVpnAccessLevelEnum**](#DefaultMsgVpnAccessLevelEnum) | The default message VPN access level for the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to a Message VPN. \"read-only\" - User has read-only access to a Message VPN. \"read-write\" - User has read-write access to most Message VPN settings. </pre> | [optional] | -|**displayName** | **String** | The user friendly name for the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**enabled** | **Boolean** | Enable or disable the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. | [optional] | -|**endpointAuthorization** | **String** | The OAuth authorization endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**endpointDiscovery** | **String** | The OpenID Connect discovery endpoint or OAuth Authorization Server Metadata endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**endpointDiscoveryRefreshInterval** | **Integer** | The number of seconds between discovery endpoint requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`. | [optional] | -|**endpointIntrospection** | **String** | The OAuth introspection endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**endpointIntrospectionTimeout** | **Integer** | The maximum time in seconds a token introspection request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`. | [optional] | -|**endpointJwks** | **String** | The OAuth JWKS endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**endpointJwksRefreshInterval** | **Integer** | The number of seconds between JWKS endpoint requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`. | [optional] | -|**endpointToken** | **String** | The OAuth token endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**endpointTokenTimeout** | **Integer** | The maximum time in seconds a token request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`. | [optional] | -|**endpointUserinfo** | **String** | The OpenID Connect Userinfo endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**endpointUserinfoTimeout** | **Integer** | The maximum time in seconds a userinfo request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`. | [optional] | -|**interactiveEnabled** | **Boolean** | Enable or disable interactive logins via this OAuth provider. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. | [optional] | -|**interactivePromptForExpiredSession** | **String** | The value of the prompt parameter provided to the OAuth authorization server for login requests where the session has expired. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**interactivePromptForNewSession** | **String** | The value of the prompt parameter provided to the OAuth authorization server for login requests where the session is new or the user has explicitly logged out. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"select_account\"`. | [optional] | -|**issuer** | **String** | The Issuer Identifier for the OAuth provider. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**oauthProfileName** | **String** | The name of the OAuth profile. | [optional] | -|**oauthRole** | [**OauthRoleEnum**](#OauthRoleEnum) | The OAuth role of the broker. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"client\"`. The allowed values and their meaning are: <pre> \"client\" - The broker is in the OAuth client role. \"resource-server\" - The broker is in the OAuth resource server role. </pre> | [optional] | -|**resourceServerParseAccessTokenEnabled** | **Boolean** | Enable or disable parsing of the access token as a JWT. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. | [optional] | -|**resourceServerRequiredAudience** | **String** | The required audience value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**resourceServerRequiredIssuer** | **String** | The required issuer value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**resourceServerRequiredScope** | **String** | A space-separated list of scopes that must be present in the scope claim. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**resourceServerRequiredType** | **String** | The required TYP value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"at+jwt\"`. | [optional] | -|**resourceServerValidateAudienceEnabled** | **Boolean** | Enable or disable verification of the audience claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. | [optional] | -|**resourceServerValidateIssuerEnabled** | **Boolean** | Enable or disable verification of the issuer claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. | [optional] | -|**resourceServerValidateScopeEnabled** | **Boolean** | Enable or disable verification of the scope claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. | [optional] | -|**resourceServerValidateTypeEnabled** | **Boolean** | Enable or disable verification of the TYP field in the access token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. | [optional] | -|**sempEnabled** | **Boolean** | Enable or disable authentication of SEMP requests with OAuth tokens. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. | [optional] | -|**usernameClaimName** | **String** | The name of the username claim. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"sub\"`. | [optional] | - - - -## Enum: DefaultGlobalAccessLevelEnum - -| Name | Value | -|---- | -----| -| NONE | "none" | -| READ_ONLY | "read-only" | -| READ_WRITE | "read-write" | -| ADMIN | "admin" | - - - -## Enum: DefaultMsgVpnAccessLevelEnum - -| Name | Value | -|---- | -----| -| NONE | "none" | -| READ_ONLY | "read-only" | -| READ_WRITE | "read-write" | - - - -## Enum: OauthRoleEnum - -| Name | Value | -|---- | -----| -| CLIENT | "client" | -| RESOURCE_SERVER | "resource-server" | - - - diff --git a/service/solace-config-client/docs/OauthProfileAccessLevelGroup.md b/service/solace-config-client/docs/OauthProfileAccessLevelGroup.md deleted file mode 100644 index ac18e149f..000000000 --- a/service/solace-config-client/docs/OauthProfileAccessLevelGroup.md +++ /dev/null @@ -1,38 +0,0 @@ - - -# OauthProfileAccessLevelGroup - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**description** | **String** | A description for the group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**globalAccessLevel** | [**GlobalAccessLevelEnum**](#GlobalAccessLevelEnum) | The global access level for this group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to global data. \"read-only\" - User has read-only access to global data. \"read-write\" - User has read-write access to most global data. \"admin\" - User has read-write access to all global data. </pre> | [optional] | -|**groupName** | **String** | The name of the group. | [optional] | -|**msgVpnAccessLevel** | [**MsgVpnAccessLevelEnum**](#MsgVpnAccessLevelEnum) | The default message VPN access level for this group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to a Message VPN. \"read-only\" - User has read-only access to a Message VPN. \"read-write\" - User has read-write access to most Message VPN settings. </pre> | [optional] | -|**oauthProfileName** | **String** | The name of the OAuth profile. | [optional] | - - - -## Enum: GlobalAccessLevelEnum - -| Name | Value | -|---- | -----| -| NONE | "none" | -| READ_ONLY | "read-only" | -| READ_WRITE | "read-write" | -| ADMIN | "admin" | - - - -## Enum: MsgVpnAccessLevelEnum - -| Name | Value | -|---- | -----| -| NONE | "none" | -| READ_ONLY | "read-only" | -| READ_WRITE | "read-write" | - - - diff --git a/service/solace-config-client/docs/OauthProfileAccessLevelGroupLinks.md b/service/solace-config-client/docs/OauthProfileAccessLevelGroupLinks.md deleted file mode 100644 index 8b10ceb32..000000000 --- a/service/solace-config-client/docs/OauthProfileAccessLevelGroupLinks.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# OauthProfileAccessLevelGroupLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**msgVpnAccessLevelExceptionsUri** | **String** | The URI of this Group Access Level's collection of Message VPN Access-Level Exception objects. | [optional] | -|**uri** | **String** | The URI of this Group Access Level object. | [optional] | - - - diff --git a/service/solace-config-client/docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.md b/service/solace-config-client/docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.md deleted file mode 100644 index 290d2b79a..000000000 --- a/service/solace-config-client/docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.md +++ /dev/null @@ -1,26 +0,0 @@ - - -# OauthProfileAccessLevelGroupMsgVpnAccessLevelException - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**accessLevel** | [**AccessLevelEnum**](#AccessLevelEnum) | The message VPN access level. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to a Message VPN. \"read-only\" - User has read-only access to a Message VPN. \"read-write\" - User has read-write access to most Message VPN settings. </pre> | [optional] | -|**groupName** | **String** | The name of the group. | [optional] | -|**msgVpnName** | **String** | The name of the message VPN. | [optional] | -|**oauthProfileName** | **String** | The name of the OAuth profile. | [optional] | - - - -## Enum: AccessLevelEnum - -| Name | Value | -|---- | -----| -| NONE | "none" | -| READ_ONLY | "read-only" | -| READ_WRITE | "read-write" | - - - diff --git a/service/solace-config-client/docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks.md b/service/solace-config-client/docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks.md deleted file mode 100644 index dc350dca7..000000000 --- a/service/solace-config-client/docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Message VPN Access-Level Exception object. | [optional] | - - - diff --git a/service/solace-config-client/docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.md b/service/solace-config-client/docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.md deleted file mode 100644 index 9f06b4d03..000000000 --- a/service/solace-config-client/docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**OauthProfileAccessLevelGroupMsgVpnAccessLevelException**](OauthProfileAccessLevelGroupMsgVpnAccessLevelException.md) | | [optional] | -|**links** | [**OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks**](OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.md b/service/solace-config-client/docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.md deleted file mode 100644 index 36fb36a9b..000000000 --- a/service/solace-config-client/docs/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<OauthProfileAccessLevelGroupMsgVpnAccessLevelException>**](OauthProfileAccessLevelGroupMsgVpnAccessLevelException.md) | | [optional] | -|**links** | [**List<OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks>**](OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/OauthProfileAccessLevelGroupResponse.md b/service/solace-config-client/docs/OauthProfileAccessLevelGroupResponse.md deleted file mode 100644 index 2a42a2778..000000000 --- a/service/solace-config-client/docs/OauthProfileAccessLevelGroupResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileAccessLevelGroupResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**OauthProfileAccessLevelGroup**](OauthProfileAccessLevelGroup.md) | | [optional] | -|**links** | [**OauthProfileAccessLevelGroupLinks**](OauthProfileAccessLevelGroupLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/OauthProfileAccessLevelGroupsResponse.md b/service/solace-config-client/docs/OauthProfileAccessLevelGroupsResponse.md deleted file mode 100644 index 731380e44..000000000 --- a/service/solace-config-client/docs/OauthProfileAccessLevelGroupsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileAccessLevelGroupsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<OauthProfileAccessLevelGroup>**](OauthProfileAccessLevelGroup.md) | | [optional] | -|**links** | [**List<OauthProfileAccessLevelGroupLinks>**](OauthProfileAccessLevelGroupLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/OauthProfileApi.md b/service/solace-config-client/docs/OauthProfileApi.md deleted file mode 100644 index 78e6e9002..000000000 --- a/service/solace-config-client/docs/OauthProfileApi.md +++ /dev/null @@ -1,3388 +0,0 @@ -# OauthProfileApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createOauthProfile**](OauthProfileApi.md#createOauthProfile) | **POST** /oauthProfiles | Create an OAuth Profile object. | -| [**createOauthProfileAccessLevelGroup**](OauthProfileApi.md#createOauthProfileAccessLevelGroup) | **POST** /oauthProfiles/{oauthProfileName}/accessLevelGroups | Create a Group Access Level object. | -| [**createOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](OauthProfileApi.md#createOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **POST** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions | Create a Message VPN Access-Level Exception object. | -| [**createOauthProfileClientAllowedHost**](OauthProfileApi.md#createOauthProfileClientAllowedHost) | **POST** /oauthProfiles/{oauthProfileName}/clientAllowedHosts | Create an Allowed Host Value object. | -| [**createOauthProfileClientAuthorizationParameter**](OauthProfileApi.md#createOauthProfileClientAuthorizationParameter) | **POST** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters | Create an Authorization Parameter object. | -| [**createOauthProfileClientRequiredClaim**](OauthProfileApi.md#createOauthProfileClientRequiredClaim) | **POST** /oauthProfiles/{oauthProfileName}/clientRequiredClaims | Create a Required Claim object. | -| [**createOauthProfileDefaultMsgVpnAccessLevelException**](OauthProfileApi.md#createOauthProfileDefaultMsgVpnAccessLevelException) | **POST** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions | Create a Message VPN Access-Level Exception object. | -| [**createOauthProfileResourceServerRequiredClaim**](OauthProfileApi.md#createOauthProfileResourceServerRequiredClaim) | **POST** /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Create a Required Claim object. | -| [**deleteOauthProfile**](OauthProfileApi.md#deleteOauthProfile) | **DELETE** /oauthProfiles/{oauthProfileName} | Delete an OAuth Profile object. | -| [**deleteOauthProfileAccessLevelGroup**](OauthProfileApi.md#deleteOauthProfileAccessLevelGroup) | **DELETE** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName} | Delete a Group Access Level object. | -| [**deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](OauthProfileApi.md#deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **DELETE** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName} | Delete a Message VPN Access-Level Exception object. | -| [**deleteOauthProfileClientAllowedHost**](OauthProfileApi.md#deleteOauthProfileClientAllowedHost) | **DELETE** /oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost} | Delete an Allowed Host Value object. | -| [**deleteOauthProfileClientAuthorizationParameter**](OauthProfileApi.md#deleteOauthProfileClientAuthorizationParameter) | **DELETE** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName} | Delete an Authorization Parameter object. | -| [**deleteOauthProfileClientRequiredClaim**](OauthProfileApi.md#deleteOauthProfileClientRequiredClaim) | **DELETE** /oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Delete a Required Claim object. | -| [**deleteOauthProfileDefaultMsgVpnAccessLevelException**](OauthProfileApi.md#deleteOauthProfileDefaultMsgVpnAccessLevelException) | **DELETE** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName} | Delete a Message VPN Access-Level Exception object. | -| [**deleteOauthProfileResourceServerRequiredClaim**](OauthProfileApi.md#deleteOauthProfileResourceServerRequiredClaim) | **DELETE** /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Delete a Required Claim object. | -| [**getOauthProfile**](OauthProfileApi.md#getOauthProfile) | **GET** /oauthProfiles/{oauthProfileName} | Get an OAuth Profile object. | -| [**getOauthProfileAccessLevelGroup**](OauthProfileApi.md#getOauthProfileAccessLevelGroup) | **GET** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName} | Get a Group Access Level object. | -| [**getOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](OauthProfileApi.md#getOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **GET** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName} | Get a Message VPN Access-Level Exception object. | -| [**getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions**](OauthProfileApi.md#getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions) | **GET** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions | Get a list of Message VPN Access-Level Exception objects. | -| [**getOauthProfileAccessLevelGroups**](OauthProfileApi.md#getOauthProfileAccessLevelGroups) | **GET** /oauthProfiles/{oauthProfileName}/accessLevelGroups | Get a list of Group Access Level objects. | -| [**getOauthProfileClientAllowedHost**](OauthProfileApi.md#getOauthProfileClientAllowedHost) | **GET** /oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost} | Get an Allowed Host Value object. | -| [**getOauthProfileClientAllowedHosts**](OauthProfileApi.md#getOauthProfileClientAllowedHosts) | **GET** /oauthProfiles/{oauthProfileName}/clientAllowedHosts | Get a list of Allowed Host Value objects. | -| [**getOauthProfileClientAuthorizationParameter**](OauthProfileApi.md#getOauthProfileClientAuthorizationParameter) | **GET** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName} | Get an Authorization Parameter object. | -| [**getOauthProfileClientAuthorizationParameters**](OauthProfileApi.md#getOauthProfileClientAuthorizationParameters) | **GET** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters | Get a list of Authorization Parameter objects. | -| [**getOauthProfileClientRequiredClaim**](OauthProfileApi.md#getOauthProfileClientRequiredClaim) | **GET** /oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName} | Get a Required Claim object. | -| [**getOauthProfileClientRequiredClaims**](OauthProfileApi.md#getOauthProfileClientRequiredClaims) | **GET** /oauthProfiles/{oauthProfileName}/clientRequiredClaims | Get a list of Required Claim objects. | -| [**getOauthProfileDefaultMsgVpnAccessLevelException**](OauthProfileApi.md#getOauthProfileDefaultMsgVpnAccessLevelException) | **GET** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName} | Get a Message VPN Access-Level Exception object. | -| [**getOauthProfileDefaultMsgVpnAccessLevelExceptions**](OauthProfileApi.md#getOauthProfileDefaultMsgVpnAccessLevelExceptions) | **GET** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions | Get a list of Message VPN Access-Level Exception objects. | -| [**getOauthProfileResourceServerRequiredClaim**](OauthProfileApi.md#getOauthProfileResourceServerRequiredClaim) | **GET** /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName} | Get a Required Claim object. | -| [**getOauthProfileResourceServerRequiredClaims**](OauthProfileApi.md#getOauthProfileResourceServerRequiredClaims) | **GET** /oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims | Get a list of Required Claim objects. | -| [**getOauthProfiles**](OauthProfileApi.md#getOauthProfiles) | **GET** /oauthProfiles | Get a list of OAuth Profile objects. | -| [**replaceOauthProfile**](OauthProfileApi.md#replaceOauthProfile) | **PUT** /oauthProfiles/{oauthProfileName} | Replace an OAuth Profile object. | -| [**replaceOauthProfileAccessLevelGroup**](OauthProfileApi.md#replaceOauthProfileAccessLevelGroup) | **PUT** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName} | Replace a Group Access Level object. | -| [**replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](OauthProfileApi.md#replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **PUT** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName} | Replace a Message VPN Access-Level Exception object. | -| [**replaceOauthProfileClientAuthorizationParameter**](OauthProfileApi.md#replaceOauthProfileClientAuthorizationParameter) | **PUT** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName} | Replace an Authorization Parameter object. | -| [**replaceOauthProfileDefaultMsgVpnAccessLevelException**](OauthProfileApi.md#replaceOauthProfileDefaultMsgVpnAccessLevelException) | **PUT** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName} | Replace a Message VPN Access-Level Exception object. | -| [**updateOauthProfile**](OauthProfileApi.md#updateOauthProfile) | **PATCH** /oauthProfiles/{oauthProfileName} | Update an OAuth Profile object. | -| [**updateOauthProfileAccessLevelGroup**](OauthProfileApi.md#updateOauthProfileAccessLevelGroup) | **PATCH** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName} | Update a Group Access Level object. | -| [**updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException**](OauthProfileApi.md#updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException) | **PATCH** /oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName} | Update a Message VPN Access-Level Exception object. | -| [**updateOauthProfileClientAuthorizationParameter**](OauthProfileApi.md#updateOauthProfileClientAuthorizationParameter) | **PATCH** /oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName} | Update an Authorization Parameter object. | -| [**updateOauthProfileDefaultMsgVpnAccessLevelException**](OauthProfileApi.md#updateOauthProfileDefaultMsgVpnAccessLevelException) | **PATCH** /oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName} | Update a Message VPN Access-Level Exception object. | - - - -## createOauthProfile - -> OauthProfileResponse createOauthProfile(body, opaquePassword, select) - -Create an OAuth Profile object. - -Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - OauthProfile body = new OauthProfile(); // OauthProfile | The OAuth Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileResponse result = apiInstance.createOauthProfile(body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#createOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **body** | [**OauthProfile**](OauthProfile.md)| The OAuth Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileResponse**](OauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createOauthProfileAccessLevelGroup - -> OauthProfileAccessLevelGroupResponse createOauthProfileAccessLevelGroup(oauthProfileName, body, opaquePassword, select) - -Create a Group Access Level object. - -Create a Group Access Level object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: groupName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - OauthProfileAccessLevelGroup body = new OauthProfileAccessLevelGroup(); // OauthProfileAccessLevelGroup | The Group Access Level object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupResponse result = apiInstance.createOauthProfileAccessLevelGroup(oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#createOauthProfileAccessLevelGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**OauthProfileAccessLevelGroup**](OauthProfileAccessLevelGroup.md)| The Group Access Level object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupResponse**](OauthProfileAccessLevelGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Group Access Level object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createOauthProfileAccessLevelGroupMsgVpnAccessLevelException - -> OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse createOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, body, opaquePassword, select) - -Create a Message VPN Access-Level Exception object. - -Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: groupName|x||x||| msgVpnName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - OauthProfileAccessLevelGroupMsgVpnAccessLevelException body = new OauthProfileAccessLevelGroupMsgVpnAccessLevelException(); // OauthProfileAccessLevelGroupMsgVpnAccessLevelException | The Message VPN Access-Level Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse result = apiInstance.createOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#createOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **body** | [**OauthProfileAccessLevelGroupMsgVpnAccessLevelException**](OauthProfileAccessLevelGroupMsgVpnAccessLevelException.md)| The Message VPN Access-Level Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse**](OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN Access-Level Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createOauthProfileClientAllowedHost - -> OauthProfileClientAllowedHostResponse createOauthProfileClientAllowedHost(oauthProfileName, body, opaquePassword, select) - -Create an Allowed Host Value object. - -Create an Allowed Host Value object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowedHost|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - OauthProfileClientAllowedHost body = new OauthProfileClientAllowedHost(); // OauthProfileClientAllowedHost | The Allowed Host Value object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientAllowedHostResponse result = apiInstance.createOauthProfileClientAllowedHost(oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#createOauthProfileClientAllowedHost"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**OauthProfileClientAllowedHost**](OauthProfileClientAllowedHost.md)| The Allowed Host Value object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientAllowedHostResponse**](OauthProfileClientAllowedHostResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Allowed Host Value object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createOauthProfileClientAuthorizationParameter - -> OauthProfileClientAuthorizationParameterResponse createOauthProfileClientAuthorizationParameter(oauthProfileName, body, opaquePassword, select) - -Create an Authorization Parameter object. - -Create an Authorization Parameter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationParameterName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - OauthProfileClientAuthorizationParameter body = new OauthProfileClientAuthorizationParameter(); // OauthProfileClientAuthorizationParameter | The Authorization Parameter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientAuthorizationParameterResponse result = apiInstance.createOauthProfileClientAuthorizationParameter(oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#createOauthProfileClientAuthorizationParameter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**OauthProfileClientAuthorizationParameter**](OauthProfileClientAuthorizationParameter.md)| The Authorization Parameter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientAuthorizationParameterResponse**](OauthProfileClientAuthorizationParameterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Parameter object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createOauthProfileClientRequiredClaim - -> OauthProfileClientRequiredClaimResponse createOauthProfileClientRequiredClaim(oauthProfileName, body, opaquePassword, select) - -Create a Required Claim object. - -Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - OauthProfileClientRequiredClaim body = new OauthProfileClientRequiredClaim(); // OauthProfileClientRequiredClaim | The Required Claim object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientRequiredClaimResponse result = apiInstance.createOauthProfileClientRequiredClaim(oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#createOauthProfileClientRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**OauthProfileClientRequiredClaim**](OauthProfileClientRequiredClaim.md)| The Required Claim object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientRequiredClaimResponse**](OauthProfileClientRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createOauthProfileDefaultMsgVpnAccessLevelException - -> OauthProfileDefaultMsgVpnAccessLevelExceptionResponse createOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, body, opaquePassword, select) - -Create a Message VPN Access-Level Exception object. - -Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Default message VPN access-level exceptions. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - OauthProfileDefaultMsgVpnAccessLevelException body = new OauthProfileDefaultMsgVpnAccessLevelException(); // OauthProfileDefaultMsgVpnAccessLevelException | The Message VPN Access-Level Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse result = apiInstance.createOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#createOauthProfileDefaultMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**OauthProfileDefaultMsgVpnAccessLevelException**](OauthProfileDefaultMsgVpnAccessLevelException.md)| The Message VPN Access-Level Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileDefaultMsgVpnAccessLevelExceptionResponse**](OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN Access-Level Exception object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createOauthProfileResourceServerRequiredClaim - -> OauthProfileResourceServerRequiredClaimResponse createOauthProfileResourceServerRequiredClaim(oauthProfileName, body, opaquePassword, select) - -Create a Required Claim object. - -Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - OauthProfileResourceServerRequiredClaim body = new OauthProfileResourceServerRequiredClaim(); // OauthProfileResourceServerRequiredClaim | The Required Claim object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileResourceServerRequiredClaimResponse result = apiInstance.createOauthProfileResourceServerRequiredClaim(oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#createOauthProfileResourceServerRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**OauthProfileResourceServerRequiredClaim**](OauthProfileResourceServerRequiredClaim.md)| The Required Claim object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileResourceServerRequiredClaimResponse**](OauthProfileResourceServerRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteOauthProfile - -> SempMetaOnlyResponse deleteOauthProfile(oauthProfileName) - -Delete an OAuth Profile object. - -Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - try { - SempMetaOnlyResponse result = apiInstance.deleteOauthProfile(oauthProfileName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#deleteOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteOauthProfileAccessLevelGroup - -> SempMetaOnlyResponse deleteOauthProfileAccessLevelGroup(oauthProfileName, groupName) - -Delete a Group Access Level object. - -Delete a Group Access Level object. The deletion of instances of this object are synchronized to HA mates via config-sync. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - try { - SempMetaOnlyResponse result = apiInstance.deleteOauthProfileAccessLevelGroup(oauthProfileName, groupName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#deleteOauthProfileAccessLevelGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException - -> SempMetaOnlyResponse deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName) - -Delete a Message VPN Access-Level Exception object. - -Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. Message VPN access-level exceptions for members of this group. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - String msgVpnName = "msgVpnName_example"; // String | The name of the message VPN. - try { - SempMetaOnlyResponse result = apiInstance.deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **msgVpnName** | **String**| The name of the message VPN. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteOauthProfileClientAllowedHost - -> SempMetaOnlyResponse deleteOauthProfileClientAllowedHost(oauthProfileName, allowedHost) - -Delete an Allowed Host Value object. - -Delete an Allowed Host Value object. The deletion of instances of this object are synchronized to HA mates via config-sync. A valid hostname for this broker in OAuth redirects. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String allowedHost = "allowedHost_example"; // String | An allowed value for the Host header. - try { - SempMetaOnlyResponse result = apiInstance.deleteOauthProfileClientAllowedHost(oauthProfileName, allowedHost); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#deleteOauthProfileClientAllowedHost"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **allowedHost** | **String**| An allowed value for the Host header. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteOauthProfileClientAuthorizationParameter - -> SempMetaOnlyResponse deleteOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName) - -Delete an Authorization Parameter object. - -Delete an Authorization Parameter object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional parameters to be passed to the OAuth authorization endpoint. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String authorizationParameterName = "authorizationParameterName_example"; // String | The name of the authorization parameter. - try { - SempMetaOnlyResponse result = apiInstance.deleteOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#deleteOauthProfileClientAuthorizationParameter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **authorizationParameterName** | **String**| The name of the authorization parameter. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteOauthProfileClientRequiredClaim - -> SempMetaOnlyResponse deleteOauthProfileClientRequiredClaim(oauthProfileName, clientRequiredClaimName) - -Delete a Required Claim object. - -Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String clientRequiredClaimName = "clientRequiredClaimName_example"; // String | The name of the ID token claim to verify. - try { - SempMetaOnlyResponse result = apiInstance.deleteOauthProfileClientRequiredClaim(oauthProfileName, clientRequiredClaimName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#deleteOauthProfileClientRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **clientRequiredClaimName** | **String**| The name of the ID token claim to verify. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteOauthProfileDefaultMsgVpnAccessLevelException - -> SempMetaOnlyResponse deleteOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName) - -Delete a Message VPN Access-Level Exception object. - -Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. Default message VPN access-level exceptions. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String msgVpnName = "msgVpnName_example"; // String | The name of the message VPN. - try { - SempMetaOnlyResponse result = apiInstance.deleteOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#deleteOauthProfileDefaultMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **msgVpnName** | **String**| The name of the message VPN. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteOauthProfileResourceServerRequiredClaim - -> SempMetaOnlyResponse deleteOauthProfileResourceServerRequiredClaim(oauthProfileName, resourceServerRequiredClaimName) - -Delete a Required Claim object. - -Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String resourceServerRequiredClaimName = "resourceServerRequiredClaimName_example"; // String | The name of the access token claim to verify. - try { - SempMetaOnlyResponse result = apiInstance.deleteOauthProfileResourceServerRequiredClaim(oauthProfileName, resourceServerRequiredClaimName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#deleteOauthProfileResourceServerRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **resourceServerRequiredClaimName** | **String**| The name of the access token claim to verify. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfile - -> OauthProfileResponse getOauthProfile(oauthProfileName, opaquePassword, select) - -Get an OAuth Profile object. - -Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileResponse result = apiInstance.getOauthProfile(oauthProfileName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#getOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileResponse**](OauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileAccessLevelGroup - -> OauthProfileAccessLevelGroupResponse getOauthProfileAccessLevelGroup(oauthProfileName, groupName, opaquePassword, select) - -Get a Group Access Level object. - -Get a Group Access Level object. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupResponse result = apiInstance.getOauthProfileAccessLevelGroup(oauthProfileName, groupName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#getOauthProfileAccessLevelGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupResponse**](OauthProfileAccessLevelGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Group Access Level object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileAccessLevelGroupMsgVpnAccessLevelException - -> OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse getOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, opaquePassword, select) - -Get a Message VPN Access-Level Exception object. - -Get a Message VPN Access-Level Exception object. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - String msgVpnName = "msgVpnName_example"; // String | The name of the message VPN. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse result = apiInstance.getOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#getOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **msgVpnName** | **String**| The name of the message VPN. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse**](OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN Access-Level Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions - -> OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions(oauthProfileName, groupName, count, cursor, opaquePassword, where, select) - -Get a list of Message VPN Access-Level Exception objects. - -Get a list of Message VPN Access-Level Exception objects. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse result = apiInstance.getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions(oauthProfileName, groupName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse**](OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Message VPN Access-Level Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileAccessLevelGroups - -> OauthProfileAccessLevelGroupsResponse getOauthProfileAccessLevelGroups(oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Group Access Level objects. - -Get a list of Group Access Level objects. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupsResponse result = apiInstance.getOauthProfileAccessLevelGroups(oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#getOauthProfileAccessLevelGroups"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupsResponse**](OauthProfileAccessLevelGroupsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Group Access Level objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileClientAllowedHost - -> OauthProfileClientAllowedHostResponse getOauthProfileClientAllowedHost(oauthProfileName, allowedHost, opaquePassword, select) - -Get an Allowed Host Value object. - -Get an Allowed Host Value object. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowedHost|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String allowedHost = "allowedHost_example"; // String | An allowed value for the Host header. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientAllowedHostResponse result = apiInstance.getOauthProfileClientAllowedHost(oauthProfileName, allowedHost, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#getOauthProfileClientAllowedHost"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **allowedHost** | **String**| An allowed value for the Host header. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientAllowedHostResponse**](OauthProfileClientAllowedHostResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Allowed Host Value object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileClientAllowedHosts - -> OauthProfileClientAllowedHostsResponse getOauthProfileClientAllowedHosts(oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Allowed Host Value objects. - -Get a list of Allowed Host Value objects. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowedHost|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientAllowedHostsResponse result = apiInstance.getOauthProfileClientAllowedHosts(oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#getOauthProfileClientAllowedHosts"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientAllowedHostsResponse**](OauthProfileClientAllowedHostsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Allowed Host Value objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileClientAuthorizationParameter - -> OauthProfileClientAuthorizationParameterResponse getOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, opaquePassword, select) - -Get an Authorization Parameter object. - -Get an Authorization Parameter object. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationParameterName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String authorizationParameterName = "authorizationParameterName_example"; // String | The name of the authorization parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientAuthorizationParameterResponse result = apiInstance.getOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#getOauthProfileClientAuthorizationParameter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **authorizationParameterName** | **String**| The name of the authorization parameter. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientAuthorizationParameterResponse**](OauthProfileClientAuthorizationParameterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Parameter object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileClientAuthorizationParameters - -> OauthProfileClientAuthorizationParametersResponse getOauthProfileClientAuthorizationParameters(oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Authorization Parameter objects. - -Get a list of Authorization Parameter objects. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationParameterName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientAuthorizationParametersResponse result = apiInstance.getOauthProfileClientAuthorizationParameters(oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#getOauthProfileClientAuthorizationParameters"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientAuthorizationParametersResponse**](OauthProfileClientAuthorizationParametersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Authorization Parameter objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileClientRequiredClaim - -> OauthProfileClientRequiredClaimResponse getOauthProfileClientRequiredClaim(oauthProfileName, clientRequiredClaimName, opaquePassword, select) - -Get a Required Claim object. - -Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String clientRequiredClaimName = "clientRequiredClaimName_example"; // String | The name of the ID token claim to verify. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientRequiredClaimResponse result = apiInstance.getOauthProfileClientRequiredClaim(oauthProfileName, clientRequiredClaimName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#getOauthProfileClientRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **clientRequiredClaimName** | **String**| The name of the ID token claim to verify. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientRequiredClaimResponse**](OauthProfileClientRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileClientRequiredClaims - -> OauthProfileClientRequiredClaimsResponse getOauthProfileClientRequiredClaims(oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Required Claim objects. - -Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientRequiredClaimsResponse result = apiInstance.getOauthProfileClientRequiredClaims(oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#getOauthProfileClientRequiredClaims"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientRequiredClaimsResponse**](OauthProfileClientRequiredClaimsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Required Claim objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileDefaultMsgVpnAccessLevelException - -> OauthProfileDefaultMsgVpnAccessLevelExceptionResponse getOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, opaquePassword, select) - -Get a Message VPN Access-Level Exception object. - -Get a Message VPN Access-Level Exception object. Default message VPN access-level exceptions. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String msgVpnName = "msgVpnName_example"; // String | The name of the message VPN. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse result = apiInstance.getOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#getOauthProfileDefaultMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **msgVpnName** | **String**| The name of the message VPN. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileDefaultMsgVpnAccessLevelExceptionResponse**](OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN Access-Level Exception object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileDefaultMsgVpnAccessLevelExceptions - -> OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse getOauthProfileDefaultMsgVpnAccessLevelExceptions(oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Message VPN Access-Level Exception objects. - -Get a list of Message VPN Access-Level Exception objects. Default message VPN access-level exceptions. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse result = apiInstance.getOauthProfileDefaultMsgVpnAccessLevelExceptions(oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#getOauthProfileDefaultMsgVpnAccessLevelExceptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse**](OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Message VPN Access-Level Exception objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileResourceServerRequiredClaim - -> OauthProfileResourceServerRequiredClaimResponse getOauthProfileResourceServerRequiredClaim(oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select) - -Get a Required Claim object. - -Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String resourceServerRequiredClaimName = "resourceServerRequiredClaimName_example"; // String | The name of the access token claim to verify. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileResourceServerRequiredClaimResponse result = apiInstance.getOauthProfileResourceServerRequiredClaim(oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#getOauthProfileResourceServerRequiredClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **resourceServerRequiredClaimName** | **String**| The name of the access token claim to verify. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileResourceServerRequiredClaimResponse**](OauthProfileResourceServerRequiredClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Required Claim object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfileResourceServerRequiredClaims - -> OauthProfileResourceServerRequiredClaimsResponse getOauthProfileResourceServerRequiredClaims(oauthProfileName, count, cursor, opaquePassword, where, select) - -Get a list of Required Claim objects. - -Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileResourceServerRequiredClaimsResponse result = apiInstance.getOauthProfileResourceServerRequiredClaims(oauthProfileName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#getOauthProfileResourceServerRequiredClaims"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileResourceServerRequiredClaimsResponse**](OauthProfileResourceServerRequiredClaimsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Required Claim objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getOauthProfiles - -> OauthProfilesResponse getOauthProfiles(count, cursor, opaquePassword, where, select) - -Get a list of OAuth Profile objects. - -Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfilesResponse result = apiInstance.getOauthProfiles(count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#getOauthProfiles"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfilesResponse**](OauthProfilesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of OAuth Profile objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceOauthProfile - -> OauthProfileResponse replaceOauthProfile(oauthProfileName, body, opaquePassword, select) - -Replace an OAuth Profile object. - -Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: accessLevelGroupsClaimName|global/admin clientId|global/admin clientRedirectUri|global/admin clientRequiredType|global/admin clientScope|global/admin clientSecret|global/admin clientValidateTypeEnabled|global/admin defaultGlobalAccessLevel|global/admin displayName|global/admin enabled|global/admin endpointAuthorization|global/admin endpointDiscovery|global/admin endpointDiscoveryRefreshInterval|global/admin endpointIntrospection|global/admin endpointIntrospectionTimeout|global/admin endpointJwks|global/admin endpointJwksRefreshInterval|global/admin endpointToken|global/admin endpointTokenTimeout|global/admin endpointUserinfo|global/admin endpointUserinfoTimeout|global/admin interactiveEnabled|global/admin interactivePromptForExpiredSession|global/admin interactivePromptForNewSession|global/admin issuer|global/admin oauthRole|global/admin resourceServerParseAccessTokenEnabled|global/admin resourceServerRequiredAudience|global/admin resourceServerRequiredIssuer|global/admin resourceServerRequiredScope|global/admin resourceServerRequiredType|global/admin resourceServerValidateAudienceEnabled|global/admin resourceServerValidateIssuerEnabled|global/admin resourceServerValidateScopeEnabled|global/admin resourceServerValidateTypeEnabled|global/admin sempEnabled|global/admin usernameClaimName|global/admin This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - OauthProfile body = new OauthProfile(); // OauthProfile | The OAuth Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileResponse result = apiInstance.replaceOauthProfile(oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#replaceOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**OauthProfile**](OauthProfile.md)| The OAuth Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileResponse**](OauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceOauthProfileAccessLevelGroup - -> OauthProfileAccessLevelGroupResponse replaceOauthProfileAccessLevelGroup(oauthProfileName, groupName, body, opaquePassword, select) - -Replace a Group Access Level object. - -Replace a Group Access Level object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- groupName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - OauthProfileAccessLevelGroup body = new OauthProfileAccessLevelGroup(); // OauthProfileAccessLevelGroup | The Group Access Level object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupResponse result = apiInstance.replaceOauthProfileAccessLevelGroup(oauthProfileName, groupName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#replaceOauthProfileAccessLevelGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **body** | [**OauthProfileAccessLevelGroup**](OauthProfileAccessLevelGroup.md)| The Group Access Level object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupResponse**](OauthProfileAccessLevelGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Group Access Level object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException - -> OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, body, opaquePassword, select) - -Replace a Message VPN Access-Level Exception object. - -Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- groupName|x||x|||| msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - String msgVpnName = "msgVpnName_example"; // String | The name of the message VPN. - OauthProfileAccessLevelGroupMsgVpnAccessLevelException body = new OauthProfileAccessLevelGroupMsgVpnAccessLevelException(); // OauthProfileAccessLevelGroupMsgVpnAccessLevelException | The Message VPN Access-Level Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse result = apiInstance.replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **msgVpnName** | **String**| The name of the message VPN. | | -| **body** | [**OauthProfileAccessLevelGroupMsgVpnAccessLevelException**](OauthProfileAccessLevelGroupMsgVpnAccessLevelException.md)| The Message VPN Access-Level Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse**](OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceOauthProfileClientAuthorizationParameter - -> OauthProfileClientAuthorizationParameterResponse replaceOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, body, opaquePassword, select) - -Replace an Authorization Parameter object. - -Replace an Authorization Parameter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authorizationParameterName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String authorizationParameterName = "authorizationParameterName_example"; // String | The name of the authorization parameter. - OauthProfileClientAuthorizationParameter body = new OauthProfileClientAuthorizationParameter(); // OauthProfileClientAuthorizationParameter | The Authorization Parameter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientAuthorizationParameterResponse result = apiInstance.replaceOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#replaceOauthProfileClientAuthorizationParameter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **authorizationParameterName** | **String**| The name of the authorization parameter. | | -| **body** | [**OauthProfileClientAuthorizationParameter**](OauthProfileClientAuthorizationParameter.md)| The Authorization Parameter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientAuthorizationParameterResponse**](OauthProfileClientAuthorizationParameterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Parameter object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceOauthProfileDefaultMsgVpnAccessLevelException - -> OauthProfileDefaultMsgVpnAccessLevelExceptionResponse replaceOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, body, opaquePassword, select) - -Replace a Message VPN Access-Level Exception object. - -Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Default message VPN access-level exceptions. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String msgVpnName = "msgVpnName_example"; // String | The name of the message VPN. - OauthProfileDefaultMsgVpnAccessLevelException body = new OauthProfileDefaultMsgVpnAccessLevelException(); // OauthProfileDefaultMsgVpnAccessLevelException | The Message VPN Access-Level Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse result = apiInstance.replaceOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#replaceOauthProfileDefaultMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **msgVpnName** | **String**| The name of the message VPN. | | -| **body** | [**OauthProfileDefaultMsgVpnAccessLevelException**](OauthProfileDefaultMsgVpnAccessLevelException.md)| The Message VPN Access-Level Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileDefaultMsgVpnAccessLevelExceptionResponse**](OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateOauthProfile - -> OauthProfileResponse updateOauthProfile(oauthProfileName, body, opaquePassword, select) - -Update an OAuth Profile object. - -Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: accessLevelGroupsClaimName|global/admin clientId|global/admin clientRedirectUri|global/admin clientRequiredType|global/admin clientScope|global/admin clientSecret|global/admin clientValidateTypeEnabled|global/admin defaultGlobalAccessLevel|global/admin displayName|global/admin enabled|global/admin endpointAuthorization|global/admin endpointDiscovery|global/admin endpointDiscoveryRefreshInterval|global/admin endpointIntrospection|global/admin endpointIntrospectionTimeout|global/admin endpointJwks|global/admin endpointJwksRefreshInterval|global/admin endpointToken|global/admin endpointTokenTimeout|global/admin endpointUserinfo|global/admin endpointUserinfoTimeout|global/admin interactiveEnabled|global/admin interactivePromptForExpiredSession|global/admin interactivePromptForNewSession|global/admin issuer|global/admin oauthRole|global/admin resourceServerParseAccessTokenEnabled|global/admin resourceServerRequiredAudience|global/admin resourceServerRequiredIssuer|global/admin resourceServerRequiredScope|global/admin resourceServerRequiredType|global/admin resourceServerValidateAudienceEnabled|global/admin resourceServerValidateIssuerEnabled|global/admin resourceServerValidateScopeEnabled|global/admin resourceServerValidateTypeEnabled|global/admin sempEnabled|global/admin usernameClaimName|global/admin This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - OauthProfile body = new OauthProfile(); // OauthProfile | The OAuth Profile object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileResponse result = apiInstance.updateOauthProfile(oauthProfileName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#updateOauthProfile"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **body** | [**OauthProfile**](OauthProfile.md)| The OAuth Profile object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileResponse**](OauthProfileResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The OAuth Profile object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateOauthProfileAccessLevelGroup - -> OauthProfileAccessLevelGroupResponse updateOauthProfileAccessLevelGroup(oauthProfileName, groupName, body, opaquePassword, select) - -Update a Group Access Level object. - -Update a Group Access Level object. Any attribute missing from the request will be left unchanged. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- groupName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - OauthProfileAccessLevelGroup body = new OauthProfileAccessLevelGroup(); // OauthProfileAccessLevelGroup | The Group Access Level object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupResponse result = apiInstance.updateOauthProfileAccessLevelGroup(oauthProfileName, groupName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#updateOauthProfileAccessLevelGroup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **body** | [**OauthProfileAccessLevelGroup**](OauthProfileAccessLevelGroup.md)| The Group Access Level object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupResponse**](OauthProfileAccessLevelGroupResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Group Access Level object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException - -> OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, body, opaquePassword, select) - -Update a Message VPN Access-Level Exception object. - -Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- groupName|x|x|||| msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String groupName = "groupName_example"; // String | The name of the group. - String msgVpnName = "msgVpnName_example"; // String | The name of the message VPN. - OauthProfileAccessLevelGroupMsgVpnAccessLevelException body = new OauthProfileAccessLevelGroupMsgVpnAccessLevelException(); // OauthProfileAccessLevelGroupMsgVpnAccessLevelException | The Message VPN Access-Level Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse result = apiInstance.updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **groupName** | **String**| The name of the group. | | -| **msgVpnName** | **String**| The name of the message VPN. | | -| **body** | [**OauthProfileAccessLevelGroupMsgVpnAccessLevelException**](OauthProfileAccessLevelGroupMsgVpnAccessLevelException.md)| The Message VPN Access-Level Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse**](OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateOauthProfileClientAuthorizationParameter - -> OauthProfileClientAuthorizationParameterResponse updateOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, body, opaquePassword, select) - -Update an Authorization Parameter object. - -Update an Authorization Parameter object. Any attribute missing from the request will be left unchanged. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authorizationParameterName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String authorizationParameterName = "authorizationParameterName_example"; // String | The name of the authorization parameter. - OauthProfileClientAuthorizationParameter body = new OauthProfileClientAuthorizationParameter(); // OauthProfileClientAuthorizationParameter | The Authorization Parameter object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileClientAuthorizationParameterResponse result = apiInstance.updateOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#updateOauthProfileClientAuthorizationParameter"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **authorizationParameterName** | **String**| The name of the authorization parameter. | | -| **body** | [**OauthProfileClientAuthorizationParameter**](OauthProfileClientAuthorizationParameter.md)| The Authorization Parameter object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileClientAuthorizationParameterResponse**](OauthProfileClientAuthorizationParameterResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Authorization Parameter object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateOauthProfileDefaultMsgVpnAccessLevelException - -> OauthProfileDefaultMsgVpnAccessLevelExceptionResponse updateOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, body, opaquePassword, select) - -Update a Message VPN Access-Level Exception object. - -Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. Default message VPN access-level exceptions. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.OauthProfileApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - OauthProfileApi apiInstance = new OauthProfileApi(defaultClient); - String oauthProfileName = "oauthProfileName_example"; // String | The name of the OAuth profile. - String msgVpnName = "msgVpnName_example"; // String | The name of the message VPN. - OauthProfileDefaultMsgVpnAccessLevelException body = new OauthProfileDefaultMsgVpnAccessLevelException(); // OauthProfileDefaultMsgVpnAccessLevelException | The Message VPN Access-Level Exception object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse result = apiInstance.updateOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling OauthProfileApi#updateOauthProfileDefaultMsgVpnAccessLevelException"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **oauthProfileName** | **String**| The name of the OAuth profile. | | -| **msgVpnName** | **String**| The name of the message VPN. | | -| **body** | [**OauthProfileDefaultMsgVpnAccessLevelException**](OauthProfileDefaultMsgVpnAccessLevelException.md)| The Message VPN Access-Level Exception object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**OauthProfileDefaultMsgVpnAccessLevelExceptionResponse**](OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/OauthProfileClientAllowedHost.md b/service/solace-config-client/docs/OauthProfileClientAllowedHost.md deleted file mode 100644 index ce8654fbb..000000000 --- a/service/solace-config-client/docs/OauthProfileClientAllowedHost.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# OauthProfileClientAllowedHost - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**allowedHost** | **String** | An allowed value for the Host header. | [optional] | -|**oauthProfileName** | **String** | The name of the OAuth profile. | [optional] | - - - diff --git a/service/solace-config-client/docs/OauthProfileClientAllowedHostLinks.md b/service/solace-config-client/docs/OauthProfileClientAllowedHostLinks.md deleted file mode 100644 index 9743cef42..000000000 --- a/service/solace-config-client/docs/OauthProfileClientAllowedHostLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# OauthProfileClientAllowedHostLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Allowed Host Value object. | [optional] | - - - diff --git a/service/solace-config-client/docs/OauthProfileClientAllowedHostResponse.md b/service/solace-config-client/docs/OauthProfileClientAllowedHostResponse.md deleted file mode 100644 index 244114e4d..000000000 --- a/service/solace-config-client/docs/OauthProfileClientAllowedHostResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileClientAllowedHostResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**OauthProfileClientAllowedHost**](OauthProfileClientAllowedHost.md) | | [optional] | -|**links** | [**OauthProfileClientAllowedHostLinks**](OauthProfileClientAllowedHostLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/OauthProfileClientAllowedHostsResponse.md b/service/solace-config-client/docs/OauthProfileClientAllowedHostsResponse.md deleted file mode 100644 index f1de7b2fd..000000000 --- a/service/solace-config-client/docs/OauthProfileClientAllowedHostsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileClientAllowedHostsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<OauthProfileClientAllowedHost>**](OauthProfileClientAllowedHost.md) | | [optional] | -|**links** | [**List<OauthProfileClientAllowedHostLinks>**](OauthProfileClientAllowedHostLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/OauthProfileClientAuthorizationParameter.md b/service/solace-config-client/docs/OauthProfileClientAuthorizationParameter.md deleted file mode 100644 index ac82fe3a7..000000000 --- a/service/solace-config-client/docs/OauthProfileClientAuthorizationParameter.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileClientAuthorizationParameter - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**authorizationParameterName** | **String** | The name of the authorization parameter. | [optional] | -|**authorizationParameterValue** | **String** | The authorization parameter value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**oauthProfileName** | **String** | The name of the OAuth profile. | [optional] | - - - diff --git a/service/solace-config-client/docs/OauthProfileClientAuthorizationParameterLinks.md b/service/solace-config-client/docs/OauthProfileClientAuthorizationParameterLinks.md deleted file mode 100644 index 9433b8bfd..000000000 --- a/service/solace-config-client/docs/OauthProfileClientAuthorizationParameterLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# OauthProfileClientAuthorizationParameterLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Authorization Parameter object. | [optional] | - - - diff --git a/service/solace-config-client/docs/OauthProfileClientAuthorizationParameterResponse.md b/service/solace-config-client/docs/OauthProfileClientAuthorizationParameterResponse.md deleted file mode 100644 index a39ac5efe..000000000 --- a/service/solace-config-client/docs/OauthProfileClientAuthorizationParameterResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileClientAuthorizationParameterResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**OauthProfileClientAuthorizationParameter**](OauthProfileClientAuthorizationParameter.md) | | [optional] | -|**links** | [**OauthProfileClientAuthorizationParameterLinks**](OauthProfileClientAuthorizationParameterLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/OauthProfileClientAuthorizationParametersResponse.md b/service/solace-config-client/docs/OauthProfileClientAuthorizationParametersResponse.md deleted file mode 100644 index 4eee3f3ca..000000000 --- a/service/solace-config-client/docs/OauthProfileClientAuthorizationParametersResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileClientAuthorizationParametersResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<OauthProfileClientAuthorizationParameter>**](OauthProfileClientAuthorizationParameter.md) | | [optional] | -|**links** | [**List<OauthProfileClientAuthorizationParameterLinks>**](OauthProfileClientAuthorizationParameterLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/OauthProfileClientRequiredClaim.md b/service/solace-config-client/docs/OauthProfileClientRequiredClaim.md deleted file mode 100644 index 35019375a..000000000 --- a/service/solace-config-client/docs/OauthProfileClientRequiredClaim.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileClientRequiredClaim - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**clientRequiredClaimName** | **String** | The name of the ID token claim to verify. | [optional] | -|**clientRequiredClaimValue** | **String** | The required claim value, which must be a string containing a valid JSON value. | [optional] | -|**oauthProfileName** | **String** | The name of the OAuth profile. | [optional] | - - - diff --git a/service/solace-config-client/docs/OauthProfileClientRequiredClaimLinks.md b/service/solace-config-client/docs/OauthProfileClientRequiredClaimLinks.md deleted file mode 100644 index 8a9b844bb..000000000 --- a/service/solace-config-client/docs/OauthProfileClientRequiredClaimLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# OauthProfileClientRequiredClaimLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Required Claim object. | [optional] | - - - diff --git a/service/solace-config-client/docs/OauthProfileClientRequiredClaimResponse.md b/service/solace-config-client/docs/OauthProfileClientRequiredClaimResponse.md deleted file mode 100644 index c4be4f369..000000000 --- a/service/solace-config-client/docs/OauthProfileClientRequiredClaimResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileClientRequiredClaimResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**OauthProfileClientRequiredClaim**](OauthProfileClientRequiredClaim.md) | | [optional] | -|**links** | [**OauthProfileClientRequiredClaimLinks**](OauthProfileClientRequiredClaimLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/OauthProfileClientRequiredClaimsResponse.md b/service/solace-config-client/docs/OauthProfileClientRequiredClaimsResponse.md deleted file mode 100644 index 347225b95..000000000 --- a/service/solace-config-client/docs/OauthProfileClientRequiredClaimsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileClientRequiredClaimsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<OauthProfileClientRequiredClaim>**](OauthProfileClientRequiredClaim.md) | | [optional] | -|**links** | [**List<OauthProfileClientRequiredClaimLinks>**](OauthProfileClientRequiredClaimLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/OauthProfileDefaultMsgVpnAccessLevelException.md b/service/solace-config-client/docs/OauthProfileDefaultMsgVpnAccessLevelException.md deleted file mode 100644 index 72c8c5389..000000000 --- a/service/solace-config-client/docs/OauthProfileDefaultMsgVpnAccessLevelException.md +++ /dev/null @@ -1,25 +0,0 @@ - - -# OauthProfileDefaultMsgVpnAccessLevelException - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**accessLevel** | [**AccessLevelEnum**](#AccessLevelEnum) | The message VPN access level. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to a Message VPN. \"read-only\" - User has read-only access to a Message VPN. \"read-write\" - User has read-write access to most Message VPN settings. </pre> | [optional] | -|**msgVpnName** | **String** | The name of the message VPN. | [optional] | -|**oauthProfileName** | **String** | The name of the OAuth profile. | [optional] | - - - -## Enum: AccessLevelEnum - -| Name | Value | -|---- | -----| -| NONE | "none" | -| READ_ONLY | "read-only" | -| READ_WRITE | "read-write" | - - - diff --git a/service/solace-config-client/docs/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks.md b/service/solace-config-client/docs/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks.md deleted file mode 100644 index 5392c9645..000000000 --- a/service/solace-config-client/docs/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# OauthProfileDefaultMsgVpnAccessLevelExceptionLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Message VPN Access-Level Exception object. | [optional] | - - - diff --git a/service/solace-config-client/docs/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.md b/service/solace-config-client/docs/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.md deleted file mode 100644 index 9ee14e60d..000000000 --- a/service/solace-config-client/docs/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileDefaultMsgVpnAccessLevelExceptionResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**OauthProfileDefaultMsgVpnAccessLevelException**](OauthProfileDefaultMsgVpnAccessLevelException.md) | | [optional] | -|**links** | [**OauthProfileDefaultMsgVpnAccessLevelExceptionLinks**](OauthProfileDefaultMsgVpnAccessLevelExceptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.md b/service/solace-config-client/docs/OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.md deleted file mode 100644 index 51451e51f..000000000 --- a/service/solace-config-client/docs/OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<OauthProfileDefaultMsgVpnAccessLevelException>**](OauthProfileDefaultMsgVpnAccessLevelException.md) | | [optional] | -|**links** | [**List<OauthProfileDefaultMsgVpnAccessLevelExceptionLinks>**](OauthProfileDefaultMsgVpnAccessLevelExceptionLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/OauthProfileLinks.md b/service/solace-config-client/docs/OauthProfileLinks.md deleted file mode 100644 index 07cf063ca..000000000 --- a/service/solace-config-client/docs/OauthProfileLinks.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# OauthProfileLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**accessLevelGroupsUri** | **String** | The URI of this OAuth Profile's collection of Group Access Level objects. | [optional] | -|**clientAllowedHostsUri** | **String** | The URI of this OAuth Profile's collection of Allowed Host Value objects. | [optional] | -|**clientAuthorizationParametersUri** | **String** | The URI of this OAuth Profile's collection of Authorization Parameter objects. | [optional] | -|**clientRequiredClaimsUri** | **String** | The URI of this OAuth Profile's collection of Required Claim objects. | [optional] | -|**defaultMsgVpnAccessLevelExceptionsUri** | **String** | The URI of this OAuth Profile's collection of Message VPN Access-Level Exception objects. | [optional] | -|**resourceServerRequiredClaimsUri** | **String** | The URI of this OAuth Profile's collection of Required Claim objects. | [optional] | -|**uri** | **String** | The URI of this OAuth Profile object. | [optional] | - - - diff --git a/service/solace-config-client/docs/OauthProfileResourceServerRequiredClaim.md b/service/solace-config-client/docs/OauthProfileResourceServerRequiredClaim.md deleted file mode 100644 index de5607f30..000000000 --- a/service/solace-config-client/docs/OauthProfileResourceServerRequiredClaim.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileResourceServerRequiredClaim - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**oauthProfileName** | **String** | The name of the OAuth profile. | [optional] | -|**resourceServerRequiredClaimName** | **String** | The name of the access token claim to verify. | [optional] | -|**resourceServerRequiredClaimValue** | **String** | The required claim value, which must be a string containing a valid JSON value. | [optional] | - - - diff --git a/service/solace-config-client/docs/OauthProfileResourceServerRequiredClaimLinks.md b/service/solace-config-client/docs/OauthProfileResourceServerRequiredClaimLinks.md deleted file mode 100644 index 991f2ed92..000000000 --- a/service/solace-config-client/docs/OauthProfileResourceServerRequiredClaimLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# OauthProfileResourceServerRequiredClaimLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Required Claim object. | [optional] | - - - diff --git a/service/solace-config-client/docs/OauthProfileResourceServerRequiredClaimResponse.md b/service/solace-config-client/docs/OauthProfileResourceServerRequiredClaimResponse.md deleted file mode 100644 index ea93db9d4..000000000 --- a/service/solace-config-client/docs/OauthProfileResourceServerRequiredClaimResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileResourceServerRequiredClaimResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**OauthProfileResourceServerRequiredClaim**](OauthProfileResourceServerRequiredClaim.md) | | [optional] | -|**links** | [**OauthProfileResourceServerRequiredClaimLinks**](OauthProfileResourceServerRequiredClaimLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/OauthProfileResourceServerRequiredClaimsResponse.md b/service/solace-config-client/docs/OauthProfileResourceServerRequiredClaimsResponse.md deleted file mode 100644 index 3df2e8289..000000000 --- a/service/solace-config-client/docs/OauthProfileResourceServerRequiredClaimsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileResourceServerRequiredClaimsResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<OauthProfileResourceServerRequiredClaim>**](OauthProfileResourceServerRequiredClaim.md) | | [optional] | -|**links** | [**List<OauthProfileResourceServerRequiredClaimLinks>**](OauthProfileResourceServerRequiredClaimLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/OauthProfileResponse.md b/service/solace-config-client/docs/OauthProfileResponse.md deleted file mode 100644 index ff37b70b6..000000000 --- a/service/solace-config-client/docs/OauthProfileResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfileResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**OauthProfile**](OauthProfile.md) | | [optional] | -|**links** | [**OauthProfileLinks**](OauthProfileLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/OauthProfilesResponse.md b/service/solace-config-client/docs/OauthProfilesResponse.md deleted file mode 100644 index b4ec618e3..000000000 --- a/service/solace-config-client/docs/OauthProfilesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# OauthProfilesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<OauthProfile>**](OauthProfile.md) | | [optional] | -|**links** | [**List<OauthProfileLinks>**](OauthProfileLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/QueueApi.md b/service/solace-config-client/docs/QueueApi.md deleted file mode 100644 index a8ae1d9ef..000000000 --- a/service/solace-config-client/docs/QueueApi.md +++ /dev/null @@ -1,820 +0,0 @@ -# QueueApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnQueue**](QueueApi.md#createMsgVpnQueue) | **POST** /msgVpns/{msgVpnName}/queues | Create a Queue object. | -| [**createMsgVpnQueueSubscription**](QueueApi.md#createMsgVpnQueueSubscription) | **POST** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions | Create a Queue Subscription object. | -| [**deleteMsgVpnQueue**](QueueApi.md#deleteMsgVpnQueue) | **DELETE** /msgVpns/{msgVpnName}/queues/{queueName} | Delete a Queue object. | -| [**deleteMsgVpnQueueSubscription**](QueueApi.md#deleteMsgVpnQueueSubscription) | **DELETE** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic} | Delete a Queue Subscription object. | -| [**getMsgVpnQueue**](QueueApi.md#getMsgVpnQueue) | **GET** /msgVpns/{msgVpnName}/queues/{queueName} | Get a Queue object. | -| [**getMsgVpnQueueSubscription**](QueueApi.md#getMsgVpnQueueSubscription) | **GET** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic} | Get a Queue Subscription object. | -| [**getMsgVpnQueueSubscriptions**](QueueApi.md#getMsgVpnQueueSubscriptions) | **GET** /msgVpns/{msgVpnName}/queues/{queueName}/subscriptions | Get a list of Queue Subscription objects. | -| [**getMsgVpnQueues**](QueueApi.md#getMsgVpnQueues) | **GET** /msgVpns/{msgVpnName}/queues | Get a list of Queue objects. | -| [**replaceMsgVpnQueue**](QueueApi.md#replaceMsgVpnQueue) | **PUT** /msgVpns/{msgVpnName}/queues/{queueName} | Replace a Queue object. | -| [**updateMsgVpnQueue**](QueueApi.md#updateMsgVpnQueue) | **PATCH** /msgVpns/{msgVpnName}/queues/{queueName} | Update a Queue object. | - - - -## createMsgVpnQueue - -> MsgVpnQueueResponse createMsgVpnQueue(msgVpnName, body, opaquePassword, select) - -Create a Queue object. - -Create a Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.QueueApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - QueueApi apiInstance = new QueueApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnQueue body = new MsgVpnQueue(); // MsgVpnQueue | The Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueResponse result = apiInstance.createMsgVpnQueue(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling QueueApi#createMsgVpnQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnQueue**](MsgVpnQueue.md)| The Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueResponse**](MsgVpnQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnQueueSubscription - -> MsgVpnQueueSubscriptionResponse createMsgVpnQueueSubscription(msgVpnName, queueName, body, opaquePassword, select) - -Create a Queue Subscription object. - -Create a Queue Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.QueueApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - QueueApi apiInstance = new QueueApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - MsgVpnQueueSubscription body = new MsgVpnQueueSubscription(); // MsgVpnQueueSubscription | The Queue Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueSubscriptionResponse result = apiInstance.createMsgVpnQueueSubscription(msgVpnName, queueName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling QueueApi#createMsgVpnQueueSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **body** | [**MsgVpnQueueSubscription**](MsgVpnQueueSubscription.md)| The Queue Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueSubscriptionResponse**](MsgVpnQueueSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Subscription object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnQueue - -> SempMetaOnlyResponse deleteMsgVpnQueue(msgVpnName, queueName) - -Delete a Queue object. - -Delete a Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.QueueApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - QueueApi apiInstance = new QueueApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnQueue(msgVpnName, queueName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling QueueApi#deleteMsgVpnQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnQueueSubscription - -> SempMetaOnlyResponse deleteMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic) - -Delete a Queue Subscription object. - -Delete a Queue Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.QueueApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - QueueApi apiInstance = new QueueApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - String subscriptionTopic = "subscriptionTopic_example"; // String | The topic of the Subscription. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling QueueApi#deleteMsgVpnQueueSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **subscriptionTopic** | **String**| The topic of the Subscription. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueue - -> MsgVpnQueueResponse getMsgVpnQueue(msgVpnName, queueName, opaquePassword, select) - -Get a Queue object. - -Get a Queue object. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.QueueApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - QueueApi apiInstance = new QueueApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueResponse result = apiInstance.getMsgVpnQueue(msgVpnName, queueName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling QueueApi#getMsgVpnQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueResponse**](MsgVpnQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueueSubscription - -> MsgVpnQueueSubscriptionResponse getMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic, opaquePassword, select) - -Get a Queue Subscription object. - -Get a Queue Subscription object. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.QueueApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - QueueApi apiInstance = new QueueApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - String subscriptionTopic = "subscriptionTopic_example"; // String | The topic of the Subscription. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueSubscriptionResponse result = apiInstance.getMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling QueueApi#getMsgVpnQueueSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **subscriptionTopic** | **String**| The topic of the Subscription. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueSubscriptionResponse**](MsgVpnQueueSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Subscription object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueueSubscriptions - -> MsgVpnQueueSubscriptionsResponse getMsgVpnQueueSubscriptions(msgVpnName, queueName, count, cursor, opaquePassword, where, select) - -Get a list of Queue Subscription objects. - -Get a list of Queue Subscription objects. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.QueueApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - QueueApi apiInstance = new QueueApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueSubscriptionsResponse result = apiInstance.getMsgVpnQueueSubscriptions(msgVpnName, queueName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling QueueApi#getMsgVpnQueueSubscriptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueSubscriptionsResponse**](MsgVpnQueueSubscriptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Queue Subscription objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueues - -> MsgVpnQueuesResponse getMsgVpnQueues(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Queue objects. - -Get a list of Queue objects. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.QueueApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - QueueApi apiInstance = new QueueApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueuesResponse result = apiInstance.getMsgVpnQueues(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling QueueApi#getMsgVpnQueues"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueuesResponse**](MsgVpnQueuesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Queue objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnQueue - -> MsgVpnQueueResponse replaceMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select) - -Replace a Queue object. - -Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| queueName|x||x|||| respectMsgPriorityEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.QueueApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - QueueApi apiInstance = new QueueApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - MsgVpnQueue body = new MsgVpnQueue(); // MsgVpnQueue | The Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueResponse result = apiInstance.replaceMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling QueueApi#replaceMsgVpnQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **body** | [**MsgVpnQueue**](MsgVpnQueue.md)| The Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueResponse**](MsgVpnQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnQueue - -> MsgVpnQueueResponse updateMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select) - -Update a Queue object. - -Update a Queue object. Any attribute missing from the request will be left unchanged. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| queueName|x|x|||| respectMsgPriorityEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.QueueApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - QueueApi apiInstance = new QueueApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueName = "queueName_example"; // String | The name of the Queue. - MsgVpnQueue body = new MsgVpnQueue(); // MsgVpnQueue | The Queue object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueResponse result = apiInstance.updateMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling QueueApi#updateMsgVpnQueue"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueName** | **String**| The name of the Queue. | | -| **body** | [**MsgVpnQueue**](MsgVpnQueue.md)| The Queue object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueResponse**](MsgVpnQueueResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/QueueTemplateApi.md b/service/solace-config-client/docs/QueueTemplateApi.md deleted file mode 100644 index 3232cf563..000000000 --- a/service/solace-config-client/docs/QueueTemplateApi.md +++ /dev/null @@ -1,492 +0,0 @@ -# QueueTemplateApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnQueueTemplate**](QueueTemplateApi.md#createMsgVpnQueueTemplate) | **POST** /msgVpns/{msgVpnName}/queueTemplates | Create a Queue Template object. | -| [**deleteMsgVpnQueueTemplate**](QueueTemplateApi.md#deleteMsgVpnQueueTemplate) | **DELETE** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Delete a Queue Template object. | -| [**getMsgVpnQueueTemplate**](QueueTemplateApi.md#getMsgVpnQueueTemplate) | **GET** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Get a Queue Template object. | -| [**getMsgVpnQueueTemplates**](QueueTemplateApi.md#getMsgVpnQueueTemplates) | **GET** /msgVpns/{msgVpnName}/queueTemplates | Get a list of Queue Template objects. | -| [**replaceMsgVpnQueueTemplate**](QueueTemplateApi.md#replaceMsgVpnQueueTemplate) | **PUT** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Replace a Queue Template object. | -| [**updateMsgVpnQueueTemplate**](QueueTemplateApi.md#updateMsgVpnQueueTemplate) | **PATCH** /msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName} | Update a Queue Template object. | - - - -## createMsgVpnQueueTemplate - -> MsgVpnQueueTemplateResponse createMsgVpnQueueTemplate(msgVpnName, body, opaquePassword, select) - -Create a Queue Template object. - -Create a Queue Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.QueueTemplateApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - QueueTemplateApi apiInstance = new QueueTemplateApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnQueueTemplate body = new MsgVpnQueueTemplate(); // MsgVpnQueueTemplate | The Queue Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueTemplateResponse result = apiInstance.createMsgVpnQueueTemplate(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling QueueTemplateApi#createMsgVpnQueueTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnQueueTemplate**](MsgVpnQueueTemplate.md)| The Queue Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueTemplateResponse**](MsgVpnQueueTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Template object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnQueueTemplate - -> SempMetaOnlyResponse deleteMsgVpnQueueTemplate(msgVpnName, queueTemplateName) - -Delete a Queue Template object. - -Delete a Queue Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.QueueTemplateApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - QueueTemplateApi apiInstance = new QueueTemplateApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueTemplateName = "queueTemplateName_example"; // String | The name of the Queue Template. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnQueueTemplate(msgVpnName, queueTemplateName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling QueueTemplateApi#deleteMsgVpnQueueTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueTemplateName** | **String**| The name of the Queue Template. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueueTemplate - -> MsgVpnQueueTemplateResponse getMsgVpnQueueTemplate(msgVpnName, queueTemplateName, opaquePassword, select) - -Get a Queue Template object. - -Get a Queue Template object. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.QueueTemplateApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - QueueTemplateApi apiInstance = new QueueTemplateApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueTemplateName = "queueTemplateName_example"; // String | The name of the Queue Template. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueTemplateResponse result = apiInstance.getMsgVpnQueueTemplate(msgVpnName, queueTemplateName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling QueueTemplateApi#getMsgVpnQueueTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueTemplateName** | **String**| The name of the Queue Template. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueTemplateResponse**](MsgVpnQueueTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Template object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnQueueTemplates - -> MsgVpnQueueTemplatesResponse getMsgVpnQueueTemplates(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Queue Template objects. - -Get a list of Queue Template objects. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.QueueTemplateApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - QueueTemplateApi apiInstance = new QueueTemplateApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueTemplatesResponse result = apiInstance.getMsgVpnQueueTemplates(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling QueueTemplateApi#getMsgVpnQueueTemplates"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueTemplatesResponse**](MsgVpnQueueTemplatesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Queue Template objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnQueueTemplate - -> MsgVpnQueueTemplateResponse replaceMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select) - -Replace a Queue Template object. - -Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.QueueTemplateApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - QueueTemplateApi apiInstance = new QueueTemplateApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueTemplateName = "queueTemplateName_example"; // String | The name of the Queue Template. - MsgVpnQueueTemplate body = new MsgVpnQueueTemplate(); // MsgVpnQueueTemplate | The Queue Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueTemplateResponse result = apiInstance.replaceMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling QueueTemplateApi#replaceMsgVpnQueueTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueTemplateName** | **String**| The name of the Queue Template. | | -| **body** | [**MsgVpnQueueTemplate**](MsgVpnQueueTemplate.md)| The Queue Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueTemplateResponse**](MsgVpnQueueTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Template object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnQueueTemplate - -> MsgVpnQueueTemplateResponse updateMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select) - -Update a Queue Template object. - -Update a Queue Template object. Any attribute missing from the request will be left unchanged. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.QueueTemplateApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - QueueTemplateApi apiInstance = new QueueTemplateApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String queueTemplateName = "queueTemplateName_example"; // String | The name of the Queue Template. - MsgVpnQueueTemplate body = new MsgVpnQueueTemplate(); // MsgVpnQueueTemplate | The Queue Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnQueueTemplateResponse result = apiInstance.updateMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling QueueTemplateApi#updateMsgVpnQueueTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **queueTemplateName** | **String**| The name of the Queue Template. | | -| **body** | [**MsgVpnQueueTemplate**](MsgVpnQueueTemplate.md)| The Queue Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnQueueTemplateResponse**](MsgVpnQueueTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Template object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/ReplayLogApi.md b/service/solace-config-client/docs/ReplayLogApi.md deleted file mode 100644 index 5681d30cd..000000000 --- a/service/solace-config-client/docs/ReplayLogApi.md +++ /dev/null @@ -1,820 +0,0 @@ -# ReplayLogApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnReplayLog**](ReplayLogApi.md#createMsgVpnReplayLog) | **POST** /msgVpns/{msgVpnName}/replayLogs | Create a Replay Log object. | -| [**createMsgVpnReplayLogTopicFilterSubscription**](ReplayLogApi.md#createMsgVpnReplayLogTopicFilterSubscription) | **POST** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions | Create a Topic Filter Subscription object. | -| [**deleteMsgVpnReplayLog**](ReplayLogApi.md#deleteMsgVpnReplayLog) | **DELETE** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Delete a Replay Log object. | -| [**deleteMsgVpnReplayLogTopicFilterSubscription**](ReplayLogApi.md#deleteMsgVpnReplayLogTopicFilterSubscription) | **DELETE** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription} | Delete a Topic Filter Subscription object. | -| [**getMsgVpnReplayLog**](ReplayLogApi.md#getMsgVpnReplayLog) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Get a Replay Log object. | -| [**getMsgVpnReplayLogTopicFilterSubscription**](ReplayLogApi.md#getMsgVpnReplayLogTopicFilterSubscription) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription} | Get a Topic Filter Subscription object. | -| [**getMsgVpnReplayLogTopicFilterSubscriptions**](ReplayLogApi.md#getMsgVpnReplayLogTopicFilterSubscriptions) | **GET** /msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions | Get a list of Topic Filter Subscription objects. | -| [**getMsgVpnReplayLogs**](ReplayLogApi.md#getMsgVpnReplayLogs) | **GET** /msgVpns/{msgVpnName}/replayLogs | Get a list of Replay Log objects. | -| [**replaceMsgVpnReplayLog**](ReplayLogApi.md#replaceMsgVpnReplayLog) | **PUT** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Replace a Replay Log object. | -| [**updateMsgVpnReplayLog**](ReplayLogApi.md#updateMsgVpnReplayLog) | **PATCH** /msgVpns/{msgVpnName}/replayLogs/{replayLogName} | Update a Replay Log object. | - - - -## createMsgVpnReplayLog - -> MsgVpnReplayLogResponse createMsgVpnReplayLog(msgVpnName, body, opaquePassword, select) - -Create a Replay Log object. - -Create a Replay Log object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ReplayLogApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ReplayLogApi apiInstance = new ReplayLogApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnReplayLog body = new MsgVpnReplayLog(); // MsgVpnReplayLog | The Replay Log object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogResponse result = apiInstance.createMsgVpnReplayLog(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ReplayLogApi#createMsgVpnReplayLog"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnReplayLog**](MsgVpnReplayLog.md)| The Replay Log object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogResponse**](MsgVpnReplayLogResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replay Log object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnReplayLogTopicFilterSubscription - -> MsgVpnReplayLogTopicFilterSubscriptionResponse createMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, body, opaquePassword, select) - -Create a Topic Filter Subscription object. - -Create a Topic Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x||x||| topicFilterSubscription|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ReplayLogApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ReplayLogApi apiInstance = new ReplayLogApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - MsgVpnReplayLogTopicFilterSubscription body = new MsgVpnReplayLogTopicFilterSubscription(); // MsgVpnReplayLogTopicFilterSubscription | The Topic Filter Subscription object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogTopicFilterSubscriptionResponse result = apiInstance.createMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ReplayLogApi#createMsgVpnReplayLogTopicFilterSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **body** | [**MsgVpnReplayLogTopicFilterSubscription**](MsgVpnReplayLogTopicFilterSubscription.md)| The Topic Filter Subscription object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogTopicFilterSubscriptionResponse**](MsgVpnReplayLogTopicFilterSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Filter Subscription object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnReplayLog - -> SempMetaOnlyResponse deleteMsgVpnReplayLog(msgVpnName, replayLogName) - -Delete a Replay Log object. - -Delete a Replay Log object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ReplayLogApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ReplayLogApi apiInstance = new ReplayLogApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnReplayLog(msgVpnName, replayLogName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ReplayLogApi#deleteMsgVpnReplayLog"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnReplayLogTopicFilterSubscription - -> SempMetaOnlyResponse deleteMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription) - -Delete a Topic Filter Subscription object. - -Delete a Topic Filter Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ReplayLogApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ReplayLogApi apiInstance = new ReplayLogApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - String topicFilterSubscription = "topicFilterSubscription_example"; // String | The topic of the Subscription. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ReplayLogApi#deleteMsgVpnReplayLogTopicFilterSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **topicFilterSubscription** | **String**| The topic of the Subscription. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplayLog - -> MsgVpnReplayLogResponse getMsgVpnReplayLog(msgVpnName, replayLogName, opaquePassword, select) - -Get a Replay Log object. - -Get a Replay Log object. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ReplayLogApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ReplayLogApi apiInstance = new ReplayLogApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogResponse result = apiInstance.getMsgVpnReplayLog(msgVpnName, replayLogName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ReplayLogApi#getMsgVpnReplayLog"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogResponse**](MsgVpnReplayLogResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replay Log object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplayLogTopicFilterSubscription - -> MsgVpnReplayLogTopicFilterSubscriptionResponse getMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription, opaquePassword, select) - -Get a Topic Filter Subscription object. - -Get a Topic Filter Subscription object. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ReplayLogApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ReplayLogApi apiInstance = new ReplayLogApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - String topicFilterSubscription = "topicFilterSubscription_example"; // String | The topic of the Subscription. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogTopicFilterSubscriptionResponse result = apiInstance.getMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ReplayLogApi#getMsgVpnReplayLogTopicFilterSubscription"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **topicFilterSubscription** | **String**| The topic of the Subscription. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogTopicFilterSubscriptionResponse**](MsgVpnReplayLogTopicFilterSubscriptionResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Filter Subscription object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplayLogTopicFilterSubscriptions - -> MsgVpnReplayLogTopicFilterSubscriptionsResponse getMsgVpnReplayLogTopicFilterSubscriptions(msgVpnName, replayLogName, count, cursor, opaquePassword, where, select) - -Get a list of Topic Filter Subscription objects. - -Get a list of Topic Filter Subscription objects. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ReplayLogApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ReplayLogApi apiInstance = new ReplayLogApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogTopicFilterSubscriptionsResponse result = apiInstance.getMsgVpnReplayLogTopicFilterSubscriptions(msgVpnName, replayLogName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ReplayLogApi#getMsgVpnReplayLogTopicFilterSubscriptions"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogTopicFilterSubscriptionsResponse**](MsgVpnReplayLogTopicFilterSubscriptionsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Topic Filter Subscription objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplayLogs - -> MsgVpnReplayLogsResponse getMsgVpnReplayLogs(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Replay Log objects. - -Get a list of Replay Log objects. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ReplayLogApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ReplayLogApi apiInstance = new ReplayLogApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogsResponse result = apiInstance.getMsgVpnReplayLogs(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ReplayLogApi#getMsgVpnReplayLogs"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogsResponse**](MsgVpnReplayLogsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Replay Log objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnReplayLog - -> MsgVpnReplayLogResponse replaceMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select) - -Replace a Replay Log object. - -Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replayLogName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ReplayLogApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ReplayLogApi apiInstance = new ReplayLogApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - MsgVpnReplayLog body = new MsgVpnReplayLog(); // MsgVpnReplayLog | The Replay Log object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogResponse result = apiInstance.replaceMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ReplayLogApi#replaceMsgVpnReplayLog"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **body** | [**MsgVpnReplayLog**](MsgVpnReplayLog.md)| The Replay Log object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogResponse**](MsgVpnReplayLogResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replay Log object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnReplayLog - -> MsgVpnReplayLogResponse updateMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select) - -Update a Replay Log object. - -Update a Replay Log object. Any attribute missing from the request will be left unchanged. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ReplayLogApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ReplayLogApi apiInstance = new ReplayLogApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replayLogName = "replayLogName_example"; // String | The name of the Replay Log. - MsgVpnReplayLog body = new MsgVpnReplayLog(); // MsgVpnReplayLog | The Replay Log object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplayLogResponse result = apiInstance.updateMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ReplayLogApi#updateMsgVpnReplayLog"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replayLogName** | **String**| The name of the Replay Log. | | -| **body** | [**MsgVpnReplayLog**](MsgVpnReplayLog.md)| The Replay Log object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplayLogResponse**](MsgVpnReplayLogResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replay Log object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/ReplicatedTopicApi.md b/service/solace-config-client/docs/ReplicatedTopicApi.md deleted file mode 100644 index d285190f5..000000000 --- a/service/solace-config-client/docs/ReplicatedTopicApi.md +++ /dev/null @@ -1,492 +0,0 @@ -# ReplicatedTopicApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnReplicatedTopic**](ReplicatedTopicApi.md#createMsgVpnReplicatedTopic) | **POST** /msgVpns/{msgVpnName}/replicatedTopics | Create a Replicated Topic object. | -| [**deleteMsgVpnReplicatedTopic**](ReplicatedTopicApi.md#deleteMsgVpnReplicatedTopic) | **DELETE** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Delete a Replicated Topic object. | -| [**getMsgVpnReplicatedTopic**](ReplicatedTopicApi.md#getMsgVpnReplicatedTopic) | **GET** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Get a Replicated Topic object. | -| [**getMsgVpnReplicatedTopics**](ReplicatedTopicApi.md#getMsgVpnReplicatedTopics) | **GET** /msgVpns/{msgVpnName}/replicatedTopics | Get a list of Replicated Topic objects. | -| [**replaceMsgVpnReplicatedTopic**](ReplicatedTopicApi.md#replaceMsgVpnReplicatedTopic) | **PUT** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Replace a Replicated Topic object. | -| [**updateMsgVpnReplicatedTopic**](ReplicatedTopicApi.md#updateMsgVpnReplicatedTopic) | **PATCH** /msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic} | Update a Replicated Topic object. | - - - -## createMsgVpnReplicatedTopic - -> MsgVpnReplicatedTopicResponse createMsgVpnReplicatedTopic(msgVpnName, body, opaquePassword, select) - -Create a Replicated Topic object. - -Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ReplicatedTopicApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ReplicatedTopicApi apiInstance = new ReplicatedTopicApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnReplicatedTopic body = new MsgVpnReplicatedTopic(); // MsgVpnReplicatedTopic | The Replicated Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplicatedTopicResponse result = apiInstance.createMsgVpnReplicatedTopic(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ReplicatedTopicApi#createMsgVpnReplicatedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnReplicatedTopic**](MsgVpnReplicatedTopic.md)| The Replicated Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplicatedTopicResponse**](MsgVpnReplicatedTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replicated Topic object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnReplicatedTopic - -> SempMetaOnlyResponse deleteMsgVpnReplicatedTopic(msgVpnName, replicatedTopic) - -Delete a Replicated Topic object. - -Delete a Replicated Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ReplicatedTopicApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ReplicatedTopicApi apiInstance = new ReplicatedTopicApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replicatedTopic = "replicatedTopic_example"; // String | The topic for applying replication. Published messages matching this topic will be replicated to the standby site. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnReplicatedTopic(msgVpnName, replicatedTopic); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ReplicatedTopicApi#deleteMsgVpnReplicatedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replicatedTopic** | **String**| The topic for applying replication. Published messages matching this topic will be replicated to the standby site. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplicatedTopic - -> MsgVpnReplicatedTopicResponse getMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, opaquePassword, select) - -Get a Replicated Topic object. - -Get a Replicated Topic object. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ReplicatedTopicApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ReplicatedTopicApi apiInstance = new ReplicatedTopicApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replicatedTopic = "replicatedTopic_example"; // String | The topic for applying replication. Published messages matching this topic will be replicated to the standby site. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplicatedTopicResponse result = apiInstance.getMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ReplicatedTopicApi#getMsgVpnReplicatedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replicatedTopic** | **String**| The topic for applying replication. Published messages matching this topic will be replicated to the standby site. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplicatedTopicResponse**](MsgVpnReplicatedTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replicated Topic object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnReplicatedTopics - -> MsgVpnReplicatedTopicsResponse getMsgVpnReplicatedTopics(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Replicated Topic objects. - -Get a list of Replicated Topic objects. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ReplicatedTopicApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ReplicatedTopicApi apiInstance = new ReplicatedTopicApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplicatedTopicsResponse result = apiInstance.getMsgVpnReplicatedTopics(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ReplicatedTopicApi#getMsgVpnReplicatedTopics"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplicatedTopicsResponse**](MsgVpnReplicatedTopicsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Replicated Topic objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnReplicatedTopic - -> MsgVpnReplicatedTopicResponse replaceMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select) - -Replace a Replicated Topic object. - -Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replicatedTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ReplicatedTopicApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ReplicatedTopicApi apiInstance = new ReplicatedTopicApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replicatedTopic = "replicatedTopic_example"; // String | The topic for applying replication. Published messages matching this topic will be replicated to the standby site. - MsgVpnReplicatedTopic body = new MsgVpnReplicatedTopic(); // MsgVpnReplicatedTopic | The Replicated Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplicatedTopicResponse result = apiInstance.replaceMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ReplicatedTopicApi#replaceMsgVpnReplicatedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replicatedTopic** | **String**| The topic for applying replication. Published messages matching this topic will be replicated to the standby site. | | -| **body** | [**MsgVpnReplicatedTopic**](MsgVpnReplicatedTopic.md)| The Replicated Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplicatedTopicResponse**](MsgVpnReplicatedTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replicated Topic object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnReplicatedTopic - -> MsgVpnReplicatedTopicResponse updateMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select) - -Update a Replicated Topic object. - -Update a Replicated Topic object. Any attribute missing from the request will be left unchanged. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.ReplicatedTopicApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - ReplicatedTopicApi apiInstance = new ReplicatedTopicApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String replicatedTopic = "replicatedTopic_example"; // String | The topic for applying replication. Published messages matching this topic will be replicated to the standby site. - MsgVpnReplicatedTopic body = new MsgVpnReplicatedTopic(); // MsgVpnReplicatedTopic | The Replicated Topic object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnReplicatedTopicResponse result = apiInstance.updateMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ReplicatedTopicApi#updateMsgVpnReplicatedTopic"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **replicatedTopic** | **String**| The topic for applying replication. Published messages matching this topic will be replicated to the standby site. | | -| **body** | [**MsgVpnReplicatedTopic**](MsgVpnReplicatedTopic.md)| The Replicated Topic object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnReplicatedTopicResponse**](MsgVpnReplicatedTopicResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Replicated Topic object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/RestDeliveryPointApi.md b/service/solace-config-client/docs/RestDeliveryPointApi.md deleted file mode 100644 index 285c9454d..000000000 --- a/service/solace-config-client/docs/RestDeliveryPointApi.md +++ /dev/null @@ -1,2660 +0,0 @@ -# RestDeliveryPointApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnRestDeliveryPoint**](RestDeliveryPointApi.md#createMsgVpnRestDeliveryPoint) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints | Create a REST Delivery Point object. | -| [**createMsgVpnRestDeliveryPointQueueBinding**](RestDeliveryPointApi.md#createMsgVpnRestDeliveryPointQueueBinding) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings | Create a Queue Binding object. | -| [**createMsgVpnRestDeliveryPointQueueBindingRequestHeader**](RestDeliveryPointApi.md#createMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders | Create a Request Header object. | -| [**createMsgVpnRestDeliveryPointRestConsumer**](RestDeliveryPointApi.md#createMsgVpnRestDeliveryPointRestConsumer) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers | Create a REST Consumer object. | -| [**createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](RestDeliveryPointApi.md#createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims | Create a Claim object. | -| [**createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](RestDeliveryPointApi.md#createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **POST** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames | Create a Trusted Common Name object. | -| [**deleteMsgVpnRestDeliveryPoint**](RestDeliveryPointApi.md#deleteMsgVpnRestDeliveryPoint) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Delete a REST Delivery Point object. | -| [**deleteMsgVpnRestDeliveryPointQueueBinding**](RestDeliveryPointApi.md#deleteMsgVpnRestDeliveryPointQueueBinding) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Delete a Queue Binding object. | -| [**deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader**](RestDeliveryPointApi.md#deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Delete a Request Header object. | -| [**deleteMsgVpnRestDeliveryPointRestConsumer**](RestDeliveryPointApi.md#deleteMsgVpnRestDeliveryPointRestConsumer) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Delete a REST Consumer object. | -| [**deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](RestDeliveryPointApi.md#deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName} | Delete a Claim object. | -| [**deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](RestDeliveryPointApi.md#deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **DELETE** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Delete a Trusted Common Name object. | -| [**getMsgVpnRestDeliveryPoint**](RestDeliveryPointApi.md#getMsgVpnRestDeliveryPoint) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Get a REST Delivery Point object. | -| [**getMsgVpnRestDeliveryPointQueueBinding**](RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointQueueBinding) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Get a Queue Binding object. | -| [**getMsgVpnRestDeliveryPointQueueBindingRequestHeader**](RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Get a Request Header object. | -| [**getMsgVpnRestDeliveryPointQueueBindingRequestHeaders**](RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointQueueBindingRequestHeaders) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders | Get a list of Request Header objects. | -| [**getMsgVpnRestDeliveryPointQueueBindings**](RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointQueueBindings) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings | Get a list of Queue Binding objects. | -| [**getMsgVpnRestDeliveryPointRestConsumer**](RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointRestConsumer) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Get a REST Consumer object. | -| [**getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName} | Get a Claim object. | -| [**getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims**](RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims | Get a list of Claim objects. | -| [**getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName} | Get a Trusted Common Name object. | -| [**getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames**](RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames | Get a list of Trusted Common Name objects. | -| [**getMsgVpnRestDeliveryPointRestConsumers**](RestDeliveryPointApi.md#getMsgVpnRestDeliveryPointRestConsumers) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers | Get a list of REST Consumer objects. | -| [**getMsgVpnRestDeliveryPoints**](RestDeliveryPointApi.md#getMsgVpnRestDeliveryPoints) | **GET** /msgVpns/{msgVpnName}/restDeliveryPoints | Get a list of REST Delivery Point objects. | -| [**replaceMsgVpnRestDeliveryPoint**](RestDeliveryPointApi.md#replaceMsgVpnRestDeliveryPoint) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Replace a REST Delivery Point object. | -| [**replaceMsgVpnRestDeliveryPointQueueBinding**](RestDeliveryPointApi.md#replaceMsgVpnRestDeliveryPointQueueBinding) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Replace a Queue Binding object. | -| [**replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader**](RestDeliveryPointApi.md#replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Replace a Request Header object. | -| [**replaceMsgVpnRestDeliveryPointRestConsumer**](RestDeliveryPointApi.md#replaceMsgVpnRestDeliveryPointRestConsumer) | **PUT** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Replace a REST Consumer object. | -| [**updateMsgVpnRestDeliveryPoint**](RestDeliveryPointApi.md#updateMsgVpnRestDeliveryPoint) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName} | Update a REST Delivery Point object. | -| [**updateMsgVpnRestDeliveryPointQueueBinding**](RestDeliveryPointApi.md#updateMsgVpnRestDeliveryPointQueueBinding) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName} | Update a Queue Binding object. | -| [**updateMsgVpnRestDeliveryPointQueueBindingRequestHeader**](RestDeliveryPointApi.md#updateMsgVpnRestDeliveryPointQueueBindingRequestHeader) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName} | Update a Request Header object. | -| [**updateMsgVpnRestDeliveryPointRestConsumer**](RestDeliveryPointApi.md#updateMsgVpnRestDeliveryPointRestConsumer) | **PATCH** /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName} | Update a REST Consumer object. | - - - -## createMsgVpnRestDeliveryPoint - -> MsgVpnRestDeliveryPointResponse createMsgVpnRestDeliveryPoint(msgVpnName, body, opaquePassword, select) - -Create a REST Delivery Point object. - -Create a REST Delivery Point object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnRestDeliveryPoint body = new MsgVpnRestDeliveryPoint(); // MsgVpnRestDeliveryPoint | The REST Delivery Point object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointResponse result = apiInstance.createMsgVpnRestDeliveryPoint(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#createMsgVpnRestDeliveryPoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnRestDeliveryPoint**](MsgVpnRestDeliveryPoint.md)| The REST Delivery Point object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointResponse**](MsgVpnRestDeliveryPointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Delivery Point object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPointQueueBinding - -> MsgVpnRestDeliveryPointQueueBindingResponse createMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, body, opaquePassword, select) - -Create a Queue Binding object. - -Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueBindingName|x|x|||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - MsgVpnRestDeliveryPointQueueBinding body = new MsgVpnRestDeliveryPointQueueBinding(); // MsgVpnRestDeliveryPointQueueBinding | The Queue Binding object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingResponse result = apiInstance.createMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#createMsgVpnRestDeliveryPointQueueBinding"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBinding**](MsgVpnRestDeliveryPointQueueBinding.md)| The Queue Binding object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingResponse**](MsgVpnRestDeliveryPointQueueBindingResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Binding object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPointQueueBindingRequestHeader - -> MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse createMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select) - -Create a Request Header object. - -Create a Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: headerName|x|x|||| msgVpnName|x||x||| queueBindingName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = new MsgVpnRestDeliveryPointQueueBindingRequestHeader(); // MsgVpnRestDeliveryPointQueueBindingRequestHeader | The Request Header object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse result = apiInstance.createMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#createMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBindingRequestHeader**](MsgVpnRestDeliveryPointQueueBindingRequestHeader.md)| The Request Header object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse**](MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Request Header object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPointRestConsumer - -> MsgVpnRestDeliveryPointRestConsumerResponse createMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, body, opaquePassword, select) - -Create a REST Consumer object. - -Create a REST Consumer object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| authenticationHttpBasicPassword||||x||x authenticationHttpHeaderValue||||x||x authenticationOauthClientSecret||||x||x authenticationOauthJwtSecretKey||||x||x msgVpnName|x||x||| restConsumerName|x|x|||| restDeliveryPointName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - MsgVpnRestDeliveryPointRestConsumer body = new MsgVpnRestDeliveryPointRestConsumer(); // MsgVpnRestDeliveryPointRestConsumer | The REST Consumer object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerResponse result = apiInstance.createMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#createMsgVpnRestDeliveryPointRestConsumer"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **body** | [**MsgVpnRestDeliveryPointRestConsumer**](MsgVpnRestDeliveryPointRestConsumer.md)| The REST Consumer object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerResponse**](MsgVpnRestDeliveryPointRestConsumerResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Consumer object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - -> MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select) - -Create a Claim object. - -Create a Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthJwtClaimName|x|x|||| oauthJwtClaimValue||x|||| restConsumerName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim body = new MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(); // MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim | The Claim object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse result = apiInstance.createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **body** | [**MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim**](MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.md)| The Claim object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse**](MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Claim object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - -> MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select) - -Create a Trusted Common Name object. - -Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||x| restConsumerName|x||x||x| restDeliveryPointName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName body = new MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(); // MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName | The Trusted Common Name object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse result = apiInstance.createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **body** | [**MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName**](MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.md)| The Trusted Common Name object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse**](MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Trusted Common Name object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPoint - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName) - -Delete a REST Delivery Point object. - -Delete a REST Delivery Point object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#deleteMsgVpnRestDeliveryPoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPointQueueBinding - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName) - -Delete a Queue Binding object. - -Delete a Queue Binding object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#deleteMsgVpnRestDeliveryPointQueueBinding"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName) - -Delete a Request Header object. - -Delete a Request Header object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - String headerName = "headerName_example"; // String | The name of the HTTP request header. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **headerName** | **String**| The name of the HTTP request header. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPointRestConsumer - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName) - -Delete a REST Consumer object. - -Delete a REST Consumer object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#deleteMsgVpnRestDeliveryPointRestConsumer"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName) - -Delete a Claim object. - -Delete a Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String oauthJwtClaimName = "oauthJwtClaimName_example"; // String | The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **oauthJwtClaimName** | **String**| The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - -> SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName) - -Delete a Trusted Common Name object. - -Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String tlsTrustedCommonName = "tlsTrustedCommonName_example"; // String | The expected trusted common name of the remote certificate. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **tlsTrustedCommonName** | **String**| The expected trusted common name of the remote certificate. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPoint - -> MsgVpnRestDeliveryPointResponse getMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, opaquePassword, select) - -Get a REST Delivery Point object. - -Get a REST Delivery Point object. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointResponse result = apiInstance.getMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#getMsgVpnRestDeliveryPoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointResponse**](MsgVpnRestDeliveryPointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Delivery Point object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointQueueBinding - -> MsgVpnRestDeliveryPointQueueBindingResponse getMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, opaquePassword, select) - -Get a Queue Binding object. - -Get a Queue Binding object. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingResponse result = apiInstance.getMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#getMsgVpnRestDeliveryPointQueueBinding"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingResponse**](MsgVpnRestDeliveryPointQueueBindingResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Binding object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointQueueBindingRequestHeader - -> MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse getMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, opaquePassword, select) - -Get a Request Header object. - -Get a Request Header object. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - String headerName = "headerName_example"; // String | The name of the HTTP request header. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse result = apiInstance.getMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#getMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **headerName** | **String**| The name of the HTTP request header. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse**](MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Request Header object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointQueueBindingRequestHeaders - -> MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse getMsgVpnRestDeliveryPointQueueBindingRequestHeaders(msgVpnName, restDeliveryPointName, queueBindingName, count, cursor, opaquePassword, where, select) - -Get a list of Request Header objects. - -Get a list of Request Header objects. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse result = apiInstance.getMsgVpnRestDeliveryPointQueueBindingRequestHeaders(msgVpnName, restDeliveryPointName, queueBindingName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#getMsgVpnRestDeliveryPointQueueBindingRequestHeaders"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse**](MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Request Header objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointQueueBindings - -> MsgVpnRestDeliveryPointQueueBindingsResponse getMsgVpnRestDeliveryPointQueueBindings(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select) - -Get a list of Queue Binding objects. - -Get a list of Queue Binding objects. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingsResponse result = apiInstance.getMsgVpnRestDeliveryPointQueueBindings(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#getMsgVpnRestDeliveryPointQueueBindings"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingsResponse**](MsgVpnRestDeliveryPointQueueBindingsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Queue Binding objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumer - -> MsgVpnRestDeliveryPointRestConsumerResponse getMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, select) - -Get a REST Consumer object. - -Get a REST Consumer object. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#getMsgVpnRestDeliveryPointRestConsumer"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerResponse**](MsgVpnRestDeliveryPointRestConsumerResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Consumer object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - -> MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName, opaquePassword, select) - -Get a Claim object. - -Get a Claim object. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String oauthJwtClaimName = "oauthJwtClaimName_example"; // String | The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **oauthJwtClaimName** | **String**| The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse**](MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Claim object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims - -> MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims(msgVpnName, restDeliveryPointName, restConsumerName, count, cursor, opaquePassword, where, select) - -Get a list of Claim objects. - -Get a list of Claim objects. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims(msgVpnName, restDeliveryPointName, restConsumerName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse**](MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Claim objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - -> MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName, opaquePassword, select) - -Get a Trusted Common Name object. - -Get a Trusted Common Name object. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String tlsTrustedCommonName = "tlsTrustedCommonName_example"; // String | The expected trusted common name of the remote certificate. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **tlsTrustedCommonName** | **String**| The expected trusted common name of the remote certificate. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse**](MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Trusted Common Name object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames - -> MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, where, select) - -Get a list of Trusted Common Name objects. - -Get a list of Trusted Common Name objects. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse**](MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Trusted Common Name objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPointRestConsumers - -> MsgVpnRestDeliveryPointRestConsumersResponse getMsgVpnRestDeliveryPointRestConsumers(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select) - -Get a list of REST Consumer objects. - -Get a list of REST Consumer objects. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumersResponse result = apiInstance.getMsgVpnRestDeliveryPointRestConsumers(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#getMsgVpnRestDeliveryPointRestConsumers"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumersResponse**](MsgVpnRestDeliveryPointRestConsumersResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of REST Consumer objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnRestDeliveryPoints - -> MsgVpnRestDeliveryPointsResponse getMsgVpnRestDeliveryPoints(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of REST Delivery Point objects. - -Get a list of REST Delivery Point objects. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointsResponse result = apiInstance.getMsgVpnRestDeliveryPoints(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#getMsgVpnRestDeliveryPoints"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointsResponse**](MsgVpnRestDeliveryPointsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of REST Delivery Point objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnRestDeliveryPoint - -> MsgVpnRestDeliveryPointResponse replaceMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select) - -Replace a REST Delivery Point object. - -Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientProfileName|||||x|| msgVpnName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - MsgVpnRestDeliveryPoint body = new MsgVpnRestDeliveryPoint(); // MsgVpnRestDeliveryPoint | The REST Delivery Point object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointResponse result = apiInstance.replaceMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#replaceMsgVpnRestDeliveryPoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **body** | [**MsgVpnRestDeliveryPoint**](MsgVpnRestDeliveryPoint.md)| The REST Delivery Point object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointResponse**](MsgVpnRestDeliveryPointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Delivery Point object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnRestDeliveryPointQueueBinding - -> MsgVpnRestDeliveryPointQueueBindingResponse replaceMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select) - -Replace a Queue Binding object. - -Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - MsgVpnRestDeliveryPointQueueBinding body = new MsgVpnRestDeliveryPointQueueBinding(); // MsgVpnRestDeliveryPointQueueBinding | The Queue Binding object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingResponse result = apiInstance.replaceMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#replaceMsgVpnRestDeliveryPointQueueBinding"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBinding**](MsgVpnRestDeliveryPointQueueBinding.md)| The Queue Binding object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingResponse**](MsgVpnRestDeliveryPointQueueBindingResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Binding object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader - -> MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select) - -Replace a Request Header object. - -Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A request header to be added to the HTTP request. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- headerName|x||x|||| msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - String headerName = "headerName_example"; // String | The name of the HTTP request header. - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = new MsgVpnRestDeliveryPointQueueBindingRequestHeader(); // MsgVpnRestDeliveryPointQueueBindingRequestHeader | The Request Header object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse result = apiInstance.replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **headerName** | **String**| The name of the HTTP request header. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBindingRequestHeader**](MsgVpnRestDeliveryPointQueueBindingRequestHeader.md)| The Request Header object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse**](MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Request Header object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnRestDeliveryPointRestConsumer - -> MsgVpnRestDeliveryPointRestConsumerResponse replaceMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select) - -Replace a REST Consumer object. - -Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey||||x|||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| authenticationHttpBasicPassword||||x|x||x authenticationHttpBasicUsername|||||x|| authenticationHttpHeaderValue||||x|||x authenticationOauthClientId|||||x|| authenticationOauthClientScope|||||x|| authenticationOauthClientSecret||||x|x||x authenticationOauthClientTokenEndpoint|||||x|| authenticationOauthJwtSecretKey||||x|x||x authenticationOauthJwtTokenEndpoint|||||x|| authenticationScheme|||||x|| msgVpnName|x||x|||| outgoingConnectionCount|||||x|| remoteHost|||||x|| remotePort|||||x|| restConsumerName|x||x|||| restDeliveryPointName|x||x|||| tlsCipherSuiteList|||||x|| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - MsgVpnRestDeliveryPointRestConsumer body = new MsgVpnRestDeliveryPointRestConsumer(); // MsgVpnRestDeliveryPointRestConsumer | The REST Consumer object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerResponse result = apiInstance.replaceMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#replaceMsgVpnRestDeliveryPointRestConsumer"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **body** | [**MsgVpnRestDeliveryPointRestConsumer**](MsgVpnRestDeliveryPointRestConsumer.md)| The REST Consumer object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerResponse**](MsgVpnRestDeliveryPointRestConsumerResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Consumer object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnRestDeliveryPoint - -> MsgVpnRestDeliveryPointResponse updateMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select) - -Update a REST Delivery Point object. - -Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientProfileName||||x|| msgVpnName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - MsgVpnRestDeliveryPoint body = new MsgVpnRestDeliveryPoint(); // MsgVpnRestDeliveryPoint | The REST Delivery Point object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointResponse result = apiInstance.updateMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#updateMsgVpnRestDeliveryPoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **body** | [**MsgVpnRestDeliveryPoint**](MsgVpnRestDeliveryPoint.md)| The REST Delivery Point object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointResponse**](MsgVpnRestDeliveryPointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Delivery Point object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnRestDeliveryPointQueueBinding - -> MsgVpnRestDeliveryPointQueueBindingResponse updateMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select) - -Update a Queue Binding object. - -Update a Queue Binding object. Any attribute missing from the request will be left unchanged. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - MsgVpnRestDeliveryPointQueueBinding body = new MsgVpnRestDeliveryPointQueueBinding(); // MsgVpnRestDeliveryPointQueueBinding | The Queue Binding object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingResponse result = apiInstance.updateMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#updateMsgVpnRestDeliveryPointQueueBinding"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBinding**](MsgVpnRestDeliveryPointQueueBinding.md)| The Queue Binding object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingResponse**](MsgVpnRestDeliveryPointQueueBindingResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Queue Binding object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnRestDeliveryPointQueueBindingRequestHeader - -> MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse updateMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select) - -Update a Request Header object. - -Update a Request Header object. Any attribute missing from the request will be left unchanged. A request header to be added to the HTTP request. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- headerName|x|x|||| msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String queueBindingName = "queueBindingName_example"; // String | The name of a queue in the Message VPN. - String headerName = "headerName_example"; // String | The name of the HTTP request header. - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = new MsgVpnRestDeliveryPointQueueBindingRequestHeader(); // MsgVpnRestDeliveryPointQueueBindingRequestHeader | The Request Header object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse result = apiInstance.updateMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **queueBindingName** | **String**| The name of a queue in the Message VPN. | | -| **headerName** | **String**| The name of the HTTP request header. | | -| **body** | [**MsgVpnRestDeliveryPointQueueBindingRequestHeader**](MsgVpnRestDeliveryPointQueueBindingRequestHeader.md)| The Request Header object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse**](MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Request Header object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnRestDeliveryPointRestConsumer - -> MsgVpnRestDeliveryPointRestConsumerResponse updateMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select) - -Update a REST Consumer object. - -Update a REST Consumer object. Any attribute missing from the request will be left unchanged. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey|||x|||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| authenticationHttpBasicPassword|||x|x||x authenticationHttpBasicUsername||||x|| authenticationHttpHeaderValue|||x|||x authenticationOauthClientId||||x|| authenticationOauthClientScope||||x|| authenticationOauthClientSecret|||x|x||x authenticationOauthClientTokenEndpoint||||x|| authenticationOauthJwtSecretKey|||x|x||x authenticationOauthJwtTokenEndpoint||||x|| authenticationScheme||||x|| msgVpnName|x|x|||| outgoingConnectionCount||||x|| remoteHost||||x|| remotePort||||x|| restConsumerName|x|x|||| restDeliveryPointName|x|x|||| tlsCipherSuiteList||||x|| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.RestDeliveryPointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - RestDeliveryPointApi apiInstance = new RestDeliveryPointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String restDeliveryPointName = "restDeliveryPointName_example"; // String | The name of the REST Delivery Point. - String restConsumerName = "restConsumerName_example"; // String | The name of the REST Consumer. - MsgVpnRestDeliveryPointRestConsumer body = new MsgVpnRestDeliveryPointRestConsumer(); // MsgVpnRestDeliveryPointRestConsumer | The REST Consumer object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnRestDeliveryPointRestConsumerResponse result = apiInstance.updateMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling RestDeliveryPointApi#updateMsgVpnRestDeliveryPointRestConsumer"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **restDeliveryPointName** | **String**| The name of the REST Delivery Point. | | -| **restConsumerName** | **String**| The name of the REST Consumer. | | -| **body** | [**MsgVpnRestDeliveryPointRestConsumer**](MsgVpnRestDeliveryPointRestConsumer.md)| The REST Consumer object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnRestDeliveryPointRestConsumerResponse**](MsgVpnRestDeliveryPointRestConsumerResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The REST Consumer object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/SempError.md b/service/solace-config-client/docs/SempError.md deleted file mode 100644 index f1d5878c0..000000000 --- a/service/solace-config-client/docs/SempError.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# SempError - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**code** | **Integer** | The error code which uniquely identifies the error that has occurred. | | -|**description** | **String** | The verbose description of the problem. | | -|**status** | **String** | The terse status string associated with `code`. | | - - - diff --git a/service/solace-config-client/docs/SempMeta.md b/service/solace-config-client/docs/SempMeta.md deleted file mode 100644 index 7305fdc0b..000000000 --- a/service/solace-config-client/docs/SempMeta.md +++ /dev/null @@ -1,17 +0,0 @@ - - -# SempMeta - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**count** | **Long** | The total number of objects requested, irrespective of page size. This may be a count of all objects in a collection or a filtered subset. It represents a snapshot in time and may change when paging through results. | [optional] | -|**error** | [**SempError**](SempError.md) | | [optional] | -|**paging** | [**SempPaging**](SempPaging.md) | | [optional] | -|**request** | [**SempRequest**](SempRequest.md) | | | -|**responseCode** | **Integer** | The HTTP response code, one of 200 (success), 4xx (client error), or 5xx (server error). | | - - - diff --git a/service/solace-config-client/docs/SempMetaOnlyResponse.md b/service/solace-config-client/docs/SempMetaOnlyResponse.md deleted file mode 100644 index 3fc227764..000000000 --- a/service/solace-config-client/docs/SempMetaOnlyResponse.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# SempMetaOnlyResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/SempPaging.md b/service/solace-config-client/docs/SempPaging.md deleted file mode 100644 index 679567022..000000000 --- a/service/solace-config-client/docs/SempPaging.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# SempPaging - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**cursorQuery** | **String** | The cursor, or position, for the next page of objects. Use this as the `cursor` query parameter of the next request. | | -|**nextPageUri** | **String** | The URI of the next page of objects. `cursorQuery` is already embedded within this URI. | | - - - diff --git a/service/solace-config-client/docs/SempRequest.md b/service/solace-config-client/docs/SempRequest.md deleted file mode 100644 index a0ea95158..000000000 --- a/service/solace-config-client/docs/SempRequest.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# SempRequest - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**method** | **String** | The HTTP method of the request which resulted in this response. | | -|**uri** | **String** | The URI of the request which resulted in this response. | [optional] | - - - diff --git a/service/solace-config-client/docs/SystemInformation.md b/service/solace-config-client/docs/SystemInformation.md deleted file mode 100644 index 3176e50d3..000000000 --- a/service/solace-config-client/docs/SystemInformation.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# SystemInformation - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**platform** | **String** | The platform running the SEMP API. Deprecated since 2.2. /systemInformation was replaced by /about/api. | [optional] | -|**sempVersion** | **String** | The version of the SEMP API. Deprecated since 2.2. /systemInformation was replaced by /about/api. | [optional] | - - - diff --git a/service/solace-config-client/docs/SystemInformationApi.md b/service/solace-config-client/docs/SystemInformationApi.md deleted file mode 100644 index 42975f136..000000000 --- a/service/solace-config-client/docs/SystemInformationApi.md +++ /dev/null @@ -1,84 +0,0 @@ -# SystemInformationApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**getSystemInformation**](SystemInformationApi.md#getSystemInformation) | **GET** /systemInformation | Get a System Information object. | - - - -## getSystemInformation - -> SystemInformationResponse getSystemInformation(opaquePassword, select) - -Get a System Information object. - -Get a System Information object. The System Information object provides metadata about the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: platform|||x| sempVersion|||x| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been deprecated since 2.2. /systemInformation was replaced by /about/api. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.SystemInformationApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - SystemInformationApi apiInstance = new SystemInformationApi(defaultClient); - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - SystemInformationResponse result = apiInstance.getSystemInformation(opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling SystemInformationApi#getSystemInformation"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**SystemInformationResponse**](SystemInformationResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The System Information object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/SystemInformationLinks.md b/service/solace-config-client/docs/SystemInformationLinks.md deleted file mode 100644 index 2b37bb98d..000000000 --- a/service/solace-config-client/docs/SystemInformationLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# SystemInformationLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this System Information object. | [optional] | - - - diff --git a/service/solace-config-client/docs/SystemInformationResponse.md b/service/solace-config-client/docs/SystemInformationResponse.md deleted file mode 100644 index 846c93133..000000000 --- a/service/solace-config-client/docs/SystemInformationResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# SystemInformationResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**SystemInformation**](SystemInformation.md) | | [optional] | -|**links** | [**SystemInformationLinks**](SystemInformationLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/TopicEndpointApi.md b/service/solace-config-client/docs/TopicEndpointApi.md deleted file mode 100644 index e3e32baf7..000000000 --- a/service/solace-config-client/docs/TopicEndpointApi.md +++ /dev/null @@ -1,492 +0,0 @@ -# TopicEndpointApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnTopicEndpoint**](TopicEndpointApi.md#createMsgVpnTopicEndpoint) | **POST** /msgVpns/{msgVpnName}/topicEndpoints | Create a Topic Endpoint object. | -| [**deleteMsgVpnTopicEndpoint**](TopicEndpointApi.md#deleteMsgVpnTopicEndpoint) | **DELETE** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Delete a Topic Endpoint object. | -| [**getMsgVpnTopicEndpoint**](TopicEndpointApi.md#getMsgVpnTopicEndpoint) | **GET** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Get a Topic Endpoint object. | -| [**getMsgVpnTopicEndpoints**](TopicEndpointApi.md#getMsgVpnTopicEndpoints) | **GET** /msgVpns/{msgVpnName}/topicEndpoints | Get a list of Topic Endpoint objects. | -| [**replaceMsgVpnTopicEndpoint**](TopicEndpointApi.md#replaceMsgVpnTopicEndpoint) | **PUT** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Replace a Topic Endpoint object. | -| [**updateMsgVpnTopicEndpoint**](TopicEndpointApi.md#updateMsgVpnTopicEndpoint) | **PATCH** /msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName} | Update a Topic Endpoint object. | - - - -## createMsgVpnTopicEndpoint - -> MsgVpnTopicEndpointResponse createMsgVpnTopicEndpoint(msgVpnName, body, opaquePassword, select) - -Create a Topic Endpoint object. - -Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.TopicEndpointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - TopicEndpointApi apiInstance = new TopicEndpointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnTopicEndpoint body = new MsgVpnTopicEndpoint(); // MsgVpnTopicEndpoint | The Topic Endpoint object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointResponse result = apiInstance.createMsgVpnTopicEndpoint(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TopicEndpointApi#createMsgVpnTopicEndpoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnTopicEndpoint**](MsgVpnTopicEndpoint.md)| The Topic Endpoint object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointResponse**](MsgVpnTopicEndpointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnTopicEndpoint - -> SempMetaOnlyResponse deleteMsgVpnTopicEndpoint(msgVpnName, topicEndpointName) - -Delete a Topic Endpoint object. - -Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.TopicEndpointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - TopicEndpointApi apiInstance = new TopicEndpointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointName = "topicEndpointName_example"; // String | The name of the Topic Endpoint. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnTopicEndpoint(msgVpnName, topicEndpointName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TopicEndpointApi#deleteMsgVpnTopicEndpoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointName** | **String**| The name of the Topic Endpoint. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnTopicEndpoint - -> MsgVpnTopicEndpointResponse getMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, opaquePassword, select) - -Get a Topic Endpoint object. - -Get a Topic Endpoint object. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.TopicEndpointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - TopicEndpointApi apiInstance = new TopicEndpointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointName = "topicEndpointName_example"; // String | The name of the Topic Endpoint. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointResponse result = apiInstance.getMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TopicEndpointApi#getMsgVpnTopicEndpoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointName** | **String**| The name of the Topic Endpoint. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointResponse**](MsgVpnTopicEndpointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnTopicEndpoints - -> MsgVpnTopicEndpointsResponse getMsgVpnTopicEndpoints(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Topic Endpoint objects. - -Get a list of Topic Endpoint objects. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.TopicEndpointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - TopicEndpointApi apiInstance = new TopicEndpointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointsResponse result = apiInstance.getMsgVpnTopicEndpoints(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TopicEndpointApi#getMsgVpnTopicEndpoints"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointsResponse**](MsgVpnTopicEndpointsResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Topic Endpoint objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnTopicEndpoint - -> MsgVpnTopicEndpointResponse replaceMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select) - -Replace a Topic Endpoint object. - -Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| respectMsgPriorityEnabled|||||x|| topicEndpointName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.TopicEndpointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - TopicEndpointApi apiInstance = new TopicEndpointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointName = "topicEndpointName_example"; // String | The name of the Topic Endpoint. - MsgVpnTopicEndpoint body = new MsgVpnTopicEndpoint(); // MsgVpnTopicEndpoint | The Topic Endpoint object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointResponse result = apiInstance.replaceMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TopicEndpointApi#replaceMsgVpnTopicEndpoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointName** | **String**| The name of the Topic Endpoint. | | -| **body** | [**MsgVpnTopicEndpoint**](MsgVpnTopicEndpoint.md)| The Topic Endpoint object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointResponse**](MsgVpnTopicEndpointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnTopicEndpoint - -> MsgVpnTopicEndpointResponse updateMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select) - -Update a Topic Endpoint object. - -Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| respectMsgPriorityEnabled||||x|| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.TopicEndpointApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - TopicEndpointApi apiInstance = new TopicEndpointApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointName = "topicEndpointName_example"; // String | The name of the Topic Endpoint. - MsgVpnTopicEndpoint body = new MsgVpnTopicEndpoint(); // MsgVpnTopicEndpoint | The Topic Endpoint object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointResponse result = apiInstance.updateMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TopicEndpointApi#updateMsgVpnTopicEndpoint"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointName** | **String**| The name of the Topic Endpoint. | | -| **body** | [**MsgVpnTopicEndpoint**](MsgVpnTopicEndpoint.md)| The Topic Endpoint object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointResponse**](MsgVpnTopicEndpointResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/TopicEndpointTemplateApi.md b/service/solace-config-client/docs/TopicEndpointTemplateApi.md deleted file mode 100644 index cdb0f3e7f..000000000 --- a/service/solace-config-client/docs/TopicEndpointTemplateApi.md +++ /dev/null @@ -1,492 +0,0 @@ -# TopicEndpointTemplateApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createMsgVpnTopicEndpointTemplate**](TopicEndpointTemplateApi.md#createMsgVpnTopicEndpointTemplate) | **POST** /msgVpns/{msgVpnName}/topicEndpointTemplates | Create a Topic Endpoint Template object. | -| [**deleteMsgVpnTopicEndpointTemplate**](TopicEndpointTemplateApi.md#deleteMsgVpnTopicEndpointTemplate) | **DELETE** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Delete a Topic Endpoint Template object. | -| [**getMsgVpnTopicEndpointTemplate**](TopicEndpointTemplateApi.md#getMsgVpnTopicEndpointTemplate) | **GET** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Get a Topic Endpoint Template object. | -| [**getMsgVpnTopicEndpointTemplates**](TopicEndpointTemplateApi.md#getMsgVpnTopicEndpointTemplates) | **GET** /msgVpns/{msgVpnName}/topicEndpointTemplates | Get a list of Topic Endpoint Template objects. | -| [**replaceMsgVpnTopicEndpointTemplate**](TopicEndpointTemplateApi.md#replaceMsgVpnTopicEndpointTemplate) | **PUT** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Replace a Topic Endpoint Template object. | -| [**updateMsgVpnTopicEndpointTemplate**](TopicEndpointTemplateApi.md#updateMsgVpnTopicEndpointTemplate) | **PATCH** /msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName} | Update a Topic Endpoint Template object. | - - - -## createMsgVpnTopicEndpointTemplate - -> MsgVpnTopicEndpointTemplateResponse createMsgVpnTopicEndpointTemplate(msgVpnName, body, opaquePassword, select) - -Create a Topic Endpoint Template object. - -Create a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.TopicEndpointTemplateApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - TopicEndpointTemplateApi apiInstance = new TopicEndpointTemplateApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - MsgVpnTopicEndpointTemplate body = new MsgVpnTopicEndpointTemplate(); // MsgVpnTopicEndpointTemplate | The Topic Endpoint Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointTemplateResponse result = apiInstance.createMsgVpnTopicEndpointTemplate(msgVpnName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TopicEndpointTemplateApi#createMsgVpnTopicEndpointTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **body** | [**MsgVpnTopicEndpointTemplate**](MsgVpnTopicEndpointTemplate.md)| The Topic Endpoint Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointTemplateResponse**](MsgVpnTopicEndpointTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint Template object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteMsgVpnTopicEndpointTemplate - -> SempMetaOnlyResponse deleteMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName) - -Delete a Topic Endpoint Template object. - -Delete a Topic Endpoint Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.TopicEndpointTemplateApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - TopicEndpointTemplateApi apiInstance = new TopicEndpointTemplateApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointTemplateName = "topicEndpointTemplateName_example"; // String | The name of the Topic Endpoint Template. - try { - SempMetaOnlyResponse result = apiInstance.deleteMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TopicEndpointTemplateApi#deleteMsgVpnTopicEndpointTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointTemplateName** | **String**| The name of the Topic Endpoint Template. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnTopicEndpointTemplate - -> MsgVpnTopicEndpointTemplateResponse getMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, opaquePassword, select) - -Get a Topic Endpoint Template object. - -Get a Topic Endpoint Template object. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.TopicEndpointTemplateApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - TopicEndpointTemplateApi apiInstance = new TopicEndpointTemplateApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointTemplateName = "topicEndpointTemplateName_example"; // String | The name of the Topic Endpoint Template. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointTemplateResponse result = apiInstance.getMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TopicEndpointTemplateApi#getMsgVpnTopicEndpointTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointTemplateName** | **String**| The name of the Topic Endpoint Template. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointTemplateResponse**](MsgVpnTopicEndpointTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint Template object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getMsgVpnTopicEndpointTemplates - -> MsgVpnTopicEndpointTemplatesResponse getMsgVpnTopicEndpointTemplates(msgVpnName, count, cursor, opaquePassword, where, select) - -Get a list of Topic Endpoint Template objects. - -Get a list of Topic Endpoint Template objects. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.TopicEndpointTemplateApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - TopicEndpointTemplateApi apiInstance = new TopicEndpointTemplateApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointTemplatesResponse result = apiInstance.getMsgVpnTopicEndpointTemplates(msgVpnName, count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TopicEndpointTemplateApi#getMsgVpnTopicEndpointTemplates"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointTemplatesResponse**](MsgVpnTopicEndpointTemplatesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Topic Endpoint Template objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceMsgVpnTopicEndpointTemplate - -> MsgVpnTopicEndpointTemplateResponse replaceMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select) - -Replace a Topic Endpoint Template object. - -Replace a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicEndpointTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.TopicEndpointTemplateApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - TopicEndpointTemplateApi apiInstance = new TopicEndpointTemplateApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointTemplateName = "topicEndpointTemplateName_example"; // String | The name of the Topic Endpoint Template. - MsgVpnTopicEndpointTemplate body = new MsgVpnTopicEndpointTemplate(); // MsgVpnTopicEndpointTemplate | The Topic Endpoint Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointTemplateResponse result = apiInstance.replaceMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TopicEndpointTemplateApi#replaceMsgVpnTopicEndpointTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointTemplateName** | **String**| The name of the Topic Endpoint Template. | | -| **body** | [**MsgVpnTopicEndpointTemplate**](MsgVpnTopicEndpointTemplate.md)| The Topic Endpoint Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointTemplateResponse**](MsgVpnTopicEndpointTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint Template object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateMsgVpnTopicEndpointTemplate - -> MsgVpnTopicEndpointTemplateResponse updateMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select) - -Update a Topic Endpoint Template object. - -Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.TopicEndpointTemplateApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - TopicEndpointTemplateApi apiInstance = new TopicEndpointTemplateApi(defaultClient); - String msgVpnName = "msgVpnName_example"; // String | The name of the Message VPN. - String topicEndpointTemplateName = "topicEndpointTemplateName_example"; // String | The name of the Topic Endpoint Template. - MsgVpnTopicEndpointTemplate body = new MsgVpnTopicEndpointTemplate(); // MsgVpnTopicEndpointTemplate | The Topic Endpoint Template object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - MsgVpnTopicEndpointTemplateResponse result = apiInstance.updateMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TopicEndpointTemplateApi#updateMsgVpnTopicEndpointTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **msgVpnName** | **String**| The name of the Message VPN. | | -| **topicEndpointTemplateName** | **String**| The name of the Topic Endpoint Template. | | -| **body** | [**MsgVpnTopicEndpointTemplate**](MsgVpnTopicEndpointTemplate.md)| The Topic Endpoint Template object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**MsgVpnTopicEndpointTemplateResponse**](MsgVpnTopicEndpointTemplateResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Topic Endpoint Template object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/VirtualHostname.md b/service/solace-config-client/docs/VirtualHostname.md deleted file mode 100644 index 3ffb2261e..000000000 --- a/service/solace-config-client/docs/VirtualHostname.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# VirtualHostname - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**enabled** | **Boolean** | Enable or disable Virtual Hostname to Message VPN mapping. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. | [optional] | -|**msgVpnName** | **String** | The message VPN to which this virtual hostname is mapped. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. | [optional] | -|**virtualHostname** | **String** | The virtual hostname. | [optional] | - - - diff --git a/service/solace-config-client/docs/VirtualHostnameApi.md b/service/solace-config-client/docs/VirtualHostnameApi.md deleted file mode 100644 index b289fa6a8..000000000 --- a/service/solace-config-client/docs/VirtualHostnameApi.md +++ /dev/null @@ -1,480 +0,0 @@ -# VirtualHostnameApi - -All URIs are relative to *http://www.solace.com/SEMP/v2/config* - -| Method | HTTP request | Description | -|------------- | ------------- | -------------| -| [**createVirtualHostname**](VirtualHostnameApi.md#createVirtualHostname) | **POST** /virtualHostnames | Create a Virtual Hostname object. | -| [**deleteVirtualHostname**](VirtualHostnameApi.md#deleteVirtualHostname) | **DELETE** /virtualHostnames/{virtualHostname} | Delete a Virtual Hostname object. | -| [**getVirtualHostname**](VirtualHostnameApi.md#getVirtualHostname) | **GET** /virtualHostnames/{virtualHostname} | Get a Virtual Hostname object. | -| [**getVirtualHostnames**](VirtualHostnameApi.md#getVirtualHostnames) | **GET** /virtualHostnames | Get a list of Virtual Hostname objects. | -| [**replaceVirtualHostname**](VirtualHostnameApi.md#replaceVirtualHostname) | **PUT** /virtualHostnames/{virtualHostname} | Replace a Virtual Hostname object. | -| [**updateVirtualHostname**](VirtualHostnameApi.md#updateVirtualHostname) | **PATCH** /virtualHostnames/{virtualHostname} | Update a Virtual Hostname object. | - - - -## createVirtualHostname - -> VirtualHostnameResponse createVirtualHostname(body, opaquePassword, select) - -Create a Virtual Hostname object. - -Create a Virtual Hostname object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: virtualHostname|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.VirtualHostnameApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - VirtualHostnameApi apiInstance = new VirtualHostnameApi(defaultClient); - VirtualHostname body = new VirtualHostname(); // VirtualHostname | The Virtual Hostname object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - VirtualHostnameResponse result = apiInstance.createVirtualHostname(body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling VirtualHostnameApi#createVirtualHostname"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **body** | [**VirtualHostname**](VirtualHostname.md)| The Virtual Hostname object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**VirtualHostnameResponse**](VirtualHostnameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Virtual Hostname object's attributes after being created, and the request metadata. | - | -| **0** | The error response. | - | - - -## deleteVirtualHostname - -> SempMetaOnlyResponse deleteVirtualHostname(virtualHostname) - -Delete a Virtual Hostname object. - -Delete a Virtual Hostname object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.VirtualHostnameApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - VirtualHostnameApi apiInstance = new VirtualHostnameApi(defaultClient); - String virtualHostname = "virtualHostname_example"; // String | The virtual hostname. - try { - SempMetaOnlyResponse result = apiInstance.deleteVirtualHostname(virtualHostname); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling VirtualHostnameApi#deleteVirtualHostname"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **virtualHostname** | **String**| The virtual hostname. | | - -### Return type - -[**SempMetaOnlyResponse**](SempMetaOnlyResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The request metadata. | - | -| **0** | The error response. | - | - - -## getVirtualHostname - -> VirtualHostnameResponse getVirtualHostname(virtualHostname, opaquePassword, select) - -Get a Virtual Hostname object. - -Get a Virtual Hostname object. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: virtualHostname|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.17. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.VirtualHostnameApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - VirtualHostnameApi apiInstance = new VirtualHostnameApi(defaultClient); - String virtualHostname = "virtualHostname_example"; // String | The virtual hostname. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - VirtualHostnameResponse result = apiInstance.getVirtualHostname(virtualHostname, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling VirtualHostnameApi#getVirtualHostname"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **virtualHostname** | **String**| The virtual hostname. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**VirtualHostnameResponse**](VirtualHostnameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Virtual Hostname object's attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## getVirtualHostnames - -> VirtualHostnamesResponse getVirtualHostnames(count, cursor, opaquePassword, where, select) - -Get a list of Virtual Hostname objects. - -Get a list of Virtual Hostname objects. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: virtualHostname|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.17. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.VirtualHostnameApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - VirtualHostnameApi apiInstance = new VirtualHostnameApi(defaultClient); - Integer count = 10; // Integer | Limit the count of objects in the response. See the documentation for the `count` parameter. - String cursor = "cursor_example"; // String | The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List where = Arrays.asList(); // List | Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - VirtualHostnamesResponse result = apiInstance.getVirtualHostnames(count, cursor, opaquePassword, where, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling VirtualHostnameApi#getVirtualHostnames"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **count** | **Integer**| Limit the count of objects in the response. See the documentation for the `count` parameter. | [optional] [default to 10] | -| **cursor** | **String**| The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. | [optional] | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **where** | [**List<String>**](String.md)| Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**VirtualHostnamesResponse**](VirtualHostnamesResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The list of Virtual Hostname objects' attributes, and the request metadata. | - | -| **0** | The error response. | - | - - -## replaceVirtualHostname - -> VirtualHostnameResponse replaceVirtualHostname(virtualHostname, body, opaquePassword, select) - -Replace a Virtual Hostname object. - -Replace a Virtual Hostname object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- virtualHostname|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.VirtualHostnameApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - VirtualHostnameApi apiInstance = new VirtualHostnameApi(defaultClient); - String virtualHostname = "virtualHostname_example"; // String | The virtual hostname. - VirtualHostname body = new VirtualHostname(); // VirtualHostname | The Virtual Hostname object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - VirtualHostnameResponse result = apiInstance.replaceVirtualHostname(virtualHostname, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling VirtualHostnameApi#replaceVirtualHostname"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **virtualHostname** | **String**| The virtual hostname. | | -| **body** | [**VirtualHostname**](VirtualHostname.md)| The Virtual Hostname object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**VirtualHostnameResponse**](VirtualHostnameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Virtual Hostname object's attributes after being replaced, and the request metadata. | - | -| **0** | The error response. | - | - - -## updateVirtualHostname - -> VirtualHostnameResponse updateVirtualHostname(virtualHostname, body, opaquePassword, select) - -Update a Virtual Hostname object. - -Update a Virtual Hostname object. Any attribute missing from the request will be left unchanged. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- virtualHostname|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - -### Example - -```java -// Import classes: -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.Configuration; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.models.*; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.VirtualHostnameApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://www.solace.com/SEMP/v2/config"); - - // Configure HTTP basic authorization: basicAuth - HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); - basicAuth.setUsername("YOUR USERNAME"); - basicAuth.setPassword("YOUR PASSWORD"); - - VirtualHostnameApi apiInstance = new VirtualHostnameApi(defaultClient); - String virtualHostname = "virtualHostname_example"; // String | The virtual hostname. - VirtualHostname body = new VirtualHostname(); // VirtualHostname | The Virtual Hostname object's attributes. - String opaquePassword = "opaquePassword_example"; // String | Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. - List select = Arrays.asList(); // List | Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. - try { - VirtualHostnameResponse result = apiInstance.updateVirtualHostname(virtualHostname, body, opaquePassword, select); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling VirtualHostnameApi#updateVirtualHostname"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **virtualHostname** | **String**| The virtual hostname. | | -| **body** | [**VirtualHostname**](VirtualHostname.md)| The Virtual Hostname object's attributes. | | -| **opaquePassword** | **String**| Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. | [optional] | -| **select** | [**List<String>**](String.md)| Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. | [optional] | - -### Return type - -[**VirtualHostnameResponse**](VirtualHostnameResponse.md) - -### Authorization - -[basicAuth](../README.md#basicAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | The Virtual Hostname object's attributes after being updated, and the request metadata. | - | -| **0** | The error response. | - | - diff --git a/service/solace-config-client/docs/VirtualHostnameLinks.md b/service/solace-config-client/docs/VirtualHostnameLinks.md deleted file mode 100644 index f5afe9c04..000000000 --- a/service/solace-config-client/docs/VirtualHostnameLinks.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# VirtualHostnameLinks - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**uri** | **String** | The URI of this Virtual Hostname object. | [optional] | - - - diff --git a/service/solace-config-client/docs/VirtualHostnameResponse.md b/service/solace-config-client/docs/VirtualHostnameResponse.md deleted file mode 100644 index 22e2b0c9c..000000000 --- a/service/solace-config-client/docs/VirtualHostnameResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# VirtualHostnameResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**VirtualHostname**](VirtualHostname.md) | | [optional] | -|**links** | [**VirtualHostnameLinks**](VirtualHostnameLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/docs/VirtualHostnamesResponse.md b/service/solace-config-client/docs/VirtualHostnamesResponse.md deleted file mode 100644 index 795228030..000000000 --- a/service/solace-config-client/docs/VirtualHostnamesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# VirtualHostnamesResponse - - -## Properties - -| Name | Type | Description | Notes | -|------------ | ------------- | ------------- | -------------| -|**data** | [**List<VirtualHostname>**](VirtualHostname.md) | | [optional] | -|**links** | [**List<VirtualHostnameLinks>**](VirtualHostnameLinks.md) | | [optional] | -|**meta** | [**SempMeta**](SempMeta.md) | | | - - - diff --git a/service/solace-config-client/pom.xml b/service/solace-config-client/pom.xml index bf61b5e8e..042f0a728 100644 --- a/service/solace-config-client/pom.xml +++ b/service/solace-config-client/pom.xml @@ -24,6 +24,39 @@ + + maven-clean-plugin + 3.2.0 + + + + src/main/java + false + true + + **/* + + + + src/test/java + false + true + + **/* + + + + + + + auto-clean + initialize + + clean + + + + org.apache.maven.plugins maven-surefire-plugin @@ -56,7 +89,68 @@ - + + + org.openapitools + openapi-generator-maven-plugin + + 6.5.0 + + + + generate + + + ${project.basedir}/src/main/resources/sempv2_spec.json + java + ${project.basedir} + com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp + com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model + com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker + resttemplate + true + true + true + false + false + additionalModelTypeAnnotations=@JsonInclude(JsonInclude.Include.NON_NULL), + usePlayWS=true + + src/main/java + + + + + + + + + com.google.code.maven-replacer-plugin + replacer + 1.5.3 + + + process-sources + + replace + + + + + + src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/ApiClient.java + + + restTemplate.getRequestFactory + new org.springframework.http.client.HttpComponentsClientHttpRequestFactory + + + + org.codehaus.mojo build-helper-maven-plugin diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AboutApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AboutApi.java deleted file mode 100644 index c62b4f93e..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AboutApi.java +++ /dev/null @@ -1,312 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutApiResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserMsgVpnResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserMsgVpnsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AboutApi { - private ApiClient apiClient; - - public AboutApi() { - this(new ApiClient()); - } - - public AboutApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Get an About object. - * Get an About object. This provides metadata about the SEMP API, such as the version of the API supported by the broker. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.13. - *

200 - The About object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return AboutResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public AboutResponse getAbout(String opaquePassword, List select) throws RestClientException { - return getAboutWithHttpInfo(opaquePassword, select).getBody(); - } - - /** - * Get an About object. - * Get an About object. This provides metadata about the SEMP API, such as the version of the API supported by the broker. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.13. - *

200 - The About object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<AboutResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getAboutWithHttpInfo(String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/about", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an API Description object. - * Get an API Description object. The API Description object provides metadata about the SEMP API. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - *

200 - The API Description object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return AboutApiResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public AboutApiResponse getAboutApi(String opaquePassword, List select) throws RestClientException { - return getAboutApiWithHttpInfo(opaquePassword, select).getBody(); - } - - /** - * Get an API Description object. - * Get an API Description object. The API Description object provides metadata about the SEMP API. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - *

200 - The API Description object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<AboutApiResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getAboutApiWithHttpInfo(String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/about/api", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a User object. - * Get a User object. Session and access level information about the user accessing the SEMP API. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - *

200 - The User object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return AboutUserResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public AboutUserResponse getAboutUser(String opaquePassword, List select) throws RestClientException { - return getAboutUserWithHttpInfo(opaquePassword, select).getBody(); - } - - /** - * Get a User object. - * Get a User object. Session and access level information about the user accessing the SEMP API. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - *

200 - The User object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<AboutUserResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getAboutUserWithHttpInfo(String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/about/user", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a User Message VPN object. - * Get a User Message VPN object. This provides information about the Message VPN access level for the username used to access the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - *

200 - The User Message VPN object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return AboutUserMsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public AboutUserMsgVpnResponse getAboutUserMsgVpn(String msgVpnName, String opaquePassword, List select) throws RestClientException { - return getAboutUserMsgVpnWithHttpInfo(msgVpnName, opaquePassword, select).getBody(); - } - - /** - * Get a User Message VPN object. - * Get a User Message VPN object. This provides information about the Message VPN access level for the username used to access the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - *

200 - The User Message VPN object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<AboutUserMsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getAboutUserMsgVpnWithHttpInfo(String msgVpnName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getAboutUserMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/about/user/msgVpns/{msgVpnName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of User Message VPN objects. - * Get a list of User Message VPN objects. This provides information about the Message VPN access level for the username used to access the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of User Message VPN objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return AboutUserMsgVpnsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public AboutUserMsgVpnsResponse getAboutUserMsgVpns(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getAboutUserMsgVpnsWithHttpInfo(count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of User Message VPN objects. - * Get a list of User Message VPN objects. This provides information about the Message VPN access level for the username used to access the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of User Message VPN objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<AboutUserMsgVpnsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getAboutUserMsgVpnsWithHttpInfo(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/about/user/msgVpns", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AclProfileApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AclProfileApi.java deleted file mode 100644 index 768fcbfa1..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AclProfileApi.java +++ /dev/null @@ -1,2336 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AclProfileApi { - private ApiClient apiClient; - - public AclProfileApi() { - this(new ApiClient()); - } - - public AclProfileApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create an ACL Profile object. - * Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileResponse createMsgVpnAclProfile(String msgVpnName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfileWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an ACL Profile object. - * Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAclProfileWithHttpInfo(String msgVpnName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Client Connect Exception object. - * Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| clientConnectExceptionAddress|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Connect Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Client Connect Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileClientConnectExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileClientConnectExceptionResponse createMsgVpnAclProfileClientConnectException(String msgVpnName, String aclProfileName, MsgVpnAclProfileClientConnectException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfileClientConnectExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Client Connect Exception object. - * Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| clientConnectExceptionAddress|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Connect Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Client Connect Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileClientConnectExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAclProfileClientConnectExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfileClientConnectException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfileClientConnectException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Publish Topic Exception object. - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| publishExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The Publish Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Publish Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfilePublishExceptionResponse createMsgVpnAclProfilePublishException(String msgVpnName, String aclProfileName, MsgVpnAclProfilePublishException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfilePublishExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Publish Topic Exception object. - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| publishExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The Publish Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Publish Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createMsgVpnAclProfilePublishExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfilePublishException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfilePublishException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Publish Topic Exception object. - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| publishTopicException|x|x|||| publishTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Publish Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Publish Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishTopicExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfilePublishTopicExceptionResponse createMsgVpnAclProfilePublishTopicException(String msgVpnName, String aclProfileName, MsgVpnAclProfilePublishTopicException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Publish Topic Exception object. - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| publishTopicException|x|x|||| publishTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Publish Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Publish Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishTopicExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfilePublishTopicException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfilePublishTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Subscribe Topic Exception object. - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| subscribeExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The Subscribe Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfileSubscribeExceptionResponse createMsgVpnAclProfileSubscribeException(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfileSubscribeExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Subscribe Topic Exception object. - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| subscribeExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The Subscribe Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createMsgVpnAclProfileSubscribeExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfileSubscribeException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Subscribe Share Name Exception object. - * Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeShareNameException|x|x|||| subscribeShareNameExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Share Name Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Share Name Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeShareNameExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeShareNameExceptionResponse createMsgVpnAclProfileSubscribeShareNameException(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeShareNameException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Subscribe Share Name Exception object. - * Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeShareNameException|x|x|||| subscribeShareNameExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Share Name Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Share Name Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeShareNameExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeShareNameException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfileSubscribeShareNameException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Subscribe Topic Exception object. - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeTopicException|x|x|||| subscribeTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeTopicExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeTopicExceptionResponse createMsgVpnAclProfileSubscribeTopicException(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeTopicException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Subscribe Topic Exception object. - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeTopicException|x|x|||| subscribeTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeTopicExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeTopicException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfileSubscribeTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an ACL Profile object. - * Delete an ACL Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAclProfile(String msgVpnName, String aclProfileName) throws RestClientException { - return deleteMsgVpnAclProfileWithHttpInfo(msgVpnName, aclProfileName).getBody(); - } - - /** - * Delete an ACL Profile object. - * Delete an ACL Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAclProfileWithHttpInfo(String msgVpnName, String aclProfileName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfile"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Client Connect Exception object. - * Delete a Client Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param clientConnectExceptionAddress The IP address/netmask of the client connect exception in CIDR form. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAclProfileClientConnectException(String msgVpnName, String aclProfileName, String clientConnectExceptionAddress) throws RestClientException { - return deleteMsgVpnAclProfileClientConnectExceptionWithHttpInfo(msgVpnName, aclProfileName, clientConnectExceptionAddress).getBody(); - } - - /** - * Delete a Client Connect Exception object. - * Delete a Client Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param clientConnectExceptionAddress The IP address/netmask of the client connect exception in CIDR form. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAclProfileClientConnectExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String clientConnectExceptionAddress) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'clientConnectExceptionAddress' is set - if (clientConnectExceptionAddress == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientConnectExceptionAddress' when calling deleteMsgVpnAclProfileClientConnectException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("clientConnectExceptionAddress", clientConnectExceptionAddress); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Publish Topic Exception object. - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteMsgVpnAclProfilePublishException(String msgVpnName, String aclProfileName, String topicSyntax, String publishExceptionTopic) throws RestClientException { - return deleteMsgVpnAclProfilePublishExceptionWithHttpInfo(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic).getBody(); - } - - /** - * Delete a Publish Topic Exception object. - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteMsgVpnAclProfilePublishExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String topicSyntax, String publishExceptionTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'topicSyntax' is set - if (topicSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicSyntax' when calling deleteMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'publishExceptionTopic' is set - if (publishExceptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishExceptionTopic' when calling deleteMsgVpnAclProfilePublishException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("topicSyntax", topicSyntax); - uriVariables.put("publishExceptionTopic", publishExceptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Publish Topic Exception object. - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param publishTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAclProfilePublishTopicException(String msgVpnName, String aclProfileName, String publishTopicExceptionSyntax, String publishTopicException) throws RestClientException { - return deleteMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException).getBody(); - } - - /** - * Delete a Publish Topic Exception object. - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param publishTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String publishTopicExceptionSyntax, String publishTopicException) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'publishTopicExceptionSyntax' is set - if (publishTopicExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishTopicExceptionSyntax' when calling deleteMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'publishTopicException' is set - if (publishTopicException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishTopicException' when calling deleteMsgVpnAclProfilePublishTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("publishTopicExceptionSyntax", publishTopicExceptionSyntax); - uriVariables.put("publishTopicException", publishTopicException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Subscribe Topic Exception object. - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeException(String msgVpnName, String aclProfileName, String topicSyntax, String subscribeExceptionTopic) throws RestClientException { - return deleteMsgVpnAclProfileSubscribeExceptionWithHttpInfo(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic).getBody(); - } - - /** - * Delete a Subscribe Topic Exception object. - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteMsgVpnAclProfileSubscribeExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String topicSyntax, String subscribeExceptionTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'topicSyntax' is set - if (topicSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicSyntax' when calling deleteMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'subscribeExceptionTopic' is set - if (subscribeExceptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeExceptionTopic' when calling deleteMsgVpnAclProfileSubscribeException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("topicSyntax", topicSyntax); - uriVariables.put("subscribeExceptionTopic", subscribeExceptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Subscribe Share Name Exception object. - * Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeShareNameExceptionSyntax The syntax of the subscribe share name for the exception to the default action taken. (required) - * @param subscribeShareNameException The subscribe share name exception to the default action taken. May include wildcard characters. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeShareNameException(String msgVpnName, String aclProfileName, String subscribeShareNameExceptionSyntax, String subscribeShareNameException) throws RestClientException { - return deleteMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException).getBody(); - } - - /** - * Delete a Subscribe Share Name Exception object. - * Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeShareNameExceptionSyntax The syntax of the subscribe share name for the exception to the default action taken. (required) - * @param subscribeShareNameException The subscribe share name exception to the default action taken. May include wildcard characters. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String subscribeShareNameExceptionSyntax, String subscribeShareNameException) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'subscribeShareNameExceptionSyntax' is set - if (subscribeShareNameExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeShareNameExceptionSyntax' when calling deleteMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'subscribeShareNameException' is set - if (subscribeShareNameException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeShareNameException' when calling deleteMsgVpnAclProfileSubscribeShareNameException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("subscribeShareNameExceptionSyntax", subscribeShareNameExceptionSyntax); - uriVariables.put("subscribeShareNameException", subscribeShareNameException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Subscribe Topic Exception object. - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeTopicException(String msgVpnName, String aclProfileName, String subscribeTopicExceptionSyntax, String subscribeTopicException) throws RestClientException { - return deleteMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException).getBody(); - } - - /** - * Delete a Subscribe Topic Exception object. - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String subscribeTopicExceptionSyntax, String subscribeTopicException) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'subscribeTopicExceptionSyntax' is set - if (subscribeTopicExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeTopicExceptionSyntax' when calling deleteMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'subscribeTopicException' is set - if (subscribeTopicException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeTopicException' when calling deleteMsgVpnAclProfileSubscribeTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("subscribeTopicExceptionSyntax", subscribeTopicExceptionSyntax); - uriVariables.put("subscribeTopicException", subscribeTopicException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an ACL Profile object. - * Get an ACL Profile object. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileResponse getMsgVpnAclProfile(String msgVpnName, String aclProfileName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfileWithHttpInfo(msgVpnName, aclProfileName, opaquePassword, select).getBody(); - } - - /** - * Get an ACL Profile object. - * Get an ACL Profile object. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileWithHttpInfo(String msgVpnName, String aclProfileName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfile"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Client Connect Exception object. - * Get a Client Connect Exception object. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Connect Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param clientConnectExceptionAddress The IP address/netmask of the client connect exception in CIDR form. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileClientConnectExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileClientConnectExceptionResponse getMsgVpnAclProfileClientConnectException(String msgVpnName, String aclProfileName, String clientConnectExceptionAddress, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfileClientConnectExceptionWithHttpInfo(msgVpnName, aclProfileName, clientConnectExceptionAddress, opaquePassword, select).getBody(); - } - - /** - * Get a Client Connect Exception object. - * Get a Client Connect Exception object. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Connect Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param clientConnectExceptionAddress The IP address/netmask of the client connect exception in CIDR form. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileClientConnectExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileClientConnectExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String clientConnectExceptionAddress, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'clientConnectExceptionAddress' is set - if (clientConnectExceptionAddress == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientConnectExceptionAddress' when calling getMsgVpnAclProfileClientConnectException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("clientConnectExceptionAddress", clientConnectExceptionAddress); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Client Connect Exception objects. - * Get a list of Client Connect Exception objects. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Connect Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileClientConnectExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileClientConnectExceptionsResponse getMsgVpnAclProfileClientConnectExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfileClientConnectExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Client Connect Exception objects. - * Get a list of Client Connect Exception objects. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Connect Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileClientConnectExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileClientConnectExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileClientConnectExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileClientConnectExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Publish Topic Exception object. - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The Publish Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfilePublishExceptionResponse getMsgVpnAclProfilePublishException(String msgVpnName, String aclProfileName, String topicSyntax, String publishExceptionTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfilePublishExceptionWithHttpInfo(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Publish Topic Exception object. - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The Publish Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAclProfilePublishExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String topicSyntax, String publishExceptionTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'topicSyntax' is set - if (topicSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicSyntax' when calling getMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'publishExceptionTopic' is set - if (publishExceptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishExceptionTopic' when calling getMsgVpnAclProfilePublishException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("topicSyntax", topicSyntax); - uriVariables.put("publishExceptionTopic", publishExceptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Publish Topic Exception objects. - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The list of Publish Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfilePublishExceptionsResponse getMsgVpnAclProfilePublishExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfilePublishExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Publish Topic Exception objects. - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The list of Publish Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAclProfilePublishExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfilePublishExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfilePublishExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Publish Topic Exception object. - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Publish Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param publishTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishTopicExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfilePublishTopicExceptionResponse getMsgVpnAclProfilePublishTopicException(String msgVpnName, String aclProfileName, String publishTopicExceptionSyntax, String publishTopicException, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException, opaquePassword, select).getBody(); - } - - /** - * Get a Publish Topic Exception object. - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Publish Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param publishTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishTopicExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String publishTopicExceptionSyntax, String publishTopicException, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'publishTopicExceptionSyntax' is set - if (publishTopicExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishTopicExceptionSyntax' when calling getMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'publishTopicException' is set - if (publishTopicException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishTopicException' when calling getMsgVpnAclProfilePublishTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("publishTopicExceptionSyntax", publishTopicExceptionSyntax); - uriVariables.put("publishTopicException", publishTopicException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Publish Topic Exception objects. - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Publish Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishTopicExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfilePublishTopicExceptionsResponse getMsgVpnAclProfilePublishTopicExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfilePublishTopicExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Publish Topic Exception objects. - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Publish Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishTopicExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfilePublishTopicExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfilePublishTopicExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfilePublishTopicExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Subscribe Topic Exception object. - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The Subscribe Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfileSubscribeExceptionResponse getMsgVpnAclProfileSubscribeException(String msgVpnName, String aclProfileName, String topicSyntax, String subscribeExceptionTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeExceptionWithHttpInfo(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Subscribe Topic Exception object. - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The Subscribe Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAclProfileSubscribeExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String topicSyntax, String subscribeExceptionTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'topicSyntax' is set - if (topicSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicSyntax' when calling getMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'subscribeExceptionTopic' is set - if (subscribeExceptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeExceptionTopic' when calling getMsgVpnAclProfileSubscribeException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("topicSyntax", topicSyntax); - uriVariables.put("subscribeExceptionTopic", subscribeExceptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Subscribe Topic Exception objects. - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The list of Subscribe Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfileSubscribeExceptionsResponse getMsgVpnAclProfileSubscribeExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Subscribe Topic Exception objects. - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The list of Subscribe Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAclProfileSubscribeExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Subscribe Share Name Exception object. - * Get a Subscribe Share Name Exception object. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Share Name Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeShareNameExceptionSyntax The syntax of the subscribe share name for the exception to the default action taken. (required) - * @param subscribeShareNameException The subscribe share name exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeShareNameExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeShareNameExceptionResponse getMsgVpnAclProfileSubscribeShareNameException(String msgVpnName, String aclProfileName, String subscribeShareNameExceptionSyntax, String subscribeShareNameException, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException, opaquePassword, select).getBody(); - } - - /** - * Get a Subscribe Share Name Exception object. - * Get a Subscribe Share Name Exception object. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Share Name Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeShareNameExceptionSyntax The syntax of the subscribe share name for the exception to the default action taken. (required) - * @param subscribeShareNameException The subscribe share name exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeShareNameExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String subscribeShareNameExceptionSyntax, String subscribeShareNameException, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'subscribeShareNameExceptionSyntax' is set - if (subscribeShareNameExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeShareNameExceptionSyntax' when calling getMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'subscribeShareNameException' is set - if (subscribeShareNameException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeShareNameException' when calling getMsgVpnAclProfileSubscribeShareNameException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("subscribeShareNameExceptionSyntax", subscribeShareNameExceptionSyntax); - uriVariables.put("subscribeShareNameException", subscribeShareNameException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Subscribe Share Name Exception objects. - * Get a list of Subscribe Share Name Exception objects. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Subscribe Share Name Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeShareNameExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeShareNameExceptionsResponse getMsgVpnAclProfileSubscribeShareNameExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeShareNameExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Subscribe Share Name Exception objects. - * Get a list of Subscribe Share Name Exception objects. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Subscribe Share Name Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeShareNameExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileSubscribeShareNameExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeShareNameExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeShareNameExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Subscribe Topic Exception object. - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeTopicExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeTopicExceptionResponse getMsgVpnAclProfileSubscribeTopicException(String msgVpnName, String aclProfileName, String subscribeTopicExceptionSyntax, String subscribeTopicException, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException, opaquePassword, select).getBody(); - } - - /** - * Get a Subscribe Topic Exception object. - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeTopicExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String subscribeTopicExceptionSyntax, String subscribeTopicException, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'subscribeTopicExceptionSyntax' is set - if (subscribeTopicExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeTopicExceptionSyntax' when calling getMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'subscribeTopicException' is set - if (subscribeTopicException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeTopicException' when calling getMsgVpnAclProfileSubscribeTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("subscribeTopicExceptionSyntax", subscribeTopicExceptionSyntax); - uriVariables.put("subscribeTopicException", subscribeTopicException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Subscribe Topic Exception objects. - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Subscribe Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeTopicExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeTopicExceptionsResponse getMsgVpnAclProfileSubscribeTopicExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeTopicExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Subscribe Topic Exception objects. - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Subscribe Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeTopicExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileSubscribeTopicExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeTopicExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeTopicExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of ACL Profile objects. - * Get a list of ACL Profile objects. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of ACL Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfilesResponse getMsgVpnAclProfiles(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfilesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of ACL Profile objects. - * Get a list of ACL Profile objects. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of ACL Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfilesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfiles"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an ACL Profile object. - * Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileResponse replaceMsgVpnAclProfile(String msgVpnName, String aclProfileName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnAclProfileWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an ACL Profile object. - * Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnAclProfileWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnAclProfile"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling replaceMsgVpnAclProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnAclProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an ACL Profile object. - * Update an ACL Profile object. Any attribute missing from the request will be left unchanged. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileResponse updateMsgVpnAclProfile(String msgVpnName, String aclProfileName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnAclProfileWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Update an ACL Profile object. - * Update an ACL Profile object. Any attribute missing from the request will be left unchanged. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnAclProfileWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnAclProfile"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling updateMsgVpnAclProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnAclProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AllApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AllApi.java deleted file mode 100644 index 0315948d0..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AllApi.java +++ /dev/null @@ -1,27840 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutApiResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserMsgVpnResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserMsgVpnsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.Broker; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.BrokerResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthoritiesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthoritiesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFilterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFiltersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleConditionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleConditionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRulesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLink; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttributeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttributesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddress; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddressResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddressesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinksResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClustersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthoritiesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthorityResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProvider; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProviderResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProvidersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroupResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroupsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpnResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpnsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFiltersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleConditionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleConditionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRulesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsername; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttributeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttributesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstance; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstanceResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstancesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClustersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCachesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridgeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridgesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactoriesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactory; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactoryResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueueResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueuesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCacheResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCachesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSession; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplateResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplatesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueuesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLog; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBinding; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeader; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumer; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplateResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplatesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHost; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHostResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHostsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParameter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParameterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParametersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SystemInformationResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostname; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostnameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostnamesResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AllApi { - private ApiClient apiClient; - - public AllApi() { - this(new ApiClient()); - } - - public AllApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Certificate Authority object. - * Create a Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||x| certContent|||||x| crlDayList|||||x| crlTimeList|||||x| crlUrl|||||x| ocspNonResponderCertEnabled|||||x| ocspOverrideUrl|||||x| ocspTimeout|||||x| revocationCheckEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The Certificate Authority object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return CertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public CertAuthorityResponse createCertAuthority(CertAuthority body, String opaquePassword, List select) throws RestClientException { - return createCertAuthorityWithHttpInfo(body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Authority object. - * Create a Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||x| certContent|||||x| crlDayList|||||x| crlTimeList|||||x| crlUrl|||||x| ocspNonResponderCertEnabled|||||x| ocspOverrideUrl|||||x| ocspTimeout|||||x| revocationCheckEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The Certificate Authority object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<CertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createCertAuthorityWithHttpInfo(CertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createCertAuthority"); - } - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities", HttpMethod.POST, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an OCSP Responder Trusted Common Name object. - * Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x||x||x| ocspTlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - *

200 - The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The OCSP Responder Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return CertAuthorityOcspTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public CertAuthorityOcspTlsTrustedCommonNameResponse createCertAuthorityOcspTlsTrustedCommonName(String certAuthorityName, CertAuthorityOcspTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - return createCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(certAuthorityName, body, opaquePassword, select).getBody(); - } - - /** - * Create an OCSP Responder Trusted Common Name object. - * Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x||x||x| ocspTlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - *

200 - The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The OCSP Responder Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<CertAuthorityOcspTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(String certAuthorityName, CertAuthorityOcspTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling createCertAuthorityOcspTlsTrustedCommonName"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createCertAuthorityOcspTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Client Certificate Authority object. - * Create a Client Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Client Certificate Authority object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Client Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ClientCertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ClientCertAuthorityResponse createClientCertAuthority(ClientCertAuthority body, String opaquePassword, List select) throws RestClientException { - return createClientCertAuthorityWithHttpInfo(body, opaquePassword, select).getBody(); - } - - /** - * Create a Client Certificate Authority object. - * Create a Client Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Client Certificate Authority object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Client Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<ClientCertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createClientCertAuthorityWithHttpInfo(ClientCertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createClientCertAuthority"); - } - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities", HttpMethod.POST, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an OCSP Responder Trusted Common Name object. - * Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x||x||| ocspTlsTrustedCommonName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The OCSP Responder Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ClientCertAuthorityOcspTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ClientCertAuthorityOcspTlsTrustedCommonNameResponse createClientCertAuthorityOcspTlsTrustedCommonName(String certAuthorityName, ClientCertAuthorityOcspTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - return createClientCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(certAuthorityName, body, opaquePassword, select).getBody(); - } - - /** - * Create an OCSP Responder Trusted Common Name object. - * Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x||x||| ocspTlsTrustedCommonName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The OCSP Responder Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<ClientCertAuthorityOcspTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createClientCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(String certAuthorityName, ClientCertAuthorityOcspTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling createClientCertAuthorityOcspTlsTrustedCommonName"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createClientCertAuthorityOcspTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Cluster object. - * Create a Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationBasicPassword||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| dmrClusterName|x|x|||| nodeName|||x||| tlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cluster object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterResponse createDmrCluster(DmrCluster body, String opaquePassword, List select) throws RestClientException { - return createDmrClusterWithHttpInfo(body, opaquePassword, select).getBody(); - } - - /** - * Create a Cluster object. - * Create a Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationBasicPassword||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| dmrClusterName|x|x|||| nodeName|||x||| tlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cluster object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createDmrClusterWithHttpInfo(DmrCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDmrCluster"); - } - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters", HttpMethod.POST, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Certificate Matching Rule object. - * Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleResponse createDmrClusterCertMatchingRule(String dmrClusterName, DmrClusterCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - return createDmrClusterCertMatchingRuleWithHttpInfo(dmrClusterName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Matching Rule object. - * Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createDmrClusterCertMatchingRuleWithHttpInfo(String dmrClusterName, DmrClusterCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling createDmrClusterCertMatchingRule"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDmrClusterCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Certificate Matching Rule Attribute Filter object. - * Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| filterName|x|x|||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleAttributeFilterResponse createDmrClusterCertMatchingRuleAttributeFilter(String dmrClusterName, String ruleName, DmrClusterCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - return createDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(dmrClusterName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Matching Rule Attribute Filter object. - * Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| filterName|x|x|||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(String dmrClusterName, String ruleName, DmrClusterCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling createDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling createDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDmrClusterCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Certificate Matching Rule Condition object. - * Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Condition object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Condition object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleConditionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleConditionResponse createDmrClusterCertMatchingRuleCondition(String dmrClusterName, String ruleName, DmrClusterCertMatchingRuleCondition body, String opaquePassword, List select) throws RestClientException { - return createDmrClusterCertMatchingRuleConditionWithHttpInfo(dmrClusterName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Matching Rule Condition object. - * Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Condition object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Condition object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleConditionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createDmrClusterCertMatchingRuleConditionWithHttpInfo(String dmrClusterName, String ruleName, DmrClusterCertMatchingRuleCondition body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling createDmrClusterCertMatchingRuleCondition"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling createDmrClusterCertMatchingRuleCondition"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDmrClusterCertMatchingRuleCondition"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Link object. - * Create a Link object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationBasicPassword||||x||x dmrClusterName|x||x||| remoteNodeName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Link object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param body The Link object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkResponse createDmrClusterLink(String dmrClusterName, DmrClusterLink body, String opaquePassword, List select) throws RestClientException { - return createDmrClusterLinkWithHttpInfo(dmrClusterName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Link object. - * Create a Link object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationBasicPassword||||x||x dmrClusterName|x||x||| remoteNodeName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Link object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param body The Link object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createDmrClusterLinkWithHttpInfo(String dmrClusterName, DmrClusterLink body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling createDmrClusterLink"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDmrClusterLink"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Link Attribute object. - * Create a Link Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| dmrClusterName|x||x||| remoteNodeName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Link Attribute object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Link Attribute object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkAttributeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkAttributeResponse createDmrClusterLinkAttribute(String dmrClusterName, String remoteNodeName, DmrClusterLinkAttribute body, String opaquePassword, List select) throws RestClientException { - return createDmrClusterLinkAttributeWithHttpInfo(dmrClusterName, remoteNodeName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Link Attribute object. - * Create a Link Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| dmrClusterName|x||x||| remoteNodeName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Link Attribute object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Link Attribute object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkAttributeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createDmrClusterLinkAttributeWithHttpInfo(String dmrClusterName, String remoteNodeName, DmrClusterLinkAttribute body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling createDmrClusterLinkAttribute"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling createDmrClusterLinkAttribute"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDmrClusterLinkAttribute"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Remote Address object. - * Create a Remote Address object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| remoteAddress|x|x|||| remoteNodeName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Remote Address object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Remote Address object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkRemoteAddressResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkRemoteAddressResponse createDmrClusterLinkRemoteAddress(String dmrClusterName, String remoteNodeName, DmrClusterLinkRemoteAddress body, String opaquePassword, List select) throws RestClientException { - return createDmrClusterLinkRemoteAddressWithHttpInfo(dmrClusterName, remoteNodeName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Remote Address object. - * Create a Remote Address object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| remoteAddress|x|x|||| remoteNodeName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Remote Address object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Remote Address object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkRemoteAddressResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createDmrClusterLinkRemoteAddressWithHttpInfo(String dmrClusterName, String remoteNodeName, DmrClusterLinkRemoteAddress body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling createDmrClusterLinkRemoteAddress"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling createDmrClusterLinkRemoteAddress"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDmrClusterLinkRemoteAddress"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Trusted Common Name object. - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||x| remoteNodeName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public DmrClusterLinkTlsTrustedCommonNameResponse createDmrClusterLinkTlsTrustedCommonName(String dmrClusterName, String remoteNodeName, DmrClusterLinkTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - return createDmrClusterLinkTlsTrustedCommonNameWithHttpInfo(dmrClusterName, remoteNodeName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Trusted Common Name object. - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||x| remoteNodeName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createDmrClusterLinkTlsTrustedCommonNameWithHttpInfo(String dmrClusterName, String remoteNodeName, DmrClusterLinkTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling createDmrClusterLinkTlsTrustedCommonName"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling createDmrClusterLinkTlsTrustedCommonName"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDmrClusterLinkTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Domain Certificate Authority object. - * Create a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Certificate Authorities trusted for domain verification. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Domain Certificate Authority object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Domain Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DomainCertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DomainCertAuthorityResponse createDomainCertAuthority(DomainCertAuthority body, String opaquePassword, List select) throws RestClientException { - return createDomainCertAuthorityWithHttpInfo(body, opaquePassword, select).getBody(); - } - - /** - * Create a Domain Certificate Authority object. - * Create a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Certificate Authorities trusted for domain verification. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Domain Certificate Authority object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Domain Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DomainCertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createDomainCertAuthorityWithHttpInfo(DomainCertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDomainCertAuthority"); - } - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/domainCertAuthorities", HttpMethod.POST, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Message VPN object. - * Create a Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| distributedCacheManagementEnabled|||||x| msgVpnName|x|x|||| replicationBridgeAuthenticationBasicPassword||||x||x replicationBridgeAuthenticationClientCertContent||||x||x replicationBridgeAuthenticationClientCertPassword||||x|| replicationEnabledQueueBehavior||||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Message VPN object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnResponse createMsgVpn(MsgVpn body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnWithHttpInfo(body, opaquePassword, select).getBody(); - } - - /** - * Create a Message VPN object. - * Create a Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| distributedCacheManagementEnabled|||||x| msgVpnName|x|x|||| replicationBridgeAuthenticationBasicPassword||||x||x replicationBridgeAuthenticationClientCertContent||||x||x replicationBridgeAuthenticationClientCertPassword||||x|| replicationEnabledQueueBehavior||||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Message VPN object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnWithHttpInfo(MsgVpn body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpn"); - } - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns", HttpMethod.POST, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an ACL Profile object. - * Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileResponse createMsgVpnAclProfile(String msgVpnName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfileWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an ACL Profile object. - * Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAclProfileWithHttpInfo(String msgVpnName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Client Connect Exception object. - * Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| clientConnectExceptionAddress|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Connect Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Client Connect Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileClientConnectExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileClientConnectExceptionResponse createMsgVpnAclProfileClientConnectException(String msgVpnName, String aclProfileName, MsgVpnAclProfileClientConnectException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfileClientConnectExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Client Connect Exception object. - * Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| clientConnectExceptionAddress|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Connect Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Client Connect Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileClientConnectExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAclProfileClientConnectExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfileClientConnectException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfileClientConnectException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Publish Topic Exception object. - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| publishExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The Publish Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Publish Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfilePublishExceptionResponse createMsgVpnAclProfilePublishException(String msgVpnName, String aclProfileName, MsgVpnAclProfilePublishException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfilePublishExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Publish Topic Exception object. - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| publishExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The Publish Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Publish Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createMsgVpnAclProfilePublishExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfilePublishException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfilePublishException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Publish Topic Exception object. - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| publishTopicException|x|x|||| publishTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Publish Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Publish Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishTopicExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfilePublishTopicExceptionResponse createMsgVpnAclProfilePublishTopicException(String msgVpnName, String aclProfileName, MsgVpnAclProfilePublishTopicException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Publish Topic Exception object. - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| publishTopicException|x|x|||| publishTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Publish Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Publish Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishTopicExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfilePublishTopicException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfilePublishTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Subscribe Topic Exception object. - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| subscribeExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The Subscribe Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfileSubscribeExceptionResponse createMsgVpnAclProfileSubscribeException(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfileSubscribeExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Subscribe Topic Exception object. - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| subscribeExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The Subscribe Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createMsgVpnAclProfileSubscribeExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfileSubscribeException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Subscribe Share Name Exception object. - * Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeShareNameException|x|x|||| subscribeShareNameExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Share Name Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Share Name Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeShareNameExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeShareNameExceptionResponse createMsgVpnAclProfileSubscribeShareNameException(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeShareNameException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Subscribe Share Name Exception object. - * Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeShareNameException|x|x|||| subscribeShareNameExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Share Name Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Share Name Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeShareNameExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeShareNameException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfileSubscribeShareNameException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Subscribe Topic Exception object. - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeTopicException|x|x|||| subscribeTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeTopicExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeTopicExceptionResponse createMsgVpnAclProfileSubscribeTopicException(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeTopicException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Subscribe Topic Exception object. - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeTopicException|x|x|||| subscribeTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeTopicExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeTopicException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfileSubscribeTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an OAuth Profile object. - * Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x msgVpnName|x||x||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResponse createMsgVpnAuthenticationOauthProfile(String msgVpnName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAuthenticationOauthProfileWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an OAuth Profile object. - * Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x msgVpnName|x||x||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAuthenticationOauthProfileWithHttpInfo(String msgVpnName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAuthenticationOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| msgVpnName|x||x||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse createMsgVpnAuthenticationOauthProfileClientRequiredClaim(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfileClientRequiredClaim body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| msgVpnName|x||x||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfileClientRequiredClaim body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an OAuth Provider object. - * Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x||x||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword||||x|x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProviderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAuthenticationOauthProviderResponse createMsgVpnAuthenticationOauthProvider(String msgVpnName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAuthenticationOauthProviderWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an OAuth Provider object. - * Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x||x||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword||||x|x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProviderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createMsgVpnAuthenticationOauthProviderWithHttpInfo(String msgVpnName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAuthenticationOauthProvider"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an Authorization Group object. - * Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationGroupName|x|x|||| msgVpnName|x||x||| orderAfterAuthorizationGroupName||||x|| orderBeforeAuthorizationGroupName||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthorizationGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthorizationGroupResponse createMsgVpnAuthorizationGroup(String msgVpnName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAuthorizationGroupWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an Authorization Group object. - * Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationGroupName|x|x|||| msgVpnName|x||x||| orderAfterAuthorizationGroupName||||x|| orderBeforeAuthorizationGroupName||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthorizationGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAuthorizationGroupWithHttpInfo(String msgVpnName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAuthorizationGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Bridge object. - * Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| msgVpnName|x||x||| remoteAuthenticationBasicPassword||||x||x remoteAuthenticationClientCertContent||||x||x remoteAuthenticationClientCertPassword||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeResponse createMsgVpnBridge(String msgVpnName, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnBridgeWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Bridge object. - * Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| msgVpnName|x||x||| remoteAuthenticationBasicPassword||||x||x remoteAuthenticationClientCertContent||||x||x remoteAuthenticationClientCertPassword||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnBridgeWithHttpInfo(String msgVpnName, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Remote Message VPN object. - * Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| msgVpnName|x||x||| password||||x||x remoteMsgVpnInterface|x||||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteMsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteMsgVpnResponse createMsgVpnBridgeRemoteMsgVpn(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnBridgeRemoteMsgVpnWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Create a Remote Message VPN object. - * Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| msgVpnName|x||x||| password||||x||x remoteMsgVpnInterface|x||||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteMsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnBridgeRemoteMsgVpnWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling createMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling createMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnBridgeRemoteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Remote Subscription object. - * Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| deliverAlwaysEnabled||x|||| msgVpnName|x||x||| remoteSubscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Remote Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteSubscriptionResponse createMsgVpnBridgeRemoteSubscription(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeRemoteSubscription body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnBridgeRemoteSubscriptionWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Create a Remote Subscription object. - * Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| deliverAlwaysEnabled||x|||| msgVpnName|x||x||| remoteSubscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Remote Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnBridgeRemoteSubscriptionWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeRemoteSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling createMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling createMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnBridgeRemoteSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Trusted Common Name object. - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||x| bridgeVirtualRouter|x||x||x| msgVpnName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnBridgeTlsTrustedCommonNameResponse createMsgVpnBridgeTlsTrustedCommonName(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Create a Trusted Common Name object. - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||x| bridgeVirtualRouter|x||x||x| msgVpnName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling createMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling createMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnBridgeTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Certificate Matching Rule object. - * Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleResponse createMsgVpnCertMatchingRule(String msgVpnName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnCertMatchingRuleWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Matching Rule object. - * Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnCertMatchingRuleWithHttpInfo(String msgVpnName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Certificate Matching Rule Attribute Filter object. - * Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: filterName|x|x|||| msgVpnName|x||x||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleAttributeFilterResponse createMsgVpnCertMatchingRuleAttributeFilter(String msgVpnName, String ruleName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(msgVpnName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Matching Rule Attribute Filter object. - * Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: filterName|x|x|||| msgVpnName|x||x||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(String msgVpnName, String ruleName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling createMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Certificate Matching Rule Condition object. - * Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule Condition object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Condition object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleConditionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleConditionResponse createMsgVpnCertMatchingRuleCondition(String msgVpnName, String ruleName, MsgVpnCertMatchingRuleCondition body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnCertMatchingRuleConditionWithHttpInfo(msgVpnName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Matching Rule Condition object. - * Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule Condition object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Condition object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleConditionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnCertMatchingRuleConditionWithHttpInfo(String msgVpnName, String ruleName, MsgVpnCertMatchingRuleCondition body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling createMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnCertMatchingRuleCondition"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Client Profile object. - * Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientProfileResponse createMsgVpnClientProfile(String msgVpnName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnClientProfileWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Client Profile object. - * Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnClientProfileWithHttpInfo(String msgVpnName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnClientProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnClientProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Client Username object. - * Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientUsername|x|x|||| msgVpnName|x||x||| password||||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameResponse createMsgVpnClientUsername(String msgVpnName, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnClientUsernameWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Client Username object. - * Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientUsername|x|x|||| msgVpnName|x||x||| password||||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnClientUsernameWithHttpInfo(String msgVpnName, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnClientUsername"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnClientUsername"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Client Username Attribute object. - * Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| clientUsername|x||x||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Client Username Attribute object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username Attribute object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameAttributeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameAttributeResponse createMsgVpnClientUsernameAttribute(String msgVpnName, String clientUsername, MsgVpnClientUsernameAttribute body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnClientUsernameAttributeWithHttpInfo(msgVpnName, clientUsername, body, opaquePassword, select).getBody(); - } - - /** - * Create a Client Username Attribute object. - * Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| clientUsername|x||x||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Client Username Attribute object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username Attribute object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameAttributeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnClientUsernameAttributeWithHttpInfo(String msgVpnName, String clientUsername, MsgVpnClientUsernameAttribute body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling createMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnClientUsernameAttribute"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Distributed Cache object. - * Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheResponse createMsgVpnDistributedCache(String msgVpnName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Distributed Cache object. - * Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheWithHttpInfo(String msgVpnName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Cache Cluster object. - * Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterResponse createMsgVpnDistributedCacheCluster(String msgVpnName, String cacheName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheClusterWithHttpInfo(msgVpnName, cacheName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Cache Cluster object. - * Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheClusterWithHttpInfo(String msgVpnName, String cacheName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling createMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCacheCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Home Cache Cluster object. - * Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Home Cache Cluster object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Home Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterGlobalCachingHomeCluster body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(msgVpnName, cacheName, clusterName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Home Cache Cluster object. - * Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Home Cache Cluster object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Home Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterGlobalCachingHomeCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Topic Prefix object. - * Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x||x||| msgVpnName|x||x||| topicPrefix|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic Prefix object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param body The Topic Prefix object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(String msgVpnName, String cacheName, String clusterName, String homeClusterName, MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Topic Prefix object. - * Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x||x||| msgVpnName|x||x||| topicPrefix|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic Prefix object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param body The Topic Prefix object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName, MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Cache Instance object. - * Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| instanceName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterInstanceResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterInstanceResponse createMsgVpnDistributedCacheClusterInstance(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheClusterInstanceWithHttpInfo(msgVpnName, cacheName, clusterName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Cache Instance object. - * Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| instanceName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterInstanceResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheClusterInstanceWithHttpInfo(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling createMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling createMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCacheClusterInstance"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Topic object. - * Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| msgVpnName|x||x||| topic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterTopicResponse createMsgVpnDistributedCacheClusterTopic(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterTopic body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheClusterTopicWithHttpInfo(msgVpnName, cacheName, clusterName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Topic object. - * Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| msgVpnName|x||x||| topic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheClusterTopicWithHttpInfo(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling createMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling createMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCacheClusterTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a DMR Bridge object. - * Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDmrBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDmrBridgeResponse createMsgVpnDmrBridge(String msgVpnName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDmrBridgeWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a DMR Bridge object. - * Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDmrBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDmrBridgeWithHttpInfo(String msgVpnName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDmrBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDmrBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a JNDI Connection Factory object. - * Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: connectionFactoryName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiConnectionFactoryResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiConnectionFactoryResponse createMsgVpnJndiConnectionFactory(String msgVpnName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnJndiConnectionFactoryWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a JNDI Connection Factory object. - * Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: connectionFactoryName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiConnectionFactoryResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnJndiConnectionFactoryWithHttpInfo(String msgVpnName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnJndiConnectionFactory"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a JNDI Queue object. - * Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiQueueResponse createMsgVpnJndiQueue(String msgVpnName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnJndiQueueWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a JNDI Queue object. - * Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnJndiQueueWithHttpInfo(String msgVpnName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnJndiQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnJndiQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a JNDI Topic object. - * Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiTopicResponse createMsgVpnJndiTopic(String msgVpnName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnJndiTopicWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a JNDI Topic object. - * Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnJndiTopicWithHttpInfo(String msgVpnName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnJndiTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnJndiTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an MQTT Retain Cache object. - * Create an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttRetainCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttRetainCacheResponse createMsgVpnMqttRetainCache(String msgVpnName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnMqttRetainCacheWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an MQTT Retain Cache object. - * Create an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttRetainCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnMqttRetainCacheWithHttpInfo(String msgVpnName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnMqttRetainCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an MQTT Session object. - * Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionResponse createMsgVpnMqttSession(String msgVpnName, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnMqttSessionWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an MQTT Session object. - * Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnMqttSessionWithHttpInfo(String msgVpnName, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnMqttSession"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnMqttSession"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Subscription object. - * Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x||x||| mqttSessionVirtualRouter|x||x||| msgVpnName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionSubscriptionResponse createMsgVpnMqttSessionSubscription(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnMqttSessionSubscriptionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Create a Subscription object. - * Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x||x||| mqttSessionVirtualRouter|x||x||| msgVpnName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnMqttSessionSubscriptionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling createMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling createMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnMqttSessionSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Queue object. - * Create a Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueResponse createMsgVpnQueue(String msgVpnName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnQueueWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Queue object. - * Create a Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnQueueWithHttpInfo(String msgVpnName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Queue Subscription object. - * Create a Queue Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueSubscriptionResponse createMsgVpnQueueSubscription(String msgVpnName, String queueName, MsgVpnQueueSubscription body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnQueueSubscriptionWithHttpInfo(msgVpnName, queueName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Queue Subscription object. - * Create a Queue Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnQueueSubscriptionWithHttpInfo(String msgVpnName, String queueName, MsgVpnQueueSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnQueueSubscription"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling createMsgVpnQueueSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnQueueSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Queue Template object. - * Create a Queue Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueTemplateResponse createMsgVpnQueueTemplate(String msgVpnName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnQueueTemplateWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Queue Template object. - * Create a Queue Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnQueueTemplateWithHttpInfo(String msgVpnName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnQueueTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnQueueTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Replay Log object. - * Create a Replay Log object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogResponse createMsgVpnReplayLog(String msgVpnName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnReplayLogWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Replay Log object. - * Create a Replay Log object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnReplayLogWithHttpInfo(String msgVpnName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnReplayLog"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnReplayLog"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Topic Filter Subscription object. - * Create a Topic Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x||x||| topicFilterSubscription|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Topic Filter Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Topic Filter Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogTopicFilterSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogTopicFilterSubscriptionResponse createMsgVpnReplayLogTopicFilterSubscription(String msgVpnName, String replayLogName, MsgVpnReplayLogTopicFilterSubscription body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(msgVpnName, replayLogName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Topic Filter Subscription object. - * Create a Topic Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x||x||| topicFilterSubscription|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Topic Filter Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Topic Filter Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogTopicFilterSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(String msgVpnName, String replayLogName, MsgVpnReplayLogTopicFilterSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling createMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnReplayLogTopicFilterSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Replicated Topic object. - * Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplicatedTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplicatedTopicResponse createMsgVpnReplicatedTopic(String msgVpnName, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnReplicatedTopicWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Replicated Topic object. - * Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplicatedTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnReplicatedTopicWithHttpInfo(String msgVpnName, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnReplicatedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a REST Delivery Point object. - * Create a REST Delivery Point object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointResponse createMsgVpnRestDeliveryPoint(String msgVpnName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a REST Delivery Point object. - * Create a REST Delivery Point object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnRestDeliveryPointWithHttpInfo(String msgVpnName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Queue Binding object. - * Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueBindingName|x|x|||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingResponse createMsgVpnRestDeliveryPointQueueBinding(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(msgVpnName, restDeliveryPointName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Queue Binding object. - * Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueBindingName|x|x|||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling createMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPointQueueBinding"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Request Header object. - * Create a Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: headerName|x|x|||| msgVpnName|x||x||| queueBindingName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse createMsgVpnRestDeliveryPointQueueBindingRequestHeader(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Request Header object. - * Create a Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: headerName|x|x|||| msgVpnName|x||x||| queueBindingName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling createMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling createMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a REST Consumer object. - * Create a REST Consumer object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| authenticationHttpBasicPassword||||x||x authenticationHttpHeaderValue||||x||x authenticationOauthClientSecret||||x||x authenticationOauthJwtSecretKey||||x||x msgVpnName|x||x||| restConsumerName|x|x|||| restDeliveryPointName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerResponse createMsgVpnRestDeliveryPointRestConsumer(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(msgVpnName, restDeliveryPointName, body, opaquePassword, select).getBody(); - } - - /** - * Create a REST Consumer object. - * Create a REST Consumer object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| authenticationHttpBasicPassword||||x||x authenticationHttpHeaderValue||||x||x authenticationOauthClientSecret||||x||x authenticationOauthJwtSecretKey||||x||x msgVpnName|x||x||| restConsumerName|x|x|||| restDeliveryPointName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling createMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPointRestConsumer"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Claim object. - * Create a Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthJwtClaimName|x|x|||| oauthJwtClaimValue||x|||| restConsumerName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - *

200 - The Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Claim object. - * Create a Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthJwtClaimName|x|x|||| oauthJwtClaimValue||x|||| restConsumerName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - *

200 - The Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Trusted Common Name object. - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||x| restConsumerName|x||x||x| restDeliveryPointName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Trusted Common Name object. - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||x| restConsumerName|x||x||x| restDeliveryPointName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Sequenced Topic object. - * Create a Sequenced Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| sequencedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Sequenced Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Sequenced Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnSequencedTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnSequencedTopicResponse createMsgVpnSequencedTopic(String msgVpnName, MsgVpnSequencedTopic body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnSequencedTopicWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Sequenced Topic object. - * Create a Sequenced Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| sequencedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Sequenced Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Sequenced Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnSequencedTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnSequencedTopicWithHttpInfo(String msgVpnName, MsgVpnSequencedTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnSequencedTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnSequencedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/sequencedTopics", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Topic Endpoint object. - * Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointResponse createMsgVpnTopicEndpoint(String msgVpnName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnTopicEndpointWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Topic Endpoint object. - * Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnTopicEndpointWithHttpInfo(String msgVpnName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnTopicEndpoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Topic Endpoint Template object. - * Create a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointTemplateResponse createMsgVpnTopicEndpointTemplate(String msgVpnName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnTopicEndpointTemplateWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Topic Endpoint Template object. - * Create a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnTopicEndpointTemplateWithHttpInfo(String msgVpnName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnTopicEndpointTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an OAuth Profile object. - * Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The OAuth Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileResponse createOauthProfile(OauthProfile body, String opaquePassword, List select) throws RestClientException { - return createOauthProfileWithHttpInfo(body, opaquePassword, select).getBody(); - } - - /** - * Create an OAuth Profile object. - * Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The OAuth Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createOauthProfileWithHttpInfo(OauthProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createOauthProfile"); - } - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles", HttpMethod.POST, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Group Access Level object. - * Create a Group Access Level object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: groupName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - *

200 - The Group Access Level object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Group Access Level object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupResponse createOauthProfileAccessLevelGroup(String oauthProfileName, OauthProfileAccessLevelGroup body, String opaquePassword, List select) throws RestClientException { - return createOauthProfileAccessLevelGroupWithHttpInfo(oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Group Access Level object. - * Create a Group Access Level object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: groupName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - *

200 - The Group Access Level object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Group Access Level object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createOauthProfileAccessLevelGroupWithHttpInfo(String oauthProfileName, OauthProfileAccessLevelGroup body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createOauthProfileAccessLevelGroup"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createOauthProfileAccessLevelGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Message VPN Access-Level Exception object. - * Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: groupName|x||x||| msgVpnName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse createOauthProfileAccessLevelGroupMsgVpnAccessLevelException(String oauthProfileName, String groupName, OauthProfileAccessLevelGroupMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - return createOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, groupName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Message VPN Access-Level Exception object. - * Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: groupName|x||x||| msgVpnName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String groupName, OauthProfileAccessLevelGroupMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling createOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an Allowed Host Value object. - * Create an Allowed Host Value object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowedHost|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Allowed Host Value object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Allowed Host Value object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientAllowedHostResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientAllowedHostResponse createOauthProfileClientAllowedHost(String oauthProfileName, OauthProfileClientAllowedHost body, String opaquePassword, List select) throws RestClientException { - return createOauthProfileClientAllowedHostWithHttpInfo(oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create an Allowed Host Value object. - * Create an Allowed Host Value object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowedHost|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Allowed Host Value object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Allowed Host Value object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientAllowedHostResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createOauthProfileClientAllowedHostWithHttpInfo(String oauthProfileName, OauthProfileClientAllowedHost body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createOauthProfileClientAllowedHost"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createOauthProfileClientAllowedHost"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAllowedHosts", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an Authorization Parameter object. - * Create an Authorization Parameter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationParameterName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Authorization Parameter object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Authorization Parameter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientAuthorizationParameterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientAuthorizationParameterResponse createOauthProfileClientAuthorizationParameter(String oauthProfileName, OauthProfileClientAuthorizationParameter body, String opaquePassword, List select) throws RestClientException { - return createOauthProfileClientAuthorizationParameterWithHttpInfo(oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create an Authorization Parameter object. - * Create an Authorization Parameter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationParameterName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Authorization Parameter object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Authorization Parameter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientAuthorizationParameterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createOauthProfileClientAuthorizationParameterWithHttpInfo(String oauthProfileName, OauthProfileClientAuthorizationParameter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createOauthProfileClientAuthorizationParameter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createOauthProfileClientAuthorizationParameter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientRequiredClaimResponse createOauthProfileClientRequiredClaim(String oauthProfileName, OauthProfileClientRequiredClaim body, String opaquePassword, List select) throws RestClientException { - return createOauthProfileClientRequiredClaimWithHttpInfo(oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createOauthProfileClientRequiredClaimWithHttpInfo(String oauthProfileName, OauthProfileClientRequiredClaim body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createOauthProfileClientRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientRequiredClaims", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Message VPN Access-Level Exception object. - * Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Default message VPN access-level exceptions. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileDefaultMsgVpnAccessLevelExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileDefaultMsgVpnAccessLevelExceptionResponse createOauthProfileDefaultMsgVpnAccessLevelException(String oauthProfileName, OauthProfileDefaultMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - return createOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Message VPN Access-Level Exception object. - * Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Default message VPN access-level exceptions. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileDefaultMsgVpnAccessLevelExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, OauthProfileDefaultMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileResourceServerRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileResourceServerRequiredClaimResponse createOauthProfileResourceServerRequiredClaim(String oauthProfileName, OauthProfileResourceServerRequiredClaim body, String opaquePassword, List select) throws RestClientException { - return createOauthProfileResourceServerRequiredClaimWithHttpInfo(oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileResourceServerRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createOauthProfileResourceServerRequiredClaimWithHttpInfo(String oauthProfileName, OauthProfileResourceServerRequiredClaim body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createOauthProfileResourceServerRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Virtual Hostname object. - * Create a Virtual Hostname object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: virtualHostname|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - *

200 - The Virtual Hostname object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Virtual Hostname object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return VirtualHostnameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public VirtualHostnameResponse createVirtualHostname(VirtualHostname body, String opaquePassword, List select) throws RestClientException { - return createVirtualHostnameWithHttpInfo(body, opaquePassword, select).getBody(); - } - - /** - * Create a Virtual Hostname object. - * Create a Virtual Hostname object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: virtualHostname|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - *

200 - The Virtual Hostname object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Virtual Hostname object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<VirtualHostnameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createVirtualHostnameWithHttpInfo(VirtualHostname body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createVirtualHostname"); - } - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/virtualHostnames", HttpMethod.POST, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Authority object. - * Delete a Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteCertAuthority(String certAuthorityName) throws RestClientException { - return deleteCertAuthorityWithHttpInfo(certAuthorityName).getBody(); - } - - /** - * Delete a Certificate Authority object. - * Delete a Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteCertAuthorityWithHttpInfo(String certAuthorityName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling deleteCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities/{certAuthorityName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an OCSP Responder Trusted Common Name object. - * Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param ocspTlsTrustedCommonName The expected Trusted Common Name of the OCSP responder remote certificate. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteCertAuthorityOcspTlsTrustedCommonName(String certAuthorityName, String ocspTlsTrustedCommonName) throws RestClientException { - return deleteCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(certAuthorityName, ocspTlsTrustedCommonName).getBody(); - } - - /** - * Delete an OCSP Responder Trusted Common Name object. - * Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param ocspTlsTrustedCommonName The expected Trusted Common Name of the OCSP responder remote certificate. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(String certAuthorityName, String ocspTlsTrustedCommonName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling deleteCertAuthorityOcspTlsTrustedCommonName"); - } - - // verify the required parameter 'ocspTlsTrustedCommonName' is set - if (ocspTlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ocspTlsTrustedCommonName' when calling deleteCertAuthorityOcspTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - uriVariables.put("ocspTlsTrustedCommonName", ocspTlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Client Certificate Authority object. - * Delete a Client Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteClientCertAuthority(String certAuthorityName) throws RestClientException { - return deleteClientCertAuthorityWithHttpInfo(certAuthorityName).getBody(); - } - - /** - * Delete a Client Certificate Authority object. - * Delete a Client Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteClientCertAuthorityWithHttpInfo(String certAuthorityName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling deleteClientCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities/{certAuthorityName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an OCSP Responder Trusted Common Name object. - * Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param ocspTlsTrustedCommonName The expected Trusted Common Name of the OCSP responder remote certificate. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteClientCertAuthorityOcspTlsTrustedCommonName(String certAuthorityName, String ocspTlsTrustedCommonName) throws RestClientException { - return deleteClientCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(certAuthorityName, ocspTlsTrustedCommonName).getBody(); - } - - /** - * Delete an OCSP Responder Trusted Common Name object. - * Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param ocspTlsTrustedCommonName The expected Trusted Common Name of the OCSP responder remote certificate. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteClientCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(String certAuthorityName, String ocspTlsTrustedCommonName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling deleteClientCertAuthorityOcspTlsTrustedCommonName"); - } - - // verify the required parameter 'ocspTlsTrustedCommonName' is set - if (ocspTlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ocspTlsTrustedCommonName' when calling deleteClientCertAuthorityOcspTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - uriVariables.put("ocspTlsTrustedCommonName", ocspTlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Cluster object. - * Delete a Cluster object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteDmrCluster(String dmrClusterName) throws RestClientException { - return deleteDmrClusterWithHttpInfo(dmrClusterName).getBody(); - } - - /** - * Delete a Cluster object. - * Delete a Cluster object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteDmrClusterWithHttpInfo(String dmrClusterName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling deleteDmrCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Matching Rule object. - * Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteDmrClusterCertMatchingRule(String dmrClusterName, String ruleName) throws RestClientException { - return deleteDmrClusterCertMatchingRuleWithHttpInfo(dmrClusterName, ruleName).getBody(); - } - - /** - * Delete a Certificate Matching Rule object. - * Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteDmrClusterCertMatchingRuleWithHttpInfo(String dmrClusterName, String ruleName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling deleteDmrClusterCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling deleteDmrClusterCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Matching Rule Attribute Filter object. - * Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Attribute Filter compares a link attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteDmrClusterCertMatchingRuleAttributeFilter(String dmrClusterName, String ruleName, String filterName) throws RestClientException { - return deleteDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(dmrClusterName, ruleName, filterName).getBody(); - } - - /** - * Delete a Certificate Matching Rule Attribute Filter object. - * Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Attribute Filter compares a link attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(String dmrClusterName, String ruleName, String filterName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling deleteDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling deleteDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling deleteDmrClusterCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Matching Rule Condition object. - * Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteDmrClusterCertMatchingRuleCondition(String dmrClusterName, String ruleName, String source) throws RestClientException { - return deleteDmrClusterCertMatchingRuleConditionWithHttpInfo(dmrClusterName, ruleName, source).getBody(); - } - - /** - * Delete a Certificate Matching Rule Condition object. - * Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteDmrClusterCertMatchingRuleConditionWithHttpInfo(String dmrClusterName, String ruleName, String source) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling deleteDmrClusterCertMatchingRuleCondition"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling deleteDmrClusterCertMatchingRuleCondition"); - } - - // verify the required parameter 'source' is set - if (source == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'source' when calling deleteDmrClusterCertMatchingRuleCondition"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("source", source); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Link object. - * Delete a Link object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteDmrClusterLink(String dmrClusterName, String remoteNodeName) throws RestClientException { - return deleteDmrClusterLinkWithHttpInfo(dmrClusterName, remoteNodeName).getBody(); - } - - /** - * Delete a Link object. - * Delete a Link object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteDmrClusterLinkWithHttpInfo(String dmrClusterName, String remoteNodeName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling deleteDmrClusterLink"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling deleteDmrClusterLink"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Link Attribute object. - * Delete a Link Attribute object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteDmrClusterLinkAttribute(String dmrClusterName, String remoteNodeName, String attributeName, String attributeValue) throws RestClientException { - return deleteDmrClusterLinkAttributeWithHttpInfo(dmrClusterName, remoteNodeName, attributeName, attributeValue).getBody(); - } - - /** - * Delete a Link Attribute object. - * Delete a Link Attribute object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteDmrClusterLinkAttributeWithHttpInfo(String dmrClusterName, String remoteNodeName, String attributeName, String attributeValue) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling deleteDmrClusterLinkAttribute"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling deleteDmrClusterLinkAttribute"); - } - - // verify the required parameter 'attributeName' is set - if (attributeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeName' when calling deleteDmrClusterLinkAttribute"); - } - - // verify the required parameter 'attributeValue' is set - if (attributeValue == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeValue' when calling deleteDmrClusterLinkAttribute"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - uriVariables.put("attributeName", attributeName); - uriVariables.put("attributeValue", attributeValue); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Remote Address object. - * Delete a Remote Address object. The deletion of instances of this object are synchronized to HA mates via config-sync. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param remoteAddress The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteDmrClusterLinkRemoteAddress(String dmrClusterName, String remoteNodeName, String remoteAddress) throws RestClientException { - return deleteDmrClusterLinkRemoteAddressWithHttpInfo(dmrClusterName, remoteNodeName, remoteAddress).getBody(); - } - - /** - * Delete a Remote Address object. - * Delete a Remote Address object. The deletion of instances of this object are synchronized to HA mates via config-sync. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param remoteAddress The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteDmrClusterLinkRemoteAddressWithHttpInfo(String dmrClusterName, String remoteNodeName, String remoteAddress) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling deleteDmrClusterLinkRemoteAddress"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling deleteDmrClusterLinkRemoteAddress"); - } - - // verify the required parameter 'remoteAddress' is set - if (remoteAddress == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteAddress' when calling deleteDmrClusterLinkRemoteAddress"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - uriVariables.put("remoteAddress", remoteAddress); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Trusted Common Name object. - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteDmrClusterLinkTlsTrustedCommonName(String dmrClusterName, String remoteNodeName, String tlsTrustedCommonName) throws RestClientException { - return deleteDmrClusterLinkTlsTrustedCommonNameWithHttpInfo(dmrClusterName, remoteNodeName, tlsTrustedCommonName).getBody(); - } - - /** - * Delete a Trusted Common Name object. - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteDmrClusterLinkTlsTrustedCommonNameWithHttpInfo(String dmrClusterName, String remoteNodeName, String tlsTrustedCommonName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling deleteDmrClusterLinkTlsTrustedCommonName"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling deleteDmrClusterLinkTlsTrustedCommonName"); - } - - // verify the required parameter 'tlsTrustedCommonName' is set - if (tlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'tlsTrustedCommonName' when calling deleteDmrClusterLinkTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - uriVariables.put("tlsTrustedCommonName", tlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Domain Certificate Authority object. - * Delete a Domain Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Certificate Authorities trusted for domain verification. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteDomainCertAuthority(String certAuthorityName) throws RestClientException { - return deleteDomainCertAuthorityWithHttpInfo(certAuthorityName).getBody(); - } - - /** - * Delete a Domain Certificate Authority object. - * Delete a Domain Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Certificate Authorities trusted for domain verification. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteDomainCertAuthorityWithHttpInfo(String certAuthorityName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling deleteDomainCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/domainCertAuthorities/{certAuthorityName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Message VPN object. - * Delete a Message VPN object. The deletion of instances of this object are synchronized to HA mates via config-sync. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpn(String msgVpnName) throws RestClientException { - return deleteMsgVpnWithHttpInfo(msgVpnName).getBody(); - } - - /** - * Delete a Message VPN object. - * Delete a Message VPN object. The deletion of instances of this object are synchronized to HA mates via config-sync. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnWithHttpInfo(String msgVpnName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an ACL Profile object. - * Delete an ACL Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAclProfile(String msgVpnName, String aclProfileName) throws RestClientException { - return deleteMsgVpnAclProfileWithHttpInfo(msgVpnName, aclProfileName).getBody(); - } - - /** - * Delete an ACL Profile object. - * Delete an ACL Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAclProfileWithHttpInfo(String msgVpnName, String aclProfileName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfile"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Client Connect Exception object. - * Delete a Client Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param clientConnectExceptionAddress The IP address/netmask of the client connect exception in CIDR form. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAclProfileClientConnectException(String msgVpnName, String aclProfileName, String clientConnectExceptionAddress) throws RestClientException { - return deleteMsgVpnAclProfileClientConnectExceptionWithHttpInfo(msgVpnName, aclProfileName, clientConnectExceptionAddress).getBody(); - } - - /** - * Delete a Client Connect Exception object. - * Delete a Client Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param clientConnectExceptionAddress The IP address/netmask of the client connect exception in CIDR form. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAclProfileClientConnectExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String clientConnectExceptionAddress) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'clientConnectExceptionAddress' is set - if (clientConnectExceptionAddress == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientConnectExceptionAddress' when calling deleteMsgVpnAclProfileClientConnectException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("clientConnectExceptionAddress", clientConnectExceptionAddress); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Publish Topic Exception object. - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteMsgVpnAclProfilePublishException(String msgVpnName, String aclProfileName, String topicSyntax, String publishExceptionTopic) throws RestClientException { - return deleteMsgVpnAclProfilePublishExceptionWithHttpInfo(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic).getBody(); - } - - /** - * Delete a Publish Topic Exception object. - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteMsgVpnAclProfilePublishExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String topicSyntax, String publishExceptionTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'topicSyntax' is set - if (topicSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicSyntax' when calling deleteMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'publishExceptionTopic' is set - if (publishExceptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishExceptionTopic' when calling deleteMsgVpnAclProfilePublishException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("topicSyntax", topicSyntax); - uriVariables.put("publishExceptionTopic", publishExceptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Publish Topic Exception object. - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param publishTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAclProfilePublishTopicException(String msgVpnName, String aclProfileName, String publishTopicExceptionSyntax, String publishTopicException) throws RestClientException { - return deleteMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException).getBody(); - } - - /** - * Delete a Publish Topic Exception object. - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param publishTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String publishTopicExceptionSyntax, String publishTopicException) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'publishTopicExceptionSyntax' is set - if (publishTopicExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishTopicExceptionSyntax' when calling deleteMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'publishTopicException' is set - if (publishTopicException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishTopicException' when calling deleteMsgVpnAclProfilePublishTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("publishTopicExceptionSyntax", publishTopicExceptionSyntax); - uriVariables.put("publishTopicException", publishTopicException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Subscribe Topic Exception object. - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeException(String msgVpnName, String aclProfileName, String topicSyntax, String subscribeExceptionTopic) throws RestClientException { - return deleteMsgVpnAclProfileSubscribeExceptionWithHttpInfo(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic).getBody(); - } - - /** - * Delete a Subscribe Topic Exception object. - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteMsgVpnAclProfileSubscribeExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String topicSyntax, String subscribeExceptionTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'topicSyntax' is set - if (topicSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicSyntax' when calling deleteMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'subscribeExceptionTopic' is set - if (subscribeExceptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeExceptionTopic' when calling deleteMsgVpnAclProfileSubscribeException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("topicSyntax", topicSyntax); - uriVariables.put("subscribeExceptionTopic", subscribeExceptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Subscribe Share Name Exception object. - * Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeShareNameExceptionSyntax The syntax of the subscribe share name for the exception to the default action taken. (required) - * @param subscribeShareNameException The subscribe share name exception to the default action taken. May include wildcard characters. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeShareNameException(String msgVpnName, String aclProfileName, String subscribeShareNameExceptionSyntax, String subscribeShareNameException) throws RestClientException { - return deleteMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException).getBody(); - } - - /** - * Delete a Subscribe Share Name Exception object. - * Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeShareNameExceptionSyntax The syntax of the subscribe share name for the exception to the default action taken. (required) - * @param subscribeShareNameException The subscribe share name exception to the default action taken. May include wildcard characters. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String subscribeShareNameExceptionSyntax, String subscribeShareNameException) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'subscribeShareNameExceptionSyntax' is set - if (subscribeShareNameExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeShareNameExceptionSyntax' when calling deleteMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'subscribeShareNameException' is set - if (subscribeShareNameException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeShareNameException' when calling deleteMsgVpnAclProfileSubscribeShareNameException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("subscribeShareNameExceptionSyntax", subscribeShareNameExceptionSyntax); - uriVariables.put("subscribeShareNameException", subscribeShareNameException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Subscribe Topic Exception object. - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeTopicException(String msgVpnName, String aclProfileName, String subscribeTopicExceptionSyntax, String subscribeTopicException) throws RestClientException { - return deleteMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException).getBody(); - } - - /** - * Delete a Subscribe Topic Exception object. - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String subscribeTopicExceptionSyntax, String subscribeTopicException) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'subscribeTopicExceptionSyntax' is set - if (subscribeTopicExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeTopicExceptionSyntax' when calling deleteMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'subscribeTopicException' is set - if (subscribeTopicException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeTopicException' when calling deleteMsgVpnAclProfileSubscribeTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("subscribeTopicExceptionSyntax", subscribeTopicExceptionSyntax); - uriVariables.put("subscribeTopicException", subscribeTopicException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an OAuth Profile object. - * Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfile(String msgVpnName, String oauthProfileName) throws RestClientException { - return deleteMsgVpnAuthenticationOauthProfileWithHttpInfo(msgVpnName, oauthProfileName).getBody(); - } - - /** - * Delete an OAuth Profile object. - * Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAuthenticationOauthProfileWithHttpInfo(String msgVpnName, String oauthProfileName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteMsgVpnAuthenticationOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim(String msgVpnName, String oauthProfileName, String clientRequiredClaimName) throws RestClientException { - return deleteMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, clientRequiredClaimName).getBody(); - } - - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, String clientRequiredClaimName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'clientRequiredClaimName' is set - if (clientRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientRequiredClaimName' when calling deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("clientRequiredClaimName", clientRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(String msgVpnName, String oauthProfileName, String resourceServerRequiredClaimName) throws RestClientException { - return deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, resourceServerRequiredClaimName).getBody(); - } - - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, String resourceServerRequiredClaimName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'resourceServerRequiredClaimName' is set - if (resourceServerRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'resourceServerRequiredClaimName' when calling deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("resourceServerRequiredClaimName", resourceServerRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an OAuth Provider object. - * Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProvider(String msgVpnName, String oauthProviderName) throws RestClientException { - return deleteMsgVpnAuthenticationOauthProviderWithHttpInfo(msgVpnName, oauthProviderName).getBody(); - } - - /** - * Delete an OAuth Provider object. - * Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteMsgVpnAuthenticationOauthProviderWithHttpInfo(String msgVpnName, String oauthProviderName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'oauthProviderName' is set - if (oauthProviderName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProviderName' when calling deleteMsgVpnAuthenticationOauthProvider"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProviderName", oauthProviderName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an Authorization Group object. - * Delete an Authorization Group object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAuthorizationGroup(String msgVpnName, String authorizationGroupName) throws RestClientException { - return deleteMsgVpnAuthorizationGroupWithHttpInfo(msgVpnName, authorizationGroupName).getBody(); - } - - /** - * Delete an Authorization Group object. - * Delete an Authorization Group object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAuthorizationGroupWithHttpInfo(String msgVpnName, String authorizationGroupName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'authorizationGroupName' is set - if (authorizationGroupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationGroupName' when calling deleteMsgVpnAuthorizationGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("authorizationGroupName", authorizationGroupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Bridge object. - * Delete a Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnBridge(String msgVpnName, String bridgeName, String bridgeVirtualRouter) throws RestClientException { - return deleteMsgVpnBridgeWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter).getBody(); - } - - /** - * Delete a Bridge object. - * Delete a Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnBridgeWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnBridge"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling deleteMsgVpnBridge"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling deleteMsgVpnBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Remote Message VPN object. - * Delete a Remote Message VPN object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnBridgeRemoteMsgVpn(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface) throws RestClientException { - return deleteMsgVpnBridgeRemoteMsgVpnWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface).getBody(); - } - - /** - * Delete a Remote Message VPN object. - * Delete a Remote Message VPN object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnBridgeRemoteMsgVpnWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnName' is set - if (remoteMsgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnName' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnLocation' is set - if (remoteMsgVpnLocation == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnLocation' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnInterface' is set - if (remoteMsgVpnInterface == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnInterface' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteMsgVpnName", remoteMsgVpnName); - uriVariables.put("remoteMsgVpnLocation", remoteMsgVpnLocation); - uriVariables.put("remoteMsgVpnInterface", remoteMsgVpnInterface); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Remote Subscription object. - * Delete a Remote Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteSubscriptionTopic The topic of the Bridge remote subscription. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnBridgeRemoteSubscription(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteSubscriptionTopic) throws RestClientException { - return deleteMsgVpnBridgeRemoteSubscriptionWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic).getBody(); - } - - /** - * Delete a Remote Subscription object. - * Delete a Remote Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteSubscriptionTopic The topic of the Bridge remote subscription. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnBridgeRemoteSubscriptionWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteSubscriptionTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling deleteMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling deleteMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'remoteSubscriptionTopic' is set - if (remoteSubscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteSubscriptionTopic' when calling deleteMsgVpnBridgeRemoteSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteSubscriptionTopic", remoteSubscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Trusted Common Name object. - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteMsgVpnBridgeTlsTrustedCommonName(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String tlsTrustedCommonName) throws RestClientException { - return deleteMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName).getBody(); - } - - /** - * Delete a Trusted Common Name object. - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String tlsTrustedCommonName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling deleteMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling deleteMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'tlsTrustedCommonName' is set - if (tlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'tlsTrustedCommonName' when calling deleteMsgVpnBridgeTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("tlsTrustedCommonName", tlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Matching Rule object. - * Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnCertMatchingRule(String msgVpnName, String ruleName) throws RestClientException { - return deleteMsgVpnCertMatchingRuleWithHttpInfo(msgVpnName, ruleName).getBody(); - } - - /** - * Delete a Certificate Matching Rule object. - * Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnCertMatchingRuleWithHttpInfo(String msgVpnName, String ruleName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling deleteMsgVpnCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Matching Rule Attribute Filter object. - * Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnCertMatchingRuleAttributeFilter(String msgVpnName, String ruleName, String filterName) throws RestClientException { - return deleteMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(msgVpnName, ruleName, filterName).getBody(); - } - - /** - * Delete a Certificate Matching Rule Attribute Filter object. - * Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(String msgVpnName, String ruleName, String filterName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling deleteMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling deleteMsgVpnCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Matching Rule Condition object. - * Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnCertMatchingRuleCondition(String msgVpnName, String ruleName, String source) throws RestClientException { - return deleteMsgVpnCertMatchingRuleConditionWithHttpInfo(msgVpnName, ruleName, source).getBody(); - } - - /** - * Delete a Certificate Matching Rule Condition object. - * Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnCertMatchingRuleConditionWithHttpInfo(String msgVpnName, String ruleName, String source) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling deleteMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'source' is set - if (source == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'source' when calling deleteMsgVpnCertMatchingRuleCondition"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("source", source); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Client Profile object. - * Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnClientProfile(String msgVpnName, String clientProfileName) throws RestClientException { - return deleteMsgVpnClientProfileWithHttpInfo(msgVpnName, clientProfileName).getBody(); - } - - /** - * Delete a Client Profile object. - * Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnClientProfileWithHttpInfo(String msgVpnName, String clientProfileName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnClientProfile"); - } - - // verify the required parameter 'clientProfileName' is set - if (clientProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientProfileName' when calling deleteMsgVpnClientProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientProfileName", clientProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Client Username object. - * Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnClientUsername(String msgVpnName, String clientUsername) throws RestClientException { - return deleteMsgVpnClientUsernameWithHttpInfo(msgVpnName, clientUsername).getBody(); - } - - /** - * Delete a Client Username object. - * Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnClientUsernameWithHttpInfo(String msgVpnName, String clientUsername) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnClientUsername"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling deleteMsgVpnClientUsername"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Client Username Attribute object. - * Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnClientUsernameAttribute(String msgVpnName, String clientUsername, String attributeName, String attributeValue) throws RestClientException { - return deleteMsgVpnClientUsernameAttributeWithHttpInfo(msgVpnName, clientUsername, attributeName, attributeValue).getBody(); - } - - /** - * Delete a Client Username Attribute object. - * Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnClientUsernameAttributeWithHttpInfo(String msgVpnName, String clientUsername, String attributeName, String attributeValue) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling deleteMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'attributeName' is set - if (attributeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeName' when calling deleteMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'attributeValue' is set - if (attributeValue == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeValue' when calling deleteMsgVpnClientUsernameAttribute"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - uriVariables.put("attributeName", attributeName); - uriVariables.put("attributeValue", attributeValue); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Distributed Cache object. - * Delete a Distributed Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCache(String msgVpnName, String cacheName) throws RestClientException { - return deleteMsgVpnDistributedCacheWithHttpInfo(msgVpnName, cacheName).getBody(); - } - - /** - * Delete a Distributed Cache object. - * Delete a Distributed Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheWithHttpInfo(String msgVpnName, String cacheName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Cache Cluster object. - * Delete a Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCacheCluster(String msgVpnName, String cacheName, String clusterName) throws RestClientException { - return deleteMsgVpnDistributedCacheClusterWithHttpInfo(msgVpnName, cacheName, clusterName).getBody(); - } - - /** - * Delete a Cache Cluster object. - * Delete a Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling deleteMsgVpnDistributedCacheCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Home Cache Cluster object. - * Delete a Home Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(String msgVpnName, String cacheName, String clusterName, String homeClusterName) throws RestClientException { - return deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName).getBody(); - } - - /** - * Delete a Home Cache Cluster object. - * Delete a Home Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Topic Prefix object. - * Delete a Topic Prefix object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param topicPrefix A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String topicPrefix) throws RestClientException { - return deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix).getBody(); - } - - /** - * Delete a Topic Prefix object. - * Delete a Topic Prefix object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param topicPrefix A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String topicPrefix) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'topicPrefix' is set - if (topicPrefix == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicPrefix' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - uriVariables.put("topicPrefix", topicPrefix); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Cache Instance object. - * Delete a Cache Instance object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterInstance(String msgVpnName, String cacheName, String clusterName, String instanceName) throws RestClientException { - return deleteMsgVpnDistributedCacheClusterInstanceWithHttpInfo(msgVpnName, cacheName, clusterName, instanceName).getBody(); - } - - /** - * Delete a Cache Instance object. - * Delete a Cache Instance object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheClusterInstanceWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String instanceName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling deleteMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'instanceName' is set - if (instanceName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'instanceName' when calling deleteMsgVpnDistributedCacheClusterInstance"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("instanceName", instanceName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Topic object. - * Delete a Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param topic The value of the Topic in the form a/b/c. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterTopic(String msgVpnName, String cacheName, String clusterName, String topic) throws RestClientException { - return deleteMsgVpnDistributedCacheClusterTopicWithHttpInfo(msgVpnName, cacheName, clusterName, topic).getBody(); - } - - /** - * Delete a Topic object. - * Delete a Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param topic The value of the Topic in the form a/b/c. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheClusterTopicWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String topic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling deleteMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'topic' is set - if (topic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topic' when calling deleteMsgVpnDistributedCacheClusterTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("topic", topic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a DMR Bridge object. - * Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDmrBridge(String msgVpnName, String remoteNodeName) throws RestClientException { - return deleteMsgVpnDmrBridgeWithHttpInfo(msgVpnName, remoteNodeName).getBody(); - } - - /** - * Delete a DMR Bridge object. - * Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDmrBridgeWithHttpInfo(String msgVpnName, String remoteNodeName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDmrBridge"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling deleteMsgVpnDmrBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a JNDI Connection Factory object. - * Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnJndiConnectionFactory(String msgVpnName, String connectionFactoryName) throws RestClientException { - return deleteMsgVpnJndiConnectionFactoryWithHttpInfo(msgVpnName, connectionFactoryName).getBody(); - } - - /** - * Delete a JNDI Connection Factory object. - * Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnJndiConnectionFactoryWithHttpInfo(String msgVpnName, String connectionFactoryName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'connectionFactoryName' is set - if (connectionFactoryName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'connectionFactoryName' when calling deleteMsgVpnJndiConnectionFactory"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("connectionFactoryName", connectionFactoryName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a JNDI Queue object. - * Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnJndiQueue(String msgVpnName, String queueName) throws RestClientException { - return deleteMsgVpnJndiQueueWithHttpInfo(msgVpnName, queueName).getBody(); - } - - /** - * Delete a JNDI Queue object. - * Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnJndiQueueWithHttpInfo(String msgVpnName, String queueName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnJndiQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling deleteMsgVpnJndiQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues/{queueName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a JNDI Topic object. - * Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnJndiTopic(String msgVpnName, String topicName) throws RestClientException { - return deleteMsgVpnJndiTopicWithHttpInfo(msgVpnName, topicName).getBody(); - } - - /** - * Delete a JNDI Topic object. - * Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnJndiTopicWithHttpInfo(String msgVpnName, String topicName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnJndiTopic"); - } - - // verify the required parameter 'topicName' is set - if (topicName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicName' when calling deleteMsgVpnJndiTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicName", topicName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics/{topicName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an MQTT Retain Cache object. - * Delete an MQTT Retain Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnMqttRetainCache(String msgVpnName, String cacheName) throws RestClientException { - return deleteMsgVpnMqttRetainCacheWithHttpInfo(msgVpnName, cacheName).getBody(); - } - - /** - * Delete an MQTT Retain Cache object. - * Delete an MQTT Retain Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnMqttRetainCacheWithHttpInfo(String msgVpnName, String cacheName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnMqttRetainCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an MQTT Session object. - * Delete an MQTT Session object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnMqttSession(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter) throws RestClientException { - return deleteMsgVpnMqttSessionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter).getBody(); - } - - /** - * Delete an MQTT Session object. - * Delete an MQTT Session object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnMqttSessionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling deleteMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling deleteMsgVpnMqttSession"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Subscription object. - * Delete a Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnMqttSessionSubscription(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic) throws RestClientException { - return deleteMsgVpnMqttSessionSubscriptionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic).getBody(); - } - - /** - * Delete a Subscription object. - * Delete a Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnMqttSessionSubscriptionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling deleteMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling deleteMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling deleteMsgVpnMqttSessionSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Queue object. - * Delete a Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnQueue(String msgVpnName, String queueName) throws RestClientException { - return deleteMsgVpnQueueWithHttpInfo(msgVpnName, queueName).getBody(); - } - - /** - * Delete a Queue object. - * Delete a Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnQueueWithHttpInfo(String msgVpnName, String queueName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling deleteMsgVpnQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Queue Subscription object. - * Delete a Queue Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param subscriptionTopic The topic of the Subscription. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnQueueSubscription(String msgVpnName, String queueName, String subscriptionTopic) throws RestClientException { - return deleteMsgVpnQueueSubscriptionWithHttpInfo(msgVpnName, queueName, subscriptionTopic).getBody(); - } - - /** - * Delete a Queue Subscription object. - * Delete a Queue Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param subscriptionTopic The topic of the Subscription. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnQueueSubscriptionWithHttpInfo(String msgVpnName, String queueName, String subscriptionTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnQueueSubscription"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling deleteMsgVpnQueueSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling deleteMsgVpnQueueSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Queue Template object. - * Delete a Queue Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnQueueTemplate(String msgVpnName, String queueTemplateName) throws RestClientException { - return deleteMsgVpnQueueTemplateWithHttpInfo(msgVpnName, queueTemplateName).getBody(); - } - - /** - * Delete a Queue Template object. - * Delete a Queue Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnQueueTemplateWithHttpInfo(String msgVpnName, String queueTemplateName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnQueueTemplate"); - } - - // verify the required parameter 'queueTemplateName' is set - if (queueTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueTemplateName' when calling deleteMsgVpnQueueTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueTemplateName", queueTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Replay Log object. - * Delete a Replay Log object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnReplayLog(String msgVpnName, String replayLogName) throws RestClientException { - return deleteMsgVpnReplayLogWithHttpInfo(msgVpnName, replayLogName).getBody(); - } - - /** - * Delete a Replay Log object. - * Delete a Replay Log object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnReplayLogWithHttpInfo(String msgVpnName, String replayLogName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnReplayLog"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling deleteMsgVpnReplayLog"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Topic Filter Subscription object. - * Delete a Topic Filter Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param topicFilterSubscription The topic of the Subscription. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnReplayLogTopicFilterSubscription(String msgVpnName, String replayLogName, String topicFilterSubscription) throws RestClientException { - return deleteMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(msgVpnName, replayLogName, topicFilterSubscription).getBody(); - } - - /** - * Delete a Topic Filter Subscription object. - * Delete a Topic Filter Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param topicFilterSubscription The topic of the Subscription. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(String msgVpnName, String replayLogName, String topicFilterSubscription) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling deleteMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'topicFilterSubscription' is set - if (topicFilterSubscription == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicFilterSubscription' when calling deleteMsgVpnReplayLogTopicFilterSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - uriVariables.put("topicFilterSubscription", topicFilterSubscription); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Replicated Topic object. - * Delete a Replicated Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnReplicatedTopic(String msgVpnName, String replicatedTopic) throws RestClientException { - return deleteMsgVpnReplicatedTopicWithHttpInfo(msgVpnName, replicatedTopic).getBody(); - } - - /** - * Delete a Replicated Topic object. - * Delete a Replicated Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnReplicatedTopicWithHttpInfo(String msgVpnName, String replicatedTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'replicatedTopic' is set - if (replicatedTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replicatedTopic' when calling deleteMsgVpnReplicatedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replicatedTopic", replicatedTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a REST Delivery Point object. - * Delete a REST Delivery Point object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPoint(String msgVpnName, String restDeliveryPointName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointWithHttpInfo(msgVpnName, restDeliveryPointName).getBody(); - } - - /** - * Delete a REST Delivery Point object. - * Delete a REST Delivery Point object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnRestDeliveryPointWithHttpInfo(String msgVpnName, String restDeliveryPointName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Queue Binding object. - * Delete a Queue Binding object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointQueueBinding(String msgVpnName, String restDeliveryPointName, String queueBindingName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName).getBody(); - } - - /** - * Delete a Queue Binding object. - * Delete a Queue Binding object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling deleteMsgVpnRestDeliveryPointQueueBinding"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Request Header object. - * Delete a Request Header object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, headerName).getBody(); - } - - /** - * Delete a Request Header object. - * Delete a Request Header object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'headerName' is set - if (headerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'headerName' when calling deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - uriVariables.put("headerName", headerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a REST Consumer object. - * Delete a REST Consumer object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumer(String msgVpnName, String restDeliveryPointName, String restConsumerName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName).getBody(); - } - - /** - * Delete a REST Consumer object. - * Delete a REST Consumer object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling deleteMsgVpnRestDeliveryPointRestConsumer"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Claim object. - * Delete a Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param oauthJwtClaimName The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(String msgVpnName, String restDeliveryPointName, String restConsumerName, String oauthJwtClaimName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName).getBody(); - } - - /** - * Delete a Claim object. - * Delete a Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param oauthJwtClaimName The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String oauthJwtClaimName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'oauthJwtClaimName' is set - if (oauthJwtClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthJwtClaimName' when calling deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - uriVariables.put("oauthJwtClaimName", oauthJwtClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Trusted Common Name object. - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(String msgVpnName, String restDeliveryPointName, String restConsumerName, String tlsTrustedCommonName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName).getBody(); - } - - /** - * Delete a Trusted Common Name object. - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String tlsTrustedCommonName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'tlsTrustedCommonName' is set - if (tlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'tlsTrustedCommonName' when calling deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - uriVariables.put("tlsTrustedCommonName", tlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Sequenced Topic object. - * Delete a Sequenced Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param sequencedTopic Topic for applying sequence numbers. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnSequencedTopic(String msgVpnName, String sequencedTopic) throws RestClientException { - return deleteMsgVpnSequencedTopicWithHttpInfo(msgVpnName, sequencedTopic).getBody(); - } - - /** - * Delete a Sequenced Topic object. - * Delete a Sequenced Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param sequencedTopic Topic for applying sequence numbers. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnSequencedTopicWithHttpInfo(String msgVpnName, String sequencedTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnSequencedTopic"); - } - - // verify the required parameter 'sequencedTopic' is set - if (sequencedTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'sequencedTopic' when calling deleteMsgVpnSequencedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("sequencedTopic", sequencedTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Topic Endpoint object. - * Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnTopicEndpoint(String msgVpnName, String topicEndpointName) throws RestClientException { - return deleteMsgVpnTopicEndpointWithHttpInfo(msgVpnName, topicEndpointName).getBody(); - } - - /** - * Delete a Topic Endpoint object. - * Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnTopicEndpointWithHttpInfo(String msgVpnName, String topicEndpointName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'topicEndpointName' is set - if (topicEndpointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointName' when calling deleteMsgVpnTopicEndpoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointName", topicEndpointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Topic Endpoint Template object. - * Delete a Topic Endpoint Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnTopicEndpointTemplate(String msgVpnName, String topicEndpointTemplateName) throws RestClientException { - return deleteMsgVpnTopicEndpointTemplateWithHttpInfo(msgVpnName, topicEndpointTemplateName).getBody(); - } - - /** - * Delete a Topic Endpoint Template object. - * Delete a Topic Endpoint Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnTopicEndpointTemplateWithHttpInfo(String msgVpnName, String topicEndpointTemplateName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'topicEndpointTemplateName' is set - if (topicEndpointTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointTemplateName' when calling deleteMsgVpnTopicEndpointTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointTemplateName", topicEndpointTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an OAuth Profile object. - * Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteOauthProfile(String oauthProfileName) throws RestClientException { - return deleteOauthProfileWithHttpInfo(oauthProfileName).getBody(); - } - - /** - * Delete an OAuth Profile object. - * Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteOauthProfileWithHttpInfo(String oauthProfileName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Group Access Level object. - * Delete a Group Access Level object. The deletion of instances of this object are synchronized to HA mates via config-sync. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteOauthProfileAccessLevelGroup(String oauthProfileName, String groupName) throws RestClientException { - return deleteOauthProfileAccessLevelGroupWithHttpInfo(oauthProfileName, groupName).getBody(); - } - - /** - * Delete a Group Access Level object. - * Delete a Group Access Level object. The deletion of instances of this object are synchronized to HA mates via config-sync. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteOauthProfileAccessLevelGroupWithHttpInfo(String oauthProfileName, String groupName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteOauthProfileAccessLevelGroup"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling deleteOauthProfileAccessLevelGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Message VPN Access-Level Exception object. - * Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. Message VPN access-level exceptions for members of this group. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param msgVpnName The name of the message VPN. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException(String oauthProfileName, String groupName, String msgVpnName) throws RestClientException { - return deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, groupName, msgVpnName).getBody(); - } - - /** - * Delete a Message VPN Access-Level Exception object. - * Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. Message VPN access-level exceptions for members of this group. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param msgVpnName The name of the message VPN. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String groupName, String msgVpnName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an Allowed Host Value object. - * Delete an Allowed Host Value object. The deletion of instances of this object are synchronized to HA mates via config-sync. A valid hostname for this broker in OAuth redirects. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param allowedHost An allowed value for the Host header. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteOauthProfileClientAllowedHost(String oauthProfileName, String allowedHost) throws RestClientException { - return deleteOauthProfileClientAllowedHostWithHttpInfo(oauthProfileName, allowedHost).getBody(); - } - - /** - * Delete an Allowed Host Value object. - * Delete an Allowed Host Value object. The deletion of instances of this object are synchronized to HA mates via config-sync. A valid hostname for this broker in OAuth redirects. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param allowedHost An allowed value for the Host header. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteOauthProfileClientAllowedHostWithHttpInfo(String oauthProfileName, String allowedHost) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteOauthProfileClientAllowedHost"); - } - - // verify the required parameter 'allowedHost' is set - if (allowedHost == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'allowedHost' when calling deleteOauthProfileClientAllowedHost"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("allowedHost", allowedHost); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an Authorization Parameter object. - * Delete an Authorization Parameter object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional parameters to be passed to the OAuth authorization endpoint. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param authorizationParameterName The name of the authorization parameter. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteOauthProfileClientAuthorizationParameter(String oauthProfileName, String authorizationParameterName) throws RestClientException { - return deleteOauthProfileClientAuthorizationParameterWithHttpInfo(oauthProfileName, authorizationParameterName).getBody(); - } - - /** - * Delete an Authorization Parameter object. - * Delete an Authorization Parameter object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional parameters to be passed to the OAuth authorization endpoint. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param authorizationParameterName The name of the authorization parameter. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteOauthProfileClientAuthorizationParameterWithHttpInfo(String oauthProfileName, String authorizationParameterName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteOauthProfileClientAuthorizationParameter"); - } - - // verify the required parameter 'authorizationParameterName' is set - if (authorizationParameterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationParameterName' when calling deleteOauthProfileClientAuthorizationParameter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("authorizationParameterName", authorizationParameterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteOauthProfileClientRequiredClaim(String oauthProfileName, String clientRequiredClaimName) throws RestClientException { - return deleteOauthProfileClientRequiredClaimWithHttpInfo(oauthProfileName, clientRequiredClaimName).getBody(); - } - - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteOauthProfileClientRequiredClaimWithHttpInfo(String oauthProfileName, String clientRequiredClaimName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'clientRequiredClaimName' is set - if (clientRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientRequiredClaimName' when calling deleteOauthProfileClientRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("clientRequiredClaimName", clientRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Message VPN Access-Level Exception object. - * Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. Default message VPN access-level exceptions. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param msgVpnName The name of the message VPN. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteOauthProfileDefaultMsgVpnAccessLevelException(String oauthProfileName, String msgVpnName) throws RestClientException { - return deleteOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, msgVpnName).getBody(); - } - - /** - * Delete a Message VPN Access-Level Exception object. - * Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. Default message VPN access-level exceptions. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param msgVpnName The name of the message VPN. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String msgVpnName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteOauthProfileResourceServerRequiredClaim(String oauthProfileName, String resourceServerRequiredClaimName) throws RestClientException { - return deleteOauthProfileResourceServerRequiredClaimWithHttpInfo(oauthProfileName, resourceServerRequiredClaimName).getBody(); - } - - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteOauthProfileResourceServerRequiredClaimWithHttpInfo(String oauthProfileName, String resourceServerRequiredClaimName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'resourceServerRequiredClaimName' is set - if (resourceServerRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'resourceServerRequiredClaimName' when calling deleteOauthProfileResourceServerRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("resourceServerRequiredClaimName", resourceServerRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Virtual Hostname object. - * Delete a Virtual Hostname object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - *

200 - The request metadata. - *

0 - The error response. - * @param virtualHostname The virtual hostname. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteVirtualHostname(String virtualHostname) throws RestClientException { - return deleteVirtualHostnameWithHttpInfo(virtualHostname).getBody(); - } - - /** - * Delete a Virtual Hostname object. - * Delete a Virtual Hostname object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - *

200 - The request metadata. - *

0 - The error response. - * @param virtualHostname The virtual hostname. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteVirtualHostnameWithHttpInfo(String virtualHostname) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'virtualHostname' is set - if (virtualHostname == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'virtualHostname' when calling deleteVirtualHostname"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("virtualHostname", virtualHostname); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/virtualHostnames/{virtualHostname}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an About object. - * Get an About object. This provides metadata about the SEMP API, such as the version of the API supported by the broker. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.13. - *

200 - The About object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return AboutResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public AboutResponse getAbout(String opaquePassword, List select) throws RestClientException { - return getAboutWithHttpInfo(opaquePassword, select).getBody(); - } - - /** - * Get an About object. - * Get an About object. This provides metadata about the SEMP API, such as the version of the API supported by the broker. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.13. - *

200 - The About object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<AboutResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getAboutWithHttpInfo(String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/about", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an API Description object. - * Get an API Description object. The API Description object provides metadata about the SEMP API. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - *

200 - The API Description object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return AboutApiResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public AboutApiResponse getAboutApi(String opaquePassword, List select) throws RestClientException { - return getAboutApiWithHttpInfo(opaquePassword, select).getBody(); - } - - /** - * Get an API Description object. - * Get an API Description object. The API Description object provides metadata about the SEMP API. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - *

200 - The API Description object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<AboutApiResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getAboutApiWithHttpInfo(String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/about/api", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a User object. - * Get a User object. Session and access level information about the user accessing the SEMP API. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - *

200 - The User object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return AboutUserResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public AboutUserResponse getAboutUser(String opaquePassword, List select) throws RestClientException { - return getAboutUserWithHttpInfo(opaquePassword, select).getBody(); - } - - /** - * Get a User object. - * Get a User object. Session and access level information about the user accessing the SEMP API. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - *

200 - The User object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<AboutUserResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getAboutUserWithHttpInfo(String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/about/user", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a User Message VPN object. - * Get a User Message VPN object. This provides information about the Message VPN access level for the username used to access the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - *

200 - The User Message VPN object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return AboutUserMsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public AboutUserMsgVpnResponse getAboutUserMsgVpn(String msgVpnName, String opaquePassword, List select) throws RestClientException { - return getAboutUserMsgVpnWithHttpInfo(msgVpnName, opaquePassword, select).getBody(); - } - - /** - * Get a User Message VPN object. - * Get a User Message VPN object. This provides information about the Message VPN access level for the username used to access the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - *

200 - The User Message VPN object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<AboutUserMsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getAboutUserMsgVpnWithHttpInfo(String msgVpnName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getAboutUserMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/about/user/msgVpns/{msgVpnName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of User Message VPN objects. - * Get a list of User Message VPN objects. This provides information about the Message VPN access level for the username used to access the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of User Message VPN objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return AboutUserMsgVpnsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public AboutUserMsgVpnsResponse getAboutUserMsgVpns(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getAboutUserMsgVpnsWithHttpInfo(count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of User Message VPN objects. - * Get a list of User Message VPN objects. This provides information about the Message VPN access level for the username used to access the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of User Message VPN objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<AboutUserMsgVpnsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getAboutUserMsgVpnsWithHttpInfo(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/about/user/msgVpns", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Broker object. - * Get a Broker object. This object contains global configuration for the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: tlsServerCertContent||x||x tlsServerCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: configSyncAuthenticationClientCertMaxChainDepth|global/read-only configSyncAuthenticationClientCertValidateDateEnabled|global/read-only configSyncClientProfileTcpInitialCongestionWindow|global/read-only configSyncClientProfileTcpKeepaliveCount|global/read-only configSyncClientProfileTcpKeepaliveIdle|global/read-only configSyncClientProfileTcpKeepaliveInterval|global/read-only configSyncClientProfileTcpMaxWindow|global/read-only configSyncClientProfileTcpMss|global/read-only configSyncEnabled|global/read-only configSyncSynchronizeUsernameEnabled|global/read-only configSyncTlsEnabled|global/read-only guaranteedMsgingDefragmentationScheduleDayList|global/read-only guaranteedMsgingDefragmentationScheduleEnabled|global/read-only guaranteedMsgingDefragmentationScheduleTimeList|global/read-only guaranteedMsgingDefragmentationThresholdEnabled|global/read-only guaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-only guaranteedMsgingDefragmentationThresholdMinInterval|global/read-only guaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-only guaranteedMsgingEnabled|global/read-only guaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-only guaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-only guaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-only guaranteedMsgingEventCacheUsageThreshold.setValue|global/read-only guaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-only guaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-only guaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-only guaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-only guaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-only guaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-only guaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-only guaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-only guaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-only guaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-only guaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-only guaranteedMsgingEventEndpointCountThreshold.setValue|global/read-only guaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-only guaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-only guaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-only guaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-only guaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-only guaranteedMsgingEventMsgCountThreshold.setPercent|global/read-only guaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-only guaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-only guaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-only guaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-only guaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-only guaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-only guaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-only guaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-only guaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-only guaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-only guaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-only guaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-only guaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-only guaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-only guaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-only guaranteedMsgingEventTransactionCountThreshold.setValue|global/read-only guaranteedMsgingMaxCacheUsage|global/read-only guaranteedMsgingMaxMsgSpoolUsage|global/read-only guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-only guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-only guaranteedMsgingTransactionReplicationCompatibilityMode|global/read-only oauthProfileDefault|global/read-only serviceAmqpEnabled|global/read-only serviceAmqpTlsListenPort|global/read-only serviceEventConnectionCountThreshold.clearPercent|global/read-only serviceEventConnectionCountThreshold.clearValue|global/read-only serviceEventConnectionCountThreshold.setPercent|global/read-only serviceEventConnectionCountThreshold.setValue|global/read-only serviceHealthCheckEnabled|global/read-only serviceHealthCheckListenPort|global/read-only serviceMateLinkEnabled|global/read-only serviceMateLinkListenPort|global/read-only serviceMqttEnabled|global/read-only serviceMsgBackboneEnabled|global/read-only serviceRedundancyEnabled|global/read-only serviceRedundancyFirstListenPort|global/read-only serviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-only serviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-only serviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-only serviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-only serviceRestIncomingEnabled|global/read-only serviceRestOutgoingEnabled|global/read-only serviceSempCorsAllowAnyHostEnabled|global/read-only serviceSempLegacyTimeoutEnabled|global/read-only serviceSempPlainTextEnabled|global/read-only serviceSempPlainTextListenPort|global/read-only serviceSempSessionIdleTimeout|global/read-only serviceSempSessionMaxLifetime|global/read-only serviceSempTlsEnabled|global/read-only serviceSempTlsListenPort|global/read-only serviceSmfCompressionListenPort|global/read-only serviceSmfEnabled|global/read-only serviceSmfEventConnectionCountThreshold.clearPercent|global/read-only serviceSmfEventConnectionCountThreshold.clearValue|global/read-only serviceSmfEventConnectionCountThreshold.setPercent|global/read-only serviceSmfEventConnectionCountThreshold.setValue|global/read-only serviceSmfPlainTextListenPort|global/read-only serviceSmfRoutingControlListenPort|global/read-only serviceSmfTlsListenPort|global/read-only serviceTlsEventConnectionCountThreshold.clearPercent|global/read-only serviceTlsEventConnectionCountThreshold.clearValue|global/read-only serviceTlsEventConnectionCountThreshold.setPercent|global/read-only serviceTlsEventConnectionCountThreshold.setValue|global/read-only serviceWebTransportEnabled|global/read-only serviceWebTransportPlainTextListenPort|global/read-only serviceWebTransportTlsListenPort|global/read-only serviceWebTransportWebUrlSuffix|global/read-only tlsBlockVersion11Enabled|global/read-only tlsCipherSuiteManagementList|global/read-only tlsCipherSuiteMsgBackboneList|global/read-only tlsCipherSuiteSecureShellList|global/read-only tlsCrimeExploitProtectionEnabled|global/read-only tlsServerCertContent|global/read-only tlsStandardDomainCertificateAuthoritiesEnabled|vpn/read-only tlsTicketLifetime|global/read-only webManagerAllowUnencryptedWizardsEnabled|vpn/read-only webManagerCustomization|vpn/read-only webManagerRedirectHttpEnabled|vpn/read-only webManagerRedirectHttpOverrideTlsPort|vpn/read-only This has been available since 2.13. - *

200 - The Broker object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return BrokerResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public BrokerResponse getBroker(String opaquePassword, List select) throws RestClientException { - return getBrokerWithHttpInfo(opaquePassword, select).getBody(); - } - - /** - * Get a Broker object. - * Get a Broker object. This object contains global configuration for the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: tlsServerCertContent||x||x tlsServerCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: configSyncAuthenticationClientCertMaxChainDepth|global/read-only configSyncAuthenticationClientCertValidateDateEnabled|global/read-only configSyncClientProfileTcpInitialCongestionWindow|global/read-only configSyncClientProfileTcpKeepaliveCount|global/read-only configSyncClientProfileTcpKeepaliveIdle|global/read-only configSyncClientProfileTcpKeepaliveInterval|global/read-only configSyncClientProfileTcpMaxWindow|global/read-only configSyncClientProfileTcpMss|global/read-only configSyncEnabled|global/read-only configSyncSynchronizeUsernameEnabled|global/read-only configSyncTlsEnabled|global/read-only guaranteedMsgingDefragmentationScheduleDayList|global/read-only guaranteedMsgingDefragmentationScheduleEnabled|global/read-only guaranteedMsgingDefragmentationScheduleTimeList|global/read-only guaranteedMsgingDefragmentationThresholdEnabled|global/read-only guaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-only guaranteedMsgingDefragmentationThresholdMinInterval|global/read-only guaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-only guaranteedMsgingEnabled|global/read-only guaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-only guaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-only guaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-only guaranteedMsgingEventCacheUsageThreshold.setValue|global/read-only guaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-only guaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-only guaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-only guaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-only guaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-only guaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-only guaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-only guaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-only guaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-only guaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-only guaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-only guaranteedMsgingEventEndpointCountThreshold.setValue|global/read-only guaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-only guaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-only guaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-only guaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-only guaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-only guaranteedMsgingEventMsgCountThreshold.setPercent|global/read-only guaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-only guaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-only guaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-only guaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-only guaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-only guaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-only guaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-only guaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-only guaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-only guaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-only guaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-only guaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-only guaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-only guaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-only guaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-only guaranteedMsgingEventTransactionCountThreshold.setValue|global/read-only guaranteedMsgingMaxCacheUsage|global/read-only guaranteedMsgingMaxMsgSpoolUsage|global/read-only guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-only guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-only guaranteedMsgingTransactionReplicationCompatibilityMode|global/read-only oauthProfileDefault|global/read-only serviceAmqpEnabled|global/read-only serviceAmqpTlsListenPort|global/read-only serviceEventConnectionCountThreshold.clearPercent|global/read-only serviceEventConnectionCountThreshold.clearValue|global/read-only serviceEventConnectionCountThreshold.setPercent|global/read-only serviceEventConnectionCountThreshold.setValue|global/read-only serviceHealthCheckEnabled|global/read-only serviceHealthCheckListenPort|global/read-only serviceMateLinkEnabled|global/read-only serviceMateLinkListenPort|global/read-only serviceMqttEnabled|global/read-only serviceMsgBackboneEnabled|global/read-only serviceRedundancyEnabled|global/read-only serviceRedundancyFirstListenPort|global/read-only serviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-only serviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-only serviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-only serviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-only serviceRestIncomingEnabled|global/read-only serviceRestOutgoingEnabled|global/read-only serviceSempCorsAllowAnyHostEnabled|global/read-only serviceSempLegacyTimeoutEnabled|global/read-only serviceSempPlainTextEnabled|global/read-only serviceSempPlainTextListenPort|global/read-only serviceSempSessionIdleTimeout|global/read-only serviceSempSessionMaxLifetime|global/read-only serviceSempTlsEnabled|global/read-only serviceSempTlsListenPort|global/read-only serviceSmfCompressionListenPort|global/read-only serviceSmfEnabled|global/read-only serviceSmfEventConnectionCountThreshold.clearPercent|global/read-only serviceSmfEventConnectionCountThreshold.clearValue|global/read-only serviceSmfEventConnectionCountThreshold.setPercent|global/read-only serviceSmfEventConnectionCountThreshold.setValue|global/read-only serviceSmfPlainTextListenPort|global/read-only serviceSmfRoutingControlListenPort|global/read-only serviceSmfTlsListenPort|global/read-only serviceTlsEventConnectionCountThreshold.clearPercent|global/read-only serviceTlsEventConnectionCountThreshold.clearValue|global/read-only serviceTlsEventConnectionCountThreshold.setPercent|global/read-only serviceTlsEventConnectionCountThreshold.setValue|global/read-only serviceWebTransportEnabled|global/read-only serviceWebTransportPlainTextListenPort|global/read-only serviceWebTransportTlsListenPort|global/read-only serviceWebTransportWebUrlSuffix|global/read-only tlsBlockVersion11Enabled|global/read-only tlsCipherSuiteManagementList|global/read-only tlsCipherSuiteMsgBackboneList|global/read-only tlsCipherSuiteSecureShellList|global/read-only tlsCrimeExploitProtectionEnabled|global/read-only tlsServerCertContent|global/read-only tlsStandardDomainCertificateAuthoritiesEnabled|vpn/read-only tlsTicketLifetime|global/read-only webManagerAllowUnencryptedWizardsEnabled|vpn/read-only webManagerCustomization|vpn/read-only webManagerRedirectHttpEnabled|vpn/read-only webManagerRedirectHttpOverrideTlsPort|vpn/read-only This has been available since 2.13. - *

200 - The Broker object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<BrokerResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getBrokerWithHttpInfo(String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Authority objects. - * Get a list of Certificate Authority objects. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| certContent|||x| crlDayList|||x| crlTimeList|||x| crlUrl|||x| ocspNonResponderCertEnabled|||x| ocspOverrideUrl|||x| ocspTimeout|||x| revocationCheckEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The list of Certificate Authority objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return CertAuthoritiesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public CertAuthoritiesResponse getCertAuthorities(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getCertAuthoritiesWithHttpInfo(count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Authority objects. - * Get a list of Certificate Authority objects. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| certContent|||x| crlDayList|||x| crlTimeList|||x| crlUrl|||x| ocspNonResponderCertEnabled|||x| ocspOverrideUrl|||x| ocspTimeout|||x| revocationCheckEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The list of Certificate Authority objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<CertAuthoritiesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getCertAuthoritiesWithHttpInfo(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Authority object. - * Get a Certificate Authority object. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| certContent|||x| crlDayList|||x| crlTimeList|||x| crlUrl|||x| ocspNonResponderCertEnabled|||x| ocspOverrideUrl|||x| ocspTimeout|||x| revocationCheckEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The Certificate Authority object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return CertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public CertAuthorityResponse getCertAuthority(String certAuthorityName, String opaquePassword, List select) throws RestClientException { - return getCertAuthorityWithHttpInfo(certAuthorityName, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Authority object. - * Get a Certificate Authority object. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| certContent|||x| crlDayList|||x| crlTimeList|||x| crlUrl|||x| ocspNonResponderCertEnabled|||x| ocspOverrideUrl|||x| ocspTimeout|||x| revocationCheckEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The Certificate Authority object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<CertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getCertAuthorityWithHttpInfo(String certAuthorityName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling getCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities/{certAuthorityName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an OCSP Responder Trusted Common Name object. - * Get an OCSP Responder Trusted Common Name object. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| ocspTlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - *

200 - The OCSP Responder Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param ocspTlsTrustedCommonName The expected Trusted Common Name of the OCSP responder remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return CertAuthorityOcspTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public CertAuthorityOcspTlsTrustedCommonNameResponse getCertAuthorityOcspTlsTrustedCommonName(String certAuthorityName, String ocspTlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - return getCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(certAuthorityName, ocspTlsTrustedCommonName, opaquePassword, select).getBody(); - } - - /** - * Get an OCSP Responder Trusted Common Name object. - * Get an OCSP Responder Trusted Common Name object. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| ocspTlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - *

200 - The OCSP Responder Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param ocspTlsTrustedCommonName The expected Trusted Common Name of the OCSP responder remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<CertAuthorityOcspTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(String certAuthorityName, String ocspTlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling getCertAuthorityOcspTlsTrustedCommonName"); - } - - // verify the required parameter 'ocspTlsTrustedCommonName' is set - if (ocspTlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ocspTlsTrustedCommonName' when calling getCertAuthorityOcspTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - uriVariables.put("ocspTlsTrustedCommonName", ocspTlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of OCSP Responder Trusted Common Name objects. - * Get a list of OCSP Responder Trusted Common Name objects. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| ocspTlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - *

200 - The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return CertAuthorityOcspTlsTrustedCommonNamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public CertAuthorityOcspTlsTrustedCommonNamesResponse getCertAuthorityOcspTlsTrustedCommonNames(String certAuthorityName, String opaquePassword, List where, List select) throws RestClientException { - return getCertAuthorityOcspTlsTrustedCommonNamesWithHttpInfo(certAuthorityName, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of OCSP Responder Trusted Common Name objects. - * Get a list of OCSP Responder Trusted Common Name objects. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| ocspTlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - *

200 - The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<CertAuthorityOcspTlsTrustedCommonNamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getCertAuthorityOcspTlsTrustedCommonNamesWithHttpInfo(String certAuthorityName, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling getCertAuthorityOcspTlsTrustedCommonNames"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Client Certificate Authority objects. - * Get a list of Client Certificate Authority objects. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The list of Client Certificate Authority objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ClientCertAuthoritiesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ClientCertAuthoritiesResponse getClientCertAuthorities(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getClientCertAuthoritiesWithHttpInfo(count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Client Certificate Authority objects. - * Get a list of Client Certificate Authority objects. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The list of Client Certificate Authority objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<ClientCertAuthoritiesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getClientCertAuthoritiesWithHttpInfo(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Client Certificate Authority object. - * Get a Client Certificate Authority object. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The Client Certificate Authority object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ClientCertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ClientCertAuthorityResponse getClientCertAuthority(String certAuthorityName, String opaquePassword, List select) throws RestClientException { - return getClientCertAuthorityWithHttpInfo(certAuthorityName, opaquePassword, select).getBody(); - } - - /** - * Get a Client Certificate Authority object. - * Get a Client Certificate Authority object. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The Client Certificate Authority object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<ClientCertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getClientCertAuthorityWithHttpInfo(String certAuthorityName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling getClientCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities/{certAuthorityName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an OCSP Responder Trusted Common Name object. - * Get an OCSP Responder Trusted Common Name object. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| ocspTlsTrustedCommonName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The OCSP Responder Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param ocspTlsTrustedCommonName The expected Trusted Common Name of the OCSP responder remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ClientCertAuthorityOcspTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ClientCertAuthorityOcspTlsTrustedCommonNameResponse getClientCertAuthorityOcspTlsTrustedCommonName(String certAuthorityName, String ocspTlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - return getClientCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(certAuthorityName, ocspTlsTrustedCommonName, opaquePassword, select).getBody(); - } - - /** - * Get an OCSP Responder Trusted Common Name object. - * Get an OCSP Responder Trusted Common Name object. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| ocspTlsTrustedCommonName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The OCSP Responder Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param ocspTlsTrustedCommonName The expected Trusted Common Name of the OCSP responder remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<ClientCertAuthorityOcspTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getClientCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(String certAuthorityName, String ocspTlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling getClientCertAuthorityOcspTlsTrustedCommonName"); - } - - // verify the required parameter 'ocspTlsTrustedCommonName' is set - if (ocspTlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ocspTlsTrustedCommonName' when calling getClientCertAuthorityOcspTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - uriVariables.put("ocspTlsTrustedCommonName", ocspTlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of OCSP Responder Trusted Common Name objects. - * Get a list of OCSP Responder Trusted Common Name objects. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| ocspTlsTrustedCommonName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ClientCertAuthorityOcspTlsTrustedCommonNamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ClientCertAuthorityOcspTlsTrustedCommonNamesResponse getClientCertAuthorityOcspTlsTrustedCommonNames(String certAuthorityName, String opaquePassword, List where, List select) throws RestClientException { - return getClientCertAuthorityOcspTlsTrustedCommonNamesWithHttpInfo(certAuthorityName, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of OCSP Responder Trusted Common Name objects. - * Get a list of OCSP Responder Trusted Common Name objects. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| ocspTlsTrustedCommonName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<ClientCertAuthorityOcspTlsTrustedCommonNamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getClientCertAuthorityOcspTlsTrustedCommonNamesWithHttpInfo(String certAuthorityName, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling getClientCertAuthorityOcspTlsTrustedCommonNames"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Cluster object. - * Get a Cluster object. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| dmrClusterName|x||| tlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cluster object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterResponse getDmrCluster(String dmrClusterName, String opaquePassword, List select) throws RestClientException { - return getDmrClusterWithHttpInfo(dmrClusterName, opaquePassword, select).getBody(); - } - - /** - * Get a Cluster object. - * Get a Cluster object. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| dmrClusterName|x||| tlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cluster object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterWithHttpInfo(String dmrClusterName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Matching Rule object. - * Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleResponse getDmrClusterCertMatchingRule(String dmrClusterName, String ruleName, String opaquePassword, List select) throws RestClientException { - return getDmrClusterCertMatchingRuleWithHttpInfo(dmrClusterName, ruleName, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Matching Rule object. - * Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterCertMatchingRuleWithHttpInfo(String dmrClusterName, String ruleName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getDmrClusterCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Matching Rule Attribute Filter object. - * Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| filterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleAttributeFilterResponse getDmrClusterCertMatchingRuleAttributeFilter(String dmrClusterName, String ruleName, String filterName, String opaquePassword, List select) throws RestClientException { - return getDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(dmrClusterName, ruleName, filterName, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Matching Rule Attribute Filter object. - * Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| filterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(String dmrClusterName, String ruleName, String filterName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling getDmrClusterCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Matching Rule Attribute Filter objects. - * Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| filterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleAttributeFiltersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleAttributeFiltersResponse getDmrClusterCertMatchingRuleAttributeFilters(String dmrClusterName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getDmrClusterCertMatchingRuleAttributeFiltersWithHttpInfo(dmrClusterName, ruleName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Matching Rule Attribute Filter objects. - * Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| filterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleAttributeFiltersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterCertMatchingRuleAttributeFiltersWithHttpInfo(String dmrClusterName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterCertMatchingRuleAttributeFilters"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getDmrClusterCertMatchingRuleAttributeFilters"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Matching Rule Condition object. - * Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Condition object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleConditionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleConditionResponse getDmrClusterCertMatchingRuleCondition(String dmrClusterName, String ruleName, String source, String opaquePassword, List select) throws RestClientException { - return getDmrClusterCertMatchingRuleConditionWithHttpInfo(dmrClusterName, ruleName, source, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Matching Rule Condition object. - * Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Condition object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleConditionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterCertMatchingRuleConditionWithHttpInfo(String dmrClusterName, String ruleName, String source, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterCertMatchingRuleCondition"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getDmrClusterCertMatchingRuleCondition"); - } - - // verify the required parameter 'source' is set - if (source == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'source' when calling getDmrClusterCertMatchingRuleCondition"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("source", source); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Matching Rule Condition objects. - * Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule Condition objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleConditionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleConditionsResponse getDmrClusterCertMatchingRuleConditions(String dmrClusterName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getDmrClusterCertMatchingRuleConditionsWithHttpInfo(dmrClusterName, ruleName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Matching Rule Condition objects. - * Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule Condition objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleConditionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterCertMatchingRuleConditionsWithHttpInfo(String dmrClusterName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterCertMatchingRuleConditions"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getDmrClusterCertMatchingRuleConditions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Matching Rule objects. - * Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRulesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRulesResponse getDmrClusterCertMatchingRules(String dmrClusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getDmrClusterCertMatchingRulesWithHttpInfo(dmrClusterName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Matching Rule objects. - * Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRulesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterCertMatchingRulesWithHttpInfo(String dmrClusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterCertMatchingRules"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Link object. - * Get a Link object. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Link object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkResponse getDmrClusterLink(String dmrClusterName, String remoteNodeName, String opaquePassword, List select) throws RestClientException { - return getDmrClusterLinkWithHttpInfo(dmrClusterName, remoteNodeName, opaquePassword, select).getBody(); - } - - /** - * Get a Link object. - * Get a Link object. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Link object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterLinkWithHttpInfo(String dmrClusterName, String remoteNodeName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterLink"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getDmrClusterLink"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Link Attribute object. - * Get a Link Attribute object. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Link Attribute object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkAttributeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkAttributeResponse getDmrClusterLinkAttribute(String dmrClusterName, String remoteNodeName, String attributeName, String attributeValue, String opaquePassword, List select) throws RestClientException { - return getDmrClusterLinkAttributeWithHttpInfo(dmrClusterName, remoteNodeName, attributeName, attributeValue, opaquePassword, select).getBody(); - } - - /** - * Get a Link Attribute object. - * Get a Link Attribute object. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Link Attribute object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkAttributeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterLinkAttributeWithHttpInfo(String dmrClusterName, String remoteNodeName, String attributeName, String attributeValue, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterLinkAttribute"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getDmrClusterLinkAttribute"); - } - - // verify the required parameter 'attributeName' is set - if (attributeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeName' when calling getDmrClusterLinkAttribute"); - } - - // verify the required parameter 'attributeValue' is set - if (attributeValue == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeValue' when calling getDmrClusterLinkAttribute"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - uriVariables.put("attributeName", attributeName); - uriVariables.put("attributeValue", attributeValue); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Link Attribute objects. - * Get a list of Link Attribute objects. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Link Attribute objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkAttributesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkAttributesResponse getDmrClusterLinkAttributes(String dmrClusterName, String remoteNodeName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getDmrClusterLinkAttributesWithHttpInfo(dmrClusterName, remoteNodeName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Link Attribute objects. - * Get a list of Link Attribute objects. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Link Attribute objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkAttributesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterLinkAttributesWithHttpInfo(String dmrClusterName, String remoteNodeName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterLinkAttributes"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getDmrClusterLinkAttributes"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Remote Address object. - * Get a Remote Address object. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| remoteAddress|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Remote Address object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param remoteAddress The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkRemoteAddressResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkRemoteAddressResponse getDmrClusterLinkRemoteAddress(String dmrClusterName, String remoteNodeName, String remoteAddress, String opaquePassword, List select) throws RestClientException { - return getDmrClusterLinkRemoteAddressWithHttpInfo(dmrClusterName, remoteNodeName, remoteAddress, opaquePassword, select).getBody(); - } - - /** - * Get a Remote Address object. - * Get a Remote Address object. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| remoteAddress|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Remote Address object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param remoteAddress The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkRemoteAddressResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterLinkRemoteAddressWithHttpInfo(String dmrClusterName, String remoteNodeName, String remoteAddress, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterLinkRemoteAddress"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getDmrClusterLinkRemoteAddress"); - } - - // verify the required parameter 'remoteAddress' is set - if (remoteAddress == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteAddress' when calling getDmrClusterLinkRemoteAddress"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - uriVariables.put("remoteAddress", remoteAddress); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Remote Address objects. - * Get a list of Remote Address objects. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| remoteAddress|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Remote Address objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkRemoteAddressesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkRemoteAddressesResponse getDmrClusterLinkRemoteAddresses(String dmrClusterName, String remoteNodeName, String opaquePassword, List where, List select) throws RestClientException { - return getDmrClusterLinkRemoteAddressesWithHttpInfo(dmrClusterName, remoteNodeName, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Remote Address objects. - * Get a list of Remote Address objects. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| remoteAddress|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Remote Address objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkRemoteAddressesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterLinkRemoteAddressesWithHttpInfo(String dmrClusterName, String remoteNodeName, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterLinkRemoteAddresses"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getDmrClusterLinkRemoteAddresses"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Trusted Common Name object. - * Get a Trusted Common Name object. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||x| remoteNodeName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public DmrClusterLinkTlsTrustedCommonNameResponse getDmrClusterLinkTlsTrustedCommonName(String dmrClusterName, String remoteNodeName, String tlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - return getDmrClusterLinkTlsTrustedCommonNameWithHttpInfo(dmrClusterName, remoteNodeName, tlsTrustedCommonName, opaquePassword, select).getBody(); - } - - /** - * Get a Trusted Common Name object. - * Get a Trusted Common Name object. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||x| remoteNodeName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getDmrClusterLinkTlsTrustedCommonNameWithHttpInfo(String dmrClusterName, String remoteNodeName, String tlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterLinkTlsTrustedCommonName"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getDmrClusterLinkTlsTrustedCommonName"); - } - - // verify the required parameter 'tlsTrustedCommonName' is set - if (tlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'tlsTrustedCommonName' when calling getDmrClusterLinkTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - uriVariables.put("tlsTrustedCommonName", tlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Trusted Common Name objects. - * Get a list of Trusted Common Name objects. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||x| remoteNodeName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The list of Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkTlsTrustedCommonNamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public DmrClusterLinkTlsTrustedCommonNamesResponse getDmrClusterLinkTlsTrustedCommonNames(String dmrClusterName, String remoteNodeName, String opaquePassword, List where, List select) throws RestClientException { - return getDmrClusterLinkTlsTrustedCommonNamesWithHttpInfo(dmrClusterName, remoteNodeName, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Trusted Common Name objects. - * Get a list of Trusted Common Name objects. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||x| remoteNodeName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The list of Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkTlsTrustedCommonNamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getDmrClusterLinkTlsTrustedCommonNamesWithHttpInfo(String dmrClusterName, String remoteNodeName, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterLinkTlsTrustedCommonNames"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getDmrClusterLinkTlsTrustedCommonNames"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Link objects. - * Get a list of Link objects. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Link objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinksResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinksResponse getDmrClusterLinks(String dmrClusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getDmrClusterLinksWithHttpInfo(dmrClusterName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Link objects. - * Get a list of Link objects. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Link objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinksResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterLinksWithHttpInfo(String dmrClusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterLinks"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Cluster objects. - * Get a list of Cluster objects. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| dmrClusterName|x||| tlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Cluster objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClustersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClustersResponse getDmrClusters(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getDmrClustersWithHttpInfo(count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Cluster objects. - * Get a list of Cluster objects. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| dmrClusterName|x||| tlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Cluster objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClustersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClustersWithHttpInfo(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Domain Certificate Authority objects. - * Get a list of Domain Certificate Authority objects. Certificate Authorities trusted for domain verification. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The list of Domain Certificate Authority objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DomainCertAuthoritiesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DomainCertAuthoritiesResponse getDomainCertAuthorities(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getDomainCertAuthoritiesWithHttpInfo(count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Domain Certificate Authority objects. - * Get a list of Domain Certificate Authority objects. Certificate Authorities trusted for domain verification. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The list of Domain Certificate Authority objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DomainCertAuthoritiesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDomainCertAuthoritiesWithHttpInfo(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/domainCertAuthorities", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Domain Certificate Authority object. - * Get a Domain Certificate Authority object. Certificate Authorities trusted for domain verification. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The Domain Certificate Authority object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DomainCertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DomainCertAuthorityResponse getDomainCertAuthority(String certAuthorityName, String opaquePassword, List select) throws RestClientException { - return getDomainCertAuthorityWithHttpInfo(certAuthorityName, opaquePassword, select).getBody(); - } - - /** - * Get a Domain Certificate Authority object. - * Get a Domain Certificate Authority object. Certificate Authorities trusted for domain verification. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The Domain Certificate Authority object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DomainCertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDomainCertAuthorityWithHttpInfo(String certAuthorityName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling getDomainCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/domainCertAuthorities/{certAuthorityName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Message VPN object. - * Get a Message VPN object. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| distributedCacheManagementEnabled|||x| msgVpnName|x||| replicationBridgeAuthenticationBasicPassword||x||x replicationBridgeAuthenticationClientCertContent||x||x replicationBridgeAuthenticationClientCertPassword||x|| replicationEnabledQueueBehavior||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Message VPN object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnResponse getMsgVpn(String msgVpnName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnWithHttpInfo(msgVpnName, opaquePassword, select).getBody(); - } - - /** - * Get a Message VPN object. - * Get a Message VPN object. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| distributedCacheManagementEnabled|||x| msgVpnName|x||| replicationBridgeAuthenticationBasicPassword||x||x replicationBridgeAuthenticationClientCertContent||x||x replicationBridgeAuthenticationClientCertPassword||x|| replicationEnabledQueueBehavior||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Message VPN object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnWithHttpInfo(String msgVpnName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an ACL Profile object. - * Get an ACL Profile object. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileResponse getMsgVpnAclProfile(String msgVpnName, String aclProfileName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfileWithHttpInfo(msgVpnName, aclProfileName, opaquePassword, select).getBody(); - } - - /** - * Get an ACL Profile object. - * Get an ACL Profile object. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileWithHttpInfo(String msgVpnName, String aclProfileName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfile"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Client Connect Exception object. - * Get a Client Connect Exception object. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Connect Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param clientConnectExceptionAddress The IP address/netmask of the client connect exception in CIDR form. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileClientConnectExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileClientConnectExceptionResponse getMsgVpnAclProfileClientConnectException(String msgVpnName, String aclProfileName, String clientConnectExceptionAddress, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfileClientConnectExceptionWithHttpInfo(msgVpnName, aclProfileName, clientConnectExceptionAddress, opaquePassword, select).getBody(); - } - - /** - * Get a Client Connect Exception object. - * Get a Client Connect Exception object. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Connect Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param clientConnectExceptionAddress The IP address/netmask of the client connect exception in CIDR form. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileClientConnectExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileClientConnectExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String clientConnectExceptionAddress, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'clientConnectExceptionAddress' is set - if (clientConnectExceptionAddress == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientConnectExceptionAddress' when calling getMsgVpnAclProfileClientConnectException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("clientConnectExceptionAddress", clientConnectExceptionAddress); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Client Connect Exception objects. - * Get a list of Client Connect Exception objects. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Connect Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileClientConnectExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileClientConnectExceptionsResponse getMsgVpnAclProfileClientConnectExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfileClientConnectExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Client Connect Exception objects. - * Get a list of Client Connect Exception objects. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Connect Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileClientConnectExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileClientConnectExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileClientConnectExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileClientConnectExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Publish Topic Exception object. - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The Publish Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfilePublishExceptionResponse getMsgVpnAclProfilePublishException(String msgVpnName, String aclProfileName, String topicSyntax, String publishExceptionTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfilePublishExceptionWithHttpInfo(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Publish Topic Exception object. - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The Publish Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAclProfilePublishExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String topicSyntax, String publishExceptionTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'topicSyntax' is set - if (topicSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicSyntax' when calling getMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'publishExceptionTopic' is set - if (publishExceptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishExceptionTopic' when calling getMsgVpnAclProfilePublishException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("topicSyntax", topicSyntax); - uriVariables.put("publishExceptionTopic", publishExceptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Publish Topic Exception objects. - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The list of Publish Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfilePublishExceptionsResponse getMsgVpnAclProfilePublishExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfilePublishExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Publish Topic Exception objects. - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The list of Publish Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAclProfilePublishExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfilePublishExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfilePublishExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Publish Topic Exception object. - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Publish Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param publishTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishTopicExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfilePublishTopicExceptionResponse getMsgVpnAclProfilePublishTopicException(String msgVpnName, String aclProfileName, String publishTopicExceptionSyntax, String publishTopicException, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException, opaquePassword, select).getBody(); - } - - /** - * Get a Publish Topic Exception object. - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Publish Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param publishTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishTopicExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String publishTopicExceptionSyntax, String publishTopicException, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'publishTopicExceptionSyntax' is set - if (publishTopicExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishTopicExceptionSyntax' when calling getMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'publishTopicException' is set - if (publishTopicException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishTopicException' when calling getMsgVpnAclProfilePublishTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("publishTopicExceptionSyntax", publishTopicExceptionSyntax); - uriVariables.put("publishTopicException", publishTopicException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Publish Topic Exception objects. - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Publish Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishTopicExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfilePublishTopicExceptionsResponse getMsgVpnAclProfilePublishTopicExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfilePublishTopicExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Publish Topic Exception objects. - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Publish Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishTopicExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfilePublishTopicExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfilePublishTopicExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfilePublishTopicExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Subscribe Topic Exception object. - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The Subscribe Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfileSubscribeExceptionResponse getMsgVpnAclProfileSubscribeException(String msgVpnName, String aclProfileName, String topicSyntax, String subscribeExceptionTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeExceptionWithHttpInfo(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Subscribe Topic Exception object. - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The Subscribe Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAclProfileSubscribeExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String topicSyntax, String subscribeExceptionTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'topicSyntax' is set - if (topicSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicSyntax' when calling getMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'subscribeExceptionTopic' is set - if (subscribeExceptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeExceptionTopic' when calling getMsgVpnAclProfileSubscribeException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("topicSyntax", topicSyntax); - uriVariables.put("subscribeExceptionTopic", subscribeExceptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Subscribe Topic Exception objects. - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The list of Subscribe Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfileSubscribeExceptionsResponse getMsgVpnAclProfileSubscribeExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Subscribe Topic Exception objects. - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The list of Subscribe Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAclProfileSubscribeExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Subscribe Share Name Exception object. - * Get a Subscribe Share Name Exception object. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Share Name Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeShareNameExceptionSyntax The syntax of the subscribe share name for the exception to the default action taken. (required) - * @param subscribeShareNameException The subscribe share name exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeShareNameExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeShareNameExceptionResponse getMsgVpnAclProfileSubscribeShareNameException(String msgVpnName, String aclProfileName, String subscribeShareNameExceptionSyntax, String subscribeShareNameException, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException, opaquePassword, select).getBody(); - } - - /** - * Get a Subscribe Share Name Exception object. - * Get a Subscribe Share Name Exception object. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Share Name Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeShareNameExceptionSyntax The syntax of the subscribe share name for the exception to the default action taken. (required) - * @param subscribeShareNameException The subscribe share name exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeShareNameExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String subscribeShareNameExceptionSyntax, String subscribeShareNameException, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'subscribeShareNameExceptionSyntax' is set - if (subscribeShareNameExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeShareNameExceptionSyntax' when calling getMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'subscribeShareNameException' is set - if (subscribeShareNameException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeShareNameException' when calling getMsgVpnAclProfileSubscribeShareNameException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("subscribeShareNameExceptionSyntax", subscribeShareNameExceptionSyntax); - uriVariables.put("subscribeShareNameException", subscribeShareNameException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Subscribe Share Name Exception objects. - * Get a list of Subscribe Share Name Exception objects. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Subscribe Share Name Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeShareNameExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeShareNameExceptionsResponse getMsgVpnAclProfileSubscribeShareNameExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeShareNameExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Subscribe Share Name Exception objects. - * Get a list of Subscribe Share Name Exception objects. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Subscribe Share Name Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeShareNameExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileSubscribeShareNameExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeShareNameExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeShareNameExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Subscribe Topic Exception object. - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeTopicExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeTopicExceptionResponse getMsgVpnAclProfileSubscribeTopicException(String msgVpnName, String aclProfileName, String subscribeTopicExceptionSyntax, String subscribeTopicException, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException, opaquePassword, select).getBody(); - } - - /** - * Get a Subscribe Topic Exception object. - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeTopicExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String subscribeTopicExceptionSyntax, String subscribeTopicException, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'subscribeTopicExceptionSyntax' is set - if (subscribeTopicExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeTopicExceptionSyntax' when calling getMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'subscribeTopicException' is set - if (subscribeTopicException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeTopicException' when calling getMsgVpnAclProfileSubscribeTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("subscribeTopicExceptionSyntax", subscribeTopicExceptionSyntax); - uriVariables.put("subscribeTopicException", subscribeTopicException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Subscribe Topic Exception objects. - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Subscribe Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeTopicExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeTopicExceptionsResponse getMsgVpnAclProfileSubscribeTopicExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeTopicExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Subscribe Topic Exception objects. - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Subscribe Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeTopicExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileSubscribeTopicExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeTopicExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeTopicExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of ACL Profile objects. - * Get a list of ACL Profile objects. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of ACL Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfilesResponse getMsgVpnAclProfiles(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfilesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of ACL Profile objects. - * Get a list of ACL Profile objects. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of ACL Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfilesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfiles"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an OAuth Profile object. - * Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResponse getMsgVpnAuthenticationOauthProfile(String msgVpnName, String oauthProfileName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfileWithHttpInfo(msgVpnName, oauthProfileName, opaquePassword, select).getBody(); - } - - /** - * Get an OAuth Profile object. - * Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfileWithHttpInfo(String msgVpnName, String oauthProfileName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getMsgVpnAuthenticationOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse getMsgVpnAuthenticationOauthProfileClientRequiredClaim(String msgVpnName, String oauthProfileName, String clientRequiredClaimName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, clientRequiredClaimName, opaquePassword, select).getBody(); - } - - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, String clientRequiredClaimName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'clientRequiredClaimName' is set - if (clientRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientRequiredClaimName' when calling getMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("clientRequiredClaimName", clientRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse getMsgVpnAuthenticationOauthProfileClientRequiredClaims(String msgVpnName, String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfileClientRequiredClaimsWithHttpInfo(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfileClientRequiredClaimsWithHttpInfo(String msgVpnName, String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfileClientRequiredClaims"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getMsgVpnAuthenticationOauthProfileClientRequiredClaims"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(String msgVpnName, String oauthProfileName, String resourceServerRequiredClaimName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select).getBody(); - } - - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, String resourceServerRequiredClaimName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'resourceServerRequiredClaimName' is set - if (resourceServerRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'resourceServerRequiredClaimName' when calling getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("resourceServerRequiredClaimName", resourceServerRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims(String msgVpnName, String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsWithHttpInfo(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsWithHttpInfo(String msgVpnName, String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of OAuth Profile objects. - * Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of OAuth Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfilesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfilesResponse getMsgVpnAuthenticationOauthProfiles(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfilesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of OAuth Profile objects. - * Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of OAuth Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfilesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfilesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfiles"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an OAuth Provider object. - * Get an OAuth Provider object. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProviderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAuthenticationOauthProviderResponse getMsgVpnAuthenticationOauthProvider(String msgVpnName, String oauthProviderName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProviderWithHttpInfo(msgVpnName, oauthProviderName, opaquePassword, select).getBody(); - } - - /** - * Get an OAuth Provider object. - * Get an OAuth Provider object. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProviderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAuthenticationOauthProviderWithHttpInfo(String msgVpnName, String oauthProviderName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'oauthProviderName' is set - if (oauthProviderName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProviderName' when calling getMsgVpnAuthenticationOauthProvider"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProviderName", oauthProviderName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of OAuth Provider objects. - * Get a list of OAuth Provider objects. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The list of OAuth Provider objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProvidersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAuthenticationOauthProvidersResponse getMsgVpnAuthenticationOauthProviders(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProvidersWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of OAuth Provider objects. - * Get a list of OAuth Provider objects. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The list of OAuth Provider objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProvidersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAuthenticationOauthProvidersWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProviders"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an Authorization Group object. - * Get an Authorization Group object. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthorizationGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthorizationGroupResponse getMsgVpnAuthorizationGroup(String msgVpnName, String authorizationGroupName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAuthorizationGroupWithHttpInfo(msgVpnName, authorizationGroupName, opaquePassword, select).getBody(); - } - - /** - * Get an Authorization Group object. - * Get an Authorization Group object. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthorizationGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthorizationGroupWithHttpInfo(String msgVpnName, String authorizationGroupName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'authorizationGroupName' is set - if (authorizationGroupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationGroupName' when calling getMsgVpnAuthorizationGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("authorizationGroupName", authorizationGroupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Authorization Group objects. - * Get a list of Authorization Group objects. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Authorization Group objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthorizationGroupsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthorizationGroupsResponse getMsgVpnAuthorizationGroups(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAuthorizationGroupsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Authorization Group objects. - * Get a list of Authorization Group objects. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Authorization Group objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthorizationGroupsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthorizationGroupsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthorizationGroups"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Bridge object. - * Get a Bridge object. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeResponse getMsgVpnBridge(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List select) throws RestClientException { - return getMsgVpnBridgeWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, select).getBody(); - } - - /** - * Get a Bridge object. - * Get a Bridge object. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgeWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridge"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridge"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Remote Message VPN object. - * Get a Remote Message VPN object. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteMsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteMsgVpnResponse getMsgVpnBridgeRemoteMsgVpn(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, String opaquePassword, List select) throws RestClientException { - return getMsgVpnBridgeRemoteMsgVpnWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, opaquePassword, select).getBody(); - } - - /** - * Get a Remote Message VPN object. - * Get a Remote Message VPN object. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteMsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgeRemoteMsgVpnWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnName' is set - if (remoteMsgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnName' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnLocation' is set - if (remoteMsgVpnLocation == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnLocation' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnInterface' is set - if (remoteMsgVpnInterface == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnInterface' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteMsgVpnName", remoteMsgVpnName); - uriVariables.put("remoteMsgVpnLocation", remoteMsgVpnLocation); - uriVariables.put("remoteMsgVpnInterface", remoteMsgVpnInterface); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Remote Message VPN objects. - * Get a list of Remote Message VPN objects. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Remote Message VPN objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteMsgVpnsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteMsgVpnsResponse getMsgVpnBridgeRemoteMsgVpns(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnBridgeRemoteMsgVpnsWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Remote Message VPN objects. - * Get a list of Remote Message VPN objects. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Remote Message VPN objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteMsgVpnsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgeRemoteMsgVpnsWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeRemoteMsgVpns"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeRemoteMsgVpns"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeRemoteMsgVpns"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Remote Subscription object. - * Get a Remote Subscription object. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteSubscriptionTopic The topic of the Bridge remote subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteSubscriptionResponse getMsgVpnBridgeRemoteSubscription(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteSubscriptionTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnBridgeRemoteSubscriptionWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Remote Subscription object. - * Get a Remote Subscription object. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteSubscriptionTopic The topic of the Bridge remote subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgeRemoteSubscriptionWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteSubscriptionTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'remoteSubscriptionTopic' is set - if (remoteSubscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteSubscriptionTopic' when calling getMsgVpnBridgeRemoteSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteSubscriptionTopic", remoteSubscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Remote Subscription objects. - * Get a list of Remote Subscription objects. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Remote Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteSubscriptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteSubscriptionsResponse getMsgVpnBridgeRemoteSubscriptions(String msgVpnName, String bridgeName, String bridgeVirtualRouter, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnBridgeRemoteSubscriptionsWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Remote Subscription objects. - * Get a list of Remote Subscription objects. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Remote Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteSubscriptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgeRemoteSubscriptionsWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeRemoteSubscriptions"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeRemoteSubscriptions"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeRemoteSubscriptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Trusted Common Name object. - * Get a Trusted Common Name object. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnBridgeTlsTrustedCommonNameResponse getMsgVpnBridgeTlsTrustedCommonName(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String tlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName, opaquePassword, select).getBody(); - } - - /** - * Get a Trusted Common Name object. - * Get a Trusted Common Name object. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String tlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'tlsTrustedCommonName' is set - if (tlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'tlsTrustedCommonName' when calling getMsgVpnBridgeTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("tlsTrustedCommonName", tlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Trusted Common Name objects. - * Get a list of Trusted Common Name objects. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The list of Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeTlsTrustedCommonNamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnBridgeTlsTrustedCommonNamesResponse getMsgVpnBridgeTlsTrustedCommonNames(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnBridgeTlsTrustedCommonNamesWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Trusted Common Name objects. - * Get a list of Trusted Common Name objects. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The list of Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeTlsTrustedCommonNamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnBridgeTlsTrustedCommonNamesWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeTlsTrustedCommonNames"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeTlsTrustedCommonNames"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeTlsTrustedCommonNames"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Bridge objects. - * Get a list of Bridge objects. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Bridge objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgesResponse getMsgVpnBridges(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnBridgesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Bridge objects. - * Get a list of Bridge objects. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Bridge objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridges"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Matching Rule object. - * Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleResponse getMsgVpnCertMatchingRule(String msgVpnName, String ruleName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnCertMatchingRuleWithHttpInfo(msgVpnName, ruleName, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Matching Rule object. - * Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRuleWithHttpInfo(String msgVpnName, String ruleName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getMsgVpnCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Matching Rule Attribute Filter object. - * Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleAttributeFilterResponse getMsgVpnCertMatchingRuleAttributeFilter(String msgVpnName, String ruleName, String filterName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(msgVpnName, ruleName, filterName, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Matching Rule Attribute Filter object. - * Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(String msgVpnName, String ruleName, String filterName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling getMsgVpnCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Matching Rule Attribute Filter objects. - * Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleAttributeFiltersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleAttributeFiltersResponse getMsgVpnCertMatchingRuleAttributeFilters(String msgVpnName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnCertMatchingRuleAttributeFiltersWithHttpInfo(msgVpnName, ruleName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Matching Rule Attribute Filter objects. - * Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleAttributeFiltersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRuleAttributeFiltersWithHttpInfo(String msgVpnName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRuleAttributeFilters"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getMsgVpnCertMatchingRuleAttributeFilters"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Matching Rule Condition object. - * Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule Condition object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleConditionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleConditionResponse getMsgVpnCertMatchingRuleCondition(String msgVpnName, String ruleName, String source, String opaquePassword, List select) throws RestClientException { - return getMsgVpnCertMatchingRuleConditionWithHttpInfo(msgVpnName, ruleName, source, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Matching Rule Condition object. - * Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule Condition object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleConditionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRuleConditionWithHttpInfo(String msgVpnName, String ruleName, String source, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'source' is set - if (source == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'source' when calling getMsgVpnCertMatchingRuleCondition"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("source", source); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Matching Rule Condition objects. - * Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Certificate Matching Rule Condition objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleConditionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleConditionsResponse getMsgVpnCertMatchingRuleConditions(String msgVpnName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnCertMatchingRuleConditionsWithHttpInfo(msgVpnName, ruleName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Matching Rule Condition objects. - * Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Certificate Matching Rule Condition objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleConditionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRuleConditionsWithHttpInfo(String msgVpnName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRuleConditions"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getMsgVpnCertMatchingRuleConditions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Matching Rule objects. - * Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Certificate Matching Rule objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRulesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRulesResponse getMsgVpnCertMatchingRules(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnCertMatchingRulesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Matching Rule objects. - * Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Certificate Matching Rule objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRulesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRulesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRules"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Client Profile object. - * Get a Client Profile object. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientProfileResponse getMsgVpnClientProfile(String msgVpnName, String clientProfileName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnClientProfileWithHttpInfo(msgVpnName, clientProfileName, opaquePassword, select).getBody(); - } - - /** - * Get a Client Profile object. - * Get a Client Profile object. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientProfileWithHttpInfo(String msgVpnName, String clientProfileName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientProfile"); - } - - // verify the required parameter 'clientProfileName' is set - if (clientProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientProfileName' when calling getMsgVpnClientProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientProfileName", clientProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Client Profile objects. - * Get a list of Client Profile objects. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientProfilesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientProfilesResponse getMsgVpnClientProfiles(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnClientProfilesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Client Profile objects. - * Get a list of Client Profile objects. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientProfilesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientProfilesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientProfiles"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Client Username object. - * Get a Client Username object. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameResponse getMsgVpnClientUsername(String msgVpnName, String clientUsername, String opaquePassword, List select) throws RestClientException { - return getMsgVpnClientUsernameWithHttpInfo(msgVpnName, clientUsername, opaquePassword, select).getBody(); - } - - /** - * Get a Client Username object. - * Get a Client Username object. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientUsernameWithHttpInfo(String msgVpnName, String clientUsername, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientUsername"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling getMsgVpnClientUsername"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Client Username Attribute object. - * Get a Client Username Attribute object. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Client Username Attribute object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameAttributeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameAttributeResponse getMsgVpnClientUsernameAttribute(String msgVpnName, String clientUsername, String attributeName, String attributeValue, String opaquePassword, List select) throws RestClientException { - return getMsgVpnClientUsernameAttributeWithHttpInfo(msgVpnName, clientUsername, attributeName, attributeValue, opaquePassword, select).getBody(); - } - - /** - * Get a Client Username Attribute object. - * Get a Client Username Attribute object. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Client Username Attribute object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameAttributeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientUsernameAttributeWithHttpInfo(String msgVpnName, String clientUsername, String attributeName, String attributeValue, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling getMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'attributeName' is set - if (attributeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeName' when calling getMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'attributeValue' is set - if (attributeValue == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeValue' when calling getMsgVpnClientUsernameAttribute"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - uriVariables.put("attributeName", attributeName); - uriVariables.put("attributeValue", attributeValue); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Client Username Attribute objects. - * Get a list of Client Username Attribute objects. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Client Username Attribute objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameAttributesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameAttributesResponse getMsgVpnClientUsernameAttributes(String msgVpnName, String clientUsername, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnClientUsernameAttributesWithHttpInfo(msgVpnName, clientUsername, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Client Username Attribute objects. - * Get a list of Client Username Attribute objects. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Client Username Attribute objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameAttributesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientUsernameAttributesWithHttpInfo(String msgVpnName, String clientUsername, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientUsernameAttributes"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling getMsgVpnClientUsernameAttributes"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Client Username objects. - * Get a list of Client Username objects. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Username objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernamesResponse getMsgVpnClientUsernames(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnClientUsernamesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Client Username objects. - * Get a list of Client Username objects. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Username objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientUsernamesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientUsernames"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Distributed Cache object. - * Get a Distributed Cache object. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheResponse getMsgVpnDistributedCache(String msgVpnName, String cacheName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheWithHttpInfo(msgVpnName, cacheName, opaquePassword, select).getBody(); - } - - /** - * Get a Distributed Cache object. - * Get a Distributed Cache object. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheWithHttpInfo(String msgVpnName, String cacheName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Cache Cluster object. - * Get a Cache Cluster object. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterResponse getMsgVpnDistributedCacheCluster(String msgVpnName, String cacheName, String clusterName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterWithHttpInfo(msgVpnName, cacheName, clusterName, opaquePassword, select).getBody(); - } - - /** - * Get a Cache Cluster object. - * Get a Cache Cluster object. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Home Cache Cluster object. - * Get a Home Cache Cluster object. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Home Cache Cluster object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName, opaquePassword, select).getBody(); - } - - /** - * Get a Home Cache Cluster object. - * Get a Home Cache Cluster object. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Home Cache Cluster object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Topic Prefix object. - * Get a Topic Prefix object. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic Prefix object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param topicPrefix A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String topicPrefix, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix, opaquePassword, select).getBody(); - } - - /** - * Get a Topic Prefix object. - * Get a Topic Prefix object. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic Prefix object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param topicPrefix A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String topicPrefix, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'topicPrefix' is set - if (topicPrefix == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicPrefix' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - uriVariables.put("topicPrefix", topicPrefix); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Topic Prefix objects. - * Get a list of Topic Prefix objects. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Topic Prefix objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes(String msgVpnName, String cacheName, String clusterName, String homeClusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Topic Prefix objects. - * Get a list of Topic Prefix objects. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Topic Prefix objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Home Cache Cluster objects. - * Get a list of Home Cache Cluster objects. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Home Cache Cluster objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterGlobalCachingHomeClustersWithHttpInfo(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Home Cache Cluster objects. - * Get a list of Home Cache Cluster objects. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Home Cache Cluster objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterGlobalCachingHomeClustersWithHttpInfo(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Cache Instance object. - * Get a Cache Instance object. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterInstanceResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterInstanceResponse getMsgVpnDistributedCacheClusterInstance(String msgVpnName, String cacheName, String clusterName, String instanceName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterInstanceWithHttpInfo(msgVpnName, cacheName, clusterName, instanceName, opaquePassword, select).getBody(); - } - - /** - * Get a Cache Instance object. - * Get a Cache Instance object. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterInstanceResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterInstanceWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String instanceName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'instanceName' is set - if (instanceName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'instanceName' when calling getMsgVpnDistributedCacheClusterInstance"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("instanceName", instanceName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Cache Instance objects. - * Get a list of Cache Instance objects. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Cache Instance objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterInstancesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterInstancesResponse getMsgVpnDistributedCacheClusterInstances(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterInstancesWithHttpInfo(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Cache Instance objects. - * Get a list of Cache Instance objects. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Cache Instance objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterInstancesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterInstancesWithHttpInfo(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterInstances"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterInstances"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterInstances"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Topic object. - * Get a Topic object. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param topic The value of the Topic in the form a/b/c. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterTopicResponse getMsgVpnDistributedCacheClusterTopic(String msgVpnName, String cacheName, String clusterName, String topic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterTopicWithHttpInfo(msgVpnName, cacheName, clusterName, topic, opaquePassword, select).getBody(); - } - - /** - * Get a Topic object. - * Get a Topic object. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param topic The value of the Topic in the form a/b/c. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterTopicWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String topic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'topic' is set - if (topic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topic' when calling getMsgVpnDistributedCacheClusterTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("topic", topic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Topic objects. - * Get a list of Topic objects. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterTopicsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterTopicsResponse getMsgVpnDistributedCacheClusterTopics(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterTopicsWithHttpInfo(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Topic objects. - * Get a list of Topic objects. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterTopicsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterTopicsWithHttpInfo(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterTopics"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterTopics"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterTopics"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Cache Cluster objects. - * Get a list of Cache Cluster objects. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Cache Cluster objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClustersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClustersResponse getMsgVpnDistributedCacheClusters(String msgVpnName, String cacheName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCacheClustersWithHttpInfo(msgVpnName, cacheName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Cache Cluster objects. - * Get a list of Cache Cluster objects. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Cache Cluster objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClustersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClustersWithHttpInfo(String msgVpnName, String cacheName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusters"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusters"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Distributed Cache objects. - * Get a list of Distributed Cache objects. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Distributed Cache objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCachesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCachesResponse getMsgVpnDistributedCaches(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCachesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Distributed Cache objects. - * Get a list of Distributed Cache objects. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Distributed Cache objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCachesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCachesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCaches"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a DMR Bridge object. - * Get a DMR Bridge object. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDmrBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDmrBridgeResponse getMsgVpnDmrBridge(String msgVpnName, String remoteNodeName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDmrBridgeWithHttpInfo(msgVpnName, remoteNodeName, opaquePassword, select).getBody(); - } - - /** - * Get a DMR Bridge object. - * Get a DMR Bridge object. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDmrBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDmrBridgeWithHttpInfo(String msgVpnName, String remoteNodeName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDmrBridge"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getMsgVpnDmrBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of DMR Bridge objects. - * Get a list of DMR Bridge objects. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of DMR Bridge objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDmrBridgesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDmrBridgesResponse getMsgVpnDmrBridges(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDmrBridgesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of DMR Bridge objects. - * Get a list of DMR Bridge objects. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of DMR Bridge objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDmrBridgesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDmrBridgesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDmrBridges"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of JNDI Connection Factory objects. - * Get a list of JNDI Connection Factory objects. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Connection Factory objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiConnectionFactoriesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiConnectionFactoriesResponse getMsgVpnJndiConnectionFactories(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnJndiConnectionFactoriesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of JNDI Connection Factory objects. - * Get a list of JNDI Connection Factory objects. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Connection Factory objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiConnectionFactoriesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiConnectionFactoriesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiConnectionFactories"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a JNDI Connection Factory object. - * Get a JNDI Connection Factory object. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiConnectionFactoryResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiConnectionFactoryResponse getMsgVpnJndiConnectionFactory(String msgVpnName, String connectionFactoryName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnJndiConnectionFactoryWithHttpInfo(msgVpnName, connectionFactoryName, opaquePassword, select).getBody(); - } - - /** - * Get a JNDI Connection Factory object. - * Get a JNDI Connection Factory object. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiConnectionFactoryResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiConnectionFactoryWithHttpInfo(String msgVpnName, String connectionFactoryName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'connectionFactoryName' is set - if (connectionFactoryName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'connectionFactoryName' when calling getMsgVpnJndiConnectionFactory"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("connectionFactoryName", connectionFactoryName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a JNDI Queue object. - * Get a JNDI Queue object. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiQueueResponse getMsgVpnJndiQueue(String msgVpnName, String queueName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnJndiQueueWithHttpInfo(msgVpnName, queueName, opaquePassword, select).getBody(); - } - - /** - * Get a JNDI Queue object. - * Get a JNDI Queue object. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiQueueWithHttpInfo(String msgVpnName, String queueName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling getMsgVpnJndiQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues/{queueName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of JNDI Queue objects. - * Get a list of JNDI Queue objects. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Queue objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiQueuesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiQueuesResponse getMsgVpnJndiQueues(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnJndiQueuesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of JNDI Queue objects. - * Get a list of JNDI Queue objects. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Queue objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiQueuesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiQueuesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiQueues"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a JNDI Topic object. - * Get a JNDI Topic object. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiTopicResponse getMsgVpnJndiTopic(String msgVpnName, String topicName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnJndiTopicWithHttpInfo(msgVpnName, topicName, opaquePassword, select).getBody(); - } - - /** - * Get a JNDI Topic object. - * Get a JNDI Topic object. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiTopicWithHttpInfo(String msgVpnName, String topicName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiTopic"); - } - - // verify the required parameter 'topicName' is set - if (topicName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicName' when calling getMsgVpnJndiTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicName", topicName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics/{topicName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of JNDI Topic objects. - * Get a list of JNDI Topic objects. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiTopicsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiTopicsResponse getMsgVpnJndiTopics(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnJndiTopicsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of JNDI Topic objects. - * Get a list of JNDI Topic objects. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiTopicsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiTopicsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiTopics"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an MQTT Retain Cache object. - * Get an MQTT Retain Cache object. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttRetainCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttRetainCacheResponse getMsgVpnMqttRetainCache(String msgVpnName, String cacheName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnMqttRetainCacheWithHttpInfo(msgVpnName, cacheName, opaquePassword, select).getBody(); - } - - /** - * Get an MQTT Retain Cache object. - * Get an MQTT Retain Cache object. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttRetainCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttRetainCacheWithHttpInfo(String msgVpnName, String cacheName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnMqttRetainCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of MQTT Retain Cache objects. - * Get a list of MQTT Retain Cache objects. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of MQTT Retain Cache objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttRetainCachesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttRetainCachesResponse getMsgVpnMqttRetainCaches(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnMqttRetainCachesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of MQTT Retain Cache objects. - * Get a list of MQTT Retain Cache objects. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of MQTT Retain Cache objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttRetainCachesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttRetainCachesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttRetainCaches"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an MQTT Session object. - * Get an MQTT Session object. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionResponse getMsgVpnMqttSession(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String opaquePassword, List select) throws RestClientException { - return getMsgVpnMqttSessionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, opaquePassword, select).getBody(); - } - - /** - * Get an MQTT Session object. - * Get an MQTT Session object. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttSessionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling getMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling getMsgVpnMqttSession"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Subscription object. - * Get a Subscription object. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionSubscriptionResponse getMsgVpnMqttSessionSubscription(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnMqttSessionSubscriptionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Subscription object. - * Get a Subscription object. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttSessionSubscriptionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling getMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling getMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling getMsgVpnMqttSessionSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Subscription objects. - * Get a list of Subscription objects. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionSubscriptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionSubscriptionsResponse getMsgVpnMqttSessionSubscriptions(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnMqttSessionSubscriptionsWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Subscription objects. - * Get a list of Subscription objects. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionSubscriptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttSessionSubscriptionsWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttSessionSubscriptions"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling getMsgVpnMqttSessionSubscriptions"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling getMsgVpnMqttSessionSubscriptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of MQTT Session objects. - * Get a list of MQTT Session objects. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of MQTT Session objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionsResponse getMsgVpnMqttSessions(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnMqttSessionsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of MQTT Session objects. - * Get a list of MQTT Session objects. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of MQTT Session objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttSessionsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttSessions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Queue object. - * Get a Queue object. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueResponse getMsgVpnQueue(String msgVpnName, String queueName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnQueueWithHttpInfo(msgVpnName, queueName, opaquePassword, select).getBody(); - } - - /** - * Get a Queue object. - * Get a Queue object. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueueWithHttpInfo(String msgVpnName, String queueName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling getMsgVpnQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Queue Subscription object. - * Get a Queue Subscription object. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param subscriptionTopic The topic of the Subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueSubscriptionResponse getMsgVpnQueueSubscription(String msgVpnName, String queueName, String subscriptionTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnQueueSubscriptionWithHttpInfo(msgVpnName, queueName, subscriptionTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Queue Subscription object. - * Get a Queue Subscription object. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param subscriptionTopic The topic of the Subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueueSubscriptionWithHttpInfo(String msgVpnName, String queueName, String subscriptionTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueueSubscription"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling getMsgVpnQueueSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling getMsgVpnQueueSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Queue Subscription objects. - * Get a list of Queue Subscription objects. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueSubscriptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueSubscriptionsResponse getMsgVpnQueueSubscriptions(String msgVpnName, String queueName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnQueueSubscriptionsWithHttpInfo(msgVpnName, queueName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Queue Subscription objects. - * Get a list of Queue Subscription objects. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueSubscriptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueueSubscriptionsWithHttpInfo(String msgVpnName, String queueName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueueSubscriptions"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling getMsgVpnQueueSubscriptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Queue Template object. - * Get a Queue Template object. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueTemplateResponse getMsgVpnQueueTemplate(String msgVpnName, String queueTemplateName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnQueueTemplateWithHttpInfo(msgVpnName, queueTemplateName, opaquePassword, select).getBody(); - } - - /** - * Get a Queue Template object. - * Get a Queue Template object. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueueTemplateWithHttpInfo(String msgVpnName, String queueTemplateName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueueTemplate"); - } - - // verify the required parameter 'queueTemplateName' is set - if (queueTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueTemplateName' when calling getMsgVpnQueueTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueTemplateName", queueTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Queue Template objects. - * Get a list of Queue Template objects. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Queue Template objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueTemplatesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueTemplatesResponse getMsgVpnQueueTemplates(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnQueueTemplatesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Queue Template objects. - * Get a list of Queue Template objects. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Queue Template objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueTemplatesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueueTemplatesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueueTemplates"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Queue objects. - * Get a list of Queue objects. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueuesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueuesResponse getMsgVpnQueues(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnQueuesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Queue objects. - * Get a list of Queue objects. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueuesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueuesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueues"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Replay Log object. - * Get a Replay Log object. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogResponse getMsgVpnReplayLog(String msgVpnName, String replayLogName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnReplayLogWithHttpInfo(msgVpnName, replayLogName, opaquePassword, select).getBody(); - } - - /** - * Get a Replay Log object. - * Get a Replay Log object. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplayLogWithHttpInfo(String msgVpnName, String replayLogName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplayLog"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling getMsgVpnReplayLog"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Topic Filter Subscription object. - * Get a Topic Filter Subscription object. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Topic Filter Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param topicFilterSubscription The topic of the Subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogTopicFilterSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogTopicFilterSubscriptionResponse getMsgVpnReplayLogTopicFilterSubscription(String msgVpnName, String replayLogName, String topicFilterSubscription, String opaquePassword, List select) throws RestClientException { - return getMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(msgVpnName, replayLogName, topicFilterSubscription, opaquePassword, select).getBody(); - } - - /** - * Get a Topic Filter Subscription object. - * Get a Topic Filter Subscription object. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Topic Filter Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param topicFilterSubscription The topic of the Subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogTopicFilterSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(String msgVpnName, String replayLogName, String topicFilterSubscription, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling getMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'topicFilterSubscription' is set - if (topicFilterSubscription == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicFilterSubscription' when calling getMsgVpnReplayLogTopicFilterSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - uriVariables.put("topicFilterSubscription", topicFilterSubscription); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Topic Filter Subscription objects. - * Get a list of Topic Filter Subscription objects. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Topic Filter Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogTopicFilterSubscriptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogTopicFilterSubscriptionsResponse getMsgVpnReplayLogTopicFilterSubscriptions(String msgVpnName, String replayLogName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnReplayLogTopicFilterSubscriptionsWithHttpInfo(msgVpnName, replayLogName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Topic Filter Subscription objects. - * Get a list of Topic Filter Subscription objects. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Topic Filter Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogTopicFilterSubscriptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplayLogTopicFilterSubscriptionsWithHttpInfo(String msgVpnName, String replayLogName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplayLogTopicFilterSubscriptions"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling getMsgVpnReplayLogTopicFilterSubscriptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Replay Log objects. - * Get a list of Replay Log objects. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - *

200 - The list of Replay Log objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogsResponse getMsgVpnReplayLogs(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnReplayLogsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Replay Log objects. - * Get a list of Replay Log objects. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - *

200 - The list of Replay Log objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplayLogsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplayLogs"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Replicated Topic object. - * Get a Replicated Topic object. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplicatedTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplicatedTopicResponse getMsgVpnReplicatedTopic(String msgVpnName, String replicatedTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnReplicatedTopicWithHttpInfo(msgVpnName, replicatedTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Replicated Topic object. - * Get a Replicated Topic object. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplicatedTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplicatedTopicWithHttpInfo(String msgVpnName, String replicatedTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'replicatedTopic' is set - if (replicatedTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replicatedTopic' when calling getMsgVpnReplicatedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replicatedTopic", replicatedTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Replicated Topic objects. - * Get a list of Replicated Topic objects. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Replicated Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplicatedTopicsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplicatedTopicsResponse getMsgVpnReplicatedTopics(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnReplicatedTopicsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Replicated Topic objects. - * Get a list of Replicated Topic objects. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Replicated Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplicatedTopicsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplicatedTopicsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplicatedTopics"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a REST Delivery Point object. - * Get a REST Delivery Point object. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointResponse getMsgVpnRestDeliveryPoint(String msgVpnName, String restDeliveryPointName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointWithHttpInfo(msgVpnName, restDeliveryPointName, opaquePassword, select).getBody(); - } - - /** - * Get a REST Delivery Point object. - * Get a REST Delivery Point object. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointWithHttpInfo(String msgVpnName, String restDeliveryPointName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Queue Binding object. - * Get a Queue Binding object. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingResponse getMsgVpnRestDeliveryPointQueueBinding(String msgVpnName, String restDeliveryPointName, String queueBindingName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, opaquePassword, select).getBody(); - } - - /** - * Get a Queue Binding object. - * Get a Queue Binding object. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling getMsgVpnRestDeliveryPointQueueBinding"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Request Header object. - * Get a Request Header object. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse getMsgVpnRestDeliveryPointQueueBindingRequestHeader(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, headerName, opaquePassword, select).getBody(); - } - - /** - * Get a Request Header object. - * Get a Request Header object. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'headerName' is set - if (headerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'headerName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - uriVariables.put("headerName", headerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Request Header objects. - * Get a list of Request Header objects. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - *

200 - The list of Request Header objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse getMsgVpnRestDeliveryPointQueueBindingRequestHeaders(String msgVpnName, String restDeliveryPointName, String queueBindingName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointQueueBindingRequestHeadersWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Request Header objects. - * Get a list of Request Header objects. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - *

200 - The list of Request Header objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointQueueBindingRequestHeadersWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeaders"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeaders"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeaders"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Queue Binding objects. - * Get a list of Queue Binding objects. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue Binding objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingsResponse getMsgVpnRestDeliveryPointQueueBindings(String msgVpnName, String restDeliveryPointName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointQueueBindingsWithHttpInfo(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Queue Binding objects. - * Get a list of Queue Binding objects. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue Binding objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointQueueBindingsWithHttpInfo(String msgVpnName, String restDeliveryPointName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointQueueBindings"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointQueueBindings"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a REST Consumer object. - * Get a REST Consumer object. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerResponse getMsgVpnRestDeliveryPointRestConsumer(String msgVpnName, String restDeliveryPointName, String restConsumerName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, select).getBody(); - } - - /** - * Get a REST Consumer object. - * Get a REST Consumer object. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling getMsgVpnRestDeliveryPointRestConsumer"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Claim object. - * Get a Claim object. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - *

200 - The Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param oauthJwtClaimName The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(String msgVpnName, String restDeliveryPointName, String restConsumerName, String oauthJwtClaimName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName, opaquePassword, select).getBody(); - } - - /** - * Get a Claim object. - * Get a Claim object. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - *

200 - The Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param oauthJwtClaimName The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String oauthJwtClaimName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'oauthJwtClaimName' is set - if (oauthJwtClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthJwtClaimName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - uriVariables.put("oauthJwtClaimName", oauthJwtClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Claim objects. - * Get a list of Claim objects. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - *

200 - The list of Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims(String msgVpnName, String restDeliveryPointName, String restConsumerName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Claim objects. - * Get a list of Claim objects. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - *

200 - The list of Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Trusted Common Name object. - * Get a Trusted Common Name object. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(String msgVpnName, String restDeliveryPointName, String restConsumerName, String tlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName, opaquePassword, select).getBody(); - } - - /** - * Get a Trusted Common Name object. - * Get a Trusted Common Name object. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String tlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'tlsTrustedCommonName' is set - if (tlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'tlsTrustedCommonName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - uriVariables.put("tlsTrustedCommonName", tlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Trusted Common Name objects. - * Get a list of Trusted Common Name objects. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The list of Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames(String msgVpnName, String restDeliveryPointName, String restConsumerName, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Trusted Common Name objects. - * Get a list of Trusted Common Name objects. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The list of Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of REST Consumer objects. - * Get a list of REST Consumer objects. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of REST Consumer objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumersResponse getMsgVpnRestDeliveryPointRestConsumers(String msgVpnName, String restDeliveryPointName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumersWithHttpInfo(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of REST Consumer objects. - * Get a list of REST Consumer objects. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of REST Consumer objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumersWithHttpInfo(String msgVpnName, String restDeliveryPointName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumers"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumers"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of REST Delivery Point objects. - * Get a list of REST Delivery Point objects. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of REST Delivery Point objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointsResponse getMsgVpnRestDeliveryPoints(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of REST Delivery Point objects. - * Get a list of REST Delivery Point objects. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of REST Delivery Point objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPoints"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Sequenced Topic object. - * Get a Sequenced Topic object. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| sequencedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Sequenced Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param sequencedTopic Topic for applying sequence numbers. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnSequencedTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnSequencedTopicResponse getMsgVpnSequencedTopic(String msgVpnName, String sequencedTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnSequencedTopicWithHttpInfo(msgVpnName, sequencedTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Sequenced Topic object. - * Get a Sequenced Topic object. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| sequencedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Sequenced Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param sequencedTopic Topic for applying sequence numbers. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnSequencedTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnSequencedTopicWithHttpInfo(String msgVpnName, String sequencedTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnSequencedTopic"); - } - - // verify the required parameter 'sequencedTopic' is set - if (sequencedTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'sequencedTopic' when calling getMsgVpnSequencedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("sequencedTopic", sequencedTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Sequenced Topic objects. - * Get a list of Sequenced Topic objects. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| sequencedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Sequenced Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnSequencedTopicsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnSequencedTopicsResponse getMsgVpnSequencedTopics(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnSequencedTopicsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Sequenced Topic objects. - * Get a list of Sequenced Topic objects. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| sequencedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Sequenced Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnSequencedTopicsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnSequencedTopicsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnSequencedTopics"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/sequencedTopics", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Topic Endpoint object. - * Get a Topic Endpoint object. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointResponse getMsgVpnTopicEndpoint(String msgVpnName, String topicEndpointName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnTopicEndpointWithHttpInfo(msgVpnName, topicEndpointName, opaquePassword, select).getBody(); - } - - /** - * Get a Topic Endpoint object. - * Get a Topic Endpoint object. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnTopicEndpointWithHttpInfo(String msgVpnName, String topicEndpointName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'topicEndpointName' is set - if (topicEndpointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointName' when calling getMsgVpnTopicEndpoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointName", topicEndpointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Topic Endpoint Template object. - * Get a Topic Endpoint Template object. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointTemplateResponse getMsgVpnTopicEndpointTemplate(String msgVpnName, String topicEndpointTemplateName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnTopicEndpointTemplateWithHttpInfo(msgVpnName, topicEndpointTemplateName, opaquePassword, select).getBody(); - } - - /** - * Get a Topic Endpoint Template object. - * Get a Topic Endpoint Template object. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnTopicEndpointTemplateWithHttpInfo(String msgVpnName, String topicEndpointTemplateName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'topicEndpointTemplateName' is set - if (topicEndpointTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointTemplateName' when calling getMsgVpnTopicEndpointTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointTemplateName", topicEndpointTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Topic Endpoint Template objects. - * Get a list of Topic Endpoint Template objects. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Topic Endpoint Template objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointTemplatesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointTemplatesResponse getMsgVpnTopicEndpointTemplates(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnTopicEndpointTemplatesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Topic Endpoint Template objects. - * Get a list of Topic Endpoint Template objects. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Topic Endpoint Template objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointTemplatesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnTopicEndpointTemplatesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnTopicEndpointTemplates"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Topic Endpoint objects. - * Get a list of Topic Endpoint objects. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Topic Endpoint objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointsResponse getMsgVpnTopicEndpoints(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnTopicEndpointsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Topic Endpoint objects. - * Get a list of Topic Endpoint objects. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Topic Endpoint objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnTopicEndpointsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnTopicEndpoints"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Message VPN objects. - * Get a list of Message VPN objects. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| distributedCacheManagementEnabled|||x| msgVpnName|x||| replicationBridgeAuthenticationBasicPassword||x||x replicationBridgeAuthenticationClientCertContent||x||x replicationBridgeAuthenticationClientCertPassword||x|| replicationEnabledQueueBehavior||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Message VPN objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnsResponse getMsgVpns(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnsWithHttpInfo(count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Message VPN objects. - * Get a list of Message VPN objects. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| distributedCacheManagementEnabled|||x| msgVpnName|x||| replicationBridgeAuthenticationBasicPassword||x||x replicationBridgeAuthenticationClientCertContent||x||x replicationBridgeAuthenticationClientCertPassword||x|| replicationEnabledQueueBehavior||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Message VPN objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnsWithHttpInfo(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an OAuth Profile object. - * Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The OAuth Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileResponse getOauthProfile(String oauthProfileName, String opaquePassword, List select) throws RestClientException { - return getOauthProfileWithHttpInfo(oauthProfileName, opaquePassword, select).getBody(); - } - - /** - * Get an OAuth Profile object. - * Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The OAuth Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileWithHttpInfo(String oauthProfileName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Group Access Level object. - * Get a Group Access Level object. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Group Access Level object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupResponse getOauthProfileAccessLevelGroup(String oauthProfileName, String groupName, String opaquePassword, List select) throws RestClientException { - return getOauthProfileAccessLevelGroupWithHttpInfo(oauthProfileName, groupName, opaquePassword, select).getBody(); - } - - /** - * Get a Group Access Level object. - * Get a Group Access Level object. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Group Access Level object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileAccessLevelGroupWithHttpInfo(String oauthProfileName, String groupName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileAccessLevelGroup"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling getOauthProfileAccessLevelGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Message VPN Access-Level Exception object. - * Get a Message VPN Access-Level Exception object. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse getOauthProfileAccessLevelGroupMsgVpnAccessLevelException(String oauthProfileName, String groupName, String msgVpnName, String opaquePassword, List select) throws RestClientException { - return getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, groupName, msgVpnName, opaquePassword, select).getBody(); - } - - /** - * Get a Message VPN Access-Level Exception object. - * Get a Message VPN Access-Level Exception object. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String groupName, String msgVpnName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling getOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Message VPN Access-Level Exception objects. - * Get a list of Message VPN Access-Level Exception objects. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Message VPN Access-Level Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions(String oauthProfileName, String groupName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsWithHttpInfo(oauthProfileName, groupName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Message VPN Access-Level Exception objects. - * Get a list of Message VPN Access-Level Exception objects. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Message VPN Access-Level Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsWithHttpInfo(String oauthProfileName, String groupName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Group Access Level objects. - * Get a list of Group Access Level objects. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Group Access Level objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupsResponse getOauthProfileAccessLevelGroups(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getOauthProfileAccessLevelGroupsWithHttpInfo(oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Group Access Level objects. - * Get a list of Group Access Level objects. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Group Access Level objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileAccessLevelGroupsWithHttpInfo(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileAccessLevelGroups"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an Allowed Host Value object. - * Get an Allowed Host Value object. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowedHost|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Allowed Host Value object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param allowedHost An allowed value for the Host header. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientAllowedHostResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientAllowedHostResponse getOauthProfileClientAllowedHost(String oauthProfileName, String allowedHost, String opaquePassword, List select) throws RestClientException { - return getOauthProfileClientAllowedHostWithHttpInfo(oauthProfileName, allowedHost, opaquePassword, select).getBody(); - } - - /** - * Get an Allowed Host Value object. - * Get an Allowed Host Value object. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowedHost|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Allowed Host Value object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param allowedHost An allowed value for the Host header. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientAllowedHostResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileClientAllowedHostWithHttpInfo(String oauthProfileName, String allowedHost, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileClientAllowedHost"); - } - - // verify the required parameter 'allowedHost' is set - if (allowedHost == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'allowedHost' when calling getOauthProfileClientAllowedHost"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("allowedHost", allowedHost); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Allowed Host Value objects. - * Get a list of Allowed Host Value objects. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowedHost|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Allowed Host Value objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientAllowedHostsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientAllowedHostsResponse getOauthProfileClientAllowedHosts(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getOauthProfileClientAllowedHostsWithHttpInfo(oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Allowed Host Value objects. - * Get a list of Allowed Host Value objects. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowedHost|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Allowed Host Value objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientAllowedHostsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileClientAllowedHostsWithHttpInfo(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileClientAllowedHosts"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAllowedHosts", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an Authorization Parameter object. - * Get an Authorization Parameter object. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationParameterName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Authorization Parameter object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param authorizationParameterName The name of the authorization parameter. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientAuthorizationParameterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientAuthorizationParameterResponse getOauthProfileClientAuthorizationParameter(String oauthProfileName, String authorizationParameterName, String opaquePassword, List select) throws RestClientException { - return getOauthProfileClientAuthorizationParameterWithHttpInfo(oauthProfileName, authorizationParameterName, opaquePassword, select).getBody(); - } - - /** - * Get an Authorization Parameter object. - * Get an Authorization Parameter object. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationParameterName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Authorization Parameter object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param authorizationParameterName The name of the authorization parameter. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientAuthorizationParameterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileClientAuthorizationParameterWithHttpInfo(String oauthProfileName, String authorizationParameterName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileClientAuthorizationParameter"); - } - - // verify the required parameter 'authorizationParameterName' is set - if (authorizationParameterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationParameterName' when calling getOauthProfileClientAuthorizationParameter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("authorizationParameterName", authorizationParameterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Authorization Parameter objects. - * Get a list of Authorization Parameter objects. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationParameterName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Authorization Parameter objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientAuthorizationParametersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientAuthorizationParametersResponse getOauthProfileClientAuthorizationParameters(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getOauthProfileClientAuthorizationParametersWithHttpInfo(oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Authorization Parameter objects. - * Get a list of Authorization Parameter objects. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationParameterName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Authorization Parameter objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientAuthorizationParametersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileClientAuthorizationParametersWithHttpInfo(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileClientAuthorizationParameters"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientRequiredClaimResponse getOauthProfileClientRequiredClaim(String oauthProfileName, String clientRequiredClaimName, String opaquePassword, List select) throws RestClientException { - return getOauthProfileClientRequiredClaimWithHttpInfo(oauthProfileName, clientRequiredClaimName, opaquePassword, select).getBody(); - } - - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileClientRequiredClaimWithHttpInfo(String oauthProfileName, String clientRequiredClaimName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'clientRequiredClaimName' is set - if (clientRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientRequiredClaimName' when calling getOauthProfileClientRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("clientRequiredClaimName", clientRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientRequiredClaimsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientRequiredClaimsResponse getOauthProfileClientRequiredClaims(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getOauthProfileClientRequiredClaimsWithHttpInfo(oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientRequiredClaimsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileClientRequiredClaimsWithHttpInfo(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileClientRequiredClaims"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientRequiredClaims", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Message VPN Access-Level Exception object. - * Get a Message VPN Access-Level Exception object. Default message VPN access-level exceptions. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileDefaultMsgVpnAccessLevelExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileDefaultMsgVpnAccessLevelExceptionResponse getOauthProfileDefaultMsgVpnAccessLevelException(String oauthProfileName, String msgVpnName, String opaquePassword, List select) throws RestClientException { - return getOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, msgVpnName, opaquePassword, select).getBody(); - } - - /** - * Get a Message VPN Access-Level Exception object. - * Get a Message VPN Access-Level Exception object. Default message VPN access-level exceptions. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileDefaultMsgVpnAccessLevelExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String msgVpnName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Message VPN Access-Level Exception objects. - * Get a list of Message VPN Access-Level Exception objects. Default message VPN access-level exceptions. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Message VPN Access-Level Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse getOauthProfileDefaultMsgVpnAccessLevelExceptions(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getOauthProfileDefaultMsgVpnAccessLevelExceptionsWithHttpInfo(oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Message VPN Access-Level Exception objects. - * Get a list of Message VPN Access-Level Exception objects. Default message VPN access-level exceptions. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Message VPN Access-Level Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileDefaultMsgVpnAccessLevelExceptionsWithHttpInfo(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileDefaultMsgVpnAccessLevelExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileResourceServerRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileResourceServerRequiredClaimResponse getOauthProfileResourceServerRequiredClaim(String oauthProfileName, String resourceServerRequiredClaimName, String opaquePassword, List select) throws RestClientException { - return getOauthProfileResourceServerRequiredClaimWithHttpInfo(oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select).getBody(); - } - - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileResourceServerRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileResourceServerRequiredClaimWithHttpInfo(String oauthProfileName, String resourceServerRequiredClaimName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'resourceServerRequiredClaimName' is set - if (resourceServerRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'resourceServerRequiredClaimName' when calling getOauthProfileResourceServerRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("resourceServerRequiredClaimName", resourceServerRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileResourceServerRequiredClaimsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileResourceServerRequiredClaimsResponse getOauthProfileResourceServerRequiredClaims(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getOauthProfileResourceServerRequiredClaimsWithHttpInfo(oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileResourceServerRequiredClaimsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileResourceServerRequiredClaimsWithHttpInfo(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileResourceServerRequiredClaims"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of OAuth Profile objects. - * Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of OAuth Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfilesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfilesResponse getOauthProfiles(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getOauthProfilesWithHttpInfo(count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of OAuth Profile objects. - * Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of OAuth Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfilesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfilesWithHttpInfo(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a System Information object. - * Get a System Information object. The System Information object provides metadata about the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: platform|||x| sempVersion|||x| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been deprecated since 2.2. /systemInformation was replaced by /about/api. - *

200 - The System Information object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return SystemInformationResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SystemInformationResponse getSystemInformation(String opaquePassword, List select) throws RestClientException { - return getSystemInformationWithHttpInfo(opaquePassword, select).getBody(); - } - - /** - * Get a System Information object. - * Get a System Information object. The System Information object provides metadata about the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: platform|||x| sempVersion|||x| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been deprecated since 2.2. /systemInformation was replaced by /about/api. - *

200 - The System Information object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<SystemInformationResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getSystemInformationWithHttpInfo(String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/systemInformation", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Virtual Hostname object. - * Get a Virtual Hostname object. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: virtualHostname|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.17. - *

200 - The Virtual Hostname object's attributes, and the request metadata. - *

0 - The error response. - * @param virtualHostname The virtual hostname. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return VirtualHostnameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public VirtualHostnameResponse getVirtualHostname(String virtualHostname, String opaquePassword, List select) throws RestClientException { - return getVirtualHostnameWithHttpInfo(virtualHostname, opaquePassword, select).getBody(); - } - - /** - * Get a Virtual Hostname object. - * Get a Virtual Hostname object. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: virtualHostname|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.17. - *

200 - The Virtual Hostname object's attributes, and the request metadata. - *

0 - The error response. - * @param virtualHostname The virtual hostname. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<VirtualHostnameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getVirtualHostnameWithHttpInfo(String virtualHostname, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'virtualHostname' is set - if (virtualHostname == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'virtualHostname' when calling getVirtualHostname"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("virtualHostname", virtualHostname); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/virtualHostnames/{virtualHostname}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Virtual Hostname objects. - * Get a list of Virtual Hostname objects. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: virtualHostname|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.17. - *

200 - The list of Virtual Hostname objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return VirtualHostnamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public VirtualHostnamesResponse getVirtualHostnames(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getVirtualHostnamesWithHttpInfo(count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Virtual Hostname objects. - * Get a list of Virtual Hostname objects. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: virtualHostname|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.17. - *

200 - The list of Virtual Hostname objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<VirtualHostnamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getVirtualHostnamesWithHttpInfo(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/virtualHostnames", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Certificate Authority object. - * Replace a Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||x| certContent||||||x| crlDayList||||||x| crlTimeList||||||x| crlUrl|||||x|x| ocspNonResponderCertEnabled||||||x| ocspOverrideUrl||||||x| ocspTimeout||||||x| revocationCheckEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The Certificate Authority object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return CertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public CertAuthorityResponse replaceCertAuthority(String certAuthorityName, CertAuthority body, String opaquePassword, List select) throws RestClientException { - return replaceCertAuthorityWithHttpInfo(certAuthorityName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Certificate Authority object. - * Replace a Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||x| certContent||||||x| crlDayList||||||x| crlTimeList||||||x| crlUrl|||||x|x| ocspNonResponderCertEnabled||||||x| ocspOverrideUrl||||||x| ocspTimeout||||||x| revocationCheckEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The Certificate Authority object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<CertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity replaceCertAuthorityWithHttpInfo(String certAuthorityName, CertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling replaceCertAuthority"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities/{certAuthorityName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Client Certificate Authority object. - * Replace a Client Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||| crlUrl|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Client Certificate Authority object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Client Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ClientCertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ClientCertAuthorityResponse replaceClientCertAuthority(String certAuthorityName, ClientCertAuthority body, String opaquePassword, List select) throws RestClientException { - return replaceClientCertAuthorityWithHttpInfo(certAuthorityName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Client Certificate Authority object. - * Replace a Client Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||| crlUrl|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Client Certificate Authority object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Client Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<ClientCertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceClientCertAuthorityWithHttpInfo(String certAuthorityName, ClientCertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling replaceClientCertAuthority"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceClientCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities/{certAuthorityName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Cluster object. - * Replace a Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword||||x|x||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| directOnlyEnabled||x||||| dmrClusterName|x||x|||| nodeName|||x|||| tlsServerCertEnforceTrustedCommonNameEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cluster object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param body The Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterResponse replaceDmrCluster(String dmrClusterName, DmrCluster body, String opaquePassword, List select) throws RestClientException { - return replaceDmrClusterWithHttpInfo(dmrClusterName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Cluster object. - * Replace a Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword||||x|x||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| directOnlyEnabled||x||||| dmrClusterName|x||x|||| nodeName|||x|||| tlsServerCertEnforceTrustedCommonNameEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cluster object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param body The Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceDmrClusterWithHttpInfo(String dmrClusterName, DmrCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling replaceDmrCluster"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceDmrCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Certificate Matching Rule object. - * Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- dmrClusterName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleResponse replaceDmrClusterCertMatchingRule(String dmrClusterName, String ruleName, DmrClusterCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - return replaceDmrClusterCertMatchingRuleWithHttpInfo(dmrClusterName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Certificate Matching Rule object. - * Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- dmrClusterName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceDmrClusterCertMatchingRuleWithHttpInfo(String dmrClusterName, String ruleName, DmrClusterCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling replaceDmrClusterCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling replaceDmrClusterCertMatchingRule"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceDmrClusterCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Certificate Matching Rule Attribute Filter object. - * Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- dmrClusterName|x||x|||| filterName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleAttributeFilterResponse replaceDmrClusterCertMatchingRuleAttributeFilter(String dmrClusterName, String ruleName, String filterName, DmrClusterCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - return replaceDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(dmrClusterName, ruleName, filterName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Certificate Matching Rule Attribute Filter object. - * Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- dmrClusterName|x||x|||| filterName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(String dmrClusterName, String ruleName, String filterName, DmrClusterCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling replaceDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling replaceDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling replaceDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceDmrClusterCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Link object. - * Replace a Link object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword||||x|x||x authenticationScheme|||||x|| dmrClusterName|x||x|||| egressFlowWindowSize|||||x|| initiator|||||x|| remoteNodeName|x||x|||| span|||||x|| transportCompressedEnabled|||||x|| transportTlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Link object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Link object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkResponse replaceDmrClusterLink(String dmrClusterName, String remoteNodeName, DmrClusterLink body, String opaquePassword, List select) throws RestClientException { - return replaceDmrClusterLinkWithHttpInfo(dmrClusterName, remoteNodeName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Link object. - * Replace a Link object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword||||x|x||x authenticationScheme|||||x|| dmrClusterName|x||x|||| egressFlowWindowSize|||||x|| initiator|||||x|| remoteNodeName|x||x|||| span|||||x|| transportCompressedEnabled|||||x|| transportTlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Link object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Link object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceDmrClusterLinkWithHttpInfo(String dmrClusterName, String remoteNodeName, DmrClusterLink body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling replaceDmrClusterLink"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling replaceDmrClusterLink"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceDmrClusterLink"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Domain Certificate Authority object. - * Replace a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Certificate Authorities trusted for domain verification. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Domain Certificate Authority object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Domain Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DomainCertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DomainCertAuthorityResponse replaceDomainCertAuthority(String certAuthorityName, DomainCertAuthority body, String opaquePassword, List select) throws RestClientException { - return replaceDomainCertAuthorityWithHttpInfo(certAuthorityName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Domain Certificate Authority object. - * Replace a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Certificate Authorities trusted for domain verification. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Domain Certificate Authority object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Domain Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DomainCertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceDomainCertAuthorityWithHttpInfo(String certAuthorityName, DomainCertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling replaceDomainCertAuthority"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceDomainCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/domainCertAuthorities/{certAuthorityName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Message VPN object. - * Replace a Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationOauthDefaultProviderName||||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled||||||x| distributedCacheManagementEnabled||||||x| msgVpnName|x||x|||| replicationBridgeAuthenticationBasicPassword||||x|||x replicationBridgeAuthenticationClientCertContent||||x|||x replicationBridgeAuthenticationClientCertPassword||||x||| replicationEnabledQueueBehavior||||x||| restTlsServerCertEnforceTrustedCommonNameEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: alias|global/read-write authenticationBasicEnabled|global/read-write authenticationBasicProfileName|global/read-write authenticationBasicRadiusDomain|global/read-write authenticationBasicType|global/read-write authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write authenticationClientCertCertificateMatchingRulesEnabled|global/read-write authenticationClientCertEnabled|global/read-write authenticationClientCertMaxChainDepth|global/read-write authenticationClientCertRevocationCheckMode|global/read-write authenticationClientCertUsernameSource|global/read-write authenticationClientCertValidateDateEnabled|global/read-write authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write authenticationKerberosEnabled|global/read-write authenticationOauthEnabled|global/read-write bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write bridgingTlsServerCertMaxChainDepth|global/read-write bridgingTlsServerCertValidateDateEnabled|global/read-write bridgingTlsServerCertValidateNameEnabled|global/read-write dmrEnabled|global/read-write exportSubscriptionsEnabled|global/read-write maxConnectionCount|global/read-write maxEgressFlowCount|global/read-write maxEndpointCount|global/read-write maxIngressFlowCount|global/read-write maxMsgSpoolUsage|global/read-write maxSubscriptionCount|global/read-write maxTransactedSessionCount|global/read-write maxTransactionCount|global/read-write mqttRetainMaxMemory|global/read-write replicationBridgeAuthenticationBasicClientUsername|global/read-write replicationBridgeAuthenticationBasicPassword|global/read-write replicationBridgeAuthenticationClientCertContent|global/read-write replicationBridgeAuthenticationClientCertPassword|global/read-write replicationBridgeAuthenticationScheme|global/read-write replicationBridgeCompressedDataEnabled|global/read-write replicationBridgeEgressFlowWindowSize|global/read-write replicationBridgeRetryDelay|global/read-write replicationBridgeTlsEnabled|global/read-write replicationBridgeUnidirectionalClientProfileName|global/read-write replicationEnabled|global/read-write replicationEnabledQueueBehavior|global/read-write replicationQueueMaxMsgSpoolUsage|global/read-write replicationRole|global/read-write restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write restTlsServerCertMaxChainDepth|global/read-write restTlsServerCertValidateDateEnabled|global/read-write restTlsServerCertValidateNameEnabled|global/read-write sempOverMsgBusAdminClientEnabled|global/read-write sempOverMsgBusAdminDistributedCacheEnabled|global/read-write sempOverMsgBusAdminEnabled|global/read-write sempOverMsgBusEnabled|global/read-write sempOverMsgBusShowEnabled|global/read-write serviceAmqpMaxConnectionCount|global/read-write serviceAmqpPlainTextListenPort|global/read-write serviceAmqpTlsListenPort|global/read-write serviceMqttMaxConnectionCount|global/read-write serviceMqttPlainTextListenPort|global/read-write serviceMqttTlsListenPort|global/read-write serviceMqttTlsWebSocketListenPort|global/read-write serviceMqttWebSocketListenPort|global/read-write serviceRestIncomingMaxConnectionCount|global/read-write serviceRestIncomingPlainTextListenPort|global/read-write serviceRestIncomingTlsListenPort|global/read-write serviceRestOutgoingMaxConnectionCount|global/read-write serviceSmfMaxConnectionCount|global/read-write serviceWebMaxConnectionCount|global/read-write This has been available since 2.0. - *

200 - The Message VPN object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnResponse replaceMsgVpn(String msgVpnName, MsgVpn body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Message VPN object. - * Replace a Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationOauthDefaultProviderName||||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled||||||x| distributedCacheManagementEnabled||||||x| msgVpnName|x||x|||| replicationBridgeAuthenticationBasicPassword||||x|||x replicationBridgeAuthenticationClientCertContent||||x|||x replicationBridgeAuthenticationClientCertPassword||||x||| replicationEnabledQueueBehavior||||x||| restTlsServerCertEnforceTrustedCommonNameEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: alias|global/read-write authenticationBasicEnabled|global/read-write authenticationBasicProfileName|global/read-write authenticationBasicRadiusDomain|global/read-write authenticationBasicType|global/read-write authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write authenticationClientCertCertificateMatchingRulesEnabled|global/read-write authenticationClientCertEnabled|global/read-write authenticationClientCertMaxChainDepth|global/read-write authenticationClientCertRevocationCheckMode|global/read-write authenticationClientCertUsernameSource|global/read-write authenticationClientCertValidateDateEnabled|global/read-write authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write authenticationKerberosEnabled|global/read-write authenticationOauthEnabled|global/read-write bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write bridgingTlsServerCertMaxChainDepth|global/read-write bridgingTlsServerCertValidateDateEnabled|global/read-write bridgingTlsServerCertValidateNameEnabled|global/read-write dmrEnabled|global/read-write exportSubscriptionsEnabled|global/read-write maxConnectionCount|global/read-write maxEgressFlowCount|global/read-write maxEndpointCount|global/read-write maxIngressFlowCount|global/read-write maxMsgSpoolUsage|global/read-write maxSubscriptionCount|global/read-write maxTransactedSessionCount|global/read-write maxTransactionCount|global/read-write mqttRetainMaxMemory|global/read-write replicationBridgeAuthenticationBasicClientUsername|global/read-write replicationBridgeAuthenticationBasicPassword|global/read-write replicationBridgeAuthenticationClientCertContent|global/read-write replicationBridgeAuthenticationClientCertPassword|global/read-write replicationBridgeAuthenticationScheme|global/read-write replicationBridgeCompressedDataEnabled|global/read-write replicationBridgeEgressFlowWindowSize|global/read-write replicationBridgeRetryDelay|global/read-write replicationBridgeTlsEnabled|global/read-write replicationBridgeUnidirectionalClientProfileName|global/read-write replicationEnabled|global/read-write replicationEnabledQueueBehavior|global/read-write replicationQueueMaxMsgSpoolUsage|global/read-write replicationRole|global/read-write restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write restTlsServerCertMaxChainDepth|global/read-write restTlsServerCertValidateDateEnabled|global/read-write restTlsServerCertValidateNameEnabled|global/read-write sempOverMsgBusAdminClientEnabled|global/read-write sempOverMsgBusAdminDistributedCacheEnabled|global/read-write sempOverMsgBusAdminEnabled|global/read-write sempOverMsgBusEnabled|global/read-write sempOverMsgBusShowEnabled|global/read-write serviceAmqpMaxConnectionCount|global/read-write serviceAmqpPlainTextListenPort|global/read-write serviceAmqpTlsListenPort|global/read-write serviceMqttMaxConnectionCount|global/read-write serviceMqttPlainTextListenPort|global/read-write serviceMqttTlsListenPort|global/read-write serviceMqttTlsWebSocketListenPort|global/read-write serviceMqttWebSocketListenPort|global/read-write serviceRestIncomingMaxConnectionCount|global/read-write serviceRestIncomingPlainTextListenPort|global/read-write serviceRestIncomingTlsListenPort|global/read-write serviceRestOutgoingMaxConnectionCount|global/read-write serviceSmfMaxConnectionCount|global/read-write serviceWebMaxConnectionCount|global/read-write This has been available since 2.0. - *

200 - The Message VPN object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnWithHttpInfo(String msgVpnName, MsgVpn body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpn"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an ACL Profile object. - * Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileResponse replaceMsgVpnAclProfile(String msgVpnName, String aclProfileName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnAclProfileWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an ACL Profile object. - * Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnAclProfileWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnAclProfile"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling replaceMsgVpnAclProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnAclProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an OAuth Profile object. - * Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResponse replaceMsgVpnAuthenticationOauthProfile(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnAuthenticationOauthProfileWithHttpInfo(msgVpnName, oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an OAuth Profile object. - * Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnAuthenticationOauthProfileWithHttpInfo(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling replaceMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnAuthenticationOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an OAuth Provider object. - * Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- audienceClaimName||||||x| audienceClaimSource||||||x| audienceClaimValue||||||x| audienceValidationEnabled||||||x| authorizationGroupClaimName||||||x| authorizationGroupClaimSource||||||x| authorizationGroupEnabled||||||x| disconnectOnTokenExpirationEnabled||||||x| enabled||||||x| jwksRefreshInterval||||||x| jwksUri||||||x| msgVpnName|x||x|||x| oauthProviderName|x||x|||x| tokenIgnoreTimeLimitsEnabled||||||x| tokenIntrospectionParameterName||||||x| tokenIntrospectionPassword||||x||x|x tokenIntrospectionTimeout||||||x| tokenIntrospectionUri||||||x| tokenIntrospectionUsername||||||x| usernameClaimName||||||x| usernameClaimSource||||||x| usernameValidateEnabled||||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProviderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAuthenticationOauthProviderResponse replaceMsgVpnAuthenticationOauthProvider(String msgVpnName, String oauthProviderName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnAuthenticationOauthProviderWithHttpInfo(msgVpnName, oauthProviderName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an OAuth Provider object. - * Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- audienceClaimName||||||x| audienceClaimSource||||||x| audienceClaimValue||||||x| audienceValidationEnabled||||||x| authorizationGroupClaimName||||||x| authorizationGroupClaimSource||||||x| authorizationGroupEnabled||||||x| disconnectOnTokenExpirationEnabled||||||x| enabled||||||x| jwksRefreshInterval||||||x| jwksUri||||||x| msgVpnName|x||x|||x| oauthProviderName|x||x|||x| tokenIgnoreTimeLimitsEnabled||||||x| tokenIntrospectionParameterName||||||x| tokenIntrospectionPassword||||x||x|x tokenIntrospectionTimeout||||||x| tokenIntrospectionUri||||||x| tokenIntrospectionUsername||||||x| usernameClaimName||||||x| usernameClaimSource||||||x| usernameValidateEnabled||||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProviderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity replaceMsgVpnAuthenticationOauthProviderWithHttpInfo(String msgVpnName, String oauthProviderName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'oauthProviderName' is set - if (oauthProviderName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProviderName' when calling replaceMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnAuthenticationOauthProvider"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProviderName", oauthProviderName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an Authorization Group object. - * Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| authorizationGroupName|x||x|||| clientProfileName|||||x|| msgVpnName|x||x|||| orderAfterAuthorizationGroupName||||x||| orderBeforeAuthorizationGroupName||||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthorizationGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthorizationGroupResponse replaceMsgVpnAuthorizationGroup(String msgVpnName, String authorizationGroupName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnAuthorizationGroupWithHttpInfo(msgVpnName, authorizationGroupName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an Authorization Group object. - * Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| authorizationGroupName|x||x|||| clientProfileName|||||x|| msgVpnName|x||x|||| orderAfterAuthorizationGroupName||||x||| orderBeforeAuthorizationGroupName||||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthorizationGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnAuthorizationGroupWithHttpInfo(String msgVpnName, String authorizationGroupName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'authorizationGroupName' is set - if (authorizationGroupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationGroupName' when calling replaceMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnAuthorizationGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("authorizationGroupName", authorizationGroupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Bridge object. - * Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| maxTtl|||||x|| msgVpnName|x||x|||| remoteAuthenticationBasicClientUsername|||||x|| remoteAuthenticationBasicPassword||||x|x||x remoteAuthenticationClientCertContent||||x|x||x remoteAuthenticationClientCertPassword||||x|x|| remoteAuthenticationScheme|||||x|| remoteDeliverToOnePriority|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeResponse replaceMsgVpnBridge(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnBridgeWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Bridge object. - * Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| maxTtl|||||x|| msgVpnName|x||x|||| remoteAuthenticationBasicClientUsername|||||x|| remoteAuthenticationBasicPassword||||x|x||x remoteAuthenticationClientCertContent||||x|x||x remoteAuthenticationClientCertPassword||||x|x|| remoteAuthenticationScheme|||||x|| remoteDeliverToOnePriority|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnBridgeWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnBridge"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling replaceMsgVpnBridge"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling replaceMsgVpnBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Remote Message VPN object. - * Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| clientUsername|||||x|| compressedDataEnabled|||||x|| egressFlowWindowSize|||||x|| msgVpnName|x||x|||| password||||x|x||x remoteMsgVpnInterface|x||x|||| remoteMsgVpnLocation|x||x|||| remoteMsgVpnName|x||x|||| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteMsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteMsgVpnResponse replaceMsgVpnBridgeRemoteMsgVpn(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnBridgeRemoteMsgVpnWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Remote Message VPN object. - * Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| clientUsername|||||x|| compressedDataEnabled|||||x|| egressFlowWindowSize|||||x|| msgVpnName|x||x|||| password||||x|x||x remoteMsgVpnInterface|x||x|||| remoteMsgVpnLocation|x||x|||| remoteMsgVpnName|x||x|||| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteMsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnBridgeRemoteMsgVpnWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnName' is set - if (remoteMsgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnName' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnLocation' is set - if (remoteMsgVpnLocation == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnLocation' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnInterface' is set - if (remoteMsgVpnInterface == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnInterface' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteMsgVpnName", remoteMsgVpnName); - uriVariables.put("remoteMsgVpnLocation", remoteMsgVpnLocation); - uriVariables.put("remoteMsgVpnInterface", remoteMsgVpnInterface); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Certificate Matching Rule object. - * Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleResponse replaceMsgVpnCertMatchingRule(String msgVpnName, String ruleName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnCertMatchingRuleWithHttpInfo(msgVpnName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Certificate Matching Rule object. - * Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnCertMatchingRuleWithHttpInfo(String msgVpnName, String ruleName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling replaceMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Certificate Matching Rule Attribute Filter object. - * Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- filterName|x||x|||| msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleAttributeFilterResponse replaceMsgVpnCertMatchingRuleAttributeFilter(String msgVpnName, String ruleName, String filterName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(msgVpnName, ruleName, filterName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Certificate Matching Rule Attribute Filter object. - * Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- filterName|x||x|||| msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(String msgVpnName, String ruleName, String filterName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling replaceMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling replaceMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Client Profile object. - * Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled||||||x| apiQueueManagementCopyFromOnCreateName||||||x| apiTopicEndpointManagementCopyFromOnCreateName||||||x| clientProfileName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientProfileResponse replaceMsgVpnClientProfile(String msgVpnName, String clientProfileName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnClientProfileWithHttpInfo(msgVpnName, clientProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Client Profile object. - * Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled||||||x| apiQueueManagementCopyFromOnCreateName||||||x| apiTopicEndpointManagementCopyFromOnCreateName||||||x| clientProfileName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnClientProfileWithHttpInfo(String msgVpnName, String clientProfileName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnClientProfile"); - } - - // verify the required parameter 'clientProfileName' is set - if (clientProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientProfileName' when calling replaceMsgVpnClientProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnClientProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientProfileName", clientProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Client Username object. - * Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| clientProfileName|||||x|| clientUsername|x||x|||| msgVpnName|x||x|||| password||||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameResponse replaceMsgVpnClientUsername(String msgVpnName, String clientUsername, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnClientUsernameWithHttpInfo(msgVpnName, clientUsername, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Client Username object. - * Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| clientProfileName|||||x|| clientUsername|x||x|||| msgVpnName|x||x|||| password||||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnClientUsernameWithHttpInfo(String msgVpnName, String clientUsername, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnClientUsername"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling replaceMsgVpnClientUsername"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnClientUsername"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Distributed Cache object. - * Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| cacheVirtualRouter||x||||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheResponse replaceMsgVpnDistributedCache(String msgVpnName, String cacheName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnDistributedCacheWithHttpInfo(msgVpnName, cacheName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Distributed Cache object. - * Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| cacheVirtualRouter||x||||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnDistributedCacheWithHttpInfo(String msgVpnName, String cacheName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnDistributedCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling replaceMsgVpnDistributedCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnDistributedCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Cache Cluster object. - * Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterResponse replaceMsgVpnDistributedCacheCluster(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnDistributedCacheClusterWithHttpInfo(msgVpnName, cacheName, clusterName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Cache Cluster object. - * Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnDistributedCacheClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling replaceMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling replaceMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnDistributedCacheCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Cache Instance object. - * Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| instanceName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterInstanceResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterInstanceResponse replaceMsgVpnDistributedCacheClusterInstance(String msgVpnName, String cacheName, String clusterName, String instanceName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnDistributedCacheClusterInstanceWithHttpInfo(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Cache Instance object. - * Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| instanceName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterInstanceResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnDistributedCacheClusterInstanceWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String instanceName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling replaceMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling replaceMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'instanceName' is set - if (instanceName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'instanceName' when calling replaceMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnDistributedCacheClusterInstance"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("instanceName", instanceName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a DMR Bridge object. - * Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| remoteNodeName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDmrBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDmrBridgeResponse replaceMsgVpnDmrBridge(String msgVpnName, String remoteNodeName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnDmrBridgeWithHttpInfo(msgVpnName, remoteNodeName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a DMR Bridge object. - * Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| remoteNodeName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDmrBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnDmrBridgeWithHttpInfo(String msgVpnName, String remoteNodeName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnDmrBridge"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling replaceMsgVpnDmrBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnDmrBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a JNDI Connection Factory object. - * Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiConnectionFactoryResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiConnectionFactoryResponse replaceMsgVpnJndiConnectionFactory(String msgVpnName, String connectionFactoryName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnJndiConnectionFactoryWithHttpInfo(msgVpnName, connectionFactoryName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a JNDI Connection Factory object. - * Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiConnectionFactoryResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnJndiConnectionFactoryWithHttpInfo(String msgVpnName, String connectionFactoryName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'connectionFactoryName' is set - if (connectionFactoryName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'connectionFactoryName' when calling replaceMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnJndiConnectionFactory"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("connectionFactoryName", connectionFactoryName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a JNDI Queue object. - * Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiQueueResponse replaceMsgVpnJndiQueue(String msgVpnName, String queueName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnJndiQueueWithHttpInfo(msgVpnName, queueName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a JNDI Queue object. - * Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnJndiQueueWithHttpInfo(String msgVpnName, String queueName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnJndiQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling replaceMsgVpnJndiQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnJndiQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues/{queueName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a JNDI Topic object. - * Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiTopicResponse replaceMsgVpnJndiTopic(String msgVpnName, String topicName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnJndiTopicWithHttpInfo(msgVpnName, topicName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a JNDI Topic object. - * Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnJndiTopicWithHttpInfo(String msgVpnName, String topicName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnJndiTopic"); - } - - // verify the required parameter 'topicName' is set - if (topicName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicName' when calling replaceMsgVpnJndiTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnJndiTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicName", topicName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics/{topicName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an MQTT Retain Cache object. - * Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttRetainCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttRetainCacheResponse replaceMsgVpnMqttRetainCache(String msgVpnName, String cacheName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnMqttRetainCacheWithHttpInfo(msgVpnName, cacheName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an MQTT Retain Cache object. - * Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttRetainCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnMqttRetainCacheWithHttpInfo(String msgVpnName, String cacheName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling replaceMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnMqttRetainCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an MQTT Session object. - * Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| owner|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionResponse replaceMsgVpnMqttSession(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnMqttSessionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Replace an MQTT Session object. - * Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| owner|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnMqttSessionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling replaceMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling replaceMsgVpnMqttSession"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnMqttSession"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Subscription object. - * Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| subscriptionTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionSubscriptionResponse replaceMsgVpnMqttSessionSubscription(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnMqttSessionSubscriptionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Subscription object. - * Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| subscriptionTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnMqttSessionSubscriptionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling replaceMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling replaceMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling replaceMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnMqttSessionSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Queue object. - * Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| queueName|x||x|||| respectMsgPriorityEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueResponse replaceMsgVpnQueue(String msgVpnName, String queueName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnQueueWithHttpInfo(msgVpnName, queueName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Queue object. - * Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| queueName|x||x|||| respectMsgPriorityEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnQueueWithHttpInfo(String msgVpnName, String queueName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling replaceMsgVpnQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Queue Template object. - * Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueTemplateResponse replaceMsgVpnQueueTemplate(String msgVpnName, String queueTemplateName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnQueueTemplateWithHttpInfo(msgVpnName, queueTemplateName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Queue Template object. - * Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnQueueTemplateWithHttpInfo(String msgVpnName, String queueTemplateName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnQueueTemplate"); - } - - // verify the required parameter 'queueTemplateName' is set - if (queueTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueTemplateName' when calling replaceMsgVpnQueueTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnQueueTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueTemplateName", queueTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Replay Log object. - * Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replayLogName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogResponse replaceMsgVpnReplayLog(String msgVpnName, String replayLogName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnReplayLogWithHttpInfo(msgVpnName, replayLogName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Replay Log object. - * Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replayLogName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnReplayLogWithHttpInfo(String msgVpnName, String replayLogName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnReplayLog"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling replaceMsgVpnReplayLog"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnReplayLog"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Replicated Topic object. - * Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replicatedTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplicatedTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplicatedTopicResponse replaceMsgVpnReplicatedTopic(String msgVpnName, String replicatedTopic, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnReplicatedTopicWithHttpInfo(msgVpnName, replicatedTopic, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Replicated Topic object. - * Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replicatedTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplicatedTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnReplicatedTopicWithHttpInfo(String msgVpnName, String replicatedTopic, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'replicatedTopic' is set - if (replicatedTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replicatedTopic' when calling replaceMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnReplicatedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replicatedTopic", replicatedTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a REST Delivery Point object. - * Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientProfileName|||||x|| msgVpnName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointResponse replaceMsgVpnRestDeliveryPoint(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnRestDeliveryPointWithHttpInfo(msgVpnName, restDeliveryPointName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a REST Delivery Point object. - * Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientProfileName|||||x|| msgVpnName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnRestDeliveryPointWithHttpInfo(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling replaceMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnRestDeliveryPoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Queue Binding object. - * Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingResponse replaceMsgVpnRestDeliveryPointQueueBinding(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Queue Binding object. - * Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling replaceMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling replaceMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnRestDeliveryPointQueueBinding"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Request Header object. - * Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A request header to be added to the HTTP request. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- headerName|x||x|||| msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Request Header object. - * Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A request header to be added to the HTTP request. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- headerName|x||x|||| msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'headerName' is set - if (headerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'headerName' when calling replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - uriVariables.put("headerName", headerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a REST Consumer object. - * Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey||||x|||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| authenticationHttpBasicPassword||||x|x||x authenticationHttpBasicUsername|||||x|| authenticationHttpHeaderValue||||x|||x authenticationOauthClientId|||||x|| authenticationOauthClientScope|||||x|| authenticationOauthClientSecret||||x|x||x authenticationOauthClientTokenEndpoint|||||x|| authenticationOauthJwtSecretKey||||x|x||x authenticationOauthJwtTokenEndpoint|||||x|| authenticationScheme|||||x|| msgVpnName|x||x|||| outgoingConnectionCount|||||x|| remoteHost|||||x|| remotePort|||||x|| restConsumerName|x||x|||| restDeliveryPointName|x||x|||| tlsCipherSuiteList|||||x|| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerResponse replaceMsgVpnRestDeliveryPointRestConsumer(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a REST Consumer object. - * Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey||||x|||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| authenticationHttpBasicPassword||||x|x||x authenticationHttpBasicUsername|||||x|| authenticationHttpHeaderValue||||x|||x authenticationOauthClientId|||||x|| authenticationOauthClientScope|||||x|| authenticationOauthClientSecret||||x|x||x authenticationOauthClientTokenEndpoint|||||x|| authenticationOauthJwtSecretKey||||x|x||x authenticationOauthJwtTokenEndpoint|||||x|| authenticationScheme|||||x|| msgVpnName|x||x|||| outgoingConnectionCount|||||x|| remoteHost|||||x|| remotePort|||||x|| restConsumerName|x||x|||| restDeliveryPointName|x||x|||| tlsCipherSuiteList|||||x|| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling replaceMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling replaceMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnRestDeliveryPointRestConsumer"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Topic Endpoint object. - * Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| respectMsgPriorityEnabled|||||x|| topicEndpointName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointResponse replaceMsgVpnTopicEndpoint(String msgVpnName, String topicEndpointName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnTopicEndpointWithHttpInfo(msgVpnName, topicEndpointName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Topic Endpoint object. - * Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| respectMsgPriorityEnabled|||||x|| topicEndpointName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnTopicEndpointWithHttpInfo(String msgVpnName, String topicEndpointName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'topicEndpointName' is set - if (topicEndpointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointName' when calling replaceMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnTopicEndpoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointName", topicEndpointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Topic Endpoint Template object. - * Replace a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicEndpointTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointTemplateResponse replaceMsgVpnTopicEndpointTemplate(String msgVpnName, String topicEndpointTemplateName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnTopicEndpointTemplateWithHttpInfo(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Topic Endpoint Template object. - * Replace a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicEndpointTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnTopicEndpointTemplateWithHttpInfo(String msgVpnName, String topicEndpointTemplateName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'topicEndpointTemplateName' is set - if (topicEndpointTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointTemplateName' when calling replaceMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnTopicEndpointTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointTemplateName", topicEndpointTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an OAuth Profile object. - * Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: accessLevelGroupsClaimName|global/admin clientId|global/admin clientRedirectUri|global/admin clientRequiredType|global/admin clientScope|global/admin clientSecret|global/admin clientValidateTypeEnabled|global/admin defaultGlobalAccessLevel|global/admin displayName|global/admin enabled|global/admin endpointAuthorization|global/admin endpointDiscovery|global/admin endpointDiscoveryRefreshInterval|global/admin endpointIntrospection|global/admin endpointIntrospectionTimeout|global/admin endpointJwks|global/admin endpointJwksRefreshInterval|global/admin endpointToken|global/admin endpointTokenTimeout|global/admin endpointUserinfo|global/admin endpointUserinfoTimeout|global/admin interactiveEnabled|global/admin interactivePromptForExpiredSession|global/admin interactivePromptForNewSession|global/admin issuer|global/admin oauthRole|global/admin resourceServerParseAccessTokenEnabled|global/admin resourceServerRequiredAudience|global/admin resourceServerRequiredIssuer|global/admin resourceServerRequiredScope|global/admin resourceServerRequiredType|global/admin resourceServerValidateAudienceEnabled|global/admin resourceServerValidateIssuerEnabled|global/admin resourceServerValidateScopeEnabled|global/admin resourceServerValidateTypeEnabled|global/admin sempEnabled|global/admin usernameClaimName|global/admin This has been available since 2.24. - *

200 - The OAuth Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileResponse replaceOauthProfile(String oauthProfileName, OauthProfile body, String opaquePassword, List select) throws RestClientException { - return replaceOauthProfileWithHttpInfo(oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an OAuth Profile object. - * Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: accessLevelGroupsClaimName|global/admin clientId|global/admin clientRedirectUri|global/admin clientRequiredType|global/admin clientScope|global/admin clientSecret|global/admin clientValidateTypeEnabled|global/admin defaultGlobalAccessLevel|global/admin displayName|global/admin enabled|global/admin endpointAuthorization|global/admin endpointDiscovery|global/admin endpointDiscoveryRefreshInterval|global/admin endpointIntrospection|global/admin endpointIntrospectionTimeout|global/admin endpointJwks|global/admin endpointJwksRefreshInterval|global/admin endpointToken|global/admin endpointTokenTimeout|global/admin endpointUserinfo|global/admin endpointUserinfoTimeout|global/admin interactiveEnabled|global/admin interactivePromptForExpiredSession|global/admin interactivePromptForNewSession|global/admin issuer|global/admin oauthRole|global/admin resourceServerParseAccessTokenEnabled|global/admin resourceServerRequiredAudience|global/admin resourceServerRequiredIssuer|global/admin resourceServerRequiredScope|global/admin resourceServerRequiredType|global/admin resourceServerValidateAudienceEnabled|global/admin resourceServerValidateIssuerEnabled|global/admin resourceServerValidateScopeEnabled|global/admin resourceServerValidateTypeEnabled|global/admin sempEnabled|global/admin usernameClaimName|global/admin This has been available since 2.24. - *

200 - The OAuth Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceOauthProfileWithHttpInfo(String oauthProfileName, OauthProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling replaceOauthProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Group Access Level object. - * Replace a Group Access Level object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- groupName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - *

200 - The Group Access Level object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param body The Group Access Level object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupResponse replaceOauthProfileAccessLevelGroup(String oauthProfileName, String groupName, OauthProfileAccessLevelGroup body, String opaquePassword, List select) throws RestClientException { - return replaceOauthProfileAccessLevelGroupWithHttpInfo(oauthProfileName, groupName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Group Access Level object. - * Replace a Group Access Level object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- groupName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - *

200 - The Group Access Level object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param body The Group Access Level object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceOauthProfileAccessLevelGroupWithHttpInfo(String oauthProfileName, String groupName, OauthProfileAccessLevelGroup body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling replaceOauthProfileAccessLevelGroup"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling replaceOauthProfileAccessLevelGroup"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceOauthProfileAccessLevelGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Message VPN Access-Level Exception object. - * Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- groupName|x||x|||| msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException(String oauthProfileName, String groupName, String msgVpnName, OauthProfileAccessLevelGroupMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - return replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, groupName, msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Message VPN Access-Level Exception object. - * Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- groupName|x||x|||| msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String groupName, String msgVpnName, OauthProfileAccessLevelGroupMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an Authorization Parameter object. - * Replace an Authorization Parameter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authorizationParameterName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Authorization Parameter object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param authorizationParameterName The name of the authorization parameter. (required) - * @param body The Authorization Parameter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientAuthorizationParameterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientAuthorizationParameterResponse replaceOauthProfileClientAuthorizationParameter(String oauthProfileName, String authorizationParameterName, OauthProfileClientAuthorizationParameter body, String opaquePassword, List select) throws RestClientException { - return replaceOauthProfileClientAuthorizationParameterWithHttpInfo(oauthProfileName, authorizationParameterName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an Authorization Parameter object. - * Replace an Authorization Parameter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authorizationParameterName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Authorization Parameter object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param authorizationParameterName The name of the authorization parameter. (required) - * @param body The Authorization Parameter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientAuthorizationParameterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceOauthProfileClientAuthorizationParameterWithHttpInfo(String oauthProfileName, String authorizationParameterName, OauthProfileClientAuthorizationParameter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling replaceOauthProfileClientAuthorizationParameter"); - } - - // verify the required parameter 'authorizationParameterName' is set - if (authorizationParameterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationParameterName' when calling replaceOauthProfileClientAuthorizationParameter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceOauthProfileClientAuthorizationParameter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("authorizationParameterName", authorizationParameterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Message VPN Access-Level Exception object. - * Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Default message VPN access-level exceptions. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileDefaultMsgVpnAccessLevelExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileDefaultMsgVpnAccessLevelExceptionResponse replaceOauthProfileDefaultMsgVpnAccessLevelException(String oauthProfileName, String msgVpnName, OauthProfileDefaultMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - return replaceOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Message VPN Access-Level Exception object. - * Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Default message VPN access-level exceptions. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileDefaultMsgVpnAccessLevelExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String msgVpnName, OauthProfileDefaultMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling replaceOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Virtual Hostname object. - * Replace a Virtual Hostname object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- virtualHostname|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - *

200 - The Virtual Hostname object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param virtualHostname The virtual hostname. (required) - * @param body The Virtual Hostname object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return VirtualHostnameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public VirtualHostnameResponse replaceVirtualHostname(String virtualHostname, VirtualHostname body, String opaquePassword, List select) throws RestClientException { - return replaceVirtualHostnameWithHttpInfo(virtualHostname, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Virtual Hostname object. - * Replace a Virtual Hostname object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- virtualHostname|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - *

200 - The Virtual Hostname object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param virtualHostname The virtual hostname. (required) - * @param body The Virtual Hostname object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<VirtualHostnameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceVirtualHostnameWithHttpInfo(String virtualHostname, VirtualHostname body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'virtualHostname' is set - if (virtualHostname == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'virtualHostname' when calling replaceVirtualHostname"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceVirtualHostname"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("virtualHostname", virtualHostname); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/virtualHostnames/{virtualHostname}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Broker object. - * Update a Broker object. Any attribute missing from the request will be left unchanged. This object contains global configuration for the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- serviceAmqpTlsListenPort||||x|| serviceHealthCheckListenPort||||x|| serviceMateLinkListenPort||||x|| serviceRedundancyFirstListenPort||||x|| serviceSempPlainTextListenPort||||x|| serviceSempTlsListenPort||||x|| serviceSmfCompressionListenPort||||x|| serviceSmfPlainTextListenPort||||x|| serviceSmfRoutingControlListenPort||||x|| serviceSmfTlsListenPort||||x|| serviceWebTransportPlainTextListenPort||||x|| serviceWebTransportTlsListenPort||||x|| serviceWebTransportWebUrlSuffix||||x|| tlsServerCertContent|||x|||x tlsServerCertPassword|||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- Broker|tlsServerCertPassword|tlsServerCertContent| EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: authClientCertRevocationCheckMode|global/admin configSyncAuthenticationClientCertMaxChainDepth|global/read-write configSyncAuthenticationClientCertValidateDateEnabled|global/read-write configSyncClientProfileTcpInitialCongestionWindow|global/read-write configSyncClientProfileTcpKeepaliveCount|global/read-write configSyncClientProfileTcpKeepaliveIdle|global/read-write configSyncClientProfileTcpKeepaliveInterval|global/read-write configSyncClientProfileTcpMaxWindow|global/read-write configSyncClientProfileTcpMss|global/read-write configSyncEnabled|global/read-write configSyncSynchronizeUsernameEnabled|global/read-write configSyncTlsEnabled|global/read-write guaranteedMsgingDefragmentationScheduleDayList|global/read-write guaranteedMsgingDefragmentationScheduleEnabled|global/read-write guaranteedMsgingDefragmentationScheduleTimeList|global/read-write guaranteedMsgingDefragmentationThresholdEnabled|global/read-write guaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-write guaranteedMsgingDefragmentationThresholdMinInterval|global/read-write guaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-write guaranteedMsgingEnabled|global/read-write guaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-write guaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-write guaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-write guaranteedMsgingEventCacheUsageThreshold.setValue|global/read-write guaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-write guaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-write guaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-write guaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-write guaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-write guaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-write guaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-write guaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-write guaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-write guaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-write guaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-write guaranteedMsgingEventEndpointCountThreshold.setValue|global/read-write guaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-write guaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-write guaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-write guaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-write guaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-write guaranteedMsgingEventMsgCountThreshold.setPercent|global/read-write guaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-write guaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-write guaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-write guaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-write guaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-write guaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-write guaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-write guaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-write guaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-write guaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-write guaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-write guaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-write guaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-write guaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-write guaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-write guaranteedMsgingEventTransactionCountThreshold.setValue|global/read-write guaranteedMsgingMaxCacheUsage|global/read-write guaranteedMsgingMaxMsgSpoolUsage|global/read-write guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-write guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-write guaranteedMsgingTransactionReplicationCompatibilityMode|global/read-write oauthProfileDefault|global/admin serviceAmqpEnabled|global/read-write serviceAmqpTlsListenPort|global/read-write serviceEventConnectionCountThreshold.clearPercent|global/read-write serviceEventConnectionCountThreshold.clearValue|global/read-write serviceEventConnectionCountThreshold.setPercent|global/read-write serviceEventConnectionCountThreshold.setValue|global/read-write serviceHealthCheckEnabled|global/read-write serviceHealthCheckListenPort|global/read-write serviceMateLinkEnabled|global/read-write serviceMateLinkListenPort|global/read-write serviceMqttEnabled|global/read-write serviceMsgBackboneEnabled|global/read-write serviceRedundancyEnabled|global/read-write serviceRedundancyFirstListenPort|global/read-write serviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-write serviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-write serviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-write serviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-write serviceRestIncomingEnabled|global/read-write serviceRestOutgoingEnabled|global/read-write serviceSempCorsAllowAnyHostEnabled|global/read-write serviceSempLegacyTimeoutEnabled|global/read-write serviceSempPlainTextEnabled|global/read-write serviceSempPlainTextListenPort|global/read-write serviceSempSessionIdleTimeout|global/read-write serviceSempSessionMaxLifetime|global/read-write serviceSempTlsEnabled|global/read-write serviceSempTlsListenPort|global/read-write serviceSmfCompressionListenPort|global/read-write serviceSmfEnabled|global/read-write serviceSmfEventConnectionCountThreshold.clearPercent|global/read-write serviceSmfEventConnectionCountThreshold.clearValue|global/read-write serviceSmfEventConnectionCountThreshold.setPercent|global/read-write serviceSmfEventConnectionCountThreshold.setValue|global/read-write serviceSmfPlainTextListenPort|global/read-write serviceSmfRoutingControlListenPort|global/read-write serviceSmfTlsListenPort|global/read-write serviceTlsEventConnectionCountThreshold.clearPercent|global/read-write serviceTlsEventConnectionCountThreshold.clearValue|global/read-write serviceTlsEventConnectionCountThreshold.setPercent|global/read-write serviceTlsEventConnectionCountThreshold.setValue|global/read-write serviceWebTransportEnabled|global/read-write serviceWebTransportPlainTextListenPort|global/read-write serviceWebTransportTlsListenPort|global/read-write serviceWebTransportWebUrlSuffix|global/read-write tlsBlockVersion11Enabled|global/read-write tlsCipherSuiteManagementList|global/read-write tlsCipherSuiteMsgBackboneList|global/read-write tlsCipherSuiteSecureShellList|global/read-write tlsCrimeExploitProtectionEnabled|global/read-write tlsServerCertContent|global/read-write tlsServerCertPassword|global/read-write tlsStandardDomainCertificateAuthoritiesEnabled|global/read-write tlsTicketLifetime|global/read-write webManagerAllowUnencryptedWizardsEnabled|global/read-write webManagerCustomization|vpn/read-write webManagerRedirectHttpEnabled|global/read-write webManagerRedirectHttpOverrideTlsPort|global/read-write This has been available since 2.13. - *

200 - The Broker object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param body The Broker object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return BrokerResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public BrokerResponse updateBroker(Broker body, String opaquePassword, List select) throws RestClientException { - return updateBrokerWithHttpInfo(body, opaquePassword, select).getBody(); - } - - /** - * Update a Broker object. - * Update a Broker object. Any attribute missing from the request will be left unchanged. This object contains global configuration for the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- serviceAmqpTlsListenPort||||x|| serviceHealthCheckListenPort||||x|| serviceMateLinkListenPort||||x|| serviceRedundancyFirstListenPort||||x|| serviceSempPlainTextListenPort||||x|| serviceSempTlsListenPort||||x|| serviceSmfCompressionListenPort||||x|| serviceSmfPlainTextListenPort||||x|| serviceSmfRoutingControlListenPort||||x|| serviceSmfTlsListenPort||||x|| serviceWebTransportPlainTextListenPort||||x|| serviceWebTransportTlsListenPort||||x|| serviceWebTransportWebUrlSuffix||||x|| tlsServerCertContent|||x|||x tlsServerCertPassword|||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- Broker|tlsServerCertPassword|tlsServerCertContent| EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: authClientCertRevocationCheckMode|global/admin configSyncAuthenticationClientCertMaxChainDepth|global/read-write configSyncAuthenticationClientCertValidateDateEnabled|global/read-write configSyncClientProfileTcpInitialCongestionWindow|global/read-write configSyncClientProfileTcpKeepaliveCount|global/read-write configSyncClientProfileTcpKeepaliveIdle|global/read-write configSyncClientProfileTcpKeepaliveInterval|global/read-write configSyncClientProfileTcpMaxWindow|global/read-write configSyncClientProfileTcpMss|global/read-write configSyncEnabled|global/read-write configSyncSynchronizeUsernameEnabled|global/read-write configSyncTlsEnabled|global/read-write guaranteedMsgingDefragmentationScheduleDayList|global/read-write guaranteedMsgingDefragmentationScheduleEnabled|global/read-write guaranteedMsgingDefragmentationScheduleTimeList|global/read-write guaranteedMsgingDefragmentationThresholdEnabled|global/read-write guaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-write guaranteedMsgingDefragmentationThresholdMinInterval|global/read-write guaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-write guaranteedMsgingEnabled|global/read-write guaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-write guaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-write guaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-write guaranteedMsgingEventCacheUsageThreshold.setValue|global/read-write guaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-write guaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-write guaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-write guaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-write guaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-write guaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-write guaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-write guaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-write guaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-write guaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-write guaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-write guaranteedMsgingEventEndpointCountThreshold.setValue|global/read-write guaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-write guaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-write guaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-write guaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-write guaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-write guaranteedMsgingEventMsgCountThreshold.setPercent|global/read-write guaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-write guaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-write guaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-write guaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-write guaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-write guaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-write guaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-write guaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-write guaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-write guaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-write guaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-write guaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-write guaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-write guaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-write guaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-write guaranteedMsgingEventTransactionCountThreshold.setValue|global/read-write guaranteedMsgingMaxCacheUsage|global/read-write guaranteedMsgingMaxMsgSpoolUsage|global/read-write guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-write guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-write guaranteedMsgingTransactionReplicationCompatibilityMode|global/read-write oauthProfileDefault|global/admin serviceAmqpEnabled|global/read-write serviceAmqpTlsListenPort|global/read-write serviceEventConnectionCountThreshold.clearPercent|global/read-write serviceEventConnectionCountThreshold.clearValue|global/read-write serviceEventConnectionCountThreshold.setPercent|global/read-write serviceEventConnectionCountThreshold.setValue|global/read-write serviceHealthCheckEnabled|global/read-write serviceHealthCheckListenPort|global/read-write serviceMateLinkEnabled|global/read-write serviceMateLinkListenPort|global/read-write serviceMqttEnabled|global/read-write serviceMsgBackboneEnabled|global/read-write serviceRedundancyEnabled|global/read-write serviceRedundancyFirstListenPort|global/read-write serviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-write serviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-write serviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-write serviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-write serviceRestIncomingEnabled|global/read-write serviceRestOutgoingEnabled|global/read-write serviceSempCorsAllowAnyHostEnabled|global/read-write serviceSempLegacyTimeoutEnabled|global/read-write serviceSempPlainTextEnabled|global/read-write serviceSempPlainTextListenPort|global/read-write serviceSempSessionIdleTimeout|global/read-write serviceSempSessionMaxLifetime|global/read-write serviceSempTlsEnabled|global/read-write serviceSempTlsListenPort|global/read-write serviceSmfCompressionListenPort|global/read-write serviceSmfEnabled|global/read-write serviceSmfEventConnectionCountThreshold.clearPercent|global/read-write serviceSmfEventConnectionCountThreshold.clearValue|global/read-write serviceSmfEventConnectionCountThreshold.setPercent|global/read-write serviceSmfEventConnectionCountThreshold.setValue|global/read-write serviceSmfPlainTextListenPort|global/read-write serviceSmfRoutingControlListenPort|global/read-write serviceSmfTlsListenPort|global/read-write serviceTlsEventConnectionCountThreshold.clearPercent|global/read-write serviceTlsEventConnectionCountThreshold.clearValue|global/read-write serviceTlsEventConnectionCountThreshold.setPercent|global/read-write serviceTlsEventConnectionCountThreshold.setValue|global/read-write serviceWebTransportEnabled|global/read-write serviceWebTransportPlainTextListenPort|global/read-write serviceWebTransportTlsListenPort|global/read-write serviceWebTransportWebUrlSuffix|global/read-write tlsBlockVersion11Enabled|global/read-write tlsCipherSuiteManagementList|global/read-write tlsCipherSuiteMsgBackboneList|global/read-write tlsCipherSuiteSecureShellList|global/read-write tlsCrimeExploitProtectionEnabled|global/read-write tlsServerCertContent|global/read-write tlsServerCertPassword|global/read-write tlsStandardDomainCertificateAuthoritiesEnabled|global/read-write tlsTicketLifetime|global/read-write webManagerAllowUnencryptedWizardsEnabled|global/read-write webManagerCustomization|vpn/read-write webManagerRedirectHttpEnabled|global/read-write webManagerRedirectHttpOverrideTlsPort|global/read-write This has been available since 2.13. - *

200 - The Broker object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param body The Broker object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<BrokerResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateBrokerWithHttpInfo(Broker body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateBroker"); - } - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/", HttpMethod.PATCH, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Certificate Authority object. - * Update a Certificate Authority object. Any attribute missing from the request will be left unchanged. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||x| certContent|||||x| crlDayList|||||x| crlTimeList|||||x| crlUrl||||x|x| ocspNonResponderCertEnabled|||||x| ocspOverrideUrl|||||x| ocspTimeout|||||x| revocationCheckEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The Certificate Authority object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return CertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public CertAuthorityResponse updateCertAuthority(String certAuthorityName, CertAuthority body, String opaquePassword, List select) throws RestClientException { - return updateCertAuthorityWithHttpInfo(certAuthorityName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Certificate Authority object. - * Update a Certificate Authority object. Any attribute missing from the request will be left unchanged. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||x| certContent|||||x| crlDayList|||||x| crlTimeList|||||x| crlUrl||||x|x| ocspNonResponderCertEnabled|||||x| ocspOverrideUrl|||||x| ocspTimeout|||||x| revocationCheckEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The Certificate Authority object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<CertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity updateCertAuthorityWithHttpInfo(String certAuthorityName, CertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling updateCertAuthority"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities/{certAuthorityName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Client Certificate Authority object. - * Update a Client Certificate Authority object. Any attribute missing from the request will be left unchanged. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||| crlUrl||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Client Certificate Authority object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Client Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ClientCertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ClientCertAuthorityResponse updateClientCertAuthority(String certAuthorityName, ClientCertAuthority body, String opaquePassword, List select) throws RestClientException { - return updateClientCertAuthorityWithHttpInfo(certAuthorityName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Client Certificate Authority object. - * Update a Client Certificate Authority object. Any attribute missing from the request will be left unchanged. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||| crlUrl||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Client Certificate Authority object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Client Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<ClientCertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateClientCertAuthorityWithHttpInfo(String certAuthorityName, ClientCertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling updateClientCertAuthority"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateClientCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities/{certAuthorityName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Cluster object. - * Update a Cluster object. Any attribute missing from the request will be left unchanged. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword|||x|x||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| directOnlyEnabled||x|||| dmrClusterName|x|x|||| nodeName||x|||| tlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cluster object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param body The Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterResponse updateDmrCluster(String dmrClusterName, DmrCluster body, String opaquePassword, List select) throws RestClientException { - return updateDmrClusterWithHttpInfo(dmrClusterName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Cluster object. - * Update a Cluster object. Any attribute missing from the request will be left unchanged. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword|||x|x||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| directOnlyEnabled||x|||| dmrClusterName|x|x|||| nodeName||x|||| tlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cluster object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param body The Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateDmrClusterWithHttpInfo(String dmrClusterName, DmrCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling updateDmrCluster"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateDmrCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Certificate Matching Rule object. - * Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- dmrClusterName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleResponse updateDmrClusterCertMatchingRule(String dmrClusterName, String ruleName, DmrClusterCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - return updateDmrClusterCertMatchingRuleWithHttpInfo(dmrClusterName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Certificate Matching Rule object. - * Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- dmrClusterName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateDmrClusterCertMatchingRuleWithHttpInfo(String dmrClusterName, String ruleName, DmrClusterCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling updateDmrClusterCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling updateDmrClusterCertMatchingRule"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateDmrClusterCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Certificate Matching Rule Attribute Filter object. - * Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- dmrClusterName|x|x|||| filterName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleAttributeFilterResponse updateDmrClusterCertMatchingRuleAttributeFilter(String dmrClusterName, String ruleName, String filterName, DmrClusterCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - return updateDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(dmrClusterName, ruleName, filterName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Certificate Matching Rule Attribute Filter object. - * Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- dmrClusterName|x|x|||| filterName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(String dmrClusterName, String ruleName, String filterName, DmrClusterCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling updateDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling updateDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling updateDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateDmrClusterCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Link object. - * Update a Link object. Any attribute missing from the request will be left unchanged. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword|||x|x||x authenticationScheme||||x|| dmrClusterName|x|x|||| egressFlowWindowSize||||x|| initiator||||x|| remoteNodeName|x|x|||| span||||x|| transportCompressedEnabled||||x|| transportTlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Link object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Link object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkResponse updateDmrClusterLink(String dmrClusterName, String remoteNodeName, DmrClusterLink body, String opaquePassword, List select) throws RestClientException { - return updateDmrClusterLinkWithHttpInfo(dmrClusterName, remoteNodeName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Link object. - * Update a Link object. Any attribute missing from the request will be left unchanged. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword|||x|x||x authenticationScheme||||x|| dmrClusterName|x|x|||| egressFlowWindowSize||||x|| initiator||||x|| remoteNodeName|x|x|||| span||||x|| transportCompressedEnabled||||x|| transportTlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Link object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Link object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateDmrClusterLinkWithHttpInfo(String dmrClusterName, String remoteNodeName, DmrClusterLink body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling updateDmrClusterLink"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling updateDmrClusterLink"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateDmrClusterLink"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Domain Certificate Authority object. - * Update a Domain Certificate Authority object. Any attribute missing from the request will be left unchanged. Certificate Authorities trusted for domain verification. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Domain Certificate Authority object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Domain Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DomainCertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DomainCertAuthorityResponse updateDomainCertAuthority(String certAuthorityName, DomainCertAuthority body, String opaquePassword, List select) throws RestClientException { - return updateDomainCertAuthorityWithHttpInfo(certAuthorityName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Domain Certificate Authority object. - * Update a Domain Certificate Authority object. Any attribute missing from the request will be left unchanged. Certificate Authorities trusted for domain verification. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Domain Certificate Authority object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Domain Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DomainCertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateDomainCertAuthorityWithHttpInfo(String certAuthorityName, DomainCertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling updateDomainCertAuthority"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateDomainCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/domainCertAuthorities/{certAuthorityName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Message VPN object. - * Update a Message VPN object. Any attribute missing from the request will be left unchanged. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationOauthDefaultProviderName|||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| distributedCacheManagementEnabled|||||x| msgVpnName|x|x|||| replicationBridgeAuthenticationBasicPassword|||x|||x replicationBridgeAuthenticationClientCertContent|||x|||x replicationBridgeAuthenticationClientCertPassword|||x||| replicationEnabledQueueBehavior|||x||| restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: alias|global/read-write authenticationBasicEnabled|global/read-write authenticationBasicProfileName|global/read-write authenticationBasicRadiusDomain|global/read-write authenticationBasicType|global/read-write authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write authenticationClientCertCertificateMatchingRulesEnabled|global/read-write authenticationClientCertEnabled|global/read-write authenticationClientCertMaxChainDepth|global/read-write authenticationClientCertRevocationCheckMode|global/read-write authenticationClientCertUsernameSource|global/read-write authenticationClientCertValidateDateEnabled|global/read-write authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write authenticationKerberosEnabled|global/read-write authenticationOauthEnabled|global/read-write bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write bridgingTlsServerCertMaxChainDepth|global/read-write bridgingTlsServerCertValidateDateEnabled|global/read-write bridgingTlsServerCertValidateNameEnabled|global/read-write dmrEnabled|global/read-write exportSubscriptionsEnabled|global/read-write maxConnectionCount|global/read-write maxEgressFlowCount|global/read-write maxEndpointCount|global/read-write maxIngressFlowCount|global/read-write maxMsgSpoolUsage|global/read-write maxSubscriptionCount|global/read-write maxTransactedSessionCount|global/read-write maxTransactionCount|global/read-write mqttRetainMaxMemory|global/read-write replicationBridgeAuthenticationBasicClientUsername|global/read-write replicationBridgeAuthenticationBasicPassword|global/read-write replicationBridgeAuthenticationClientCertContent|global/read-write replicationBridgeAuthenticationClientCertPassword|global/read-write replicationBridgeAuthenticationScheme|global/read-write replicationBridgeCompressedDataEnabled|global/read-write replicationBridgeEgressFlowWindowSize|global/read-write replicationBridgeRetryDelay|global/read-write replicationBridgeTlsEnabled|global/read-write replicationBridgeUnidirectionalClientProfileName|global/read-write replicationEnabled|global/read-write replicationEnabledQueueBehavior|global/read-write replicationQueueMaxMsgSpoolUsage|global/read-write replicationRole|global/read-write restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write restTlsServerCertMaxChainDepth|global/read-write restTlsServerCertValidateDateEnabled|global/read-write restTlsServerCertValidateNameEnabled|global/read-write sempOverMsgBusAdminClientEnabled|global/read-write sempOverMsgBusAdminDistributedCacheEnabled|global/read-write sempOverMsgBusAdminEnabled|global/read-write sempOverMsgBusEnabled|global/read-write sempOverMsgBusShowEnabled|global/read-write serviceAmqpMaxConnectionCount|global/read-write serviceAmqpPlainTextListenPort|global/read-write serviceAmqpTlsListenPort|global/read-write serviceMqttMaxConnectionCount|global/read-write serviceMqttPlainTextListenPort|global/read-write serviceMqttTlsListenPort|global/read-write serviceMqttTlsWebSocketListenPort|global/read-write serviceMqttWebSocketListenPort|global/read-write serviceRestIncomingMaxConnectionCount|global/read-write serviceRestIncomingPlainTextListenPort|global/read-write serviceRestIncomingTlsListenPort|global/read-write serviceRestOutgoingMaxConnectionCount|global/read-write serviceSmfMaxConnectionCount|global/read-write serviceWebMaxConnectionCount|global/read-write This has been available since 2.0. - *

200 - The Message VPN object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnResponse updateMsgVpn(String msgVpnName, MsgVpn body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Message VPN object. - * Update a Message VPN object. Any attribute missing from the request will be left unchanged. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationOauthDefaultProviderName|||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| distributedCacheManagementEnabled|||||x| msgVpnName|x|x|||| replicationBridgeAuthenticationBasicPassword|||x|||x replicationBridgeAuthenticationClientCertContent|||x|||x replicationBridgeAuthenticationClientCertPassword|||x||| replicationEnabledQueueBehavior|||x||| restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: alias|global/read-write authenticationBasicEnabled|global/read-write authenticationBasicProfileName|global/read-write authenticationBasicRadiusDomain|global/read-write authenticationBasicType|global/read-write authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write authenticationClientCertCertificateMatchingRulesEnabled|global/read-write authenticationClientCertEnabled|global/read-write authenticationClientCertMaxChainDepth|global/read-write authenticationClientCertRevocationCheckMode|global/read-write authenticationClientCertUsernameSource|global/read-write authenticationClientCertValidateDateEnabled|global/read-write authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write authenticationKerberosEnabled|global/read-write authenticationOauthEnabled|global/read-write bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write bridgingTlsServerCertMaxChainDepth|global/read-write bridgingTlsServerCertValidateDateEnabled|global/read-write bridgingTlsServerCertValidateNameEnabled|global/read-write dmrEnabled|global/read-write exportSubscriptionsEnabled|global/read-write maxConnectionCount|global/read-write maxEgressFlowCount|global/read-write maxEndpointCount|global/read-write maxIngressFlowCount|global/read-write maxMsgSpoolUsage|global/read-write maxSubscriptionCount|global/read-write maxTransactedSessionCount|global/read-write maxTransactionCount|global/read-write mqttRetainMaxMemory|global/read-write replicationBridgeAuthenticationBasicClientUsername|global/read-write replicationBridgeAuthenticationBasicPassword|global/read-write replicationBridgeAuthenticationClientCertContent|global/read-write replicationBridgeAuthenticationClientCertPassword|global/read-write replicationBridgeAuthenticationScheme|global/read-write replicationBridgeCompressedDataEnabled|global/read-write replicationBridgeEgressFlowWindowSize|global/read-write replicationBridgeRetryDelay|global/read-write replicationBridgeTlsEnabled|global/read-write replicationBridgeUnidirectionalClientProfileName|global/read-write replicationEnabled|global/read-write replicationEnabledQueueBehavior|global/read-write replicationQueueMaxMsgSpoolUsage|global/read-write replicationRole|global/read-write restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write restTlsServerCertMaxChainDepth|global/read-write restTlsServerCertValidateDateEnabled|global/read-write restTlsServerCertValidateNameEnabled|global/read-write sempOverMsgBusAdminClientEnabled|global/read-write sempOverMsgBusAdminDistributedCacheEnabled|global/read-write sempOverMsgBusAdminEnabled|global/read-write sempOverMsgBusEnabled|global/read-write sempOverMsgBusShowEnabled|global/read-write serviceAmqpMaxConnectionCount|global/read-write serviceAmqpPlainTextListenPort|global/read-write serviceAmqpTlsListenPort|global/read-write serviceMqttMaxConnectionCount|global/read-write serviceMqttPlainTextListenPort|global/read-write serviceMqttTlsListenPort|global/read-write serviceMqttTlsWebSocketListenPort|global/read-write serviceMqttWebSocketListenPort|global/read-write serviceRestIncomingMaxConnectionCount|global/read-write serviceRestIncomingPlainTextListenPort|global/read-write serviceRestIncomingTlsListenPort|global/read-write serviceRestOutgoingMaxConnectionCount|global/read-write serviceSmfMaxConnectionCount|global/read-write serviceWebMaxConnectionCount|global/read-write This has been available since 2.0. - *

200 - The Message VPN object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnWithHttpInfo(String msgVpnName, MsgVpn body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpn"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an ACL Profile object. - * Update an ACL Profile object. Any attribute missing from the request will be left unchanged. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileResponse updateMsgVpnAclProfile(String msgVpnName, String aclProfileName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnAclProfileWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Update an ACL Profile object. - * Update an ACL Profile object. Any attribute missing from the request will be left unchanged. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnAclProfileWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnAclProfile"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling updateMsgVpnAclProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnAclProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an OAuth Profile object. - * Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResponse updateMsgVpnAuthenticationOauthProfile(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnAuthenticationOauthProfileWithHttpInfo(msgVpnName, oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Update an OAuth Profile object. - * Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnAuthenticationOauthProfileWithHttpInfo(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling updateMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnAuthenticationOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an OAuth Provider object. - * Update an OAuth Provider object. Any attribute missing from the request will be left unchanged. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x|x|||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword|||x||x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProviderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAuthenticationOauthProviderResponse updateMsgVpnAuthenticationOauthProvider(String msgVpnName, String oauthProviderName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnAuthenticationOauthProviderWithHttpInfo(msgVpnName, oauthProviderName, body, opaquePassword, select).getBody(); - } - - /** - * Update an OAuth Provider object. - * Update an OAuth Provider object. Any attribute missing from the request will be left unchanged. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x|x|||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword|||x||x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProviderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity updateMsgVpnAuthenticationOauthProviderWithHttpInfo(String msgVpnName, String oauthProviderName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'oauthProviderName' is set - if (oauthProviderName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProviderName' when calling updateMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnAuthenticationOauthProvider"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProviderName", oauthProviderName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an Authorization Group object. - * Update an Authorization Group object. Any attribute missing from the request will be left unchanged. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| authorizationGroupName|x|x|||| clientProfileName||||x|| msgVpnName|x|x|||| orderAfterAuthorizationGroupName|||x||| orderBeforeAuthorizationGroupName|||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthorizationGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthorizationGroupResponse updateMsgVpnAuthorizationGroup(String msgVpnName, String authorizationGroupName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnAuthorizationGroupWithHttpInfo(msgVpnName, authorizationGroupName, body, opaquePassword, select).getBody(); - } - - /** - * Update an Authorization Group object. - * Update an Authorization Group object. Any attribute missing from the request will be left unchanged. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| authorizationGroupName|x|x|||| clientProfileName||||x|| msgVpnName|x|x|||| orderAfterAuthorizationGroupName|||x||| orderBeforeAuthorizationGroupName|||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthorizationGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnAuthorizationGroupWithHttpInfo(String msgVpnName, String authorizationGroupName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'authorizationGroupName' is set - if (authorizationGroupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationGroupName' when calling updateMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnAuthorizationGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("authorizationGroupName", authorizationGroupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Bridge object. - * Update a Bridge object. Any attribute missing from the request will be left unchanged. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| maxTtl||||x|| msgVpnName|x|x|||| remoteAuthenticationBasicClientUsername||||x|| remoteAuthenticationBasicPassword|||x|x||x remoteAuthenticationClientCertContent|||x|x||x remoteAuthenticationClientCertPassword|||x|x|| remoteAuthenticationScheme||||x|| remoteDeliverToOnePriority||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeResponse updateMsgVpnBridge(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnBridgeWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Update a Bridge object. - * Update a Bridge object. Any attribute missing from the request will be left unchanged. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| maxTtl||||x|| msgVpnName|x|x|||| remoteAuthenticationBasicClientUsername||||x|| remoteAuthenticationBasicPassword|||x|x||x remoteAuthenticationClientCertContent|||x|x||x remoteAuthenticationClientCertPassword|||x|x|| remoteAuthenticationScheme||||x|| remoteDeliverToOnePriority||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnBridgeWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnBridge"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling updateMsgVpnBridge"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling updateMsgVpnBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Remote Message VPN object. - * Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| clientUsername||||x|| compressedDataEnabled||||x|| egressFlowWindowSize||||x|| msgVpnName|x|x|||| password|||x|x||x remoteMsgVpnInterface|x|x|||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteMsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteMsgVpnResponse updateMsgVpnBridgeRemoteMsgVpn(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnBridgeRemoteMsgVpnWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select).getBody(); - } - - /** - * Update a Remote Message VPN object. - * Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| clientUsername||||x|| compressedDataEnabled||||x|| egressFlowWindowSize||||x|| msgVpnName|x|x|||| password|||x|x||x remoteMsgVpnInterface|x|x|||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteMsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnBridgeRemoteMsgVpnWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnName' is set - if (remoteMsgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnName' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnLocation' is set - if (remoteMsgVpnLocation == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnLocation' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnInterface' is set - if (remoteMsgVpnInterface == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnInterface' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteMsgVpnName", remoteMsgVpnName); - uriVariables.put("remoteMsgVpnLocation", remoteMsgVpnLocation); - uriVariables.put("remoteMsgVpnInterface", remoteMsgVpnInterface); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Certificate Matching Rule object. - * Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleResponse updateMsgVpnCertMatchingRule(String msgVpnName, String ruleName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnCertMatchingRuleWithHttpInfo(msgVpnName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Certificate Matching Rule object. - * Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnCertMatchingRuleWithHttpInfo(String msgVpnName, String ruleName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling updateMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Certificate Matching Rule Attribute Filter object. - * Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- filterName|x|x|||| msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleAttributeFilterResponse updateMsgVpnCertMatchingRuleAttributeFilter(String msgVpnName, String ruleName, String filterName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(msgVpnName, ruleName, filterName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Certificate Matching Rule Attribute Filter object. - * Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- filterName|x|x|||| msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(String msgVpnName, String ruleName, String filterName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling updateMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling updateMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Client Profile object. - * Update a Client Profile object. Any attribute missing from the request will be left unchanged. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientProfileResponse updateMsgVpnClientProfile(String msgVpnName, String clientProfileName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnClientProfileWithHttpInfo(msgVpnName, clientProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Client Profile object. - * Update a Client Profile object. Any attribute missing from the request will be left unchanged. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnClientProfileWithHttpInfo(String msgVpnName, String clientProfileName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnClientProfile"); - } - - // verify the required parameter 'clientProfileName' is set - if (clientProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientProfileName' when calling updateMsgVpnClientProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnClientProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientProfileName", clientProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Client Username object. - * Update a Client Username object. Any attribute missing from the request will be left unchanged. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| clientProfileName||||x|| clientUsername|x|x|||| msgVpnName|x|x|||| password|||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameResponse updateMsgVpnClientUsername(String msgVpnName, String clientUsername, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnClientUsernameWithHttpInfo(msgVpnName, clientUsername, body, opaquePassword, select).getBody(); - } - - /** - * Update a Client Username object. - * Update a Client Username object. Any attribute missing from the request will be left unchanged. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| clientProfileName||||x|| clientUsername|x|x|||| msgVpnName|x|x|||| password|||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnClientUsernameWithHttpInfo(String msgVpnName, String clientUsername, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnClientUsername"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling updateMsgVpnClientUsername"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnClientUsername"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Distributed Cache object. - * Update a Distributed Cache object. Any attribute missing from the request will be left unchanged. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| cacheVirtualRouter||x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheResponse updateMsgVpnDistributedCache(String msgVpnName, String cacheName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnDistributedCacheWithHttpInfo(msgVpnName, cacheName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Distributed Cache object. - * Update a Distributed Cache object. Any attribute missing from the request will be left unchanged. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| cacheVirtualRouter||x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnDistributedCacheWithHttpInfo(String msgVpnName, String cacheName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnDistributedCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling updateMsgVpnDistributedCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnDistributedCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Cache Cluster object. - * Update a Cache Cluster object. Any attribute missing from the request will be left unchanged. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterResponse updateMsgVpnDistributedCacheCluster(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnDistributedCacheClusterWithHttpInfo(msgVpnName, cacheName, clusterName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Cache Cluster object. - * Update a Cache Cluster object. Any attribute missing from the request will be left unchanged. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnDistributedCacheClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling updateMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling updateMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnDistributedCacheCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Cache Instance object. - * Update a Cache Instance object. Any attribute missing from the request will be left unchanged. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| instanceName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterInstanceResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterInstanceResponse updateMsgVpnDistributedCacheClusterInstance(String msgVpnName, String cacheName, String clusterName, String instanceName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnDistributedCacheClusterInstanceWithHttpInfo(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Cache Instance object. - * Update a Cache Instance object. Any attribute missing from the request will be left unchanged. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| instanceName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterInstanceResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnDistributedCacheClusterInstanceWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String instanceName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling updateMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling updateMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'instanceName' is set - if (instanceName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'instanceName' when calling updateMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnDistributedCacheClusterInstance"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("instanceName", instanceName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a DMR Bridge object. - * Update a DMR Bridge object. Any attribute missing from the request will be left unchanged. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDmrBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDmrBridgeResponse updateMsgVpnDmrBridge(String msgVpnName, String remoteNodeName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnDmrBridgeWithHttpInfo(msgVpnName, remoteNodeName, body, opaquePassword, select).getBody(); - } - - /** - * Update a DMR Bridge object. - * Update a DMR Bridge object. Any attribute missing from the request will be left unchanged. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDmrBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnDmrBridgeWithHttpInfo(String msgVpnName, String remoteNodeName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnDmrBridge"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling updateMsgVpnDmrBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnDmrBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a JNDI Connection Factory object. - * Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiConnectionFactoryResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiConnectionFactoryResponse updateMsgVpnJndiConnectionFactory(String msgVpnName, String connectionFactoryName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnJndiConnectionFactoryWithHttpInfo(msgVpnName, connectionFactoryName, body, opaquePassword, select).getBody(); - } - - /** - * Update a JNDI Connection Factory object. - * Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiConnectionFactoryResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnJndiConnectionFactoryWithHttpInfo(String msgVpnName, String connectionFactoryName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'connectionFactoryName' is set - if (connectionFactoryName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'connectionFactoryName' when calling updateMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnJndiConnectionFactory"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("connectionFactoryName", connectionFactoryName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a JNDI Queue object. - * Update a JNDI Queue object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiQueueResponse updateMsgVpnJndiQueue(String msgVpnName, String queueName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnJndiQueueWithHttpInfo(msgVpnName, queueName, body, opaquePassword, select).getBody(); - } - - /** - * Update a JNDI Queue object. - * Update a JNDI Queue object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnJndiQueueWithHttpInfo(String msgVpnName, String queueName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnJndiQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling updateMsgVpnJndiQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnJndiQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues/{queueName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a JNDI Topic object. - * Update a JNDI Topic object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiTopicResponse updateMsgVpnJndiTopic(String msgVpnName, String topicName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnJndiTopicWithHttpInfo(msgVpnName, topicName, body, opaquePassword, select).getBody(); - } - - /** - * Update a JNDI Topic object. - * Update a JNDI Topic object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnJndiTopicWithHttpInfo(String msgVpnName, String topicName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnJndiTopic"); - } - - // verify the required parameter 'topicName' is set - if (topicName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicName' when calling updateMsgVpnJndiTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnJndiTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicName", topicName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics/{topicName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an MQTT Retain Cache object. - * Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttRetainCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttRetainCacheResponse updateMsgVpnMqttRetainCache(String msgVpnName, String cacheName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnMqttRetainCacheWithHttpInfo(msgVpnName, cacheName, body, opaquePassword, select).getBody(); - } - - /** - * Update an MQTT Retain Cache object. - * Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttRetainCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnMqttRetainCacheWithHttpInfo(String msgVpnName, String cacheName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling updateMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnMqttRetainCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an MQTT Session object. - * Update an MQTT Session object. Any attribute missing from the request will be left unchanged. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| owner||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionResponse updateMsgVpnMqttSession(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnMqttSessionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Update an MQTT Session object. - * Update an MQTT Session object. Any attribute missing from the request will be left unchanged. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| owner||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnMqttSessionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling updateMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling updateMsgVpnMqttSession"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnMqttSession"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Subscription object. - * Update a Subscription object. Any attribute missing from the request will be left unchanged. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionSubscriptionResponse updateMsgVpnMqttSessionSubscription(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnMqttSessionSubscriptionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select).getBody(); - } - - /** - * Update a Subscription object. - * Update a Subscription object. Any attribute missing from the request will be left unchanged. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnMqttSessionSubscriptionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling updateMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling updateMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling updateMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnMqttSessionSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Queue object. - * Update a Queue object. Any attribute missing from the request will be left unchanged. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| queueName|x|x|||| respectMsgPriorityEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueResponse updateMsgVpnQueue(String msgVpnName, String queueName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnQueueWithHttpInfo(msgVpnName, queueName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Queue object. - * Update a Queue object. Any attribute missing from the request will be left unchanged. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| queueName|x|x|||| respectMsgPriorityEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnQueueWithHttpInfo(String msgVpnName, String queueName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling updateMsgVpnQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Queue Template object. - * Update a Queue Template object. Any attribute missing from the request will be left unchanged. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueTemplateResponse updateMsgVpnQueueTemplate(String msgVpnName, String queueTemplateName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnQueueTemplateWithHttpInfo(msgVpnName, queueTemplateName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Queue Template object. - * Update a Queue Template object. Any attribute missing from the request will be left unchanged. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnQueueTemplateWithHttpInfo(String msgVpnName, String queueTemplateName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnQueueTemplate"); - } - - // verify the required parameter 'queueTemplateName' is set - if (queueTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueTemplateName' when calling updateMsgVpnQueueTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnQueueTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueTemplateName", queueTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Replay Log object. - * Update a Replay Log object. Any attribute missing from the request will be left unchanged. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogResponse updateMsgVpnReplayLog(String msgVpnName, String replayLogName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnReplayLogWithHttpInfo(msgVpnName, replayLogName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Replay Log object. - * Update a Replay Log object. Any attribute missing from the request will be left unchanged. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnReplayLogWithHttpInfo(String msgVpnName, String replayLogName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnReplayLog"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling updateMsgVpnReplayLog"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnReplayLog"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Replicated Topic object. - * Update a Replicated Topic object. Any attribute missing from the request will be left unchanged. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplicatedTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplicatedTopicResponse updateMsgVpnReplicatedTopic(String msgVpnName, String replicatedTopic, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnReplicatedTopicWithHttpInfo(msgVpnName, replicatedTopic, body, opaquePassword, select).getBody(); - } - - /** - * Update a Replicated Topic object. - * Update a Replicated Topic object. Any attribute missing from the request will be left unchanged. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplicatedTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnReplicatedTopicWithHttpInfo(String msgVpnName, String replicatedTopic, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'replicatedTopic' is set - if (replicatedTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replicatedTopic' when calling updateMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnReplicatedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replicatedTopic", replicatedTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a REST Delivery Point object. - * Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientProfileName||||x|| msgVpnName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointResponse updateMsgVpnRestDeliveryPoint(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnRestDeliveryPointWithHttpInfo(msgVpnName, restDeliveryPointName, body, opaquePassword, select).getBody(); - } - - /** - * Update a REST Delivery Point object. - * Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientProfileName||||x|| msgVpnName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnRestDeliveryPointWithHttpInfo(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling updateMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnRestDeliveryPoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Queue Binding object. - * Update a Queue Binding object. Any attribute missing from the request will be left unchanged. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingResponse updateMsgVpnRestDeliveryPointQueueBinding(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Queue Binding object. - * Update a Queue Binding object. Any attribute missing from the request will be left unchanged. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling updateMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling updateMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnRestDeliveryPointQueueBinding"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Request Header object. - * Update a Request Header object. Any attribute missing from the request will be left unchanged. A request header to be added to the HTTP request. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- headerName|x|x|||| msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse updateMsgVpnRestDeliveryPointQueueBindingRequestHeader(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Request Header object. - * Update a Request Header object. Any attribute missing from the request will be left unchanged. A request header to be added to the HTTP request. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- headerName|x|x|||| msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'headerName' is set - if (headerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'headerName' when calling updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - uriVariables.put("headerName", headerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a REST Consumer object. - * Update a REST Consumer object. Any attribute missing from the request will be left unchanged. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey|||x|||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| authenticationHttpBasicPassword|||x|x||x authenticationHttpBasicUsername||||x|| authenticationHttpHeaderValue|||x|||x authenticationOauthClientId||||x|| authenticationOauthClientScope||||x|| authenticationOauthClientSecret|||x|x||x authenticationOauthClientTokenEndpoint||||x|| authenticationOauthJwtSecretKey|||x|x||x authenticationOauthJwtTokenEndpoint||||x|| authenticationScheme||||x|| msgVpnName|x|x|||| outgoingConnectionCount||||x|| remoteHost||||x|| remotePort||||x|| restConsumerName|x|x|||| restDeliveryPointName|x|x|||| tlsCipherSuiteList||||x|| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerResponse updateMsgVpnRestDeliveryPointRestConsumer(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select).getBody(); - } - - /** - * Update a REST Consumer object. - * Update a REST Consumer object. Any attribute missing from the request will be left unchanged. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey|||x|||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| authenticationHttpBasicPassword|||x|x||x authenticationHttpBasicUsername||||x|| authenticationHttpHeaderValue|||x|||x authenticationOauthClientId||||x|| authenticationOauthClientScope||||x|| authenticationOauthClientSecret|||x|x||x authenticationOauthClientTokenEndpoint||||x|| authenticationOauthJwtSecretKey|||x|x||x authenticationOauthJwtTokenEndpoint||||x|| authenticationScheme||||x|| msgVpnName|x|x|||| outgoingConnectionCount||||x|| remoteHost||||x|| remotePort||||x|| restConsumerName|x|x|||| restDeliveryPointName|x|x|||| tlsCipherSuiteList||||x|| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling updateMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling updateMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnRestDeliveryPointRestConsumer"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Topic Endpoint object. - * Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| respectMsgPriorityEnabled||||x|| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointResponse updateMsgVpnTopicEndpoint(String msgVpnName, String topicEndpointName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnTopicEndpointWithHttpInfo(msgVpnName, topicEndpointName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Topic Endpoint object. - * Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| respectMsgPriorityEnabled||||x|| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnTopicEndpointWithHttpInfo(String msgVpnName, String topicEndpointName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'topicEndpointName' is set - if (topicEndpointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointName' when calling updateMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnTopicEndpoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointName", topicEndpointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Topic Endpoint Template object. - * Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointTemplateResponse updateMsgVpnTopicEndpointTemplate(String msgVpnName, String topicEndpointTemplateName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnTopicEndpointTemplateWithHttpInfo(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Topic Endpoint Template object. - * Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnTopicEndpointTemplateWithHttpInfo(String msgVpnName, String topicEndpointTemplateName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'topicEndpointTemplateName' is set - if (topicEndpointTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointTemplateName' when calling updateMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnTopicEndpointTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointTemplateName", topicEndpointTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an OAuth Profile object. - * Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: accessLevelGroupsClaimName|global/admin clientId|global/admin clientRedirectUri|global/admin clientRequiredType|global/admin clientScope|global/admin clientSecret|global/admin clientValidateTypeEnabled|global/admin defaultGlobalAccessLevel|global/admin displayName|global/admin enabled|global/admin endpointAuthorization|global/admin endpointDiscovery|global/admin endpointDiscoveryRefreshInterval|global/admin endpointIntrospection|global/admin endpointIntrospectionTimeout|global/admin endpointJwks|global/admin endpointJwksRefreshInterval|global/admin endpointToken|global/admin endpointTokenTimeout|global/admin endpointUserinfo|global/admin endpointUserinfoTimeout|global/admin interactiveEnabled|global/admin interactivePromptForExpiredSession|global/admin interactivePromptForNewSession|global/admin issuer|global/admin oauthRole|global/admin resourceServerParseAccessTokenEnabled|global/admin resourceServerRequiredAudience|global/admin resourceServerRequiredIssuer|global/admin resourceServerRequiredScope|global/admin resourceServerRequiredType|global/admin resourceServerValidateAudienceEnabled|global/admin resourceServerValidateIssuerEnabled|global/admin resourceServerValidateScopeEnabled|global/admin resourceServerValidateTypeEnabled|global/admin sempEnabled|global/admin usernameClaimName|global/admin This has been available since 2.24. - *

200 - The OAuth Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileResponse updateOauthProfile(String oauthProfileName, OauthProfile body, String opaquePassword, List select) throws RestClientException { - return updateOauthProfileWithHttpInfo(oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Update an OAuth Profile object. - * Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: accessLevelGroupsClaimName|global/admin clientId|global/admin clientRedirectUri|global/admin clientRequiredType|global/admin clientScope|global/admin clientSecret|global/admin clientValidateTypeEnabled|global/admin defaultGlobalAccessLevel|global/admin displayName|global/admin enabled|global/admin endpointAuthorization|global/admin endpointDiscovery|global/admin endpointDiscoveryRefreshInterval|global/admin endpointIntrospection|global/admin endpointIntrospectionTimeout|global/admin endpointJwks|global/admin endpointJwksRefreshInterval|global/admin endpointToken|global/admin endpointTokenTimeout|global/admin endpointUserinfo|global/admin endpointUserinfoTimeout|global/admin interactiveEnabled|global/admin interactivePromptForExpiredSession|global/admin interactivePromptForNewSession|global/admin issuer|global/admin oauthRole|global/admin resourceServerParseAccessTokenEnabled|global/admin resourceServerRequiredAudience|global/admin resourceServerRequiredIssuer|global/admin resourceServerRequiredScope|global/admin resourceServerRequiredType|global/admin resourceServerValidateAudienceEnabled|global/admin resourceServerValidateIssuerEnabled|global/admin resourceServerValidateScopeEnabled|global/admin resourceServerValidateTypeEnabled|global/admin sempEnabled|global/admin usernameClaimName|global/admin This has been available since 2.24. - *

200 - The OAuth Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateOauthProfileWithHttpInfo(String oauthProfileName, OauthProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling updateOauthProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Group Access Level object. - * Update a Group Access Level object. Any attribute missing from the request will be left unchanged. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- groupName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - *

200 - The Group Access Level object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param body The Group Access Level object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupResponse updateOauthProfileAccessLevelGroup(String oauthProfileName, String groupName, OauthProfileAccessLevelGroup body, String opaquePassword, List select) throws RestClientException { - return updateOauthProfileAccessLevelGroupWithHttpInfo(oauthProfileName, groupName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Group Access Level object. - * Update a Group Access Level object. Any attribute missing from the request will be left unchanged. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- groupName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - *

200 - The Group Access Level object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param body The Group Access Level object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateOauthProfileAccessLevelGroupWithHttpInfo(String oauthProfileName, String groupName, OauthProfileAccessLevelGroup body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling updateOauthProfileAccessLevelGroup"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling updateOauthProfileAccessLevelGroup"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateOauthProfileAccessLevelGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Message VPN Access-Level Exception object. - * Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- groupName|x|x|||| msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException(String oauthProfileName, String groupName, String msgVpnName, OauthProfileAccessLevelGroupMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - return updateOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, groupName, msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Message VPN Access-Level Exception object. - * Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- groupName|x|x|||| msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String groupName, String msgVpnName, OauthProfileAccessLevelGroupMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an Authorization Parameter object. - * Update an Authorization Parameter object. Any attribute missing from the request will be left unchanged. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authorizationParameterName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Authorization Parameter object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param authorizationParameterName The name of the authorization parameter. (required) - * @param body The Authorization Parameter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientAuthorizationParameterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientAuthorizationParameterResponse updateOauthProfileClientAuthorizationParameter(String oauthProfileName, String authorizationParameterName, OauthProfileClientAuthorizationParameter body, String opaquePassword, List select) throws RestClientException { - return updateOauthProfileClientAuthorizationParameterWithHttpInfo(oauthProfileName, authorizationParameterName, body, opaquePassword, select).getBody(); - } - - /** - * Update an Authorization Parameter object. - * Update an Authorization Parameter object. Any attribute missing from the request will be left unchanged. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authorizationParameterName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Authorization Parameter object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param authorizationParameterName The name of the authorization parameter. (required) - * @param body The Authorization Parameter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientAuthorizationParameterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateOauthProfileClientAuthorizationParameterWithHttpInfo(String oauthProfileName, String authorizationParameterName, OauthProfileClientAuthorizationParameter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling updateOauthProfileClientAuthorizationParameter"); - } - - // verify the required parameter 'authorizationParameterName' is set - if (authorizationParameterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationParameterName' when calling updateOauthProfileClientAuthorizationParameter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateOauthProfileClientAuthorizationParameter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("authorizationParameterName", authorizationParameterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Message VPN Access-Level Exception object. - * Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. Default message VPN access-level exceptions. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileDefaultMsgVpnAccessLevelExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileDefaultMsgVpnAccessLevelExceptionResponse updateOauthProfileDefaultMsgVpnAccessLevelException(String oauthProfileName, String msgVpnName, OauthProfileDefaultMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - return updateOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Message VPN Access-Level Exception object. - * Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. Default message VPN access-level exceptions. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileDefaultMsgVpnAccessLevelExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String msgVpnName, OauthProfileDefaultMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling updateOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Virtual Hostname object. - * Update a Virtual Hostname object. Any attribute missing from the request will be left unchanged. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- virtualHostname|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - *

200 - The Virtual Hostname object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param virtualHostname The virtual hostname. (required) - * @param body The Virtual Hostname object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return VirtualHostnameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public VirtualHostnameResponse updateVirtualHostname(String virtualHostname, VirtualHostname body, String opaquePassword, List select) throws RestClientException { - return updateVirtualHostnameWithHttpInfo(virtualHostname, body, opaquePassword, select).getBody(); - } - - /** - * Update a Virtual Hostname object. - * Update a Virtual Hostname object. Any attribute missing from the request will be left unchanged. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- virtualHostname|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - *

200 - The Virtual Hostname object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param virtualHostname The virtual hostname. (required) - * @param body The Virtual Hostname object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<VirtualHostnameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateVirtualHostnameWithHttpInfo(String virtualHostname, VirtualHostname body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'virtualHostname' is set - if (virtualHostname == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'virtualHostname' when calling updateVirtualHostname"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateVirtualHostname"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("virtualHostname", virtualHostname); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/virtualHostnames/{virtualHostname}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthenticationOauthProfileApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthenticationOauthProfileApi.java deleted file mode 100644 index af65800b7..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthenticationOauthProfileApi.java +++ /dev/null @@ -1,1048 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AuthenticationOauthProfileApi { - private ApiClient apiClient; - - public AuthenticationOauthProfileApi() { - this(new ApiClient()); - } - - public AuthenticationOauthProfileApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create an OAuth Profile object. - * Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x msgVpnName|x||x||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResponse createMsgVpnAuthenticationOauthProfile(String msgVpnName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAuthenticationOauthProfileWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an OAuth Profile object. - * Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x msgVpnName|x||x||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAuthenticationOauthProfileWithHttpInfo(String msgVpnName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAuthenticationOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| msgVpnName|x||x||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse createMsgVpnAuthenticationOauthProfileClientRequiredClaim(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfileClientRequiredClaim body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| msgVpnName|x||x||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfileClientRequiredClaim body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an OAuth Profile object. - * Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfile(String msgVpnName, String oauthProfileName) throws RestClientException { - return deleteMsgVpnAuthenticationOauthProfileWithHttpInfo(msgVpnName, oauthProfileName).getBody(); - } - - /** - * Delete an OAuth Profile object. - * Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAuthenticationOauthProfileWithHttpInfo(String msgVpnName, String oauthProfileName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteMsgVpnAuthenticationOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim(String msgVpnName, String oauthProfileName, String clientRequiredClaimName) throws RestClientException { - return deleteMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, clientRequiredClaimName).getBody(); - } - - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, String clientRequiredClaimName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'clientRequiredClaimName' is set - if (clientRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientRequiredClaimName' when calling deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("clientRequiredClaimName", clientRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(String msgVpnName, String oauthProfileName, String resourceServerRequiredClaimName) throws RestClientException { - return deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, resourceServerRequiredClaimName).getBody(); - } - - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, String resourceServerRequiredClaimName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'resourceServerRequiredClaimName' is set - if (resourceServerRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'resourceServerRequiredClaimName' when calling deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("resourceServerRequiredClaimName", resourceServerRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an OAuth Profile object. - * Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResponse getMsgVpnAuthenticationOauthProfile(String msgVpnName, String oauthProfileName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfileWithHttpInfo(msgVpnName, oauthProfileName, opaquePassword, select).getBody(); - } - - /** - * Get an OAuth Profile object. - * Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfileWithHttpInfo(String msgVpnName, String oauthProfileName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getMsgVpnAuthenticationOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse getMsgVpnAuthenticationOauthProfileClientRequiredClaim(String msgVpnName, String oauthProfileName, String clientRequiredClaimName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, clientRequiredClaimName, opaquePassword, select).getBody(); - } - - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, String clientRequiredClaimName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'clientRequiredClaimName' is set - if (clientRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientRequiredClaimName' when calling getMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("clientRequiredClaimName", clientRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse getMsgVpnAuthenticationOauthProfileClientRequiredClaims(String msgVpnName, String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfileClientRequiredClaimsWithHttpInfo(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfileClientRequiredClaimsWithHttpInfo(String msgVpnName, String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfileClientRequiredClaims"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getMsgVpnAuthenticationOauthProfileClientRequiredClaims"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(String msgVpnName, String oauthProfileName, String resourceServerRequiredClaimName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select).getBody(); - } - - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, String resourceServerRequiredClaimName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'resourceServerRequiredClaimName' is set - if (resourceServerRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'resourceServerRequiredClaimName' when calling getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("resourceServerRequiredClaimName", resourceServerRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims(String msgVpnName, String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsWithHttpInfo(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsWithHttpInfo(String msgVpnName, String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of OAuth Profile objects. - * Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of OAuth Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfilesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfilesResponse getMsgVpnAuthenticationOauthProfiles(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfilesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of OAuth Profile objects. - * Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of OAuth Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfilesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfilesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfiles"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an OAuth Profile object. - * Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResponse replaceMsgVpnAuthenticationOauthProfile(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnAuthenticationOauthProfileWithHttpInfo(msgVpnName, oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an OAuth Profile object. - * Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnAuthenticationOauthProfileWithHttpInfo(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling replaceMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnAuthenticationOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an OAuth Profile object. - * Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResponse updateMsgVpnAuthenticationOauthProfile(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnAuthenticationOauthProfileWithHttpInfo(msgVpnName, oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Update an OAuth Profile object. - * Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnAuthenticationOauthProfileWithHttpInfo(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling updateMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnAuthenticationOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthenticationOauthProviderApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthenticationOauthProviderApi.java deleted file mode 100644 index eee7a22d1..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthenticationOauthProviderApi.java +++ /dev/null @@ -1,484 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProvider; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProviderResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProvidersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AuthenticationOauthProviderApi { - private ApiClient apiClient; - - public AuthenticationOauthProviderApi() { - this(new ApiClient()); - } - - public AuthenticationOauthProviderApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create an OAuth Provider object. - * Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x||x||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword||||x|x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProviderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAuthenticationOauthProviderResponse createMsgVpnAuthenticationOauthProvider(String msgVpnName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAuthenticationOauthProviderWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an OAuth Provider object. - * Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x||x||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword||||x|x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProviderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createMsgVpnAuthenticationOauthProviderWithHttpInfo(String msgVpnName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAuthenticationOauthProvider"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an OAuth Provider object. - * Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProvider(String msgVpnName, String oauthProviderName) throws RestClientException { - return deleteMsgVpnAuthenticationOauthProviderWithHttpInfo(msgVpnName, oauthProviderName).getBody(); - } - - /** - * Delete an OAuth Provider object. - * Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteMsgVpnAuthenticationOauthProviderWithHttpInfo(String msgVpnName, String oauthProviderName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'oauthProviderName' is set - if (oauthProviderName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProviderName' when calling deleteMsgVpnAuthenticationOauthProvider"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProviderName", oauthProviderName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an OAuth Provider object. - * Get an OAuth Provider object. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProviderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAuthenticationOauthProviderResponse getMsgVpnAuthenticationOauthProvider(String msgVpnName, String oauthProviderName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProviderWithHttpInfo(msgVpnName, oauthProviderName, opaquePassword, select).getBody(); - } - - /** - * Get an OAuth Provider object. - * Get an OAuth Provider object. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProviderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAuthenticationOauthProviderWithHttpInfo(String msgVpnName, String oauthProviderName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'oauthProviderName' is set - if (oauthProviderName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProviderName' when calling getMsgVpnAuthenticationOauthProvider"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProviderName", oauthProviderName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of OAuth Provider objects. - * Get a list of OAuth Provider objects. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The list of OAuth Provider objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProvidersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAuthenticationOauthProvidersResponse getMsgVpnAuthenticationOauthProviders(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProvidersWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of OAuth Provider objects. - * Get a list of OAuth Provider objects. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The list of OAuth Provider objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProvidersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAuthenticationOauthProvidersWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProviders"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an OAuth Provider object. - * Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- audienceClaimName||||||x| audienceClaimSource||||||x| audienceClaimValue||||||x| audienceValidationEnabled||||||x| authorizationGroupClaimName||||||x| authorizationGroupClaimSource||||||x| authorizationGroupEnabled||||||x| disconnectOnTokenExpirationEnabled||||||x| enabled||||||x| jwksRefreshInterval||||||x| jwksUri||||||x| msgVpnName|x||x|||x| oauthProviderName|x||x|||x| tokenIgnoreTimeLimitsEnabled||||||x| tokenIntrospectionParameterName||||||x| tokenIntrospectionPassword||||x||x|x tokenIntrospectionTimeout||||||x| tokenIntrospectionUri||||||x| tokenIntrospectionUsername||||||x| usernameClaimName||||||x| usernameClaimSource||||||x| usernameValidateEnabled||||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProviderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAuthenticationOauthProviderResponse replaceMsgVpnAuthenticationOauthProvider(String msgVpnName, String oauthProviderName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnAuthenticationOauthProviderWithHttpInfo(msgVpnName, oauthProviderName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an OAuth Provider object. - * Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- audienceClaimName||||||x| audienceClaimSource||||||x| audienceClaimValue||||||x| audienceValidationEnabled||||||x| authorizationGroupClaimName||||||x| authorizationGroupClaimSource||||||x| authorizationGroupEnabled||||||x| disconnectOnTokenExpirationEnabled||||||x| enabled||||||x| jwksRefreshInterval||||||x| jwksUri||||||x| msgVpnName|x||x|||x| oauthProviderName|x||x|||x| tokenIgnoreTimeLimitsEnabled||||||x| tokenIntrospectionParameterName||||||x| tokenIntrospectionPassword||||x||x|x tokenIntrospectionTimeout||||||x| tokenIntrospectionUri||||||x| tokenIntrospectionUsername||||||x| usernameClaimName||||||x| usernameClaimSource||||||x| usernameValidateEnabled||||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProviderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity replaceMsgVpnAuthenticationOauthProviderWithHttpInfo(String msgVpnName, String oauthProviderName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'oauthProviderName' is set - if (oauthProviderName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProviderName' when calling replaceMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnAuthenticationOauthProvider"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProviderName", oauthProviderName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an OAuth Provider object. - * Update an OAuth Provider object. Any attribute missing from the request will be left unchanged. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x|x|||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword|||x||x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProviderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAuthenticationOauthProviderResponse updateMsgVpnAuthenticationOauthProvider(String msgVpnName, String oauthProviderName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnAuthenticationOauthProviderWithHttpInfo(msgVpnName, oauthProviderName, body, opaquePassword, select).getBody(); - } - - /** - * Update an OAuth Provider object. - * Update an OAuth Provider object. Any attribute missing from the request will be left unchanged. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x|x|||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword|||x||x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProviderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity updateMsgVpnAuthenticationOauthProviderWithHttpInfo(String msgVpnName, String oauthProviderName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'oauthProviderName' is set - if (oauthProviderName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProviderName' when calling updateMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnAuthenticationOauthProvider"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProviderName", oauthProviderName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthorizationGroupApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthorizationGroupApi.java deleted file mode 100644 index aa8204cd3..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthorizationGroupApi.java +++ /dev/null @@ -1,460 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroupResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroupsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AuthorizationGroupApi { - private ApiClient apiClient; - - public AuthorizationGroupApi() { - this(new ApiClient()); - } - - public AuthorizationGroupApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create an Authorization Group object. - * Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationGroupName|x|x|||| msgVpnName|x||x||| orderAfterAuthorizationGroupName||||x|| orderBeforeAuthorizationGroupName||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthorizationGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthorizationGroupResponse createMsgVpnAuthorizationGroup(String msgVpnName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAuthorizationGroupWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an Authorization Group object. - * Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationGroupName|x|x|||| msgVpnName|x||x||| orderAfterAuthorizationGroupName||||x|| orderBeforeAuthorizationGroupName||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthorizationGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAuthorizationGroupWithHttpInfo(String msgVpnName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAuthorizationGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an Authorization Group object. - * Delete an Authorization Group object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAuthorizationGroup(String msgVpnName, String authorizationGroupName) throws RestClientException { - return deleteMsgVpnAuthorizationGroupWithHttpInfo(msgVpnName, authorizationGroupName).getBody(); - } - - /** - * Delete an Authorization Group object. - * Delete an Authorization Group object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAuthorizationGroupWithHttpInfo(String msgVpnName, String authorizationGroupName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'authorizationGroupName' is set - if (authorizationGroupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationGroupName' when calling deleteMsgVpnAuthorizationGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("authorizationGroupName", authorizationGroupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an Authorization Group object. - * Get an Authorization Group object. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthorizationGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthorizationGroupResponse getMsgVpnAuthorizationGroup(String msgVpnName, String authorizationGroupName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAuthorizationGroupWithHttpInfo(msgVpnName, authorizationGroupName, opaquePassword, select).getBody(); - } - - /** - * Get an Authorization Group object. - * Get an Authorization Group object. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthorizationGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthorizationGroupWithHttpInfo(String msgVpnName, String authorizationGroupName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'authorizationGroupName' is set - if (authorizationGroupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationGroupName' when calling getMsgVpnAuthorizationGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("authorizationGroupName", authorizationGroupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Authorization Group objects. - * Get a list of Authorization Group objects. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Authorization Group objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthorizationGroupsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthorizationGroupsResponse getMsgVpnAuthorizationGroups(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAuthorizationGroupsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Authorization Group objects. - * Get a list of Authorization Group objects. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Authorization Group objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthorizationGroupsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthorizationGroupsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthorizationGroups"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an Authorization Group object. - * Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| authorizationGroupName|x||x|||| clientProfileName|||||x|| msgVpnName|x||x|||| orderAfterAuthorizationGroupName||||x||| orderBeforeAuthorizationGroupName||||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthorizationGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthorizationGroupResponse replaceMsgVpnAuthorizationGroup(String msgVpnName, String authorizationGroupName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnAuthorizationGroupWithHttpInfo(msgVpnName, authorizationGroupName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an Authorization Group object. - * Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| authorizationGroupName|x||x|||| clientProfileName|||||x|| msgVpnName|x||x|||| orderAfterAuthorizationGroupName||||x||| orderBeforeAuthorizationGroupName||||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthorizationGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnAuthorizationGroupWithHttpInfo(String msgVpnName, String authorizationGroupName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'authorizationGroupName' is set - if (authorizationGroupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationGroupName' when calling replaceMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnAuthorizationGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("authorizationGroupName", authorizationGroupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an Authorization Group object. - * Update an Authorization Group object. Any attribute missing from the request will be left unchanged. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| authorizationGroupName|x|x|||| clientProfileName||||x|| msgVpnName|x|x|||| orderAfterAuthorizationGroupName|||x||| orderBeforeAuthorizationGroupName|||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthorizationGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthorizationGroupResponse updateMsgVpnAuthorizationGroup(String msgVpnName, String authorizationGroupName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnAuthorizationGroupWithHttpInfo(msgVpnName, authorizationGroupName, body, opaquePassword, select).getBody(); - } - - /** - * Update an Authorization Group object. - * Update an Authorization Group object. Any attribute missing from the request will be left unchanged. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| authorizationGroupName|x|x|||| clientProfileName||||x|| msgVpnName|x|x|||| orderAfterAuthorizationGroupName|||x||| orderBeforeAuthorizationGroupName|||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthorizationGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnAuthorizationGroupWithHttpInfo(String msgVpnName, String authorizationGroupName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'authorizationGroupName' is set - if (authorizationGroupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationGroupName' when calling updateMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnAuthorizationGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("authorizationGroupName", authorizationGroupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/BridgeApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/BridgeApi.java deleted file mode 100644 index 924c24f3c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/BridgeApi.java +++ /dev/null @@ -1,1720 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpnResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpnsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class BridgeApi { - private ApiClient apiClient; - - public BridgeApi() { - this(new ApiClient()); - } - - public BridgeApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Bridge object. - * Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| msgVpnName|x||x||| remoteAuthenticationBasicPassword||||x||x remoteAuthenticationClientCertContent||||x||x remoteAuthenticationClientCertPassword||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeResponse createMsgVpnBridge(String msgVpnName, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnBridgeWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Bridge object. - * Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| msgVpnName|x||x||| remoteAuthenticationBasicPassword||||x||x remoteAuthenticationClientCertContent||||x||x remoteAuthenticationClientCertPassword||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnBridgeWithHttpInfo(String msgVpnName, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Remote Message VPN object. - * Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| msgVpnName|x||x||| password||||x||x remoteMsgVpnInterface|x||||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteMsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteMsgVpnResponse createMsgVpnBridgeRemoteMsgVpn(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnBridgeRemoteMsgVpnWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Create a Remote Message VPN object. - * Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| msgVpnName|x||x||| password||||x||x remoteMsgVpnInterface|x||||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteMsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnBridgeRemoteMsgVpnWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling createMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling createMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnBridgeRemoteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Remote Subscription object. - * Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| deliverAlwaysEnabled||x|||| msgVpnName|x||x||| remoteSubscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Remote Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteSubscriptionResponse createMsgVpnBridgeRemoteSubscription(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeRemoteSubscription body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnBridgeRemoteSubscriptionWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Create a Remote Subscription object. - * Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| deliverAlwaysEnabled||x|||| msgVpnName|x||x||| remoteSubscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Remote Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnBridgeRemoteSubscriptionWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeRemoteSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling createMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling createMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnBridgeRemoteSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Trusted Common Name object. - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||x| bridgeVirtualRouter|x||x||x| msgVpnName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnBridgeTlsTrustedCommonNameResponse createMsgVpnBridgeTlsTrustedCommonName(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Create a Trusted Common Name object. - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||x| bridgeVirtualRouter|x||x||x| msgVpnName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling createMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling createMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnBridgeTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Bridge object. - * Delete a Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnBridge(String msgVpnName, String bridgeName, String bridgeVirtualRouter) throws RestClientException { - return deleteMsgVpnBridgeWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter).getBody(); - } - - /** - * Delete a Bridge object. - * Delete a Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnBridgeWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnBridge"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling deleteMsgVpnBridge"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling deleteMsgVpnBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Remote Message VPN object. - * Delete a Remote Message VPN object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnBridgeRemoteMsgVpn(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface) throws RestClientException { - return deleteMsgVpnBridgeRemoteMsgVpnWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface).getBody(); - } - - /** - * Delete a Remote Message VPN object. - * Delete a Remote Message VPN object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnBridgeRemoteMsgVpnWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnName' is set - if (remoteMsgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnName' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnLocation' is set - if (remoteMsgVpnLocation == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnLocation' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnInterface' is set - if (remoteMsgVpnInterface == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnInterface' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteMsgVpnName", remoteMsgVpnName); - uriVariables.put("remoteMsgVpnLocation", remoteMsgVpnLocation); - uriVariables.put("remoteMsgVpnInterface", remoteMsgVpnInterface); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Remote Subscription object. - * Delete a Remote Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteSubscriptionTopic The topic of the Bridge remote subscription. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnBridgeRemoteSubscription(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteSubscriptionTopic) throws RestClientException { - return deleteMsgVpnBridgeRemoteSubscriptionWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic).getBody(); - } - - /** - * Delete a Remote Subscription object. - * Delete a Remote Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteSubscriptionTopic The topic of the Bridge remote subscription. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnBridgeRemoteSubscriptionWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteSubscriptionTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling deleteMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling deleteMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'remoteSubscriptionTopic' is set - if (remoteSubscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteSubscriptionTopic' when calling deleteMsgVpnBridgeRemoteSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteSubscriptionTopic", remoteSubscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Trusted Common Name object. - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteMsgVpnBridgeTlsTrustedCommonName(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String tlsTrustedCommonName) throws RestClientException { - return deleteMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName).getBody(); - } - - /** - * Delete a Trusted Common Name object. - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String tlsTrustedCommonName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling deleteMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling deleteMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'tlsTrustedCommonName' is set - if (tlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'tlsTrustedCommonName' when calling deleteMsgVpnBridgeTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("tlsTrustedCommonName", tlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Bridge object. - * Get a Bridge object. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeResponse getMsgVpnBridge(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List select) throws RestClientException { - return getMsgVpnBridgeWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, select).getBody(); - } - - /** - * Get a Bridge object. - * Get a Bridge object. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgeWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridge"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridge"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Remote Message VPN object. - * Get a Remote Message VPN object. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteMsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteMsgVpnResponse getMsgVpnBridgeRemoteMsgVpn(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, String opaquePassword, List select) throws RestClientException { - return getMsgVpnBridgeRemoteMsgVpnWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, opaquePassword, select).getBody(); - } - - /** - * Get a Remote Message VPN object. - * Get a Remote Message VPN object. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteMsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgeRemoteMsgVpnWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnName' is set - if (remoteMsgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnName' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnLocation' is set - if (remoteMsgVpnLocation == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnLocation' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnInterface' is set - if (remoteMsgVpnInterface == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnInterface' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteMsgVpnName", remoteMsgVpnName); - uriVariables.put("remoteMsgVpnLocation", remoteMsgVpnLocation); - uriVariables.put("remoteMsgVpnInterface", remoteMsgVpnInterface); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Remote Message VPN objects. - * Get a list of Remote Message VPN objects. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Remote Message VPN objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteMsgVpnsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteMsgVpnsResponse getMsgVpnBridgeRemoteMsgVpns(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnBridgeRemoteMsgVpnsWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Remote Message VPN objects. - * Get a list of Remote Message VPN objects. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Remote Message VPN objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteMsgVpnsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgeRemoteMsgVpnsWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeRemoteMsgVpns"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeRemoteMsgVpns"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeRemoteMsgVpns"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Remote Subscription object. - * Get a Remote Subscription object. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteSubscriptionTopic The topic of the Bridge remote subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteSubscriptionResponse getMsgVpnBridgeRemoteSubscription(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteSubscriptionTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnBridgeRemoteSubscriptionWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Remote Subscription object. - * Get a Remote Subscription object. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteSubscriptionTopic The topic of the Bridge remote subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgeRemoteSubscriptionWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteSubscriptionTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'remoteSubscriptionTopic' is set - if (remoteSubscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteSubscriptionTopic' when calling getMsgVpnBridgeRemoteSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteSubscriptionTopic", remoteSubscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Remote Subscription objects. - * Get a list of Remote Subscription objects. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Remote Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteSubscriptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteSubscriptionsResponse getMsgVpnBridgeRemoteSubscriptions(String msgVpnName, String bridgeName, String bridgeVirtualRouter, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnBridgeRemoteSubscriptionsWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Remote Subscription objects. - * Get a list of Remote Subscription objects. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Remote Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteSubscriptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgeRemoteSubscriptionsWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeRemoteSubscriptions"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeRemoteSubscriptions"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeRemoteSubscriptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Trusted Common Name object. - * Get a Trusted Common Name object. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnBridgeTlsTrustedCommonNameResponse getMsgVpnBridgeTlsTrustedCommonName(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String tlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName, opaquePassword, select).getBody(); - } - - /** - * Get a Trusted Common Name object. - * Get a Trusted Common Name object. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String tlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'tlsTrustedCommonName' is set - if (tlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'tlsTrustedCommonName' when calling getMsgVpnBridgeTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("tlsTrustedCommonName", tlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Trusted Common Name objects. - * Get a list of Trusted Common Name objects. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The list of Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeTlsTrustedCommonNamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnBridgeTlsTrustedCommonNamesResponse getMsgVpnBridgeTlsTrustedCommonNames(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnBridgeTlsTrustedCommonNamesWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Trusted Common Name objects. - * Get a list of Trusted Common Name objects. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The list of Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeTlsTrustedCommonNamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnBridgeTlsTrustedCommonNamesWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeTlsTrustedCommonNames"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeTlsTrustedCommonNames"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeTlsTrustedCommonNames"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Bridge objects. - * Get a list of Bridge objects. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Bridge objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgesResponse getMsgVpnBridges(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnBridgesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Bridge objects. - * Get a list of Bridge objects. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Bridge objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridges"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Bridge object. - * Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| maxTtl|||||x|| msgVpnName|x||x|||| remoteAuthenticationBasicClientUsername|||||x|| remoteAuthenticationBasicPassword||||x|x||x remoteAuthenticationClientCertContent||||x|x||x remoteAuthenticationClientCertPassword||||x|x|| remoteAuthenticationScheme|||||x|| remoteDeliverToOnePriority|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeResponse replaceMsgVpnBridge(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnBridgeWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Bridge object. - * Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| maxTtl|||||x|| msgVpnName|x||x|||| remoteAuthenticationBasicClientUsername|||||x|| remoteAuthenticationBasicPassword||||x|x||x remoteAuthenticationClientCertContent||||x|x||x remoteAuthenticationClientCertPassword||||x|x|| remoteAuthenticationScheme|||||x|| remoteDeliverToOnePriority|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnBridgeWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnBridge"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling replaceMsgVpnBridge"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling replaceMsgVpnBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Remote Message VPN object. - * Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| clientUsername|||||x|| compressedDataEnabled|||||x|| egressFlowWindowSize|||||x|| msgVpnName|x||x|||| password||||x|x||x remoteMsgVpnInterface|x||x|||| remoteMsgVpnLocation|x||x|||| remoteMsgVpnName|x||x|||| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteMsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteMsgVpnResponse replaceMsgVpnBridgeRemoteMsgVpn(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnBridgeRemoteMsgVpnWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Remote Message VPN object. - * Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| clientUsername|||||x|| compressedDataEnabled|||||x|| egressFlowWindowSize|||||x|| msgVpnName|x||x|||| password||||x|x||x remoteMsgVpnInterface|x||x|||| remoteMsgVpnLocation|x||x|||| remoteMsgVpnName|x||x|||| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteMsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnBridgeRemoteMsgVpnWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnName' is set - if (remoteMsgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnName' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnLocation' is set - if (remoteMsgVpnLocation == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnLocation' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnInterface' is set - if (remoteMsgVpnInterface == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnInterface' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteMsgVpnName", remoteMsgVpnName); - uriVariables.put("remoteMsgVpnLocation", remoteMsgVpnLocation); - uriVariables.put("remoteMsgVpnInterface", remoteMsgVpnInterface); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Bridge object. - * Update a Bridge object. Any attribute missing from the request will be left unchanged. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| maxTtl||||x|| msgVpnName|x|x|||| remoteAuthenticationBasicClientUsername||||x|| remoteAuthenticationBasicPassword|||x|x||x remoteAuthenticationClientCertContent|||x|x||x remoteAuthenticationClientCertPassword|||x|x|| remoteAuthenticationScheme||||x|| remoteDeliverToOnePriority||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeResponse updateMsgVpnBridge(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnBridgeWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Update a Bridge object. - * Update a Bridge object. Any attribute missing from the request will be left unchanged. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| maxTtl||||x|| msgVpnName|x|x|||| remoteAuthenticationBasicClientUsername||||x|| remoteAuthenticationBasicPassword|||x|x||x remoteAuthenticationClientCertContent|||x|x||x remoteAuthenticationClientCertPassword|||x|x|| remoteAuthenticationScheme||||x|| remoteDeliverToOnePriority||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnBridgeWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnBridge"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling updateMsgVpnBridge"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling updateMsgVpnBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Remote Message VPN object. - * Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| clientUsername||||x|| compressedDataEnabled||||x|| egressFlowWindowSize||||x|| msgVpnName|x|x|||| password|||x|x||x remoteMsgVpnInterface|x|x|||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteMsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteMsgVpnResponse updateMsgVpnBridgeRemoteMsgVpn(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnBridgeRemoteMsgVpnWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select).getBody(); - } - - /** - * Update a Remote Message VPN object. - * Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| clientUsername||||x|| compressedDataEnabled||||x|| egressFlowWindowSize||||x|| msgVpnName|x|x|||| password|||x|x||x remoteMsgVpnInterface|x|x|||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteMsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnBridgeRemoteMsgVpnWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnName' is set - if (remoteMsgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnName' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnLocation' is set - if (remoteMsgVpnLocation == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnLocation' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnInterface' is set - if (remoteMsgVpnInterface == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnInterface' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteMsgVpnName", remoteMsgVpnName); - uriVariables.put("remoteMsgVpnLocation", remoteMsgVpnLocation); - uriVariables.put("remoteMsgVpnInterface", remoteMsgVpnInterface); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/CertAuthorityApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/CertAuthorityApi.java deleted file mode 100644 index 93d65fc16..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/CertAuthorityApi.java +++ /dev/null @@ -1,704 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthoritiesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class CertAuthorityApi { - private ApiClient apiClient; - - public CertAuthorityApi() { - this(new ApiClient()); - } - - public CertAuthorityApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Certificate Authority object. - * Create a Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||x| certContent|||||x| crlDayList|||||x| crlTimeList|||||x| crlUrl|||||x| ocspNonResponderCertEnabled|||||x| ocspOverrideUrl|||||x| ocspTimeout|||||x| revocationCheckEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The Certificate Authority object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return CertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public CertAuthorityResponse createCertAuthority(CertAuthority body, String opaquePassword, List select) throws RestClientException { - return createCertAuthorityWithHttpInfo(body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Authority object. - * Create a Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||x| certContent|||||x| crlDayList|||||x| crlTimeList|||||x| crlUrl|||||x| ocspNonResponderCertEnabled|||||x| ocspOverrideUrl|||||x| ocspTimeout|||||x| revocationCheckEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The Certificate Authority object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<CertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createCertAuthorityWithHttpInfo(CertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createCertAuthority"); - } - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities", HttpMethod.POST, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an OCSP Responder Trusted Common Name object. - * Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x||x||x| ocspTlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - *

200 - The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The OCSP Responder Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return CertAuthorityOcspTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public CertAuthorityOcspTlsTrustedCommonNameResponse createCertAuthorityOcspTlsTrustedCommonName(String certAuthorityName, CertAuthorityOcspTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - return createCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(certAuthorityName, body, opaquePassword, select).getBody(); - } - - /** - * Create an OCSP Responder Trusted Common Name object. - * Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x||x||x| ocspTlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - *

200 - The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The OCSP Responder Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<CertAuthorityOcspTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(String certAuthorityName, CertAuthorityOcspTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling createCertAuthorityOcspTlsTrustedCommonName"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createCertAuthorityOcspTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Authority object. - * Delete a Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteCertAuthority(String certAuthorityName) throws RestClientException { - return deleteCertAuthorityWithHttpInfo(certAuthorityName).getBody(); - } - - /** - * Delete a Certificate Authority object. - * Delete a Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteCertAuthorityWithHttpInfo(String certAuthorityName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling deleteCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities/{certAuthorityName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an OCSP Responder Trusted Common Name object. - * Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param ocspTlsTrustedCommonName The expected Trusted Common Name of the OCSP responder remote certificate. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteCertAuthorityOcspTlsTrustedCommonName(String certAuthorityName, String ocspTlsTrustedCommonName) throws RestClientException { - return deleteCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(certAuthorityName, ocspTlsTrustedCommonName).getBody(); - } - - /** - * Delete an OCSP Responder Trusted Common Name object. - * Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param ocspTlsTrustedCommonName The expected Trusted Common Name of the OCSP responder remote certificate. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(String certAuthorityName, String ocspTlsTrustedCommonName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling deleteCertAuthorityOcspTlsTrustedCommonName"); - } - - // verify the required parameter 'ocspTlsTrustedCommonName' is set - if (ocspTlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ocspTlsTrustedCommonName' when calling deleteCertAuthorityOcspTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - uriVariables.put("ocspTlsTrustedCommonName", ocspTlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Authority objects. - * Get a list of Certificate Authority objects. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| certContent|||x| crlDayList|||x| crlTimeList|||x| crlUrl|||x| ocspNonResponderCertEnabled|||x| ocspOverrideUrl|||x| ocspTimeout|||x| revocationCheckEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The list of Certificate Authority objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return CertAuthoritiesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public CertAuthoritiesResponse getCertAuthorities(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getCertAuthoritiesWithHttpInfo(count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Authority objects. - * Get a list of Certificate Authority objects. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| certContent|||x| crlDayList|||x| crlTimeList|||x| crlUrl|||x| ocspNonResponderCertEnabled|||x| ocspOverrideUrl|||x| ocspTimeout|||x| revocationCheckEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The list of Certificate Authority objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<CertAuthoritiesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getCertAuthoritiesWithHttpInfo(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Authority object. - * Get a Certificate Authority object. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| certContent|||x| crlDayList|||x| crlTimeList|||x| crlUrl|||x| ocspNonResponderCertEnabled|||x| ocspOverrideUrl|||x| ocspTimeout|||x| revocationCheckEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The Certificate Authority object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return CertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public CertAuthorityResponse getCertAuthority(String certAuthorityName, String opaquePassword, List select) throws RestClientException { - return getCertAuthorityWithHttpInfo(certAuthorityName, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Authority object. - * Get a Certificate Authority object. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| certContent|||x| crlDayList|||x| crlTimeList|||x| crlUrl|||x| ocspNonResponderCertEnabled|||x| ocspOverrideUrl|||x| ocspTimeout|||x| revocationCheckEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The Certificate Authority object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<CertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getCertAuthorityWithHttpInfo(String certAuthorityName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling getCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities/{certAuthorityName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an OCSP Responder Trusted Common Name object. - * Get an OCSP Responder Trusted Common Name object. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| ocspTlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - *

200 - The OCSP Responder Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param ocspTlsTrustedCommonName The expected Trusted Common Name of the OCSP responder remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return CertAuthorityOcspTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public CertAuthorityOcspTlsTrustedCommonNameResponse getCertAuthorityOcspTlsTrustedCommonName(String certAuthorityName, String ocspTlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - return getCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(certAuthorityName, ocspTlsTrustedCommonName, opaquePassword, select).getBody(); - } - - /** - * Get an OCSP Responder Trusted Common Name object. - * Get an OCSP Responder Trusted Common Name object. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| ocspTlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - *

200 - The OCSP Responder Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param ocspTlsTrustedCommonName The expected Trusted Common Name of the OCSP responder remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<CertAuthorityOcspTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(String certAuthorityName, String ocspTlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling getCertAuthorityOcspTlsTrustedCommonName"); - } - - // verify the required parameter 'ocspTlsTrustedCommonName' is set - if (ocspTlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ocspTlsTrustedCommonName' when calling getCertAuthorityOcspTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - uriVariables.put("ocspTlsTrustedCommonName", ocspTlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of OCSP Responder Trusted Common Name objects. - * Get a list of OCSP Responder Trusted Common Name objects. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| ocspTlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - *

200 - The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return CertAuthorityOcspTlsTrustedCommonNamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public CertAuthorityOcspTlsTrustedCommonNamesResponse getCertAuthorityOcspTlsTrustedCommonNames(String certAuthorityName, String opaquePassword, List where, List select) throws RestClientException { - return getCertAuthorityOcspTlsTrustedCommonNamesWithHttpInfo(certAuthorityName, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of OCSP Responder Trusted Common Name objects. - * Get a list of OCSP Responder Trusted Common Name objects. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| ocspTlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - *

200 - The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<CertAuthorityOcspTlsTrustedCommonNamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getCertAuthorityOcspTlsTrustedCommonNamesWithHttpInfo(String certAuthorityName, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling getCertAuthorityOcspTlsTrustedCommonNames"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Certificate Authority object. - * Replace a Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||x| certContent||||||x| crlDayList||||||x| crlTimeList||||||x| crlUrl|||||x|x| ocspNonResponderCertEnabled||||||x| ocspOverrideUrl||||||x| ocspTimeout||||||x| revocationCheckEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The Certificate Authority object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return CertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public CertAuthorityResponse replaceCertAuthority(String certAuthorityName, CertAuthority body, String opaquePassword, List select) throws RestClientException { - return replaceCertAuthorityWithHttpInfo(certAuthorityName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Certificate Authority object. - * Replace a Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||x| certContent||||||x| crlDayList||||||x| crlTimeList||||||x| crlUrl|||||x|x| ocspNonResponderCertEnabled||||||x| ocspOverrideUrl||||||x| ocspTimeout||||||x| revocationCheckEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The Certificate Authority object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<CertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity replaceCertAuthorityWithHttpInfo(String certAuthorityName, CertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling replaceCertAuthority"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities/{certAuthorityName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Certificate Authority object. - * Update a Certificate Authority object. Any attribute missing from the request will be left unchanged. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||x| certContent|||||x| crlDayList|||||x| crlTimeList|||||x| crlUrl||||x|x| ocspNonResponderCertEnabled|||||x| ocspOverrideUrl|||||x| ocspTimeout|||||x| revocationCheckEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The Certificate Authority object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return CertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public CertAuthorityResponse updateCertAuthority(String certAuthorityName, CertAuthority body, String opaquePassword, List select) throws RestClientException { - return updateCertAuthorityWithHttpInfo(certAuthorityName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Certificate Authority object. - * Update a Certificate Authority object. Any attribute missing from the request will be left unchanged. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||x| certContent|||||x| crlDayList|||||x| crlTimeList|||||x| crlUrl||||x|x| ocspNonResponderCertEnabled|||||x| ocspOverrideUrl|||||x| ocspTimeout|||||x| revocationCheckEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - *

200 - The Certificate Authority object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<CertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity updateCertAuthorityWithHttpInfo(String certAuthorityName, CertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling updateCertAuthority"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/certAuthorities/{certAuthorityName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/CertMatchingRuleApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/CertMatchingRuleApi.java deleted file mode 100644 index 0f3641ef0..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/CertMatchingRuleApi.java +++ /dev/null @@ -1,1214 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFiltersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleConditionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleConditionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRulesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class CertMatchingRuleApi { - private ApiClient apiClient; - - public CertMatchingRuleApi() { - this(new ApiClient()); - } - - public CertMatchingRuleApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Certificate Matching Rule object. - * Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleResponse createMsgVpnCertMatchingRule(String msgVpnName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnCertMatchingRuleWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Matching Rule object. - * Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnCertMatchingRuleWithHttpInfo(String msgVpnName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Certificate Matching Rule Attribute Filter object. - * Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: filterName|x|x|||| msgVpnName|x||x||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleAttributeFilterResponse createMsgVpnCertMatchingRuleAttributeFilter(String msgVpnName, String ruleName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(msgVpnName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Matching Rule Attribute Filter object. - * Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: filterName|x|x|||| msgVpnName|x||x||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(String msgVpnName, String ruleName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling createMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Certificate Matching Rule Condition object. - * Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule Condition object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Condition object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleConditionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleConditionResponse createMsgVpnCertMatchingRuleCondition(String msgVpnName, String ruleName, MsgVpnCertMatchingRuleCondition body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnCertMatchingRuleConditionWithHttpInfo(msgVpnName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Matching Rule Condition object. - * Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule Condition object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Condition object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleConditionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnCertMatchingRuleConditionWithHttpInfo(String msgVpnName, String ruleName, MsgVpnCertMatchingRuleCondition body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling createMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnCertMatchingRuleCondition"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Matching Rule object. - * Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnCertMatchingRule(String msgVpnName, String ruleName) throws RestClientException { - return deleteMsgVpnCertMatchingRuleWithHttpInfo(msgVpnName, ruleName).getBody(); - } - - /** - * Delete a Certificate Matching Rule object. - * Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnCertMatchingRuleWithHttpInfo(String msgVpnName, String ruleName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling deleteMsgVpnCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Matching Rule Attribute Filter object. - * Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnCertMatchingRuleAttributeFilter(String msgVpnName, String ruleName, String filterName) throws RestClientException { - return deleteMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(msgVpnName, ruleName, filterName).getBody(); - } - - /** - * Delete a Certificate Matching Rule Attribute Filter object. - * Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(String msgVpnName, String ruleName, String filterName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling deleteMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling deleteMsgVpnCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Matching Rule Condition object. - * Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnCertMatchingRuleCondition(String msgVpnName, String ruleName, String source) throws RestClientException { - return deleteMsgVpnCertMatchingRuleConditionWithHttpInfo(msgVpnName, ruleName, source).getBody(); - } - - /** - * Delete a Certificate Matching Rule Condition object. - * Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnCertMatchingRuleConditionWithHttpInfo(String msgVpnName, String ruleName, String source) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling deleteMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'source' is set - if (source == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'source' when calling deleteMsgVpnCertMatchingRuleCondition"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("source", source); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Matching Rule object. - * Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleResponse getMsgVpnCertMatchingRule(String msgVpnName, String ruleName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnCertMatchingRuleWithHttpInfo(msgVpnName, ruleName, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Matching Rule object. - * Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRuleWithHttpInfo(String msgVpnName, String ruleName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getMsgVpnCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Matching Rule Attribute Filter object. - * Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleAttributeFilterResponse getMsgVpnCertMatchingRuleAttributeFilter(String msgVpnName, String ruleName, String filterName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(msgVpnName, ruleName, filterName, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Matching Rule Attribute Filter object. - * Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(String msgVpnName, String ruleName, String filterName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling getMsgVpnCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Matching Rule Attribute Filter objects. - * Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleAttributeFiltersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleAttributeFiltersResponse getMsgVpnCertMatchingRuleAttributeFilters(String msgVpnName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnCertMatchingRuleAttributeFiltersWithHttpInfo(msgVpnName, ruleName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Matching Rule Attribute Filter objects. - * Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleAttributeFiltersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRuleAttributeFiltersWithHttpInfo(String msgVpnName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRuleAttributeFilters"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getMsgVpnCertMatchingRuleAttributeFilters"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Matching Rule Condition object. - * Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule Condition object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleConditionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleConditionResponse getMsgVpnCertMatchingRuleCondition(String msgVpnName, String ruleName, String source, String opaquePassword, List select) throws RestClientException { - return getMsgVpnCertMatchingRuleConditionWithHttpInfo(msgVpnName, ruleName, source, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Matching Rule Condition object. - * Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule Condition object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleConditionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRuleConditionWithHttpInfo(String msgVpnName, String ruleName, String source, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'source' is set - if (source == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'source' when calling getMsgVpnCertMatchingRuleCondition"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("source", source); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Matching Rule Condition objects. - * Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Certificate Matching Rule Condition objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleConditionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleConditionsResponse getMsgVpnCertMatchingRuleConditions(String msgVpnName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnCertMatchingRuleConditionsWithHttpInfo(msgVpnName, ruleName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Matching Rule Condition objects. - * Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Certificate Matching Rule Condition objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleConditionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRuleConditionsWithHttpInfo(String msgVpnName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRuleConditions"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getMsgVpnCertMatchingRuleConditions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Matching Rule objects. - * Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Certificate Matching Rule objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRulesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRulesResponse getMsgVpnCertMatchingRules(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnCertMatchingRulesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Matching Rule objects. - * Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Certificate Matching Rule objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRulesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRulesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRules"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Certificate Matching Rule object. - * Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleResponse replaceMsgVpnCertMatchingRule(String msgVpnName, String ruleName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnCertMatchingRuleWithHttpInfo(msgVpnName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Certificate Matching Rule object. - * Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnCertMatchingRuleWithHttpInfo(String msgVpnName, String ruleName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling replaceMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Certificate Matching Rule Attribute Filter object. - * Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- filterName|x||x|||| msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleAttributeFilterResponse replaceMsgVpnCertMatchingRuleAttributeFilter(String msgVpnName, String ruleName, String filterName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(msgVpnName, ruleName, filterName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Certificate Matching Rule Attribute Filter object. - * Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- filterName|x||x|||| msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(String msgVpnName, String ruleName, String filterName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling replaceMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling replaceMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Certificate Matching Rule object. - * Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleResponse updateMsgVpnCertMatchingRule(String msgVpnName, String ruleName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnCertMatchingRuleWithHttpInfo(msgVpnName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Certificate Matching Rule object. - * Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnCertMatchingRuleWithHttpInfo(String msgVpnName, String ruleName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling updateMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Certificate Matching Rule Attribute Filter object. - * Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- filterName|x|x|||| msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleAttributeFilterResponse updateMsgVpnCertMatchingRuleAttributeFilter(String msgVpnName, String ruleName, String filterName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(msgVpnName, ruleName, filterName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Certificate Matching Rule Attribute Filter object. - * Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- filterName|x|x|||| msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(String msgVpnName, String ruleName, String filterName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling updateMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling updateMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientCertAuthorityApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientCertAuthorityApi.java deleted file mode 100644 index 070d54ce7..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientCertAuthorityApi.java +++ /dev/null @@ -1,664 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthoritiesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class ClientCertAuthorityApi { - private ApiClient apiClient; - - public ClientCertAuthorityApi() { - this(new ApiClient()); - } - - public ClientCertAuthorityApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Client Certificate Authority object. - * Create a Client Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Client Certificate Authority object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Client Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ClientCertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ClientCertAuthorityResponse createClientCertAuthority(ClientCertAuthority body, String opaquePassword, List select) throws RestClientException { - return createClientCertAuthorityWithHttpInfo(body, opaquePassword, select).getBody(); - } - - /** - * Create a Client Certificate Authority object. - * Create a Client Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Client Certificate Authority object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Client Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<ClientCertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createClientCertAuthorityWithHttpInfo(ClientCertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createClientCertAuthority"); - } - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities", HttpMethod.POST, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an OCSP Responder Trusted Common Name object. - * Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x||x||| ocspTlsTrustedCommonName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The OCSP Responder Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ClientCertAuthorityOcspTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ClientCertAuthorityOcspTlsTrustedCommonNameResponse createClientCertAuthorityOcspTlsTrustedCommonName(String certAuthorityName, ClientCertAuthorityOcspTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - return createClientCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(certAuthorityName, body, opaquePassword, select).getBody(); - } - - /** - * Create an OCSP Responder Trusted Common Name object. - * Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x||x||| ocspTlsTrustedCommonName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The OCSP Responder Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<ClientCertAuthorityOcspTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createClientCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(String certAuthorityName, ClientCertAuthorityOcspTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling createClientCertAuthorityOcspTlsTrustedCommonName"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createClientCertAuthorityOcspTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Client Certificate Authority object. - * Delete a Client Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteClientCertAuthority(String certAuthorityName) throws RestClientException { - return deleteClientCertAuthorityWithHttpInfo(certAuthorityName).getBody(); - } - - /** - * Delete a Client Certificate Authority object. - * Delete a Client Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteClientCertAuthorityWithHttpInfo(String certAuthorityName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling deleteClientCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities/{certAuthorityName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an OCSP Responder Trusted Common Name object. - * Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param ocspTlsTrustedCommonName The expected Trusted Common Name of the OCSP responder remote certificate. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteClientCertAuthorityOcspTlsTrustedCommonName(String certAuthorityName, String ocspTlsTrustedCommonName) throws RestClientException { - return deleteClientCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(certAuthorityName, ocspTlsTrustedCommonName).getBody(); - } - - /** - * Delete an OCSP Responder Trusted Common Name object. - * Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param ocspTlsTrustedCommonName The expected Trusted Common Name of the OCSP responder remote certificate. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteClientCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(String certAuthorityName, String ocspTlsTrustedCommonName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling deleteClientCertAuthorityOcspTlsTrustedCommonName"); - } - - // verify the required parameter 'ocspTlsTrustedCommonName' is set - if (ocspTlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ocspTlsTrustedCommonName' when calling deleteClientCertAuthorityOcspTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - uriVariables.put("ocspTlsTrustedCommonName", ocspTlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Client Certificate Authority objects. - * Get a list of Client Certificate Authority objects. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The list of Client Certificate Authority objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ClientCertAuthoritiesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ClientCertAuthoritiesResponse getClientCertAuthorities(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getClientCertAuthoritiesWithHttpInfo(count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Client Certificate Authority objects. - * Get a list of Client Certificate Authority objects. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The list of Client Certificate Authority objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<ClientCertAuthoritiesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getClientCertAuthoritiesWithHttpInfo(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Client Certificate Authority object. - * Get a Client Certificate Authority object. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The Client Certificate Authority object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ClientCertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ClientCertAuthorityResponse getClientCertAuthority(String certAuthorityName, String opaquePassword, List select) throws RestClientException { - return getClientCertAuthorityWithHttpInfo(certAuthorityName, opaquePassword, select).getBody(); - } - - /** - * Get a Client Certificate Authority object. - * Get a Client Certificate Authority object. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The Client Certificate Authority object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<ClientCertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getClientCertAuthorityWithHttpInfo(String certAuthorityName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling getClientCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities/{certAuthorityName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an OCSP Responder Trusted Common Name object. - * Get an OCSP Responder Trusted Common Name object. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| ocspTlsTrustedCommonName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The OCSP Responder Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param ocspTlsTrustedCommonName The expected Trusted Common Name of the OCSP responder remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ClientCertAuthorityOcspTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ClientCertAuthorityOcspTlsTrustedCommonNameResponse getClientCertAuthorityOcspTlsTrustedCommonName(String certAuthorityName, String ocspTlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - return getClientCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(certAuthorityName, ocspTlsTrustedCommonName, opaquePassword, select).getBody(); - } - - /** - * Get an OCSP Responder Trusted Common Name object. - * Get an OCSP Responder Trusted Common Name object. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| ocspTlsTrustedCommonName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The OCSP Responder Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param ocspTlsTrustedCommonName The expected Trusted Common Name of the OCSP responder remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<ClientCertAuthorityOcspTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getClientCertAuthorityOcspTlsTrustedCommonNameWithHttpInfo(String certAuthorityName, String ocspTlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling getClientCertAuthorityOcspTlsTrustedCommonName"); - } - - // verify the required parameter 'ocspTlsTrustedCommonName' is set - if (ocspTlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ocspTlsTrustedCommonName' when calling getClientCertAuthorityOcspTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - uriVariables.put("ocspTlsTrustedCommonName", ocspTlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of OCSP Responder Trusted Common Name objects. - * Get a list of OCSP Responder Trusted Common Name objects. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| ocspTlsTrustedCommonName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ClientCertAuthorityOcspTlsTrustedCommonNamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ClientCertAuthorityOcspTlsTrustedCommonNamesResponse getClientCertAuthorityOcspTlsTrustedCommonNames(String certAuthorityName, String opaquePassword, List where, List select) throws RestClientException { - return getClientCertAuthorityOcspTlsTrustedCommonNamesWithHttpInfo(certAuthorityName, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of OCSP Responder Trusted Common Name objects. - * Get a list of OCSP Responder Trusted Common Name objects. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| ocspTlsTrustedCommonName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<ClientCertAuthorityOcspTlsTrustedCommonNamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getClientCertAuthorityOcspTlsTrustedCommonNamesWithHttpInfo(String certAuthorityName, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling getClientCertAuthorityOcspTlsTrustedCommonNames"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Client Certificate Authority object. - * Replace a Client Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||| crlUrl|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Client Certificate Authority object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Client Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ClientCertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ClientCertAuthorityResponse replaceClientCertAuthority(String certAuthorityName, ClientCertAuthority body, String opaquePassword, List select) throws RestClientException { - return replaceClientCertAuthorityWithHttpInfo(certAuthorityName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Client Certificate Authority object. - * Replace a Client Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||| crlUrl|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Client Certificate Authority object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Client Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<ClientCertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceClientCertAuthorityWithHttpInfo(String certAuthorityName, ClientCertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling replaceClientCertAuthority"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceClientCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities/{certAuthorityName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Client Certificate Authority object. - * Update a Client Certificate Authority object. Any attribute missing from the request will be left unchanged. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||| crlUrl||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Client Certificate Authority object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Client Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ClientCertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ClientCertAuthorityResponse updateClientCertAuthority(String certAuthorityName, ClientCertAuthority body, String opaquePassword, List select) throws RestClientException { - return updateClientCertAuthorityWithHttpInfo(certAuthorityName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Client Certificate Authority object. - * Update a Client Certificate Authority object. Any attribute missing from the request will be left unchanged. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||| crlUrl||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Client Certificate Authority object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Client Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<ClientCertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateClientCertAuthorityWithHttpInfo(String certAuthorityName, ClientCertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling updateClientCertAuthority"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateClientCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/clientCertAuthorities/{certAuthorityName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientProfileApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientProfileApi.java deleted file mode 100644 index 3dd6fcc8c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientProfileApi.java +++ /dev/null @@ -1,460 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class ClientProfileApi { - private ApiClient apiClient; - - public ClientProfileApi() { - this(new ApiClient()); - } - - public ClientProfileApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Client Profile object. - * Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientProfileResponse createMsgVpnClientProfile(String msgVpnName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnClientProfileWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Client Profile object. - * Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnClientProfileWithHttpInfo(String msgVpnName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnClientProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnClientProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Client Profile object. - * Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnClientProfile(String msgVpnName, String clientProfileName) throws RestClientException { - return deleteMsgVpnClientProfileWithHttpInfo(msgVpnName, clientProfileName).getBody(); - } - - /** - * Delete a Client Profile object. - * Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnClientProfileWithHttpInfo(String msgVpnName, String clientProfileName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnClientProfile"); - } - - // verify the required parameter 'clientProfileName' is set - if (clientProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientProfileName' when calling deleteMsgVpnClientProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientProfileName", clientProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Client Profile object. - * Get a Client Profile object. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientProfileResponse getMsgVpnClientProfile(String msgVpnName, String clientProfileName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnClientProfileWithHttpInfo(msgVpnName, clientProfileName, opaquePassword, select).getBody(); - } - - /** - * Get a Client Profile object. - * Get a Client Profile object. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientProfileWithHttpInfo(String msgVpnName, String clientProfileName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientProfile"); - } - - // verify the required parameter 'clientProfileName' is set - if (clientProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientProfileName' when calling getMsgVpnClientProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientProfileName", clientProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Client Profile objects. - * Get a list of Client Profile objects. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientProfilesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientProfilesResponse getMsgVpnClientProfiles(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnClientProfilesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Client Profile objects. - * Get a list of Client Profile objects. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientProfilesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientProfilesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientProfiles"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Client Profile object. - * Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled||||||x| apiQueueManagementCopyFromOnCreateName||||||x| apiTopicEndpointManagementCopyFromOnCreateName||||||x| clientProfileName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientProfileResponse replaceMsgVpnClientProfile(String msgVpnName, String clientProfileName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnClientProfileWithHttpInfo(msgVpnName, clientProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Client Profile object. - * Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled||||||x| apiQueueManagementCopyFromOnCreateName||||||x| apiTopicEndpointManagementCopyFromOnCreateName||||||x| clientProfileName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnClientProfileWithHttpInfo(String msgVpnName, String clientProfileName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnClientProfile"); - } - - // verify the required parameter 'clientProfileName' is set - if (clientProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientProfileName' when calling replaceMsgVpnClientProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnClientProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientProfileName", clientProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Client Profile object. - * Update a Client Profile object. Any attribute missing from the request will be left unchanged. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientProfileResponse updateMsgVpnClientProfile(String msgVpnName, String clientProfileName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnClientProfileWithHttpInfo(msgVpnName, clientProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Client Profile object. - * Update a Client Profile object. Any attribute missing from the request will be left unchanged. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnClientProfileWithHttpInfo(String msgVpnName, String clientProfileName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnClientProfile"); - } - - // verify the required parameter 'clientProfileName' is set - if (clientProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientProfileName' when calling updateMsgVpnClientProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnClientProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientProfileName", clientProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientUsernameApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientUsernameApi.java deleted file mode 100644 index f7e93876c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientUsernameApi.java +++ /dev/null @@ -1,770 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsername; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttributeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttributesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class ClientUsernameApi { - private ApiClient apiClient; - - public ClientUsernameApi() { - this(new ApiClient()); - } - - public ClientUsernameApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Client Username object. - * Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientUsername|x|x|||| msgVpnName|x||x||| password||||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameResponse createMsgVpnClientUsername(String msgVpnName, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnClientUsernameWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Client Username object. - * Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientUsername|x|x|||| msgVpnName|x||x||| password||||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnClientUsernameWithHttpInfo(String msgVpnName, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnClientUsername"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnClientUsername"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Client Username Attribute object. - * Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| clientUsername|x||x||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Client Username Attribute object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username Attribute object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameAttributeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameAttributeResponse createMsgVpnClientUsernameAttribute(String msgVpnName, String clientUsername, MsgVpnClientUsernameAttribute body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnClientUsernameAttributeWithHttpInfo(msgVpnName, clientUsername, body, opaquePassword, select).getBody(); - } - - /** - * Create a Client Username Attribute object. - * Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| clientUsername|x||x||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Client Username Attribute object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username Attribute object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameAttributeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnClientUsernameAttributeWithHttpInfo(String msgVpnName, String clientUsername, MsgVpnClientUsernameAttribute body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling createMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnClientUsernameAttribute"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Client Username object. - * Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnClientUsername(String msgVpnName, String clientUsername) throws RestClientException { - return deleteMsgVpnClientUsernameWithHttpInfo(msgVpnName, clientUsername).getBody(); - } - - /** - * Delete a Client Username object. - * Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnClientUsernameWithHttpInfo(String msgVpnName, String clientUsername) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnClientUsername"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling deleteMsgVpnClientUsername"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Client Username Attribute object. - * Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnClientUsernameAttribute(String msgVpnName, String clientUsername, String attributeName, String attributeValue) throws RestClientException { - return deleteMsgVpnClientUsernameAttributeWithHttpInfo(msgVpnName, clientUsername, attributeName, attributeValue).getBody(); - } - - /** - * Delete a Client Username Attribute object. - * Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnClientUsernameAttributeWithHttpInfo(String msgVpnName, String clientUsername, String attributeName, String attributeValue) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling deleteMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'attributeName' is set - if (attributeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeName' when calling deleteMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'attributeValue' is set - if (attributeValue == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeValue' when calling deleteMsgVpnClientUsernameAttribute"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - uriVariables.put("attributeName", attributeName); - uriVariables.put("attributeValue", attributeValue); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Client Username object. - * Get a Client Username object. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameResponse getMsgVpnClientUsername(String msgVpnName, String clientUsername, String opaquePassword, List select) throws RestClientException { - return getMsgVpnClientUsernameWithHttpInfo(msgVpnName, clientUsername, opaquePassword, select).getBody(); - } - - /** - * Get a Client Username object. - * Get a Client Username object. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientUsernameWithHttpInfo(String msgVpnName, String clientUsername, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientUsername"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling getMsgVpnClientUsername"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Client Username Attribute object. - * Get a Client Username Attribute object. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Client Username Attribute object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameAttributeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameAttributeResponse getMsgVpnClientUsernameAttribute(String msgVpnName, String clientUsername, String attributeName, String attributeValue, String opaquePassword, List select) throws RestClientException { - return getMsgVpnClientUsernameAttributeWithHttpInfo(msgVpnName, clientUsername, attributeName, attributeValue, opaquePassword, select).getBody(); - } - - /** - * Get a Client Username Attribute object. - * Get a Client Username Attribute object. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Client Username Attribute object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameAttributeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientUsernameAttributeWithHttpInfo(String msgVpnName, String clientUsername, String attributeName, String attributeValue, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling getMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'attributeName' is set - if (attributeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeName' when calling getMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'attributeValue' is set - if (attributeValue == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeValue' when calling getMsgVpnClientUsernameAttribute"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - uriVariables.put("attributeName", attributeName); - uriVariables.put("attributeValue", attributeValue); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Client Username Attribute objects. - * Get a list of Client Username Attribute objects. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Client Username Attribute objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameAttributesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameAttributesResponse getMsgVpnClientUsernameAttributes(String msgVpnName, String clientUsername, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnClientUsernameAttributesWithHttpInfo(msgVpnName, clientUsername, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Client Username Attribute objects. - * Get a list of Client Username Attribute objects. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Client Username Attribute objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameAttributesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientUsernameAttributesWithHttpInfo(String msgVpnName, String clientUsername, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientUsernameAttributes"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling getMsgVpnClientUsernameAttributes"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Client Username objects. - * Get a list of Client Username objects. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Username objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernamesResponse getMsgVpnClientUsernames(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnClientUsernamesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Client Username objects. - * Get a list of Client Username objects. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Username objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientUsernamesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientUsernames"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Client Username object. - * Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| clientProfileName|||||x|| clientUsername|x||x|||| msgVpnName|x||x|||| password||||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameResponse replaceMsgVpnClientUsername(String msgVpnName, String clientUsername, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnClientUsernameWithHttpInfo(msgVpnName, clientUsername, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Client Username object. - * Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| clientProfileName|||||x|| clientUsername|x||x|||| msgVpnName|x||x|||| password||||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnClientUsernameWithHttpInfo(String msgVpnName, String clientUsername, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnClientUsername"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling replaceMsgVpnClientUsername"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnClientUsername"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Client Username object. - * Update a Client Username object. Any attribute missing from the request will be left unchanged. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| clientProfileName||||x|| clientUsername|x|x|||| msgVpnName|x|x|||| password|||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameResponse updateMsgVpnClientUsername(String msgVpnName, String clientUsername, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnClientUsernameWithHttpInfo(msgVpnName, clientUsername, body, opaquePassword, select).getBody(); - } - - /** - * Update a Client Username object. - * Update a Client Username object. Any attribute missing from the request will be left unchanged. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| clientProfileName||||x|| clientUsername|x|x|||| msgVpnName|x|x|||| password|||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnClientUsernameWithHttpInfo(String msgVpnName, String clientUsername, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnClientUsername"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling updateMsgVpnClientUsername"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnClientUsername"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DistributedCacheApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DistributedCacheApi.java deleted file mode 100644 index 9a1f37215..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DistributedCacheApi.java +++ /dev/null @@ -1,2438 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstance; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstanceResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstancesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClustersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCachesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DistributedCacheApi { - private ApiClient apiClient; - - public DistributedCacheApi() { - this(new ApiClient()); - } - - public DistributedCacheApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Distributed Cache object. - * Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheResponse createMsgVpnDistributedCache(String msgVpnName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Distributed Cache object. - * Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheWithHttpInfo(String msgVpnName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Cache Cluster object. - * Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterResponse createMsgVpnDistributedCacheCluster(String msgVpnName, String cacheName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheClusterWithHttpInfo(msgVpnName, cacheName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Cache Cluster object. - * Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheClusterWithHttpInfo(String msgVpnName, String cacheName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling createMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCacheCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Home Cache Cluster object. - * Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Home Cache Cluster object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Home Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterGlobalCachingHomeCluster body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(msgVpnName, cacheName, clusterName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Home Cache Cluster object. - * Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Home Cache Cluster object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Home Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterGlobalCachingHomeCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Topic Prefix object. - * Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x||x||| msgVpnName|x||x||| topicPrefix|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic Prefix object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param body The Topic Prefix object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(String msgVpnName, String cacheName, String clusterName, String homeClusterName, MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Topic Prefix object. - * Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x||x||| msgVpnName|x||x||| topicPrefix|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic Prefix object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param body The Topic Prefix object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName, MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Cache Instance object. - * Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| instanceName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterInstanceResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterInstanceResponse createMsgVpnDistributedCacheClusterInstance(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheClusterInstanceWithHttpInfo(msgVpnName, cacheName, clusterName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Cache Instance object. - * Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| instanceName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterInstanceResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheClusterInstanceWithHttpInfo(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling createMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling createMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCacheClusterInstance"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Topic object. - * Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| msgVpnName|x||x||| topic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterTopicResponse createMsgVpnDistributedCacheClusterTopic(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterTopic body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheClusterTopicWithHttpInfo(msgVpnName, cacheName, clusterName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Topic object. - * Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| msgVpnName|x||x||| topic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheClusterTopicWithHttpInfo(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling createMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling createMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCacheClusterTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Distributed Cache object. - * Delete a Distributed Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCache(String msgVpnName, String cacheName) throws RestClientException { - return deleteMsgVpnDistributedCacheWithHttpInfo(msgVpnName, cacheName).getBody(); - } - - /** - * Delete a Distributed Cache object. - * Delete a Distributed Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheWithHttpInfo(String msgVpnName, String cacheName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Cache Cluster object. - * Delete a Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCacheCluster(String msgVpnName, String cacheName, String clusterName) throws RestClientException { - return deleteMsgVpnDistributedCacheClusterWithHttpInfo(msgVpnName, cacheName, clusterName).getBody(); - } - - /** - * Delete a Cache Cluster object. - * Delete a Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling deleteMsgVpnDistributedCacheCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Home Cache Cluster object. - * Delete a Home Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(String msgVpnName, String cacheName, String clusterName, String homeClusterName) throws RestClientException { - return deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName).getBody(); - } - - /** - * Delete a Home Cache Cluster object. - * Delete a Home Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Topic Prefix object. - * Delete a Topic Prefix object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param topicPrefix A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String topicPrefix) throws RestClientException { - return deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix).getBody(); - } - - /** - * Delete a Topic Prefix object. - * Delete a Topic Prefix object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param topicPrefix A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String topicPrefix) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'topicPrefix' is set - if (topicPrefix == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicPrefix' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - uriVariables.put("topicPrefix", topicPrefix); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Cache Instance object. - * Delete a Cache Instance object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterInstance(String msgVpnName, String cacheName, String clusterName, String instanceName) throws RestClientException { - return deleteMsgVpnDistributedCacheClusterInstanceWithHttpInfo(msgVpnName, cacheName, clusterName, instanceName).getBody(); - } - - /** - * Delete a Cache Instance object. - * Delete a Cache Instance object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheClusterInstanceWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String instanceName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling deleteMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'instanceName' is set - if (instanceName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'instanceName' when calling deleteMsgVpnDistributedCacheClusterInstance"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("instanceName", instanceName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Topic object. - * Delete a Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param topic The value of the Topic in the form a/b/c. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterTopic(String msgVpnName, String cacheName, String clusterName, String topic) throws RestClientException { - return deleteMsgVpnDistributedCacheClusterTopicWithHttpInfo(msgVpnName, cacheName, clusterName, topic).getBody(); - } - - /** - * Delete a Topic object. - * Delete a Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param topic The value of the Topic in the form a/b/c. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheClusterTopicWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String topic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling deleteMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'topic' is set - if (topic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topic' when calling deleteMsgVpnDistributedCacheClusterTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("topic", topic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Distributed Cache object. - * Get a Distributed Cache object. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheResponse getMsgVpnDistributedCache(String msgVpnName, String cacheName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheWithHttpInfo(msgVpnName, cacheName, opaquePassword, select).getBody(); - } - - /** - * Get a Distributed Cache object. - * Get a Distributed Cache object. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheWithHttpInfo(String msgVpnName, String cacheName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Cache Cluster object. - * Get a Cache Cluster object. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterResponse getMsgVpnDistributedCacheCluster(String msgVpnName, String cacheName, String clusterName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterWithHttpInfo(msgVpnName, cacheName, clusterName, opaquePassword, select).getBody(); - } - - /** - * Get a Cache Cluster object. - * Get a Cache Cluster object. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Home Cache Cluster object. - * Get a Home Cache Cluster object. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Home Cache Cluster object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName, opaquePassword, select).getBody(); - } - - /** - * Get a Home Cache Cluster object. - * Get a Home Cache Cluster object. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Home Cache Cluster object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Topic Prefix object. - * Get a Topic Prefix object. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic Prefix object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param topicPrefix A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String topicPrefix, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix, opaquePassword, select).getBody(); - } - - /** - * Get a Topic Prefix object. - * Get a Topic Prefix object. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic Prefix object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param topicPrefix A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String topicPrefix, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'topicPrefix' is set - if (topicPrefix == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicPrefix' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - uriVariables.put("topicPrefix", topicPrefix); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Topic Prefix objects. - * Get a list of Topic Prefix objects. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Topic Prefix objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes(String msgVpnName, String cacheName, String clusterName, String homeClusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Topic Prefix objects. - * Get a list of Topic Prefix objects. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Topic Prefix objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Home Cache Cluster objects. - * Get a list of Home Cache Cluster objects. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Home Cache Cluster objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterGlobalCachingHomeClustersWithHttpInfo(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Home Cache Cluster objects. - * Get a list of Home Cache Cluster objects. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Home Cache Cluster objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterGlobalCachingHomeClustersWithHttpInfo(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Cache Instance object. - * Get a Cache Instance object. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterInstanceResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterInstanceResponse getMsgVpnDistributedCacheClusterInstance(String msgVpnName, String cacheName, String clusterName, String instanceName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterInstanceWithHttpInfo(msgVpnName, cacheName, clusterName, instanceName, opaquePassword, select).getBody(); - } - - /** - * Get a Cache Instance object. - * Get a Cache Instance object. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterInstanceResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterInstanceWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String instanceName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'instanceName' is set - if (instanceName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'instanceName' when calling getMsgVpnDistributedCacheClusterInstance"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("instanceName", instanceName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Cache Instance objects. - * Get a list of Cache Instance objects. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Cache Instance objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterInstancesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterInstancesResponse getMsgVpnDistributedCacheClusterInstances(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterInstancesWithHttpInfo(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Cache Instance objects. - * Get a list of Cache Instance objects. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Cache Instance objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterInstancesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterInstancesWithHttpInfo(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterInstances"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterInstances"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterInstances"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Topic object. - * Get a Topic object. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param topic The value of the Topic in the form a/b/c. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterTopicResponse getMsgVpnDistributedCacheClusterTopic(String msgVpnName, String cacheName, String clusterName, String topic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterTopicWithHttpInfo(msgVpnName, cacheName, clusterName, topic, opaquePassword, select).getBody(); - } - - /** - * Get a Topic object. - * Get a Topic object. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param topic The value of the Topic in the form a/b/c. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterTopicWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String topic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'topic' is set - if (topic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topic' when calling getMsgVpnDistributedCacheClusterTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("topic", topic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Topic objects. - * Get a list of Topic objects. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterTopicsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterTopicsResponse getMsgVpnDistributedCacheClusterTopics(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterTopicsWithHttpInfo(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Topic objects. - * Get a list of Topic objects. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterTopicsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterTopicsWithHttpInfo(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterTopics"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterTopics"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterTopics"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Cache Cluster objects. - * Get a list of Cache Cluster objects. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Cache Cluster objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClustersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClustersResponse getMsgVpnDistributedCacheClusters(String msgVpnName, String cacheName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCacheClustersWithHttpInfo(msgVpnName, cacheName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Cache Cluster objects. - * Get a list of Cache Cluster objects. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Cache Cluster objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClustersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClustersWithHttpInfo(String msgVpnName, String cacheName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusters"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusters"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Distributed Cache objects. - * Get a list of Distributed Cache objects. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Distributed Cache objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCachesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCachesResponse getMsgVpnDistributedCaches(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCachesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Distributed Cache objects. - * Get a list of Distributed Cache objects. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Distributed Cache objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCachesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCachesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCaches"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Distributed Cache object. - * Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| cacheVirtualRouter||x||||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheResponse replaceMsgVpnDistributedCache(String msgVpnName, String cacheName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnDistributedCacheWithHttpInfo(msgVpnName, cacheName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Distributed Cache object. - * Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| cacheVirtualRouter||x||||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnDistributedCacheWithHttpInfo(String msgVpnName, String cacheName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnDistributedCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling replaceMsgVpnDistributedCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnDistributedCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Cache Cluster object. - * Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterResponse replaceMsgVpnDistributedCacheCluster(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnDistributedCacheClusterWithHttpInfo(msgVpnName, cacheName, clusterName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Cache Cluster object. - * Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnDistributedCacheClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling replaceMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling replaceMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnDistributedCacheCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Cache Instance object. - * Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| instanceName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterInstanceResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterInstanceResponse replaceMsgVpnDistributedCacheClusterInstance(String msgVpnName, String cacheName, String clusterName, String instanceName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnDistributedCacheClusterInstanceWithHttpInfo(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Cache Instance object. - * Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| instanceName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterInstanceResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnDistributedCacheClusterInstanceWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String instanceName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling replaceMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling replaceMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'instanceName' is set - if (instanceName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'instanceName' when calling replaceMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnDistributedCacheClusterInstance"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("instanceName", instanceName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Distributed Cache object. - * Update a Distributed Cache object. Any attribute missing from the request will be left unchanged. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| cacheVirtualRouter||x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheResponse updateMsgVpnDistributedCache(String msgVpnName, String cacheName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnDistributedCacheWithHttpInfo(msgVpnName, cacheName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Distributed Cache object. - * Update a Distributed Cache object. Any attribute missing from the request will be left unchanged. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| cacheVirtualRouter||x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnDistributedCacheWithHttpInfo(String msgVpnName, String cacheName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnDistributedCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling updateMsgVpnDistributedCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnDistributedCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Cache Cluster object. - * Update a Cache Cluster object. Any attribute missing from the request will be left unchanged. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterResponse updateMsgVpnDistributedCacheCluster(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnDistributedCacheClusterWithHttpInfo(msgVpnName, cacheName, clusterName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Cache Cluster object. - * Update a Cache Cluster object. Any attribute missing from the request will be left unchanged. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnDistributedCacheClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling updateMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling updateMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnDistributedCacheCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Cache Instance object. - * Update a Cache Instance object. Any attribute missing from the request will be left unchanged. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| instanceName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterInstanceResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterInstanceResponse updateMsgVpnDistributedCacheClusterInstance(String msgVpnName, String cacheName, String clusterName, String instanceName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnDistributedCacheClusterInstanceWithHttpInfo(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Cache Instance object. - * Update a Cache Instance object. Any attribute missing from the request will be left unchanged. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| instanceName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterInstanceResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnDistributedCacheClusterInstanceWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String instanceName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling updateMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling updateMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'instanceName' is set - if (instanceName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'instanceName' when calling updateMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnDistributedCacheClusterInstance"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("instanceName", instanceName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DmrBridgeApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DmrBridgeApi.java deleted file mode 100644 index 0058967cb..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DmrBridgeApi.java +++ /dev/null @@ -1,460 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridgeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridgesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrBridgeApi { - private ApiClient apiClient; - - public DmrBridgeApi() { - this(new ApiClient()); - } - - public DmrBridgeApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a DMR Bridge object. - * Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDmrBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDmrBridgeResponse createMsgVpnDmrBridge(String msgVpnName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDmrBridgeWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a DMR Bridge object. - * Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDmrBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDmrBridgeWithHttpInfo(String msgVpnName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDmrBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDmrBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a DMR Bridge object. - * Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDmrBridge(String msgVpnName, String remoteNodeName) throws RestClientException { - return deleteMsgVpnDmrBridgeWithHttpInfo(msgVpnName, remoteNodeName).getBody(); - } - - /** - * Delete a DMR Bridge object. - * Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDmrBridgeWithHttpInfo(String msgVpnName, String remoteNodeName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDmrBridge"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling deleteMsgVpnDmrBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a DMR Bridge object. - * Get a DMR Bridge object. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDmrBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDmrBridgeResponse getMsgVpnDmrBridge(String msgVpnName, String remoteNodeName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDmrBridgeWithHttpInfo(msgVpnName, remoteNodeName, opaquePassword, select).getBody(); - } - - /** - * Get a DMR Bridge object. - * Get a DMR Bridge object. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDmrBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDmrBridgeWithHttpInfo(String msgVpnName, String remoteNodeName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDmrBridge"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getMsgVpnDmrBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of DMR Bridge objects. - * Get a list of DMR Bridge objects. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of DMR Bridge objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDmrBridgesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDmrBridgesResponse getMsgVpnDmrBridges(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDmrBridgesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of DMR Bridge objects. - * Get a list of DMR Bridge objects. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of DMR Bridge objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDmrBridgesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDmrBridgesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDmrBridges"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a DMR Bridge object. - * Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| remoteNodeName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDmrBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDmrBridgeResponse replaceMsgVpnDmrBridge(String msgVpnName, String remoteNodeName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnDmrBridgeWithHttpInfo(msgVpnName, remoteNodeName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a DMR Bridge object. - * Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| remoteNodeName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDmrBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnDmrBridgeWithHttpInfo(String msgVpnName, String remoteNodeName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnDmrBridge"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling replaceMsgVpnDmrBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnDmrBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a DMR Bridge object. - * Update a DMR Bridge object. Any attribute missing from the request will be left unchanged. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDmrBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDmrBridgeResponse updateMsgVpnDmrBridge(String msgVpnName, String remoteNodeName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnDmrBridgeWithHttpInfo(msgVpnName, remoteNodeName, body, opaquePassword, select).getBody(); - } - - /** - * Update a DMR Bridge object. - * Update a DMR Bridge object. Any attribute missing from the request will be left unchanged. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDmrBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnDmrBridgeWithHttpInfo(String msgVpnName, String remoteNodeName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnDmrBridge"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling updateMsgVpnDmrBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnDmrBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DmrClusterApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DmrClusterApi.java deleted file mode 100644 index 05eaf1380..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DmrClusterApi.java +++ /dev/null @@ -1,2888 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFilterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFiltersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleConditionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleConditionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRulesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLink; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttributeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttributesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddress; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddressResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddressesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinksResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClustersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterApi { - private ApiClient apiClient; - - public DmrClusterApi() { - this(new ApiClient()); - } - - public DmrClusterApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Cluster object. - * Create a Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationBasicPassword||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| dmrClusterName|x|x|||| nodeName|||x||| tlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cluster object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterResponse createDmrCluster(DmrCluster body, String opaquePassword, List select) throws RestClientException { - return createDmrClusterWithHttpInfo(body, opaquePassword, select).getBody(); - } - - /** - * Create a Cluster object. - * Create a Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationBasicPassword||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| dmrClusterName|x|x|||| nodeName|||x||| tlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cluster object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createDmrClusterWithHttpInfo(DmrCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDmrCluster"); - } - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters", HttpMethod.POST, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Certificate Matching Rule object. - * Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleResponse createDmrClusterCertMatchingRule(String dmrClusterName, DmrClusterCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - return createDmrClusterCertMatchingRuleWithHttpInfo(dmrClusterName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Matching Rule object. - * Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createDmrClusterCertMatchingRuleWithHttpInfo(String dmrClusterName, DmrClusterCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling createDmrClusterCertMatchingRule"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDmrClusterCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Certificate Matching Rule Attribute Filter object. - * Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| filterName|x|x|||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleAttributeFilterResponse createDmrClusterCertMatchingRuleAttributeFilter(String dmrClusterName, String ruleName, DmrClusterCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - return createDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(dmrClusterName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Matching Rule Attribute Filter object. - * Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| filterName|x|x|||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(String dmrClusterName, String ruleName, DmrClusterCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling createDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling createDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDmrClusterCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Certificate Matching Rule Condition object. - * Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Condition object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Condition object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleConditionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleConditionResponse createDmrClusterCertMatchingRuleCondition(String dmrClusterName, String ruleName, DmrClusterCertMatchingRuleCondition body, String opaquePassword, List select) throws RestClientException { - return createDmrClusterCertMatchingRuleConditionWithHttpInfo(dmrClusterName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Matching Rule Condition object. - * Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Condition object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Condition object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleConditionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createDmrClusterCertMatchingRuleConditionWithHttpInfo(String dmrClusterName, String ruleName, DmrClusterCertMatchingRuleCondition body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling createDmrClusterCertMatchingRuleCondition"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling createDmrClusterCertMatchingRuleCondition"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDmrClusterCertMatchingRuleCondition"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Link object. - * Create a Link object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationBasicPassword||||x||x dmrClusterName|x||x||| remoteNodeName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Link object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param body The Link object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkResponse createDmrClusterLink(String dmrClusterName, DmrClusterLink body, String opaquePassword, List select) throws RestClientException { - return createDmrClusterLinkWithHttpInfo(dmrClusterName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Link object. - * Create a Link object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationBasicPassword||||x||x dmrClusterName|x||x||| remoteNodeName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Link object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param body The Link object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createDmrClusterLinkWithHttpInfo(String dmrClusterName, DmrClusterLink body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling createDmrClusterLink"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDmrClusterLink"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Link Attribute object. - * Create a Link Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| dmrClusterName|x||x||| remoteNodeName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Link Attribute object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Link Attribute object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkAttributeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkAttributeResponse createDmrClusterLinkAttribute(String dmrClusterName, String remoteNodeName, DmrClusterLinkAttribute body, String opaquePassword, List select) throws RestClientException { - return createDmrClusterLinkAttributeWithHttpInfo(dmrClusterName, remoteNodeName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Link Attribute object. - * Create a Link Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| dmrClusterName|x||x||| remoteNodeName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Link Attribute object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Link Attribute object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkAttributeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createDmrClusterLinkAttributeWithHttpInfo(String dmrClusterName, String remoteNodeName, DmrClusterLinkAttribute body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling createDmrClusterLinkAttribute"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling createDmrClusterLinkAttribute"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDmrClusterLinkAttribute"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Remote Address object. - * Create a Remote Address object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| remoteAddress|x|x|||| remoteNodeName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Remote Address object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Remote Address object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkRemoteAddressResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkRemoteAddressResponse createDmrClusterLinkRemoteAddress(String dmrClusterName, String remoteNodeName, DmrClusterLinkRemoteAddress body, String opaquePassword, List select) throws RestClientException { - return createDmrClusterLinkRemoteAddressWithHttpInfo(dmrClusterName, remoteNodeName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Remote Address object. - * Create a Remote Address object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| remoteAddress|x|x|||| remoteNodeName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Remote Address object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Remote Address object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkRemoteAddressResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createDmrClusterLinkRemoteAddressWithHttpInfo(String dmrClusterName, String remoteNodeName, DmrClusterLinkRemoteAddress body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling createDmrClusterLinkRemoteAddress"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling createDmrClusterLinkRemoteAddress"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDmrClusterLinkRemoteAddress"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Trusted Common Name object. - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||x| remoteNodeName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public DmrClusterLinkTlsTrustedCommonNameResponse createDmrClusterLinkTlsTrustedCommonName(String dmrClusterName, String remoteNodeName, DmrClusterLinkTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - return createDmrClusterLinkTlsTrustedCommonNameWithHttpInfo(dmrClusterName, remoteNodeName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Trusted Common Name object. - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||x| remoteNodeName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createDmrClusterLinkTlsTrustedCommonNameWithHttpInfo(String dmrClusterName, String remoteNodeName, DmrClusterLinkTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling createDmrClusterLinkTlsTrustedCommonName"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling createDmrClusterLinkTlsTrustedCommonName"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDmrClusterLinkTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Cluster object. - * Delete a Cluster object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteDmrCluster(String dmrClusterName) throws RestClientException { - return deleteDmrClusterWithHttpInfo(dmrClusterName).getBody(); - } - - /** - * Delete a Cluster object. - * Delete a Cluster object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteDmrClusterWithHttpInfo(String dmrClusterName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling deleteDmrCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Matching Rule object. - * Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteDmrClusterCertMatchingRule(String dmrClusterName, String ruleName) throws RestClientException { - return deleteDmrClusterCertMatchingRuleWithHttpInfo(dmrClusterName, ruleName).getBody(); - } - - /** - * Delete a Certificate Matching Rule object. - * Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteDmrClusterCertMatchingRuleWithHttpInfo(String dmrClusterName, String ruleName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling deleteDmrClusterCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling deleteDmrClusterCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Matching Rule Attribute Filter object. - * Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Attribute Filter compares a link attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteDmrClusterCertMatchingRuleAttributeFilter(String dmrClusterName, String ruleName, String filterName) throws RestClientException { - return deleteDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(dmrClusterName, ruleName, filterName).getBody(); - } - - /** - * Delete a Certificate Matching Rule Attribute Filter object. - * Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Attribute Filter compares a link attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(String dmrClusterName, String ruleName, String filterName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling deleteDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling deleteDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling deleteDmrClusterCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Matching Rule Condition object. - * Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteDmrClusterCertMatchingRuleCondition(String dmrClusterName, String ruleName, String source) throws RestClientException { - return deleteDmrClusterCertMatchingRuleConditionWithHttpInfo(dmrClusterName, ruleName, source).getBody(); - } - - /** - * Delete a Certificate Matching Rule Condition object. - * Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteDmrClusterCertMatchingRuleConditionWithHttpInfo(String dmrClusterName, String ruleName, String source) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling deleteDmrClusterCertMatchingRuleCondition"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling deleteDmrClusterCertMatchingRuleCondition"); - } - - // verify the required parameter 'source' is set - if (source == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'source' when calling deleteDmrClusterCertMatchingRuleCondition"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("source", source); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Link object. - * Delete a Link object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteDmrClusterLink(String dmrClusterName, String remoteNodeName) throws RestClientException { - return deleteDmrClusterLinkWithHttpInfo(dmrClusterName, remoteNodeName).getBody(); - } - - /** - * Delete a Link object. - * Delete a Link object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteDmrClusterLinkWithHttpInfo(String dmrClusterName, String remoteNodeName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling deleteDmrClusterLink"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling deleteDmrClusterLink"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Link Attribute object. - * Delete a Link Attribute object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteDmrClusterLinkAttribute(String dmrClusterName, String remoteNodeName, String attributeName, String attributeValue) throws RestClientException { - return deleteDmrClusterLinkAttributeWithHttpInfo(dmrClusterName, remoteNodeName, attributeName, attributeValue).getBody(); - } - - /** - * Delete a Link Attribute object. - * Delete a Link Attribute object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteDmrClusterLinkAttributeWithHttpInfo(String dmrClusterName, String remoteNodeName, String attributeName, String attributeValue) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling deleteDmrClusterLinkAttribute"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling deleteDmrClusterLinkAttribute"); - } - - // verify the required parameter 'attributeName' is set - if (attributeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeName' when calling deleteDmrClusterLinkAttribute"); - } - - // verify the required parameter 'attributeValue' is set - if (attributeValue == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeValue' when calling deleteDmrClusterLinkAttribute"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - uriVariables.put("attributeName", attributeName); - uriVariables.put("attributeValue", attributeValue); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Remote Address object. - * Delete a Remote Address object. The deletion of instances of this object are synchronized to HA mates via config-sync. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param remoteAddress The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteDmrClusterLinkRemoteAddress(String dmrClusterName, String remoteNodeName, String remoteAddress) throws RestClientException { - return deleteDmrClusterLinkRemoteAddressWithHttpInfo(dmrClusterName, remoteNodeName, remoteAddress).getBody(); - } - - /** - * Delete a Remote Address object. - * Delete a Remote Address object. The deletion of instances of this object are synchronized to HA mates via config-sync. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param remoteAddress The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteDmrClusterLinkRemoteAddressWithHttpInfo(String dmrClusterName, String remoteNodeName, String remoteAddress) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling deleteDmrClusterLinkRemoteAddress"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling deleteDmrClusterLinkRemoteAddress"); - } - - // verify the required parameter 'remoteAddress' is set - if (remoteAddress == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteAddress' when calling deleteDmrClusterLinkRemoteAddress"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - uriVariables.put("remoteAddress", remoteAddress); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Trusted Common Name object. - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteDmrClusterLinkTlsTrustedCommonName(String dmrClusterName, String remoteNodeName, String tlsTrustedCommonName) throws RestClientException { - return deleteDmrClusterLinkTlsTrustedCommonNameWithHttpInfo(dmrClusterName, remoteNodeName, tlsTrustedCommonName).getBody(); - } - - /** - * Delete a Trusted Common Name object. - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteDmrClusterLinkTlsTrustedCommonNameWithHttpInfo(String dmrClusterName, String remoteNodeName, String tlsTrustedCommonName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling deleteDmrClusterLinkTlsTrustedCommonName"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling deleteDmrClusterLinkTlsTrustedCommonName"); - } - - // verify the required parameter 'tlsTrustedCommonName' is set - if (tlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'tlsTrustedCommonName' when calling deleteDmrClusterLinkTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - uriVariables.put("tlsTrustedCommonName", tlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Cluster object. - * Get a Cluster object. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| dmrClusterName|x||| tlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cluster object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterResponse getDmrCluster(String dmrClusterName, String opaquePassword, List select) throws RestClientException { - return getDmrClusterWithHttpInfo(dmrClusterName, opaquePassword, select).getBody(); - } - - /** - * Get a Cluster object. - * Get a Cluster object. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| dmrClusterName|x||| tlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cluster object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterWithHttpInfo(String dmrClusterName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Matching Rule object. - * Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleResponse getDmrClusterCertMatchingRule(String dmrClusterName, String ruleName, String opaquePassword, List select) throws RestClientException { - return getDmrClusterCertMatchingRuleWithHttpInfo(dmrClusterName, ruleName, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Matching Rule object. - * Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterCertMatchingRuleWithHttpInfo(String dmrClusterName, String ruleName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getDmrClusterCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Matching Rule Attribute Filter object. - * Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| filterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleAttributeFilterResponse getDmrClusterCertMatchingRuleAttributeFilter(String dmrClusterName, String ruleName, String filterName, String opaquePassword, List select) throws RestClientException { - return getDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(dmrClusterName, ruleName, filterName, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Matching Rule Attribute Filter object. - * Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| filterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(String dmrClusterName, String ruleName, String filterName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling getDmrClusterCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Matching Rule Attribute Filter objects. - * Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| filterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleAttributeFiltersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleAttributeFiltersResponse getDmrClusterCertMatchingRuleAttributeFilters(String dmrClusterName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getDmrClusterCertMatchingRuleAttributeFiltersWithHttpInfo(dmrClusterName, ruleName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Matching Rule Attribute Filter objects. - * Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| filterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleAttributeFiltersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterCertMatchingRuleAttributeFiltersWithHttpInfo(String dmrClusterName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterCertMatchingRuleAttributeFilters"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getDmrClusterCertMatchingRuleAttributeFilters"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Matching Rule Condition object. - * Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Condition object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleConditionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleConditionResponse getDmrClusterCertMatchingRuleCondition(String dmrClusterName, String ruleName, String source, String opaquePassword, List select) throws RestClientException { - return getDmrClusterCertMatchingRuleConditionWithHttpInfo(dmrClusterName, ruleName, source, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Matching Rule Condition object. - * Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Condition object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleConditionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterCertMatchingRuleConditionWithHttpInfo(String dmrClusterName, String ruleName, String source, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterCertMatchingRuleCondition"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getDmrClusterCertMatchingRuleCondition"); - } - - // verify the required parameter 'source' is set - if (source == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'source' when calling getDmrClusterCertMatchingRuleCondition"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("source", source); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Matching Rule Condition objects. - * Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule Condition objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleConditionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleConditionsResponse getDmrClusterCertMatchingRuleConditions(String dmrClusterName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getDmrClusterCertMatchingRuleConditionsWithHttpInfo(dmrClusterName, ruleName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Matching Rule Condition objects. - * Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule Condition objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleConditionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterCertMatchingRuleConditionsWithHttpInfo(String dmrClusterName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterCertMatchingRuleConditions"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getDmrClusterCertMatchingRuleConditions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Matching Rule objects. - * Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRulesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRulesResponse getDmrClusterCertMatchingRules(String dmrClusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getDmrClusterCertMatchingRulesWithHttpInfo(dmrClusterName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Matching Rule objects. - * Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRulesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterCertMatchingRulesWithHttpInfo(String dmrClusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterCertMatchingRules"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Link object. - * Get a Link object. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Link object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkResponse getDmrClusterLink(String dmrClusterName, String remoteNodeName, String opaquePassword, List select) throws RestClientException { - return getDmrClusterLinkWithHttpInfo(dmrClusterName, remoteNodeName, opaquePassword, select).getBody(); - } - - /** - * Get a Link object. - * Get a Link object. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Link object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterLinkWithHttpInfo(String dmrClusterName, String remoteNodeName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterLink"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getDmrClusterLink"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Link Attribute object. - * Get a Link Attribute object. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Link Attribute object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkAttributeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkAttributeResponse getDmrClusterLinkAttribute(String dmrClusterName, String remoteNodeName, String attributeName, String attributeValue, String opaquePassword, List select) throws RestClientException { - return getDmrClusterLinkAttributeWithHttpInfo(dmrClusterName, remoteNodeName, attributeName, attributeValue, opaquePassword, select).getBody(); - } - - /** - * Get a Link Attribute object. - * Get a Link Attribute object. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Link Attribute object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkAttributeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterLinkAttributeWithHttpInfo(String dmrClusterName, String remoteNodeName, String attributeName, String attributeValue, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterLinkAttribute"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getDmrClusterLinkAttribute"); - } - - // verify the required parameter 'attributeName' is set - if (attributeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeName' when calling getDmrClusterLinkAttribute"); - } - - // verify the required parameter 'attributeValue' is set - if (attributeValue == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeValue' when calling getDmrClusterLinkAttribute"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - uriVariables.put("attributeName", attributeName); - uriVariables.put("attributeValue", attributeValue); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Link Attribute objects. - * Get a list of Link Attribute objects. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Link Attribute objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkAttributesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkAttributesResponse getDmrClusterLinkAttributes(String dmrClusterName, String remoteNodeName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getDmrClusterLinkAttributesWithHttpInfo(dmrClusterName, remoteNodeName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Link Attribute objects. - * Get a list of Link Attribute objects. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Link Attribute objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkAttributesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterLinkAttributesWithHttpInfo(String dmrClusterName, String remoteNodeName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterLinkAttributes"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getDmrClusterLinkAttributes"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Remote Address object. - * Get a Remote Address object. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| remoteAddress|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Remote Address object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param remoteAddress The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkRemoteAddressResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkRemoteAddressResponse getDmrClusterLinkRemoteAddress(String dmrClusterName, String remoteNodeName, String remoteAddress, String opaquePassword, List select) throws RestClientException { - return getDmrClusterLinkRemoteAddressWithHttpInfo(dmrClusterName, remoteNodeName, remoteAddress, opaquePassword, select).getBody(); - } - - /** - * Get a Remote Address object. - * Get a Remote Address object. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| remoteAddress|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Remote Address object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param remoteAddress The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkRemoteAddressResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterLinkRemoteAddressWithHttpInfo(String dmrClusterName, String remoteNodeName, String remoteAddress, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterLinkRemoteAddress"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getDmrClusterLinkRemoteAddress"); - } - - // verify the required parameter 'remoteAddress' is set - if (remoteAddress == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteAddress' when calling getDmrClusterLinkRemoteAddress"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - uriVariables.put("remoteAddress", remoteAddress); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Remote Address objects. - * Get a list of Remote Address objects. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| remoteAddress|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Remote Address objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkRemoteAddressesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkRemoteAddressesResponse getDmrClusterLinkRemoteAddresses(String dmrClusterName, String remoteNodeName, String opaquePassword, List where, List select) throws RestClientException { - return getDmrClusterLinkRemoteAddressesWithHttpInfo(dmrClusterName, remoteNodeName, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Remote Address objects. - * Get a list of Remote Address objects. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| remoteAddress|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Remote Address objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkRemoteAddressesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterLinkRemoteAddressesWithHttpInfo(String dmrClusterName, String remoteNodeName, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterLinkRemoteAddresses"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getDmrClusterLinkRemoteAddresses"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Trusted Common Name object. - * Get a Trusted Common Name object. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||x| remoteNodeName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public DmrClusterLinkTlsTrustedCommonNameResponse getDmrClusterLinkTlsTrustedCommonName(String dmrClusterName, String remoteNodeName, String tlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - return getDmrClusterLinkTlsTrustedCommonNameWithHttpInfo(dmrClusterName, remoteNodeName, tlsTrustedCommonName, opaquePassword, select).getBody(); - } - - /** - * Get a Trusted Common Name object. - * Get a Trusted Common Name object. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||x| remoteNodeName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getDmrClusterLinkTlsTrustedCommonNameWithHttpInfo(String dmrClusterName, String remoteNodeName, String tlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterLinkTlsTrustedCommonName"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getDmrClusterLinkTlsTrustedCommonName"); - } - - // verify the required parameter 'tlsTrustedCommonName' is set - if (tlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'tlsTrustedCommonName' when calling getDmrClusterLinkTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - uriVariables.put("tlsTrustedCommonName", tlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Trusted Common Name objects. - * Get a list of Trusted Common Name objects. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||x| remoteNodeName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The list of Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkTlsTrustedCommonNamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public DmrClusterLinkTlsTrustedCommonNamesResponse getDmrClusterLinkTlsTrustedCommonNames(String dmrClusterName, String remoteNodeName, String opaquePassword, List where, List select) throws RestClientException { - return getDmrClusterLinkTlsTrustedCommonNamesWithHttpInfo(dmrClusterName, remoteNodeName, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Trusted Common Name objects. - * Get a list of Trusted Common Name objects. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||x| remoteNodeName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The list of Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkTlsTrustedCommonNamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getDmrClusterLinkTlsTrustedCommonNamesWithHttpInfo(String dmrClusterName, String remoteNodeName, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterLinkTlsTrustedCommonNames"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getDmrClusterLinkTlsTrustedCommonNames"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Link objects. - * Get a list of Link objects. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Link objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinksResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinksResponse getDmrClusterLinks(String dmrClusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getDmrClusterLinksWithHttpInfo(dmrClusterName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Link objects. - * Get a list of Link objects. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Link objects' attributes, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinksResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClusterLinksWithHttpInfo(String dmrClusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling getDmrClusterLinks"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Cluster objects. - * Get a list of Cluster objects. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| dmrClusterName|x||| tlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Cluster objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClustersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClustersResponse getDmrClusters(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getDmrClustersWithHttpInfo(count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Cluster objects. - * Get a list of Cluster objects. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| dmrClusterName|x||| tlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Cluster objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClustersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDmrClustersWithHttpInfo(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Cluster object. - * Replace a Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword||||x|x||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| directOnlyEnabled||x||||| dmrClusterName|x||x|||| nodeName|||x|||| tlsServerCertEnforceTrustedCommonNameEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cluster object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param body The Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterResponse replaceDmrCluster(String dmrClusterName, DmrCluster body, String opaquePassword, List select) throws RestClientException { - return replaceDmrClusterWithHttpInfo(dmrClusterName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Cluster object. - * Replace a Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword||||x|x||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| directOnlyEnabled||x||||| dmrClusterName|x||x|||| nodeName|||x|||| tlsServerCertEnforceTrustedCommonNameEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cluster object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param body The Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceDmrClusterWithHttpInfo(String dmrClusterName, DmrCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling replaceDmrCluster"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceDmrCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Certificate Matching Rule object. - * Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- dmrClusterName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleResponse replaceDmrClusterCertMatchingRule(String dmrClusterName, String ruleName, DmrClusterCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - return replaceDmrClusterCertMatchingRuleWithHttpInfo(dmrClusterName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Certificate Matching Rule object. - * Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- dmrClusterName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceDmrClusterCertMatchingRuleWithHttpInfo(String dmrClusterName, String ruleName, DmrClusterCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling replaceDmrClusterCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling replaceDmrClusterCertMatchingRule"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceDmrClusterCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Certificate Matching Rule Attribute Filter object. - * Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- dmrClusterName|x||x|||| filterName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleAttributeFilterResponse replaceDmrClusterCertMatchingRuleAttributeFilter(String dmrClusterName, String ruleName, String filterName, DmrClusterCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - return replaceDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(dmrClusterName, ruleName, filterName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Certificate Matching Rule Attribute Filter object. - * Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- dmrClusterName|x||x|||| filterName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(String dmrClusterName, String ruleName, String filterName, DmrClusterCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling replaceDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling replaceDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling replaceDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceDmrClusterCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Link object. - * Replace a Link object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword||||x|x||x authenticationScheme|||||x|| dmrClusterName|x||x|||| egressFlowWindowSize|||||x|| initiator|||||x|| remoteNodeName|x||x|||| span|||||x|| transportCompressedEnabled|||||x|| transportTlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Link object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Link object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkResponse replaceDmrClusterLink(String dmrClusterName, String remoteNodeName, DmrClusterLink body, String opaquePassword, List select) throws RestClientException { - return replaceDmrClusterLinkWithHttpInfo(dmrClusterName, remoteNodeName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Link object. - * Replace a Link object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword||||x|x||x authenticationScheme|||||x|| dmrClusterName|x||x|||| egressFlowWindowSize|||||x|| initiator|||||x|| remoteNodeName|x||x|||| span|||||x|| transportCompressedEnabled|||||x|| transportTlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Link object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Link object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceDmrClusterLinkWithHttpInfo(String dmrClusterName, String remoteNodeName, DmrClusterLink body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling replaceDmrClusterLink"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling replaceDmrClusterLink"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceDmrClusterLink"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Cluster object. - * Update a Cluster object. Any attribute missing from the request will be left unchanged. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword|||x|x||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| directOnlyEnabled||x|||| dmrClusterName|x|x|||| nodeName||x|||| tlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cluster object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param body The Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterResponse updateDmrCluster(String dmrClusterName, DmrCluster body, String opaquePassword, List select) throws RestClientException { - return updateDmrClusterWithHttpInfo(dmrClusterName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Cluster object. - * Update a Cluster object. Any attribute missing from the request will be left unchanged. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword|||x|x||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| directOnlyEnabled||x|||| dmrClusterName|x|x|||| nodeName||x|||| tlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cluster object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param body The Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateDmrClusterWithHttpInfo(String dmrClusterName, DmrCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling updateDmrCluster"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateDmrCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Certificate Matching Rule object. - * Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- dmrClusterName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleResponse updateDmrClusterCertMatchingRule(String dmrClusterName, String ruleName, DmrClusterCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - return updateDmrClusterCertMatchingRuleWithHttpInfo(dmrClusterName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Certificate Matching Rule object. - * Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- dmrClusterName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateDmrClusterCertMatchingRuleWithHttpInfo(String dmrClusterName, String ruleName, DmrClusterCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling updateDmrClusterCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling updateDmrClusterCertMatchingRule"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateDmrClusterCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Certificate Matching Rule Attribute Filter object. - * Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- dmrClusterName|x|x|||| filterName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterCertMatchingRuleAttributeFilterResponse updateDmrClusterCertMatchingRuleAttributeFilter(String dmrClusterName, String ruleName, String filterName, DmrClusterCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - return updateDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(dmrClusterName, ruleName, filterName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Certificate Matching Rule Attribute Filter object. - * Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- dmrClusterName|x|x|||| filterName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateDmrClusterCertMatchingRuleAttributeFilterWithHttpInfo(String dmrClusterName, String ruleName, String filterName, DmrClusterCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling updateDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling updateDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling updateDmrClusterCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateDmrClusterCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Link object. - * Update a Link object. Any attribute missing from the request will be left unchanged. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword|||x|x||x authenticationScheme||||x|| dmrClusterName|x|x|||| egressFlowWindowSize||||x|| initiator||||x|| remoteNodeName|x|x|||| span||||x|| transportCompressedEnabled||||x|| transportTlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Link object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Link object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DmrClusterLinkResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DmrClusterLinkResponse updateDmrClusterLink(String dmrClusterName, String remoteNodeName, DmrClusterLink body, String opaquePassword, List select) throws RestClientException { - return updateDmrClusterLinkWithHttpInfo(dmrClusterName, remoteNodeName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Link object. - * Update a Link object. Any attribute missing from the request will be left unchanged. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword|||x|x||x authenticationScheme||||x|| dmrClusterName|x|x|||| egressFlowWindowSize||||x|| initiator||||x|| remoteNodeName|x|x|||| span||||x|| transportCompressedEnabled||||x|| transportTlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Link object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param dmrClusterName The name of the Cluster. (required) - * @param remoteNodeName The name of the node at the remote end of the Link. (required) - * @param body The Link object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DmrClusterLinkResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateDmrClusterLinkWithHttpInfo(String dmrClusterName, String remoteNodeName, DmrClusterLink body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'dmrClusterName' is set - if (dmrClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'dmrClusterName' when calling updateDmrClusterLink"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling updateDmrClusterLink"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateDmrClusterLink"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("dmrClusterName", dmrClusterName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/dmrClusters/{dmrClusterName}/links/{remoteNodeName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DomainCertAuthorityApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DomainCertAuthorityApi.java deleted file mode 100644 index f8f3b834f..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DomainCertAuthorityApi.java +++ /dev/null @@ -1,408 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthoritiesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthorityResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DomainCertAuthorityApi { - private ApiClient apiClient; - - public DomainCertAuthorityApi() { - this(new ApiClient()); - } - - public DomainCertAuthorityApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Domain Certificate Authority object. - * Create a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Certificate Authorities trusted for domain verification. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Domain Certificate Authority object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Domain Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DomainCertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DomainCertAuthorityResponse createDomainCertAuthority(DomainCertAuthority body, String opaquePassword, List select) throws RestClientException { - return createDomainCertAuthorityWithHttpInfo(body, opaquePassword, select).getBody(); - } - - /** - * Create a Domain Certificate Authority object. - * Create a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Certificate Authorities trusted for domain verification. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Domain Certificate Authority object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Domain Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DomainCertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createDomainCertAuthorityWithHttpInfo(DomainCertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createDomainCertAuthority"); - } - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/domainCertAuthorities", HttpMethod.POST, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Domain Certificate Authority object. - * Delete a Domain Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Certificate Authorities trusted for domain verification. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteDomainCertAuthority(String certAuthorityName) throws RestClientException { - return deleteDomainCertAuthorityWithHttpInfo(certAuthorityName).getBody(); - } - - /** - * Delete a Domain Certificate Authority object. - * Delete a Domain Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Certificate Authorities trusted for domain verification. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteDomainCertAuthorityWithHttpInfo(String certAuthorityName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling deleteDomainCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/domainCertAuthorities/{certAuthorityName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Domain Certificate Authority objects. - * Get a list of Domain Certificate Authority objects. Certificate Authorities trusted for domain verification. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The list of Domain Certificate Authority objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DomainCertAuthoritiesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DomainCertAuthoritiesResponse getDomainCertAuthorities(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getDomainCertAuthoritiesWithHttpInfo(count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Domain Certificate Authority objects. - * Get a list of Domain Certificate Authority objects. Certificate Authorities trusted for domain verification. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The list of Domain Certificate Authority objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DomainCertAuthoritiesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDomainCertAuthoritiesWithHttpInfo(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/domainCertAuthorities", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Domain Certificate Authority object. - * Get a Domain Certificate Authority object. Certificate Authorities trusted for domain verification. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The Domain Certificate Authority object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DomainCertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DomainCertAuthorityResponse getDomainCertAuthority(String certAuthorityName, String opaquePassword, List select) throws RestClientException { - return getDomainCertAuthorityWithHttpInfo(certAuthorityName, opaquePassword, select).getBody(); - } - - /** - * Get a Domain Certificate Authority object. - * Get a Domain Certificate Authority object. Certificate Authorities trusted for domain verification. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - *

200 - The Domain Certificate Authority object's attributes, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DomainCertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getDomainCertAuthorityWithHttpInfo(String certAuthorityName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling getDomainCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/domainCertAuthorities/{certAuthorityName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Domain Certificate Authority object. - * Replace a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Certificate Authorities trusted for domain verification. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Domain Certificate Authority object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Domain Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DomainCertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DomainCertAuthorityResponse replaceDomainCertAuthority(String certAuthorityName, DomainCertAuthority body, String opaquePassword, List select) throws RestClientException { - return replaceDomainCertAuthorityWithHttpInfo(certAuthorityName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Domain Certificate Authority object. - * Replace a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Certificate Authorities trusted for domain verification. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Domain Certificate Authority object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Domain Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DomainCertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceDomainCertAuthorityWithHttpInfo(String certAuthorityName, DomainCertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling replaceDomainCertAuthority"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceDomainCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/domainCertAuthorities/{certAuthorityName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Domain Certificate Authority object. - * Update a Domain Certificate Authority object. Any attribute missing from the request will be left unchanged. Certificate Authorities trusted for domain verification. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Domain Certificate Authority object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Domain Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return DomainCertAuthorityResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public DomainCertAuthorityResponse updateDomainCertAuthority(String certAuthorityName, DomainCertAuthority body, String opaquePassword, List select) throws RestClientException { - return updateDomainCertAuthorityWithHttpInfo(certAuthorityName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Domain Certificate Authority object. - * Update a Domain Certificate Authority object. Any attribute missing from the request will be left unchanged. Certificate Authorities trusted for domain verification. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - *

200 - The Domain Certificate Authority object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param certAuthorityName The name of the Certificate Authority. (required) - * @param body The Domain Certificate Authority object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<DomainCertAuthorityResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateDomainCertAuthorityWithHttpInfo(String certAuthorityName, DomainCertAuthority body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'certAuthorityName' is set - if (certAuthorityName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'certAuthorityName' when calling updateDomainCertAuthority"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateDomainCertAuthority"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("certAuthorityName", certAuthorityName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/domainCertAuthorities/{certAuthorityName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/JndiApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/JndiApi.java deleted file mode 100644 index a9317005e..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/JndiApi.java +++ /dev/null @@ -1,1284 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactoriesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactory; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactoryResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueueResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueuesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class JndiApi { - private ApiClient apiClient; - - public JndiApi() { - this(new ApiClient()); - } - - public JndiApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a JNDI Connection Factory object. - * Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: connectionFactoryName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiConnectionFactoryResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiConnectionFactoryResponse createMsgVpnJndiConnectionFactory(String msgVpnName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnJndiConnectionFactoryWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a JNDI Connection Factory object. - * Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: connectionFactoryName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiConnectionFactoryResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnJndiConnectionFactoryWithHttpInfo(String msgVpnName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnJndiConnectionFactory"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a JNDI Queue object. - * Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiQueueResponse createMsgVpnJndiQueue(String msgVpnName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnJndiQueueWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a JNDI Queue object. - * Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnJndiQueueWithHttpInfo(String msgVpnName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnJndiQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnJndiQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a JNDI Topic object. - * Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiTopicResponse createMsgVpnJndiTopic(String msgVpnName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnJndiTopicWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a JNDI Topic object. - * Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnJndiTopicWithHttpInfo(String msgVpnName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnJndiTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnJndiTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a JNDI Connection Factory object. - * Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnJndiConnectionFactory(String msgVpnName, String connectionFactoryName) throws RestClientException { - return deleteMsgVpnJndiConnectionFactoryWithHttpInfo(msgVpnName, connectionFactoryName).getBody(); - } - - /** - * Delete a JNDI Connection Factory object. - * Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnJndiConnectionFactoryWithHttpInfo(String msgVpnName, String connectionFactoryName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'connectionFactoryName' is set - if (connectionFactoryName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'connectionFactoryName' when calling deleteMsgVpnJndiConnectionFactory"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("connectionFactoryName", connectionFactoryName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a JNDI Queue object. - * Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnJndiQueue(String msgVpnName, String queueName) throws RestClientException { - return deleteMsgVpnJndiQueueWithHttpInfo(msgVpnName, queueName).getBody(); - } - - /** - * Delete a JNDI Queue object. - * Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnJndiQueueWithHttpInfo(String msgVpnName, String queueName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnJndiQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling deleteMsgVpnJndiQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues/{queueName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a JNDI Topic object. - * Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnJndiTopic(String msgVpnName, String topicName) throws RestClientException { - return deleteMsgVpnJndiTopicWithHttpInfo(msgVpnName, topicName).getBody(); - } - - /** - * Delete a JNDI Topic object. - * Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnJndiTopicWithHttpInfo(String msgVpnName, String topicName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnJndiTopic"); - } - - // verify the required parameter 'topicName' is set - if (topicName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicName' when calling deleteMsgVpnJndiTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicName", topicName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics/{topicName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of JNDI Connection Factory objects. - * Get a list of JNDI Connection Factory objects. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Connection Factory objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiConnectionFactoriesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiConnectionFactoriesResponse getMsgVpnJndiConnectionFactories(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnJndiConnectionFactoriesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of JNDI Connection Factory objects. - * Get a list of JNDI Connection Factory objects. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Connection Factory objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiConnectionFactoriesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiConnectionFactoriesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiConnectionFactories"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a JNDI Connection Factory object. - * Get a JNDI Connection Factory object. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiConnectionFactoryResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiConnectionFactoryResponse getMsgVpnJndiConnectionFactory(String msgVpnName, String connectionFactoryName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnJndiConnectionFactoryWithHttpInfo(msgVpnName, connectionFactoryName, opaquePassword, select).getBody(); - } - - /** - * Get a JNDI Connection Factory object. - * Get a JNDI Connection Factory object. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiConnectionFactoryResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiConnectionFactoryWithHttpInfo(String msgVpnName, String connectionFactoryName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'connectionFactoryName' is set - if (connectionFactoryName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'connectionFactoryName' when calling getMsgVpnJndiConnectionFactory"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("connectionFactoryName", connectionFactoryName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a JNDI Queue object. - * Get a JNDI Queue object. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiQueueResponse getMsgVpnJndiQueue(String msgVpnName, String queueName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnJndiQueueWithHttpInfo(msgVpnName, queueName, opaquePassword, select).getBody(); - } - - /** - * Get a JNDI Queue object. - * Get a JNDI Queue object. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiQueueWithHttpInfo(String msgVpnName, String queueName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling getMsgVpnJndiQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues/{queueName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of JNDI Queue objects. - * Get a list of JNDI Queue objects. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Queue objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiQueuesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiQueuesResponse getMsgVpnJndiQueues(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnJndiQueuesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of JNDI Queue objects. - * Get a list of JNDI Queue objects. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Queue objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiQueuesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiQueuesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiQueues"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a JNDI Topic object. - * Get a JNDI Topic object. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiTopicResponse getMsgVpnJndiTopic(String msgVpnName, String topicName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnJndiTopicWithHttpInfo(msgVpnName, topicName, opaquePassword, select).getBody(); - } - - /** - * Get a JNDI Topic object. - * Get a JNDI Topic object. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiTopicWithHttpInfo(String msgVpnName, String topicName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiTopic"); - } - - // verify the required parameter 'topicName' is set - if (topicName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicName' when calling getMsgVpnJndiTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicName", topicName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics/{topicName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of JNDI Topic objects. - * Get a list of JNDI Topic objects. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiTopicsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiTopicsResponse getMsgVpnJndiTopics(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnJndiTopicsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of JNDI Topic objects. - * Get a list of JNDI Topic objects. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiTopicsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiTopicsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiTopics"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a JNDI Connection Factory object. - * Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiConnectionFactoryResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiConnectionFactoryResponse replaceMsgVpnJndiConnectionFactory(String msgVpnName, String connectionFactoryName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnJndiConnectionFactoryWithHttpInfo(msgVpnName, connectionFactoryName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a JNDI Connection Factory object. - * Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiConnectionFactoryResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnJndiConnectionFactoryWithHttpInfo(String msgVpnName, String connectionFactoryName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'connectionFactoryName' is set - if (connectionFactoryName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'connectionFactoryName' when calling replaceMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnJndiConnectionFactory"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("connectionFactoryName", connectionFactoryName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a JNDI Queue object. - * Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiQueueResponse replaceMsgVpnJndiQueue(String msgVpnName, String queueName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnJndiQueueWithHttpInfo(msgVpnName, queueName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a JNDI Queue object. - * Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnJndiQueueWithHttpInfo(String msgVpnName, String queueName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnJndiQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling replaceMsgVpnJndiQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnJndiQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues/{queueName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a JNDI Topic object. - * Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiTopicResponse replaceMsgVpnJndiTopic(String msgVpnName, String topicName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnJndiTopicWithHttpInfo(msgVpnName, topicName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a JNDI Topic object. - * Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnJndiTopicWithHttpInfo(String msgVpnName, String topicName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnJndiTopic"); - } - - // verify the required parameter 'topicName' is set - if (topicName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicName' when calling replaceMsgVpnJndiTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnJndiTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicName", topicName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics/{topicName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a JNDI Connection Factory object. - * Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiConnectionFactoryResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiConnectionFactoryResponse updateMsgVpnJndiConnectionFactory(String msgVpnName, String connectionFactoryName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnJndiConnectionFactoryWithHttpInfo(msgVpnName, connectionFactoryName, body, opaquePassword, select).getBody(); - } - - /** - * Update a JNDI Connection Factory object. - * Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiConnectionFactoryResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnJndiConnectionFactoryWithHttpInfo(String msgVpnName, String connectionFactoryName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'connectionFactoryName' is set - if (connectionFactoryName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'connectionFactoryName' when calling updateMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnJndiConnectionFactory"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("connectionFactoryName", connectionFactoryName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a JNDI Queue object. - * Update a JNDI Queue object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiQueueResponse updateMsgVpnJndiQueue(String msgVpnName, String queueName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnJndiQueueWithHttpInfo(msgVpnName, queueName, body, opaquePassword, select).getBody(); - } - - /** - * Update a JNDI Queue object. - * Update a JNDI Queue object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnJndiQueueWithHttpInfo(String msgVpnName, String queueName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnJndiQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling updateMsgVpnJndiQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnJndiQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues/{queueName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a JNDI Topic object. - * Update a JNDI Topic object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiTopicResponse updateMsgVpnJndiTopic(String msgVpnName, String topicName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnJndiTopicWithHttpInfo(msgVpnName, topicName, body, opaquePassword, select).getBody(); - } - - /** - * Update a JNDI Topic object. - * Update a JNDI Topic object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnJndiTopicWithHttpInfo(String msgVpnName, String topicName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnJndiTopic"); - } - - // verify the required parameter 'topicName' is set - if (topicName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicName' when calling updateMsgVpnJndiTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnJndiTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicName", topicName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics/{topicName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MqttRetainCacheApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MqttRetainCacheApi.java deleted file mode 100644 index b46fe8602..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MqttRetainCacheApi.java +++ /dev/null @@ -1,460 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCacheResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCachesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MqttRetainCacheApi { - private ApiClient apiClient; - - public MqttRetainCacheApi() { - this(new ApiClient()); - } - - public MqttRetainCacheApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create an MQTT Retain Cache object. - * Create an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttRetainCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttRetainCacheResponse createMsgVpnMqttRetainCache(String msgVpnName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnMqttRetainCacheWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an MQTT Retain Cache object. - * Create an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttRetainCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnMqttRetainCacheWithHttpInfo(String msgVpnName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnMqttRetainCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an MQTT Retain Cache object. - * Delete an MQTT Retain Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnMqttRetainCache(String msgVpnName, String cacheName) throws RestClientException { - return deleteMsgVpnMqttRetainCacheWithHttpInfo(msgVpnName, cacheName).getBody(); - } - - /** - * Delete an MQTT Retain Cache object. - * Delete an MQTT Retain Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnMqttRetainCacheWithHttpInfo(String msgVpnName, String cacheName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnMqttRetainCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an MQTT Retain Cache object. - * Get an MQTT Retain Cache object. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttRetainCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttRetainCacheResponse getMsgVpnMqttRetainCache(String msgVpnName, String cacheName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnMqttRetainCacheWithHttpInfo(msgVpnName, cacheName, opaquePassword, select).getBody(); - } - - /** - * Get an MQTT Retain Cache object. - * Get an MQTT Retain Cache object. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttRetainCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttRetainCacheWithHttpInfo(String msgVpnName, String cacheName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnMqttRetainCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of MQTT Retain Cache objects. - * Get a list of MQTT Retain Cache objects. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of MQTT Retain Cache objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttRetainCachesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttRetainCachesResponse getMsgVpnMqttRetainCaches(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnMqttRetainCachesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of MQTT Retain Cache objects. - * Get a list of MQTT Retain Cache objects. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of MQTT Retain Cache objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttRetainCachesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttRetainCachesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttRetainCaches"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an MQTT Retain Cache object. - * Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttRetainCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttRetainCacheResponse replaceMsgVpnMqttRetainCache(String msgVpnName, String cacheName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnMqttRetainCacheWithHttpInfo(msgVpnName, cacheName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an MQTT Retain Cache object. - * Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttRetainCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnMqttRetainCacheWithHttpInfo(String msgVpnName, String cacheName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling replaceMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnMqttRetainCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an MQTT Retain Cache object. - * Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttRetainCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttRetainCacheResponse updateMsgVpnMqttRetainCache(String msgVpnName, String cacheName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnMqttRetainCacheWithHttpInfo(msgVpnName, cacheName, body, opaquePassword, select).getBody(); - } - - /** - * Update an MQTT Retain Cache object. - * Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttRetainCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnMqttRetainCacheWithHttpInfo(String msgVpnName, String cacheName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling updateMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnMqttRetainCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MqttSessionApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MqttSessionApi.java deleted file mode 100644 index 6563cca92..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MqttSessionApi.java +++ /dev/null @@ -1,1000 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSession; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MqttSessionApi { - private ApiClient apiClient; - - public MqttSessionApi() { - this(new ApiClient()); - } - - public MqttSessionApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create an MQTT Session object. - * Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionResponse createMsgVpnMqttSession(String msgVpnName, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnMqttSessionWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an MQTT Session object. - * Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnMqttSessionWithHttpInfo(String msgVpnName, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnMqttSession"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnMqttSession"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Subscription object. - * Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x||x||| mqttSessionVirtualRouter|x||x||| msgVpnName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionSubscriptionResponse createMsgVpnMqttSessionSubscription(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnMqttSessionSubscriptionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Create a Subscription object. - * Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x||x||| mqttSessionVirtualRouter|x||x||| msgVpnName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnMqttSessionSubscriptionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling createMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling createMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnMqttSessionSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an MQTT Session object. - * Delete an MQTT Session object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnMqttSession(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter) throws RestClientException { - return deleteMsgVpnMqttSessionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter).getBody(); - } - - /** - * Delete an MQTT Session object. - * Delete an MQTT Session object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnMqttSessionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling deleteMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling deleteMsgVpnMqttSession"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Subscription object. - * Delete a Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnMqttSessionSubscription(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic) throws RestClientException { - return deleteMsgVpnMqttSessionSubscriptionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic).getBody(); - } - - /** - * Delete a Subscription object. - * Delete a Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnMqttSessionSubscriptionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling deleteMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling deleteMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling deleteMsgVpnMqttSessionSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an MQTT Session object. - * Get an MQTT Session object. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionResponse getMsgVpnMqttSession(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String opaquePassword, List select) throws RestClientException { - return getMsgVpnMqttSessionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, opaquePassword, select).getBody(); - } - - /** - * Get an MQTT Session object. - * Get an MQTT Session object. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttSessionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling getMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling getMsgVpnMqttSession"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Subscription object. - * Get a Subscription object. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionSubscriptionResponse getMsgVpnMqttSessionSubscription(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnMqttSessionSubscriptionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Subscription object. - * Get a Subscription object. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttSessionSubscriptionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling getMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling getMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling getMsgVpnMqttSessionSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Subscription objects. - * Get a list of Subscription objects. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionSubscriptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionSubscriptionsResponse getMsgVpnMqttSessionSubscriptions(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnMqttSessionSubscriptionsWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Subscription objects. - * Get a list of Subscription objects. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionSubscriptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttSessionSubscriptionsWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttSessionSubscriptions"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling getMsgVpnMqttSessionSubscriptions"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling getMsgVpnMqttSessionSubscriptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of MQTT Session objects. - * Get a list of MQTT Session objects. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of MQTT Session objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionsResponse getMsgVpnMqttSessions(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnMqttSessionsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of MQTT Session objects. - * Get a list of MQTT Session objects. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of MQTT Session objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttSessionsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttSessions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an MQTT Session object. - * Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| owner|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionResponse replaceMsgVpnMqttSession(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnMqttSessionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Replace an MQTT Session object. - * Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| owner|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnMqttSessionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling replaceMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling replaceMsgVpnMqttSession"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnMqttSession"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Subscription object. - * Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| subscriptionTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionSubscriptionResponse replaceMsgVpnMqttSessionSubscription(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnMqttSessionSubscriptionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Subscription object. - * Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| subscriptionTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnMqttSessionSubscriptionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling replaceMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling replaceMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling replaceMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnMqttSessionSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an MQTT Session object. - * Update an MQTT Session object. Any attribute missing from the request will be left unchanged. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| owner||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionResponse updateMsgVpnMqttSession(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnMqttSessionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Update an MQTT Session object. - * Update an MQTT Session object. Any attribute missing from the request will be left unchanged. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| owner||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnMqttSessionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling updateMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling updateMsgVpnMqttSession"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnMqttSession"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Subscription object. - * Update a Subscription object. Any attribute missing from the request will be left unchanged. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionSubscriptionResponse updateMsgVpnMqttSessionSubscription(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnMqttSessionSubscriptionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select).getBody(); - } - - /** - * Update a Subscription object. - * Update a Subscription object. Any attribute missing from the request will be left unchanged. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnMqttSessionSubscriptionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling updateMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling updateMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling updateMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnMqttSessionSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MsgVpnApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MsgVpnApi.java deleted file mode 100644 index 71bdb0974..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MsgVpnApi.java +++ /dev/null @@ -1,19742 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProvider; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProviderResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProvidersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroupResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroupsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpnResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpnsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFiltersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleConditionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleConditionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRulesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsername; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttributeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttributesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstance; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstanceResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstancesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClustersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCachesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridgeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridgesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactoriesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactory; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactoryResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueueResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueuesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCacheResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCachesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSession; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplateResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplatesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueuesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLog; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBinding; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeader; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumer; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplateResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplatesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnApi { - private ApiClient apiClient; - - public MsgVpnApi() { - this(new ApiClient()); - } - - public MsgVpnApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Message VPN object. - * Create a Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| distributedCacheManagementEnabled|||||x| msgVpnName|x|x|||| replicationBridgeAuthenticationBasicPassword||||x||x replicationBridgeAuthenticationClientCertContent||||x||x replicationBridgeAuthenticationClientCertPassword||||x|| replicationEnabledQueueBehavior||||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Message VPN object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnResponse createMsgVpn(MsgVpn body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnWithHttpInfo(body, opaquePassword, select).getBody(); - } - - /** - * Create a Message VPN object. - * Create a Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| distributedCacheManagementEnabled|||||x| msgVpnName|x|x|||| replicationBridgeAuthenticationBasicPassword||||x||x replicationBridgeAuthenticationClientCertContent||||x||x replicationBridgeAuthenticationClientCertPassword||||x|| replicationEnabledQueueBehavior||||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Message VPN object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnWithHttpInfo(MsgVpn body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpn"); - } - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns", HttpMethod.POST, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an ACL Profile object. - * Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileResponse createMsgVpnAclProfile(String msgVpnName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfileWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an ACL Profile object. - * Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAclProfileWithHttpInfo(String msgVpnName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Client Connect Exception object. - * Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| clientConnectExceptionAddress|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Connect Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Client Connect Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileClientConnectExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileClientConnectExceptionResponse createMsgVpnAclProfileClientConnectException(String msgVpnName, String aclProfileName, MsgVpnAclProfileClientConnectException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfileClientConnectExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Client Connect Exception object. - * Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| clientConnectExceptionAddress|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Connect Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Client Connect Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileClientConnectExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAclProfileClientConnectExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfileClientConnectException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfileClientConnectException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Publish Topic Exception object. - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| publishExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The Publish Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Publish Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfilePublishExceptionResponse createMsgVpnAclProfilePublishException(String msgVpnName, String aclProfileName, MsgVpnAclProfilePublishException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfilePublishExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Publish Topic Exception object. - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| publishExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The Publish Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Publish Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createMsgVpnAclProfilePublishExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfilePublishException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfilePublishException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Publish Topic Exception object. - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| publishTopicException|x|x|||| publishTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Publish Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Publish Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishTopicExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfilePublishTopicExceptionResponse createMsgVpnAclProfilePublishTopicException(String msgVpnName, String aclProfileName, MsgVpnAclProfilePublishTopicException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Publish Topic Exception object. - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| publishTopicException|x|x|||| publishTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Publish Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Publish Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishTopicExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfilePublishTopicException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfilePublishTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Subscribe Topic Exception object. - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| subscribeExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The Subscribe Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfileSubscribeExceptionResponse createMsgVpnAclProfileSubscribeException(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfileSubscribeExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Subscribe Topic Exception object. - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| subscribeExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The Subscribe Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createMsgVpnAclProfileSubscribeExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfileSubscribeException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Subscribe Share Name Exception object. - * Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeShareNameException|x|x|||| subscribeShareNameExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Share Name Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Share Name Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeShareNameExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeShareNameExceptionResponse createMsgVpnAclProfileSubscribeShareNameException(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeShareNameException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Subscribe Share Name Exception object. - * Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeShareNameException|x|x|||| subscribeShareNameExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Share Name Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Share Name Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeShareNameExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeShareNameException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfileSubscribeShareNameException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Subscribe Topic Exception object. - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeTopicException|x|x|||| subscribeTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeTopicExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeTopicExceptionResponse createMsgVpnAclProfileSubscribeTopicException(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeTopicException body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Subscribe Topic Exception object. - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeTopicException|x|x|||| subscribeTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Topic Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The Subscribe Topic Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeTopicExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfileSubscribeTopicException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling createMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAclProfileSubscribeTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an OAuth Profile object. - * Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x msgVpnName|x||x||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResponse createMsgVpnAuthenticationOauthProfile(String msgVpnName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAuthenticationOauthProfileWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an OAuth Profile object. - * Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x msgVpnName|x||x||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAuthenticationOauthProfileWithHttpInfo(String msgVpnName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAuthenticationOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| msgVpnName|x||x||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse createMsgVpnAuthenticationOauthProfileClientRequiredClaim(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfileClientRequiredClaim body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| msgVpnName|x||x||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfileClientRequiredClaim body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an OAuth Provider object. - * Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x||x||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword||||x|x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProviderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAuthenticationOauthProviderResponse createMsgVpnAuthenticationOauthProvider(String msgVpnName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAuthenticationOauthProviderWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an OAuth Provider object. - * Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x||x||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword||||x|x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProviderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createMsgVpnAuthenticationOauthProviderWithHttpInfo(String msgVpnName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAuthenticationOauthProvider"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an Authorization Group object. - * Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationGroupName|x|x|||| msgVpnName|x||x||| orderAfterAuthorizationGroupName||||x|| orderBeforeAuthorizationGroupName||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthorizationGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthorizationGroupResponse createMsgVpnAuthorizationGroup(String msgVpnName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnAuthorizationGroupWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an Authorization Group object. - * Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationGroupName|x|x|||| msgVpnName|x||x||| orderAfterAuthorizationGroupName||||x|| orderBeforeAuthorizationGroupName||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthorizationGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnAuthorizationGroupWithHttpInfo(String msgVpnName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnAuthorizationGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Bridge object. - * Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| msgVpnName|x||x||| remoteAuthenticationBasicPassword||||x||x remoteAuthenticationClientCertContent||||x||x remoteAuthenticationClientCertPassword||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeResponse createMsgVpnBridge(String msgVpnName, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnBridgeWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Bridge object. - * Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| msgVpnName|x||x||| remoteAuthenticationBasicPassword||||x||x remoteAuthenticationClientCertContent||||x||x remoteAuthenticationClientCertPassword||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnBridgeWithHttpInfo(String msgVpnName, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Remote Message VPN object. - * Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| msgVpnName|x||x||| password||||x||x remoteMsgVpnInterface|x||||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteMsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteMsgVpnResponse createMsgVpnBridgeRemoteMsgVpn(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnBridgeRemoteMsgVpnWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Create a Remote Message VPN object. - * Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| msgVpnName|x||x||| password||||x||x remoteMsgVpnInterface|x||||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteMsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnBridgeRemoteMsgVpnWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling createMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling createMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnBridgeRemoteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Remote Subscription object. - * Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| deliverAlwaysEnabled||x|||| msgVpnName|x||x||| remoteSubscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Remote Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteSubscriptionResponse createMsgVpnBridgeRemoteSubscription(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeRemoteSubscription body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnBridgeRemoteSubscriptionWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Create a Remote Subscription object. - * Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| deliverAlwaysEnabled||x|||| msgVpnName|x||x||| remoteSubscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Remote Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnBridgeRemoteSubscriptionWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeRemoteSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling createMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling createMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnBridgeRemoteSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Trusted Common Name object. - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||x| bridgeVirtualRouter|x||x||x| msgVpnName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnBridgeTlsTrustedCommonNameResponse createMsgVpnBridgeTlsTrustedCommonName(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Create a Trusted Common Name object. - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||x| bridgeVirtualRouter|x||x||x| msgVpnName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridgeTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling createMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling createMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnBridgeTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Certificate Matching Rule object. - * Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleResponse createMsgVpnCertMatchingRule(String msgVpnName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnCertMatchingRuleWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Matching Rule object. - * Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnCertMatchingRuleWithHttpInfo(String msgVpnName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Certificate Matching Rule Attribute Filter object. - * Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: filterName|x|x|||| msgVpnName|x||x||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleAttributeFilterResponse createMsgVpnCertMatchingRuleAttributeFilter(String msgVpnName, String ruleName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(msgVpnName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Matching Rule Attribute Filter object. - * Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: filterName|x|x|||| msgVpnName|x||x||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(String msgVpnName, String ruleName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling createMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Certificate Matching Rule Condition object. - * Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule Condition object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Condition object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleConditionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleConditionResponse createMsgVpnCertMatchingRuleCondition(String msgVpnName, String ruleName, MsgVpnCertMatchingRuleCondition body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnCertMatchingRuleConditionWithHttpInfo(msgVpnName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Certificate Matching Rule Condition object. - * Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule Condition object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule Condition object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleConditionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnCertMatchingRuleConditionWithHttpInfo(String msgVpnName, String ruleName, MsgVpnCertMatchingRuleCondition body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling createMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnCertMatchingRuleCondition"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Client Profile object. - * Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientProfileResponse createMsgVpnClientProfile(String msgVpnName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnClientProfileWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Client Profile object. - * Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnClientProfileWithHttpInfo(String msgVpnName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnClientProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnClientProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Client Username object. - * Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientUsername|x|x|||| msgVpnName|x||x||| password||||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameResponse createMsgVpnClientUsername(String msgVpnName, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnClientUsernameWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Client Username object. - * Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientUsername|x|x|||| msgVpnName|x||x||| password||||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnClientUsernameWithHttpInfo(String msgVpnName, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnClientUsername"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnClientUsername"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Client Username Attribute object. - * Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| clientUsername|x||x||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Client Username Attribute object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username Attribute object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameAttributeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameAttributeResponse createMsgVpnClientUsernameAttribute(String msgVpnName, String clientUsername, MsgVpnClientUsernameAttribute body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnClientUsernameAttributeWithHttpInfo(msgVpnName, clientUsername, body, opaquePassword, select).getBody(); - } - - /** - * Create a Client Username Attribute object. - * Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| clientUsername|x||x||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Client Username Attribute object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username Attribute object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameAttributeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnClientUsernameAttributeWithHttpInfo(String msgVpnName, String clientUsername, MsgVpnClientUsernameAttribute body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling createMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnClientUsernameAttribute"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Distributed Cache object. - * Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheResponse createMsgVpnDistributedCache(String msgVpnName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Distributed Cache object. - * Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheWithHttpInfo(String msgVpnName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Cache Cluster object. - * Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterResponse createMsgVpnDistributedCacheCluster(String msgVpnName, String cacheName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheClusterWithHttpInfo(msgVpnName, cacheName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Cache Cluster object. - * Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheClusterWithHttpInfo(String msgVpnName, String cacheName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling createMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCacheCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Home Cache Cluster object. - * Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Home Cache Cluster object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Home Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterGlobalCachingHomeCluster body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(msgVpnName, cacheName, clusterName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Home Cache Cluster object. - * Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Home Cache Cluster object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Home Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterGlobalCachingHomeCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Topic Prefix object. - * Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x||x||| msgVpnName|x||x||| topicPrefix|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic Prefix object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param body The Topic Prefix object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(String msgVpnName, String cacheName, String clusterName, String homeClusterName, MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Topic Prefix object. - * Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x||x||| msgVpnName|x||x||| topicPrefix|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic Prefix object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param body The Topic Prefix object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName, MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Cache Instance object. - * Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| instanceName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterInstanceResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterInstanceResponse createMsgVpnDistributedCacheClusterInstance(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheClusterInstanceWithHttpInfo(msgVpnName, cacheName, clusterName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Cache Instance object. - * Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| instanceName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterInstanceResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheClusterInstanceWithHttpInfo(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling createMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling createMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCacheClusterInstance"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Topic object. - * Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| msgVpnName|x||x||| topic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterTopicResponse createMsgVpnDistributedCacheClusterTopic(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterTopic body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDistributedCacheClusterTopicWithHttpInfo(msgVpnName, cacheName, clusterName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Topic object. - * Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| msgVpnName|x||x||| topic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDistributedCacheClusterTopicWithHttpInfo(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheClusterTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling createMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling createMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDistributedCacheClusterTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a DMR Bridge object. - * Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDmrBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDmrBridgeResponse createMsgVpnDmrBridge(String msgVpnName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnDmrBridgeWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a DMR Bridge object. - * Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDmrBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnDmrBridgeWithHttpInfo(String msgVpnName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnDmrBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnDmrBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a JNDI Connection Factory object. - * Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: connectionFactoryName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiConnectionFactoryResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiConnectionFactoryResponse createMsgVpnJndiConnectionFactory(String msgVpnName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnJndiConnectionFactoryWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a JNDI Connection Factory object. - * Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: connectionFactoryName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiConnectionFactoryResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnJndiConnectionFactoryWithHttpInfo(String msgVpnName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnJndiConnectionFactory"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a JNDI Queue object. - * Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiQueueResponse createMsgVpnJndiQueue(String msgVpnName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnJndiQueueWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a JNDI Queue object. - * Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnJndiQueueWithHttpInfo(String msgVpnName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnJndiQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnJndiQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a JNDI Topic object. - * Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiTopicResponse createMsgVpnJndiTopic(String msgVpnName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnJndiTopicWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a JNDI Topic object. - * Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnJndiTopicWithHttpInfo(String msgVpnName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnJndiTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnJndiTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an MQTT Retain Cache object. - * Create an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttRetainCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttRetainCacheResponse createMsgVpnMqttRetainCache(String msgVpnName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnMqttRetainCacheWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an MQTT Retain Cache object. - * Create an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttRetainCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnMqttRetainCacheWithHttpInfo(String msgVpnName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnMqttRetainCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an MQTT Session object. - * Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionResponse createMsgVpnMqttSession(String msgVpnName, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnMqttSessionWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create an MQTT Session object. - * Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnMqttSessionWithHttpInfo(String msgVpnName, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnMqttSession"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnMqttSession"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Subscription object. - * Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x||x||| mqttSessionVirtualRouter|x||x||| msgVpnName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionSubscriptionResponse createMsgVpnMqttSessionSubscription(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnMqttSessionSubscriptionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Create a Subscription object. - * Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x||x||| mqttSessionVirtualRouter|x||x||| msgVpnName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnMqttSessionSubscriptionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling createMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling createMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnMqttSessionSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Queue object. - * Create a Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueResponse createMsgVpnQueue(String msgVpnName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnQueueWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Queue object. - * Create a Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnQueueWithHttpInfo(String msgVpnName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Queue Subscription object. - * Create a Queue Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueSubscriptionResponse createMsgVpnQueueSubscription(String msgVpnName, String queueName, MsgVpnQueueSubscription body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnQueueSubscriptionWithHttpInfo(msgVpnName, queueName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Queue Subscription object. - * Create a Queue Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnQueueSubscriptionWithHttpInfo(String msgVpnName, String queueName, MsgVpnQueueSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnQueueSubscription"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling createMsgVpnQueueSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnQueueSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Queue Template object. - * Create a Queue Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueTemplateResponse createMsgVpnQueueTemplate(String msgVpnName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnQueueTemplateWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Queue Template object. - * Create a Queue Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnQueueTemplateWithHttpInfo(String msgVpnName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnQueueTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnQueueTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Replay Log object. - * Create a Replay Log object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogResponse createMsgVpnReplayLog(String msgVpnName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnReplayLogWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Replay Log object. - * Create a Replay Log object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnReplayLogWithHttpInfo(String msgVpnName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnReplayLog"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnReplayLog"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Topic Filter Subscription object. - * Create a Topic Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x||x||| topicFilterSubscription|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Topic Filter Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Topic Filter Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogTopicFilterSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogTopicFilterSubscriptionResponse createMsgVpnReplayLogTopicFilterSubscription(String msgVpnName, String replayLogName, MsgVpnReplayLogTopicFilterSubscription body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(msgVpnName, replayLogName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Topic Filter Subscription object. - * Create a Topic Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x||x||| topicFilterSubscription|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Topic Filter Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Topic Filter Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogTopicFilterSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(String msgVpnName, String replayLogName, MsgVpnReplayLogTopicFilterSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling createMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnReplayLogTopicFilterSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Replicated Topic object. - * Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplicatedTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplicatedTopicResponse createMsgVpnReplicatedTopic(String msgVpnName, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnReplicatedTopicWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Replicated Topic object. - * Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplicatedTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnReplicatedTopicWithHttpInfo(String msgVpnName, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnReplicatedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a REST Delivery Point object. - * Create a REST Delivery Point object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointResponse createMsgVpnRestDeliveryPoint(String msgVpnName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a REST Delivery Point object. - * Create a REST Delivery Point object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnRestDeliveryPointWithHttpInfo(String msgVpnName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Queue Binding object. - * Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueBindingName|x|x|||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingResponse createMsgVpnRestDeliveryPointQueueBinding(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(msgVpnName, restDeliveryPointName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Queue Binding object. - * Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueBindingName|x|x|||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling createMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPointQueueBinding"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Request Header object. - * Create a Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: headerName|x|x|||| msgVpnName|x||x||| queueBindingName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse createMsgVpnRestDeliveryPointQueueBindingRequestHeader(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Request Header object. - * Create a Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: headerName|x|x|||| msgVpnName|x||x||| queueBindingName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling createMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling createMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a REST Consumer object. - * Create a REST Consumer object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| authenticationHttpBasicPassword||||x||x authenticationHttpHeaderValue||||x||x authenticationOauthClientSecret||||x||x authenticationOauthJwtSecretKey||||x||x msgVpnName|x||x||| restConsumerName|x|x|||| restDeliveryPointName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerResponse createMsgVpnRestDeliveryPointRestConsumer(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(msgVpnName, restDeliveryPointName, body, opaquePassword, select).getBody(); - } - - /** - * Create a REST Consumer object. - * Create a REST Consumer object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| authenticationHttpBasicPassword||||x||x authenticationHttpHeaderValue||||x||x authenticationOauthClientSecret||||x||x authenticationOauthJwtSecretKey||||x||x msgVpnName|x||x||| restConsumerName|x|x|||| restDeliveryPointName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling createMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPointRestConsumer"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Claim object. - * Create a Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthJwtClaimName|x|x|||| oauthJwtClaimValue||x|||| restConsumerName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - *

200 - The Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Claim object. - * Create a Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthJwtClaimName|x|x|||| oauthJwtClaimValue||x|||| restConsumerName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - *

200 - The Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Trusted Common Name object. - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||x| restConsumerName|x||x||x| restDeliveryPointName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Trusted Common Name object. - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||x| restConsumerName|x||x||x| restDeliveryPointName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Sequenced Topic object. - * Create a Sequenced Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| sequencedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Sequenced Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Sequenced Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnSequencedTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnSequencedTopicResponse createMsgVpnSequencedTopic(String msgVpnName, MsgVpnSequencedTopic body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnSequencedTopicWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Sequenced Topic object. - * Create a Sequenced Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| sequencedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Sequenced Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Sequenced Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnSequencedTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnSequencedTopicWithHttpInfo(String msgVpnName, MsgVpnSequencedTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnSequencedTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnSequencedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/sequencedTopics", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Topic Endpoint object. - * Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointResponse createMsgVpnTopicEndpoint(String msgVpnName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnTopicEndpointWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Topic Endpoint object. - * Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnTopicEndpointWithHttpInfo(String msgVpnName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnTopicEndpoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Topic Endpoint Template object. - * Create a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointTemplateResponse createMsgVpnTopicEndpointTemplate(String msgVpnName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnTopicEndpointTemplateWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Topic Endpoint Template object. - * Create a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnTopicEndpointTemplateWithHttpInfo(String msgVpnName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnTopicEndpointTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Message VPN object. - * Delete a Message VPN object. The deletion of instances of this object are synchronized to HA mates via config-sync. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpn(String msgVpnName) throws RestClientException { - return deleteMsgVpnWithHttpInfo(msgVpnName).getBody(); - } - - /** - * Delete a Message VPN object. - * Delete a Message VPN object. The deletion of instances of this object are synchronized to HA mates via config-sync. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnWithHttpInfo(String msgVpnName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an ACL Profile object. - * Delete an ACL Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAclProfile(String msgVpnName, String aclProfileName) throws RestClientException { - return deleteMsgVpnAclProfileWithHttpInfo(msgVpnName, aclProfileName).getBody(); - } - - /** - * Delete an ACL Profile object. - * Delete an ACL Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAclProfileWithHttpInfo(String msgVpnName, String aclProfileName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfile"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Client Connect Exception object. - * Delete a Client Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param clientConnectExceptionAddress The IP address/netmask of the client connect exception in CIDR form. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAclProfileClientConnectException(String msgVpnName, String aclProfileName, String clientConnectExceptionAddress) throws RestClientException { - return deleteMsgVpnAclProfileClientConnectExceptionWithHttpInfo(msgVpnName, aclProfileName, clientConnectExceptionAddress).getBody(); - } - - /** - * Delete a Client Connect Exception object. - * Delete a Client Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param clientConnectExceptionAddress The IP address/netmask of the client connect exception in CIDR form. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAclProfileClientConnectExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String clientConnectExceptionAddress) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'clientConnectExceptionAddress' is set - if (clientConnectExceptionAddress == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientConnectExceptionAddress' when calling deleteMsgVpnAclProfileClientConnectException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("clientConnectExceptionAddress", clientConnectExceptionAddress); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Publish Topic Exception object. - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteMsgVpnAclProfilePublishException(String msgVpnName, String aclProfileName, String topicSyntax, String publishExceptionTopic) throws RestClientException { - return deleteMsgVpnAclProfilePublishExceptionWithHttpInfo(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic).getBody(); - } - - /** - * Delete a Publish Topic Exception object. - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteMsgVpnAclProfilePublishExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String topicSyntax, String publishExceptionTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'topicSyntax' is set - if (topicSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicSyntax' when calling deleteMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'publishExceptionTopic' is set - if (publishExceptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishExceptionTopic' when calling deleteMsgVpnAclProfilePublishException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("topicSyntax", topicSyntax); - uriVariables.put("publishExceptionTopic", publishExceptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Publish Topic Exception object. - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param publishTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAclProfilePublishTopicException(String msgVpnName, String aclProfileName, String publishTopicExceptionSyntax, String publishTopicException) throws RestClientException { - return deleteMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException).getBody(); - } - - /** - * Delete a Publish Topic Exception object. - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param publishTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String publishTopicExceptionSyntax, String publishTopicException) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'publishTopicExceptionSyntax' is set - if (publishTopicExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishTopicExceptionSyntax' when calling deleteMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'publishTopicException' is set - if (publishTopicException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishTopicException' when calling deleteMsgVpnAclProfilePublishTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("publishTopicExceptionSyntax", publishTopicExceptionSyntax); - uriVariables.put("publishTopicException", publishTopicException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Subscribe Topic Exception object. - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeException(String msgVpnName, String aclProfileName, String topicSyntax, String subscribeExceptionTopic) throws RestClientException { - return deleteMsgVpnAclProfileSubscribeExceptionWithHttpInfo(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic).getBody(); - } - - /** - * Delete a Subscribe Topic Exception object. - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteMsgVpnAclProfileSubscribeExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String topicSyntax, String subscribeExceptionTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'topicSyntax' is set - if (topicSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicSyntax' when calling deleteMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'subscribeExceptionTopic' is set - if (subscribeExceptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeExceptionTopic' when calling deleteMsgVpnAclProfileSubscribeException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("topicSyntax", topicSyntax); - uriVariables.put("subscribeExceptionTopic", subscribeExceptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Subscribe Share Name Exception object. - * Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeShareNameExceptionSyntax The syntax of the subscribe share name for the exception to the default action taken. (required) - * @param subscribeShareNameException The subscribe share name exception to the default action taken. May include wildcard characters. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeShareNameException(String msgVpnName, String aclProfileName, String subscribeShareNameExceptionSyntax, String subscribeShareNameException) throws RestClientException { - return deleteMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException).getBody(); - } - - /** - * Delete a Subscribe Share Name Exception object. - * Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeShareNameExceptionSyntax The syntax of the subscribe share name for the exception to the default action taken. (required) - * @param subscribeShareNameException The subscribe share name exception to the default action taken. May include wildcard characters. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String subscribeShareNameExceptionSyntax, String subscribeShareNameException) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'subscribeShareNameExceptionSyntax' is set - if (subscribeShareNameExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeShareNameExceptionSyntax' when calling deleteMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'subscribeShareNameException' is set - if (subscribeShareNameException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeShareNameException' when calling deleteMsgVpnAclProfileSubscribeShareNameException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("subscribeShareNameExceptionSyntax", subscribeShareNameExceptionSyntax); - uriVariables.put("subscribeShareNameException", subscribeShareNameException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Subscribe Topic Exception object. - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAclProfileSubscribeTopicException(String msgVpnName, String aclProfileName, String subscribeTopicExceptionSyntax, String subscribeTopicException) throws RestClientException { - return deleteMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException).getBody(); - } - - /** - * Delete a Subscribe Topic Exception object. - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String subscribeTopicExceptionSyntax, String subscribeTopicException) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling deleteMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'subscribeTopicExceptionSyntax' is set - if (subscribeTopicExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeTopicExceptionSyntax' when calling deleteMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'subscribeTopicException' is set - if (subscribeTopicException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeTopicException' when calling deleteMsgVpnAclProfileSubscribeTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("subscribeTopicExceptionSyntax", subscribeTopicExceptionSyntax); - uriVariables.put("subscribeTopicException", subscribeTopicException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an OAuth Profile object. - * Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfile(String msgVpnName, String oauthProfileName) throws RestClientException { - return deleteMsgVpnAuthenticationOauthProfileWithHttpInfo(msgVpnName, oauthProfileName).getBody(); - } - - /** - * Delete an OAuth Profile object. - * Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAuthenticationOauthProfileWithHttpInfo(String msgVpnName, String oauthProfileName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteMsgVpnAuthenticationOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim(String msgVpnName, String oauthProfileName, String clientRequiredClaimName) throws RestClientException { - return deleteMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, clientRequiredClaimName).getBody(); - } - - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, String clientRequiredClaimName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'clientRequiredClaimName' is set - if (clientRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientRequiredClaimName' when calling deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("clientRequiredClaimName", clientRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(String msgVpnName, String oauthProfileName, String resourceServerRequiredClaimName) throws RestClientException { - return deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, resourceServerRequiredClaimName).getBody(); - } - - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, String resourceServerRequiredClaimName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'resourceServerRequiredClaimName' is set - if (resourceServerRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'resourceServerRequiredClaimName' when calling deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("resourceServerRequiredClaimName", resourceServerRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an OAuth Provider object. - * Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteMsgVpnAuthenticationOauthProvider(String msgVpnName, String oauthProviderName) throws RestClientException { - return deleteMsgVpnAuthenticationOauthProviderWithHttpInfo(msgVpnName, oauthProviderName).getBody(); - } - - /** - * Delete an OAuth Provider object. - * Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteMsgVpnAuthenticationOauthProviderWithHttpInfo(String msgVpnName, String oauthProviderName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'oauthProviderName' is set - if (oauthProviderName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProviderName' when calling deleteMsgVpnAuthenticationOauthProvider"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProviderName", oauthProviderName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an Authorization Group object. - * Delete an Authorization Group object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnAuthorizationGroup(String msgVpnName, String authorizationGroupName) throws RestClientException { - return deleteMsgVpnAuthorizationGroupWithHttpInfo(msgVpnName, authorizationGroupName).getBody(); - } - - /** - * Delete an Authorization Group object. - * Delete an Authorization Group object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnAuthorizationGroupWithHttpInfo(String msgVpnName, String authorizationGroupName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'authorizationGroupName' is set - if (authorizationGroupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationGroupName' when calling deleteMsgVpnAuthorizationGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("authorizationGroupName", authorizationGroupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Bridge object. - * Delete a Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnBridge(String msgVpnName, String bridgeName, String bridgeVirtualRouter) throws RestClientException { - return deleteMsgVpnBridgeWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter).getBody(); - } - - /** - * Delete a Bridge object. - * Delete a Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnBridgeWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnBridge"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling deleteMsgVpnBridge"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling deleteMsgVpnBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Remote Message VPN object. - * Delete a Remote Message VPN object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnBridgeRemoteMsgVpn(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface) throws RestClientException { - return deleteMsgVpnBridgeRemoteMsgVpnWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface).getBody(); - } - - /** - * Delete a Remote Message VPN object. - * Delete a Remote Message VPN object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnBridgeRemoteMsgVpnWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnName' is set - if (remoteMsgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnName' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnLocation' is set - if (remoteMsgVpnLocation == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnLocation' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnInterface' is set - if (remoteMsgVpnInterface == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnInterface' when calling deleteMsgVpnBridgeRemoteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteMsgVpnName", remoteMsgVpnName); - uriVariables.put("remoteMsgVpnLocation", remoteMsgVpnLocation); - uriVariables.put("remoteMsgVpnInterface", remoteMsgVpnInterface); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Remote Subscription object. - * Delete a Remote Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteSubscriptionTopic The topic of the Bridge remote subscription. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnBridgeRemoteSubscription(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteSubscriptionTopic) throws RestClientException { - return deleteMsgVpnBridgeRemoteSubscriptionWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic).getBody(); - } - - /** - * Delete a Remote Subscription object. - * Delete a Remote Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteSubscriptionTopic The topic of the Bridge remote subscription. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnBridgeRemoteSubscriptionWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteSubscriptionTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling deleteMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling deleteMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'remoteSubscriptionTopic' is set - if (remoteSubscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteSubscriptionTopic' when calling deleteMsgVpnBridgeRemoteSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteSubscriptionTopic", remoteSubscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Trusted Common Name object. - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteMsgVpnBridgeTlsTrustedCommonName(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String tlsTrustedCommonName) throws RestClientException { - return deleteMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName).getBody(); - } - - /** - * Delete a Trusted Common Name object. - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String tlsTrustedCommonName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling deleteMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling deleteMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'tlsTrustedCommonName' is set - if (tlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'tlsTrustedCommonName' when calling deleteMsgVpnBridgeTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("tlsTrustedCommonName", tlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Matching Rule object. - * Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnCertMatchingRule(String msgVpnName, String ruleName) throws RestClientException { - return deleteMsgVpnCertMatchingRuleWithHttpInfo(msgVpnName, ruleName).getBody(); - } - - /** - * Delete a Certificate Matching Rule object. - * Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnCertMatchingRuleWithHttpInfo(String msgVpnName, String ruleName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling deleteMsgVpnCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Matching Rule Attribute Filter object. - * Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnCertMatchingRuleAttributeFilter(String msgVpnName, String ruleName, String filterName) throws RestClientException { - return deleteMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(msgVpnName, ruleName, filterName).getBody(); - } - - /** - * Delete a Certificate Matching Rule Attribute Filter object. - * Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(String msgVpnName, String ruleName, String filterName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling deleteMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling deleteMsgVpnCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Certificate Matching Rule Condition object. - * Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnCertMatchingRuleCondition(String msgVpnName, String ruleName, String source) throws RestClientException { - return deleteMsgVpnCertMatchingRuleConditionWithHttpInfo(msgVpnName, ruleName, source).getBody(); - } - - /** - * Delete a Certificate Matching Rule Condition object. - * Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnCertMatchingRuleConditionWithHttpInfo(String msgVpnName, String ruleName, String source) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling deleteMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'source' is set - if (source == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'source' when calling deleteMsgVpnCertMatchingRuleCondition"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("source", source); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Client Profile object. - * Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnClientProfile(String msgVpnName, String clientProfileName) throws RestClientException { - return deleteMsgVpnClientProfileWithHttpInfo(msgVpnName, clientProfileName).getBody(); - } - - /** - * Delete a Client Profile object. - * Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnClientProfileWithHttpInfo(String msgVpnName, String clientProfileName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnClientProfile"); - } - - // verify the required parameter 'clientProfileName' is set - if (clientProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientProfileName' when calling deleteMsgVpnClientProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientProfileName", clientProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Client Username object. - * Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnClientUsername(String msgVpnName, String clientUsername) throws RestClientException { - return deleteMsgVpnClientUsernameWithHttpInfo(msgVpnName, clientUsername).getBody(); - } - - /** - * Delete a Client Username object. - * Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnClientUsernameWithHttpInfo(String msgVpnName, String clientUsername) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnClientUsername"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling deleteMsgVpnClientUsername"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Client Username Attribute object. - * Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnClientUsernameAttribute(String msgVpnName, String clientUsername, String attributeName, String attributeValue) throws RestClientException { - return deleteMsgVpnClientUsernameAttributeWithHttpInfo(msgVpnName, clientUsername, attributeName, attributeValue).getBody(); - } - - /** - * Delete a Client Username Attribute object. - * Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnClientUsernameAttributeWithHttpInfo(String msgVpnName, String clientUsername, String attributeName, String attributeValue) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling deleteMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'attributeName' is set - if (attributeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeName' when calling deleteMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'attributeValue' is set - if (attributeValue == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeValue' when calling deleteMsgVpnClientUsernameAttribute"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - uriVariables.put("attributeName", attributeName); - uriVariables.put("attributeValue", attributeValue); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Distributed Cache object. - * Delete a Distributed Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCache(String msgVpnName, String cacheName) throws RestClientException { - return deleteMsgVpnDistributedCacheWithHttpInfo(msgVpnName, cacheName).getBody(); - } - - /** - * Delete a Distributed Cache object. - * Delete a Distributed Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheWithHttpInfo(String msgVpnName, String cacheName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Cache Cluster object. - * Delete a Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCacheCluster(String msgVpnName, String cacheName, String clusterName) throws RestClientException { - return deleteMsgVpnDistributedCacheClusterWithHttpInfo(msgVpnName, cacheName, clusterName).getBody(); - } - - /** - * Delete a Cache Cluster object. - * Delete a Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling deleteMsgVpnDistributedCacheCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Home Cache Cluster object. - * Delete a Home Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(String msgVpnName, String cacheName, String clusterName, String homeClusterName) throws RestClientException { - return deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName).getBody(); - } - - /** - * Delete a Home Cache Cluster object. - * Delete a Home Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Topic Prefix object. - * Delete a Topic Prefix object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param topicPrefix A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String topicPrefix) throws RestClientException { - return deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix).getBody(); - } - - /** - * Delete a Topic Prefix object. - * Delete a Topic Prefix object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param topicPrefix A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String topicPrefix) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'topicPrefix' is set - if (topicPrefix == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicPrefix' when calling deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - uriVariables.put("topicPrefix", topicPrefix); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Cache Instance object. - * Delete a Cache Instance object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterInstance(String msgVpnName, String cacheName, String clusterName, String instanceName) throws RestClientException { - return deleteMsgVpnDistributedCacheClusterInstanceWithHttpInfo(msgVpnName, cacheName, clusterName, instanceName).getBody(); - } - - /** - * Delete a Cache Instance object. - * Delete a Cache Instance object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheClusterInstanceWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String instanceName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling deleteMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'instanceName' is set - if (instanceName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'instanceName' when calling deleteMsgVpnDistributedCacheClusterInstance"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("instanceName", instanceName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Topic object. - * Delete a Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param topic The value of the Topic in the form a/b/c. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDistributedCacheClusterTopic(String msgVpnName, String cacheName, String clusterName, String topic) throws RestClientException { - return deleteMsgVpnDistributedCacheClusterTopicWithHttpInfo(msgVpnName, cacheName, clusterName, topic).getBody(); - } - - /** - * Delete a Topic object. - * Delete a Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param topic The value of the Topic in the form a/b/c. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDistributedCacheClusterTopicWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String topic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling deleteMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'topic' is set - if (topic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topic' when calling deleteMsgVpnDistributedCacheClusterTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("topic", topic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a DMR Bridge object. - * Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnDmrBridge(String msgVpnName, String remoteNodeName) throws RestClientException { - return deleteMsgVpnDmrBridgeWithHttpInfo(msgVpnName, remoteNodeName).getBody(); - } - - /** - * Delete a DMR Bridge object. - * Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnDmrBridgeWithHttpInfo(String msgVpnName, String remoteNodeName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnDmrBridge"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling deleteMsgVpnDmrBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a JNDI Connection Factory object. - * Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnJndiConnectionFactory(String msgVpnName, String connectionFactoryName) throws RestClientException { - return deleteMsgVpnJndiConnectionFactoryWithHttpInfo(msgVpnName, connectionFactoryName).getBody(); - } - - /** - * Delete a JNDI Connection Factory object. - * Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnJndiConnectionFactoryWithHttpInfo(String msgVpnName, String connectionFactoryName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'connectionFactoryName' is set - if (connectionFactoryName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'connectionFactoryName' when calling deleteMsgVpnJndiConnectionFactory"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("connectionFactoryName", connectionFactoryName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a JNDI Queue object. - * Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnJndiQueue(String msgVpnName, String queueName) throws RestClientException { - return deleteMsgVpnJndiQueueWithHttpInfo(msgVpnName, queueName).getBody(); - } - - /** - * Delete a JNDI Queue object. - * Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnJndiQueueWithHttpInfo(String msgVpnName, String queueName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnJndiQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling deleteMsgVpnJndiQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues/{queueName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a JNDI Topic object. - * Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnJndiTopic(String msgVpnName, String topicName) throws RestClientException { - return deleteMsgVpnJndiTopicWithHttpInfo(msgVpnName, topicName).getBody(); - } - - /** - * Delete a JNDI Topic object. - * Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnJndiTopicWithHttpInfo(String msgVpnName, String topicName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnJndiTopic"); - } - - // verify the required parameter 'topicName' is set - if (topicName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicName' when calling deleteMsgVpnJndiTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicName", topicName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics/{topicName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an MQTT Retain Cache object. - * Delete an MQTT Retain Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnMqttRetainCache(String msgVpnName, String cacheName) throws RestClientException { - return deleteMsgVpnMqttRetainCacheWithHttpInfo(msgVpnName, cacheName).getBody(); - } - - /** - * Delete an MQTT Retain Cache object. - * Delete an MQTT Retain Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnMqttRetainCacheWithHttpInfo(String msgVpnName, String cacheName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling deleteMsgVpnMqttRetainCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an MQTT Session object. - * Delete an MQTT Session object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnMqttSession(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter) throws RestClientException { - return deleteMsgVpnMqttSessionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter).getBody(); - } - - /** - * Delete an MQTT Session object. - * Delete an MQTT Session object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnMqttSessionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling deleteMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling deleteMsgVpnMqttSession"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Subscription object. - * Delete a Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnMqttSessionSubscription(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic) throws RestClientException { - return deleteMsgVpnMqttSessionSubscriptionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic).getBody(); - } - - /** - * Delete a Subscription object. - * Delete a Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnMqttSessionSubscriptionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling deleteMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling deleteMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling deleteMsgVpnMqttSessionSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Queue object. - * Delete a Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnQueue(String msgVpnName, String queueName) throws RestClientException { - return deleteMsgVpnQueueWithHttpInfo(msgVpnName, queueName).getBody(); - } - - /** - * Delete a Queue object. - * Delete a Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnQueueWithHttpInfo(String msgVpnName, String queueName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling deleteMsgVpnQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Queue Subscription object. - * Delete a Queue Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param subscriptionTopic The topic of the Subscription. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnQueueSubscription(String msgVpnName, String queueName, String subscriptionTopic) throws RestClientException { - return deleteMsgVpnQueueSubscriptionWithHttpInfo(msgVpnName, queueName, subscriptionTopic).getBody(); - } - - /** - * Delete a Queue Subscription object. - * Delete a Queue Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param subscriptionTopic The topic of the Subscription. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnQueueSubscriptionWithHttpInfo(String msgVpnName, String queueName, String subscriptionTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnQueueSubscription"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling deleteMsgVpnQueueSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling deleteMsgVpnQueueSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Queue Template object. - * Delete a Queue Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnQueueTemplate(String msgVpnName, String queueTemplateName) throws RestClientException { - return deleteMsgVpnQueueTemplateWithHttpInfo(msgVpnName, queueTemplateName).getBody(); - } - - /** - * Delete a Queue Template object. - * Delete a Queue Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnQueueTemplateWithHttpInfo(String msgVpnName, String queueTemplateName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnQueueTemplate"); - } - - // verify the required parameter 'queueTemplateName' is set - if (queueTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueTemplateName' when calling deleteMsgVpnQueueTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueTemplateName", queueTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Replay Log object. - * Delete a Replay Log object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnReplayLog(String msgVpnName, String replayLogName) throws RestClientException { - return deleteMsgVpnReplayLogWithHttpInfo(msgVpnName, replayLogName).getBody(); - } - - /** - * Delete a Replay Log object. - * Delete a Replay Log object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnReplayLogWithHttpInfo(String msgVpnName, String replayLogName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnReplayLog"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling deleteMsgVpnReplayLog"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Topic Filter Subscription object. - * Delete a Topic Filter Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param topicFilterSubscription The topic of the Subscription. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnReplayLogTopicFilterSubscription(String msgVpnName, String replayLogName, String topicFilterSubscription) throws RestClientException { - return deleteMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(msgVpnName, replayLogName, topicFilterSubscription).getBody(); - } - - /** - * Delete a Topic Filter Subscription object. - * Delete a Topic Filter Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param topicFilterSubscription The topic of the Subscription. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(String msgVpnName, String replayLogName, String topicFilterSubscription) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling deleteMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'topicFilterSubscription' is set - if (topicFilterSubscription == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicFilterSubscription' when calling deleteMsgVpnReplayLogTopicFilterSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - uriVariables.put("topicFilterSubscription", topicFilterSubscription); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Replicated Topic object. - * Delete a Replicated Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnReplicatedTopic(String msgVpnName, String replicatedTopic) throws RestClientException { - return deleteMsgVpnReplicatedTopicWithHttpInfo(msgVpnName, replicatedTopic).getBody(); - } - - /** - * Delete a Replicated Topic object. - * Delete a Replicated Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnReplicatedTopicWithHttpInfo(String msgVpnName, String replicatedTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'replicatedTopic' is set - if (replicatedTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replicatedTopic' when calling deleteMsgVpnReplicatedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replicatedTopic", replicatedTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a REST Delivery Point object. - * Delete a REST Delivery Point object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPoint(String msgVpnName, String restDeliveryPointName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointWithHttpInfo(msgVpnName, restDeliveryPointName).getBody(); - } - - /** - * Delete a REST Delivery Point object. - * Delete a REST Delivery Point object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnRestDeliveryPointWithHttpInfo(String msgVpnName, String restDeliveryPointName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Queue Binding object. - * Delete a Queue Binding object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointQueueBinding(String msgVpnName, String restDeliveryPointName, String queueBindingName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName).getBody(); - } - - /** - * Delete a Queue Binding object. - * Delete a Queue Binding object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling deleteMsgVpnRestDeliveryPointQueueBinding"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Request Header object. - * Delete a Request Header object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, headerName).getBody(); - } - - /** - * Delete a Request Header object. - * Delete a Request Header object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'headerName' is set - if (headerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'headerName' when calling deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - uriVariables.put("headerName", headerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a REST Consumer object. - * Delete a REST Consumer object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumer(String msgVpnName, String restDeliveryPointName, String restConsumerName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName).getBody(); - } - - /** - * Delete a REST Consumer object. - * Delete a REST Consumer object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling deleteMsgVpnRestDeliveryPointRestConsumer"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Claim object. - * Delete a Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param oauthJwtClaimName The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(String msgVpnName, String restDeliveryPointName, String restConsumerName, String oauthJwtClaimName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName).getBody(); - } - - /** - * Delete a Claim object. - * Delete a Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param oauthJwtClaimName The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String oauthJwtClaimName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'oauthJwtClaimName' is set - if (oauthJwtClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthJwtClaimName' when calling deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - uriVariables.put("oauthJwtClaimName", oauthJwtClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Trusted Common Name object. - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(String msgVpnName, String restDeliveryPointName, String restConsumerName, String tlsTrustedCommonName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName).getBody(); - } - - /** - * Delete a Trusted Common Name object. - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String tlsTrustedCommonName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'tlsTrustedCommonName' is set - if (tlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'tlsTrustedCommonName' when calling deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - uriVariables.put("tlsTrustedCommonName", tlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Sequenced Topic object. - * Delete a Sequenced Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param sequencedTopic Topic for applying sequence numbers. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnSequencedTopic(String msgVpnName, String sequencedTopic) throws RestClientException { - return deleteMsgVpnSequencedTopicWithHttpInfo(msgVpnName, sequencedTopic).getBody(); - } - - /** - * Delete a Sequenced Topic object. - * Delete a Sequenced Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param sequencedTopic Topic for applying sequence numbers. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnSequencedTopicWithHttpInfo(String msgVpnName, String sequencedTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnSequencedTopic"); - } - - // verify the required parameter 'sequencedTopic' is set - if (sequencedTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'sequencedTopic' when calling deleteMsgVpnSequencedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("sequencedTopic", sequencedTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Topic Endpoint object. - * Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnTopicEndpoint(String msgVpnName, String topicEndpointName) throws RestClientException { - return deleteMsgVpnTopicEndpointWithHttpInfo(msgVpnName, topicEndpointName).getBody(); - } - - /** - * Delete a Topic Endpoint object. - * Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnTopicEndpointWithHttpInfo(String msgVpnName, String topicEndpointName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'topicEndpointName' is set - if (topicEndpointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointName' when calling deleteMsgVpnTopicEndpoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointName", topicEndpointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Topic Endpoint Template object. - * Delete a Topic Endpoint Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnTopicEndpointTemplate(String msgVpnName, String topicEndpointTemplateName) throws RestClientException { - return deleteMsgVpnTopicEndpointTemplateWithHttpInfo(msgVpnName, topicEndpointTemplateName).getBody(); - } - - /** - * Delete a Topic Endpoint Template object. - * Delete a Topic Endpoint Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnTopicEndpointTemplateWithHttpInfo(String msgVpnName, String topicEndpointTemplateName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'topicEndpointTemplateName' is set - if (topicEndpointTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointTemplateName' when calling deleteMsgVpnTopicEndpointTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointTemplateName", topicEndpointTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Message VPN object. - * Get a Message VPN object. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| distributedCacheManagementEnabled|||x| msgVpnName|x||| replicationBridgeAuthenticationBasicPassword||x||x replicationBridgeAuthenticationClientCertContent||x||x replicationBridgeAuthenticationClientCertPassword||x|| replicationEnabledQueueBehavior||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Message VPN object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnResponse getMsgVpn(String msgVpnName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnWithHttpInfo(msgVpnName, opaquePassword, select).getBody(); - } - - /** - * Get a Message VPN object. - * Get a Message VPN object. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| distributedCacheManagementEnabled|||x| msgVpnName|x||| replicationBridgeAuthenticationBasicPassword||x||x replicationBridgeAuthenticationClientCertContent||x||x replicationBridgeAuthenticationClientCertPassword||x|| replicationEnabledQueueBehavior||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Message VPN object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnWithHttpInfo(String msgVpnName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an ACL Profile object. - * Get an ACL Profile object. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileResponse getMsgVpnAclProfile(String msgVpnName, String aclProfileName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfileWithHttpInfo(msgVpnName, aclProfileName, opaquePassword, select).getBody(); - } - - /** - * Get an ACL Profile object. - * Get an ACL Profile object. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileWithHttpInfo(String msgVpnName, String aclProfileName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfile"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Client Connect Exception object. - * Get a Client Connect Exception object. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Connect Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param clientConnectExceptionAddress The IP address/netmask of the client connect exception in CIDR form. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileClientConnectExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileClientConnectExceptionResponse getMsgVpnAclProfileClientConnectException(String msgVpnName, String aclProfileName, String clientConnectExceptionAddress, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfileClientConnectExceptionWithHttpInfo(msgVpnName, aclProfileName, clientConnectExceptionAddress, opaquePassword, select).getBody(); - } - - /** - * Get a Client Connect Exception object. - * Get a Client Connect Exception object. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Connect Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param clientConnectExceptionAddress The IP address/netmask of the client connect exception in CIDR form. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileClientConnectExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileClientConnectExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String clientConnectExceptionAddress, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileClientConnectException"); - } - - // verify the required parameter 'clientConnectExceptionAddress' is set - if (clientConnectExceptionAddress == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientConnectExceptionAddress' when calling getMsgVpnAclProfileClientConnectException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("clientConnectExceptionAddress", clientConnectExceptionAddress); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Client Connect Exception objects. - * Get a list of Client Connect Exception objects. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Connect Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileClientConnectExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileClientConnectExceptionsResponse getMsgVpnAclProfileClientConnectExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfileClientConnectExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Client Connect Exception objects. - * Get a list of Client Connect Exception objects. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Connect Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileClientConnectExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileClientConnectExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileClientConnectExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileClientConnectExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Publish Topic Exception object. - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The Publish Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfilePublishExceptionResponse getMsgVpnAclProfilePublishException(String msgVpnName, String aclProfileName, String topicSyntax, String publishExceptionTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfilePublishExceptionWithHttpInfo(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Publish Topic Exception object. - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The Publish Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAclProfilePublishExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String topicSyntax, String publishExceptionTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'topicSyntax' is set - if (topicSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicSyntax' when calling getMsgVpnAclProfilePublishException"); - } - - // verify the required parameter 'publishExceptionTopic' is set - if (publishExceptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishExceptionTopic' when calling getMsgVpnAclProfilePublishException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("topicSyntax", topicSyntax); - uriVariables.put("publishExceptionTopic", publishExceptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Publish Topic Exception objects. - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The list of Publish Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfilePublishExceptionsResponse getMsgVpnAclProfilePublishExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfilePublishExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Publish Topic Exception objects. - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - *

200 - The list of Publish Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAclProfilePublishExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfilePublishExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfilePublishExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Publish Topic Exception object. - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Publish Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param publishTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishTopicExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfilePublishTopicExceptionResponse getMsgVpnAclProfilePublishTopicException(String msgVpnName, String aclProfileName, String publishTopicExceptionSyntax, String publishTopicException, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException, opaquePassword, select).getBody(); - } - - /** - * Get a Publish Topic Exception object. - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Publish Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param publishTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param publishTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishTopicExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfilePublishTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String publishTopicExceptionSyntax, String publishTopicException, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'publishTopicExceptionSyntax' is set - if (publishTopicExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishTopicExceptionSyntax' when calling getMsgVpnAclProfilePublishTopicException"); - } - - // verify the required parameter 'publishTopicException' is set - if (publishTopicException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'publishTopicException' when calling getMsgVpnAclProfilePublishTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("publishTopicExceptionSyntax", publishTopicExceptionSyntax); - uriVariables.put("publishTopicException", publishTopicException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Publish Topic Exception objects. - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Publish Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilePublishTopicExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfilePublishTopicExceptionsResponse getMsgVpnAclProfilePublishTopicExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfilePublishTopicExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Publish Topic Exception objects. - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Publish Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilePublishTopicExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfilePublishTopicExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfilePublishTopicExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfilePublishTopicExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Subscribe Topic Exception object. - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The Subscribe Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfileSubscribeExceptionResponse getMsgVpnAclProfileSubscribeException(String msgVpnName, String aclProfileName, String topicSyntax, String subscribeExceptionTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeExceptionWithHttpInfo(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Subscribe Topic Exception object. - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The Subscribe Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param topicSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeExceptionTopic The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAclProfileSubscribeExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String topicSyntax, String subscribeExceptionTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'topicSyntax' is set - if (topicSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicSyntax' when calling getMsgVpnAclProfileSubscribeException"); - } - - // verify the required parameter 'subscribeExceptionTopic' is set - if (subscribeExceptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeExceptionTopic' when calling getMsgVpnAclProfileSubscribeException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("topicSyntax", topicSyntax); - uriVariables.put("subscribeExceptionTopic", subscribeExceptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Subscribe Topic Exception objects. - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The list of Subscribe Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAclProfileSubscribeExceptionsResponse getMsgVpnAclProfileSubscribeExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Subscribe Topic Exception objects. - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - *

200 - The list of Subscribe Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAclProfileSubscribeExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Subscribe Share Name Exception object. - * Get a Subscribe Share Name Exception object. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Share Name Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeShareNameExceptionSyntax The syntax of the subscribe share name for the exception to the default action taken. (required) - * @param subscribeShareNameException The subscribe share name exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeShareNameExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeShareNameExceptionResponse getMsgVpnAclProfileSubscribeShareNameException(String msgVpnName, String aclProfileName, String subscribeShareNameExceptionSyntax, String subscribeShareNameException, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException, opaquePassword, select).getBody(); - } - - /** - * Get a Subscribe Share Name Exception object. - * Get a Subscribe Share Name Exception object. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Share Name Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeShareNameExceptionSyntax The syntax of the subscribe share name for the exception to the default action taken. (required) - * @param subscribeShareNameException The subscribe share name exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeShareNameExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileSubscribeShareNameExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String subscribeShareNameExceptionSyntax, String subscribeShareNameException, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'subscribeShareNameExceptionSyntax' is set - if (subscribeShareNameExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeShareNameExceptionSyntax' when calling getMsgVpnAclProfileSubscribeShareNameException"); - } - - // verify the required parameter 'subscribeShareNameException' is set - if (subscribeShareNameException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeShareNameException' when calling getMsgVpnAclProfileSubscribeShareNameException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("subscribeShareNameExceptionSyntax", subscribeShareNameExceptionSyntax); - uriVariables.put("subscribeShareNameException", subscribeShareNameException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Subscribe Share Name Exception objects. - * Get a list of Subscribe Share Name Exception objects. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Subscribe Share Name Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeShareNameExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeShareNameExceptionsResponse getMsgVpnAclProfileSubscribeShareNameExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeShareNameExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Subscribe Share Name Exception objects. - * Get a list of Subscribe Share Name Exception objects. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Subscribe Share Name Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeShareNameExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileSubscribeShareNameExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeShareNameExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeShareNameExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Subscribe Topic Exception object. - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeTopicExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeTopicExceptionResponse getMsgVpnAclProfileSubscribeTopicException(String msgVpnName, String aclProfileName, String subscribeTopicExceptionSyntax, String subscribeTopicException, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException, opaquePassword, select).getBody(); - } - - /** - * Get a Subscribe Topic Exception object. - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Subscribe Topic Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param subscribeTopicExceptionSyntax The syntax of the topic for the exception to the default action taken. (required) - * @param subscribeTopicException The topic for the exception to the default action taken. May include wildcard characters. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeTopicExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileSubscribeTopicExceptionWithHttpInfo(String msgVpnName, String aclProfileName, String subscribeTopicExceptionSyntax, String subscribeTopicException, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'subscribeTopicExceptionSyntax' is set - if (subscribeTopicExceptionSyntax == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeTopicExceptionSyntax' when calling getMsgVpnAclProfileSubscribeTopicException"); - } - - // verify the required parameter 'subscribeTopicException' is set - if (subscribeTopicException == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscribeTopicException' when calling getMsgVpnAclProfileSubscribeTopicException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - uriVariables.put("subscribeTopicExceptionSyntax", subscribeTopicExceptionSyntax); - uriVariables.put("subscribeTopicException", subscribeTopicException); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Subscribe Topic Exception objects. - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Subscribe Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileSubscribeTopicExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileSubscribeTopicExceptionsResponse getMsgVpnAclProfileSubscribeTopicExceptions(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfileSubscribeTopicExceptionsWithHttpInfo(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Subscribe Topic Exception objects. - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Subscribe Topic Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileSubscribeTopicExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfileSubscribeTopicExceptionsWithHttpInfo(String msgVpnName, String aclProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfileSubscribeTopicExceptions"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling getMsgVpnAclProfileSubscribeTopicExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of ACL Profile objects. - * Get a list of ACL Profile objects. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of ACL Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfilesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfilesResponse getMsgVpnAclProfiles(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAclProfilesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of ACL Profile objects. - * Get a list of ACL Profile objects. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of ACL Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfilesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAclProfilesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAclProfiles"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an OAuth Profile object. - * Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResponse getMsgVpnAuthenticationOauthProfile(String msgVpnName, String oauthProfileName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfileWithHttpInfo(msgVpnName, oauthProfileName, opaquePassword, select).getBody(); - } - - /** - * Get an OAuth Profile object. - * Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfileWithHttpInfo(String msgVpnName, String oauthProfileName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getMsgVpnAuthenticationOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse getMsgVpnAuthenticationOauthProfileClientRequiredClaim(String msgVpnName, String oauthProfileName, String clientRequiredClaimName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, clientRequiredClaimName, opaquePassword, select).getBody(); - } - - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfileClientRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, String clientRequiredClaimName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'clientRequiredClaimName' is set - if (clientRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientRequiredClaimName' when calling getMsgVpnAuthenticationOauthProfileClientRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("clientRequiredClaimName", clientRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse getMsgVpnAuthenticationOauthProfileClientRequiredClaims(String msgVpnName, String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfileClientRequiredClaimsWithHttpInfo(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfileClientRequiredClaimsWithHttpInfo(String msgVpnName, String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfileClientRequiredClaims"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getMsgVpnAuthenticationOauthProfileClientRequiredClaims"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(String msgVpnName, String oauthProfileName, String resourceServerRequiredClaimName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(msgVpnName, oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select).getBody(); - } - - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimWithHttpInfo(String msgVpnName, String oauthProfileName, String resourceServerRequiredClaimName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'resourceServerRequiredClaimName' is set - if (resourceServerRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'resourceServerRequiredClaimName' when calling getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("resourceServerRequiredClaimName", resourceServerRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims(String msgVpnName, String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsWithHttpInfo(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsWithHttpInfo(String msgVpnName, String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of OAuth Profile objects. - * Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of OAuth Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfilesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfilesResponse getMsgVpnAuthenticationOauthProfiles(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProfilesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of OAuth Profile objects. - * Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - *

200 - The list of OAuth Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfilesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthenticationOauthProfilesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProfiles"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an OAuth Provider object. - * Get an OAuth Provider object. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProviderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAuthenticationOauthProviderResponse getMsgVpnAuthenticationOauthProvider(String msgVpnName, String oauthProviderName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProviderWithHttpInfo(msgVpnName, oauthProviderName, opaquePassword, select).getBody(); - } - - /** - * Get an OAuth Provider object. - * Get an OAuth Provider object. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProviderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAuthenticationOauthProviderWithHttpInfo(String msgVpnName, String oauthProviderName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'oauthProviderName' is set - if (oauthProviderName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProviderName' when calling getMsgVpnAuthenticationOauthProvider"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProviderName", oauthProviderName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of OAuth Provider objects. - * Get a list of OAuth Provider objects. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The list of OAuth Provider objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProvidersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAuthenticationOauthProvidersResponse getMsgVpnAuthenticationOauthProviders(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAuthenticationOauthProvidersWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of OAuth Provider objects. - * Get a list of OAuth Provider objects. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The list of OAuth Provider objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProvidersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnAuthenticationOauthProvidersWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthenticationOauthProviders"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an Authorization Group object. - * Get an Authorization Group object. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthorizationGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthorizationGroupResponse getMsgVpnAuthorizationGroup(String msgVpnName, String authorizationGroupName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnAuthorizationGroupWithHttpInfo(msgVpnName, authorizationGroupName, opaquePassword, select).getBody(); - } - - /** - * Get an Authorization Group object. - * Get an Authorization Group object. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthorizationGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthorizationGroupWithHttpInfo(String msgVpnName, String authorizationGroupName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'authorizationGroupName' is set - if (authorizationGroupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationGroupName' when calling getMsgVpnAuthorizationGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("authorizationGroupName", authorizationGroupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Authorization Group objects. - * Get a list of Authorization Group objects. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Authorization Group objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthorizationGroupsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthorizationGroupsResponse getMsgVpnAuthorizationGroups(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnAuthorizationGroupsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Authorization Group objects. - * Get a list of Authorization Group objects. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Authorization Group objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthorizationGroupsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnAuthorizationGroupsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnAuthorizationGroups"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Bridge object. - * Get a Bridge object. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeResponse getMsgVpnBridge(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List select) throws RestClientException { - return getMsgVpnBridgeWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, select).getBody(); - } - - /** - * Get a Bridge object. - * Get a Bridge object. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgeWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridge"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridge"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Remote Message VPN object. - * Get a Remote Message VPN object. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteMsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteMsgVpnResponse getMsgVpnBridgeRemoteMsgVpn(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, String opaquePassword, List select) throws RestClientException { - return getMsgVpnBridgeRemoteMsgVpnWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, opaquePassword, select).getBody(); - } - - /** - * Get a Remote Message VPN object. - * Get a Remote Message VPN object. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteMsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgeRemoteMsgVpnWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnName' is set - if (remoteMsgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnName' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnLocation' is set - if (remoteMsgVpnLocation == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnLocation' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnInterface' is set - if (remoteMsgVpnInterface == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnInterface' when calling getMsgVpnBridgeRemoteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteMsgVpnName", remoteMsgVpnName); - uriVariables.put("remoteMsgVpnLocation", remoteMsgVpnLocation); - uriVariables.put("remoteMsgVpnInterface", remoteMsgVpnInterface); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Remote Message VPN objects. - * Get a list of Remote Message VPN objects. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Remote Message VPN objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteMsgVpnsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteMsgVpnsResponse getMsgVpnBridgeRemoteMsgVpns(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnBridgeRemoteMsgVpnsWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Remote Message VPN objects. - * Get a list of Remote Message VPN objects. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Remote Message VPN objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteMsgVpnsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgeRemoteMsgVpnsWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeRemoteMsgVpns"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeRemoteMsgVpns"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeRemoteMsgVpns"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Remote Subscription object. - * Get a Remote Subscription object. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteSubscriptionTopic The topic of the Bridge remote subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteSubscriptionResponse getMsgVpnBridgeRemoteSubscription(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteSubscriptionTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnBridgeRemoteSubscriptionWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Remote Subscription object. - * Get a Remote Subscription object. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteSubscriptionTopic The topic of the Bridge remote subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgeRemoteSubscriptionWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteSubscriptionTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeRemoteSubscription"); - } - - // verify the required parameter 'remoteSubscriptionTopic' is set - if (remoteSubscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteSubscriptionTopic' when calling getMsgVpnBridgeRemoteSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteSubscriptionTopic", remoteSubscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Remote Subscription objects. - * Get a list of Remote Subscription objects. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Remote Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteSubscriptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteSubscriptionsResponse getMsgVpnBridgeRemoteSubscriptions(String msgVpnName, String bridgeName, String bridgeVirtualRouter, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnBridgeRemoteSubscriptionsWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Remote Subscription objects. - * Get a list of Remote Subscription objects. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Remote Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteSubscriptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgeRemoteSubscriptionsWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeRemoteSubscriptions"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeRemoteSubscriptions"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeRemoteSubscriptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Trusted Common Name object. - * Get a Trusted Common Name object. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnBridgeTlsTrustedCommonNameResponse getMsgVpnBridgeTlsTrustedCommonName(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String tlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName, opaquePassword, select).getBody(); - } - - /** - * Get a Trusted Common Name object. - * Get a Trusted Common Name object. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnBridgeTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String tlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeTlsTrustedCommonName"); - } - - // verify the required parameter 'tlsTrustedCommonName' is set - if (tlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'tlsTrustedCommonName' when calling getMsgVpnBridgeTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("tlsTrustedCommonName", tlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Trusted Common Name objects. - * Get a list of Trusted Common Name objects. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The list of Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeTlsTrustedCommonNamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnBridgeTlsTrustedCommonNamesResponse getMsgVpnBridgeTlsTrustedCommonNames(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnBridgeTlsTrustedCommonNamesWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Trusted Common Name objects. - * Get a list of Trusted Common Name objects. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The list of Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeTlsTrustedCommonNamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnBridgeTlsTrustedCommonNamesWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridgeTlsTrustedCommonNames"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling getMsgVpnBridgeTlsTrustedCommonNames"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling getMsgVpnBridgeTlsTrustedCommonNames"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Bridge objects. - * Get a list of Bridge objects. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Bridge objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgesResponse getMsgVpnBridges(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnBridgesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Bridge objects. - * Get a list of Bridge objects. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Bridge objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnBridgesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnBridges"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Matching Rule object. - * Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleResponse getMsgVpnCertMatchingRule(String msgVpnName, String ruleName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnCertMatchingRuleWithHttpInfo(msgVpnName, ruleName, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Matching Rule object. - * Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRuleWithHttpInfo(String msgVpnName, String ruleName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getMsgVpnCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Matching Rule Attribute Filter object. - * Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleAttributeFilterResponse getMsgVpnCertMatchingRuleAttributeFilter(String msgVpnName, String ruleName, String filterName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(msgVpnName, ruleName, filterName, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Matching Rule Attribute Filter object. - * Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(String msgVpnName, String ruleName, String filterName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling getMsgVpnCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Matching Rule Attribute Filter objects. - * Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleAttributeFiltersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleAttributeFiltersResponse getMsgVpnCertMatchingRuleAttributeFilters(String msgVpnName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnCertMatchingRuleAttributeFiltersWithHttpInfo(msgVpnName, ruleName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Matching Rule Attribute Filter objects. - * Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - *

200 - The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleAttributeFiltersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRuleAttributeFiltersWithHttpInfo(String msgVpnName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRuleAttributeFilters"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getMsgVpnCertMatchingRuleAttributeFilters"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Certificate Matching Rule Condition object. - * Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule Condition object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleConditionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleConditionResponse getMsgVpnCertMatchingRuleCondition(String msgVpnName, String ruleName, String source, String opaquePassword, List select) throws RestClientException { - return getMsgVpnCertMatchingRuleConditionWithHttpInfo(msgVpnName, ruleName, source, opaquePassword, select).getBody(); - } - - /** - * Get a Certificate Matching Rule Condition object. - * Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule Condition object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param source Certificate field to be compared with the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleConditionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRuleConditionWithHttpInfo(String msgVpnName, String ruleName, String source, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getMsgVpnCertMatchingRuleCondition"); - } - - // verify the required parameter 'source' is set - if (source == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'source' when calling getMsgVpnCertMatchingRuleCondition"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("source", source); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Matching Rule Condition objects. - * Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Certificate Matching Rule Condition objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleConditionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleConditionsResponse getMsgVpnCertMatchingRuleConditions(String msgVpnName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnCertMatchingRuleConditionsWithHttpInfo(msgVpnName, ruleName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Matching Rule Condition objects. - * Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Certificate Matching Rule Condition objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleConditionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRuleConditionsWithHttpInfo(String msgVpnName, String ruleName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRuleConditions"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling getMsgVpnCertMatchingRuleConditions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Certificate Matching Rule objects. - * Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Certificate Matching Rule objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRulesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRulesResponse getMsgVpnCertMatchingRules(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnCertMatchingRulesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Certificate Matching Rule objects. - * Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Certificate Matching Rule objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRulesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnCertMatchingRulesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnCertMatchingRules"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Client Profile object. - * Get a Client Profile object. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientProfileResponse getMsgVpnClientProfile(String msgVpnName, String clientProfileName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnClientProfileWithHttpInfo(msgVpnName, clientProfileName, opaquePassword, select).getBody(); - } - - /** - * Get a Client Profile object. - * Get a Client Profile object. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientProfileWithHttpInfo(String msgVpnName, String clientProfileName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientProfile"); - } - - // verify the required parameter 'clientProfileName' is set - if (clientProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientProfileName' when calling getMsgVpnClientProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientProfileName", clientProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Client Profile objects. - * Get a list of Client Profile objects. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientProfilesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientProfilesResponse getMsgVpnClientProfiles(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnClientProfilesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Client Profile objects. - * Get a list of Client Profile objects. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientProfilesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientProfilesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientProfiles"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Client Username object. - * Get a Client Username object. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameResponse getMsgVpnClientUsername(String msgVpnName, String clientUsername, String opaquePassword, List select) throws RestClientException { - return getMsgVpnClientUsernameWithHttpInfo(msgVpnName, clientUsername, opaquePassword, select).getBody(); - } - - /** - * Get a Client Username object. - * Get a Client Username object. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientUsernameWithHttpInfo(String msgVpnName, String clientUsername, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientUsername"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling getMsgVpnClientUsername"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Client Username Attribute object. - * Get a Client Username Attribute object. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Client Username Attribute object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameAttributeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameAttributeResponse getMsgVpnClientUsernameAttribute(String msgVpnName, String clientUsername, String attributeName, String attributeValue, String opaquePassword, List select) throws RestClientException { - return getMsgVpnClientUsernameAttributeWithHttpInfo(msgVpnName, clientUsername, attributeName, attributeValue, opaquePassword, select).getBody(); - } - - /** - * Get a Client Username Attribute object. - * Get a Client Username Attribute object. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Client Username Attribute object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param attributeName The name of the Attribute. (required) - * @param attributeValue The value of the Attribute. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameAttributeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientUsernameAttributeWithHttpInfo(String msgVpnName, String clientUsername, String attributeName, String attributeValue, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling getMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'attributeName' is set - if (attributeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeName' when calling getMsgVpnClientUsernameAttribute"); - } - - // verify the required parameter 'attributeValue' is set - if (attributeValue == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'attributeValue' when calling getMsgVpnClientUsernameAttribute"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - uriVariables.put("attributeName", attributeName); - uriVariables.put("attributeValue", attributeValue); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Client Username Attribute objects. - * Get a list of Client Username Attribute objects. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Client Username Attribute objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameAttributesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameAttributesResponse getMsgVpnClientUsernameAttributes(String msgVpnName, String clientUsername, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnClientUsernameAttributesWithHttpInfo(msgVpnName, clientUsername, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Client Username Attribute objects. - * Get a list of Client Username Attribute objects. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Client Username Attribute objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameAttributesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientUsernameAttributesWithHttpInfo(String msgVpnName, String clientUsername, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientUsernameAttributes"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling getMsgVpnClientUsernameAttributes"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Client Username objects. - * Get a list of Client Username objects. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Username objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernamesResponse getMsgVpnClientUsernames(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnClientUsernamesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Client Username objects. - * Get a list of Client Username objects. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Client Username objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnClientUsernamesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnClientUsernames"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Distributed Cache object. - * Get a Distributed Cache object. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheResponse getMsgVpnDistributedCache(String msgVpnName, String cacheName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheWithHttpInfo(msgVpnName, cacheName, opaquePassword, select).getBody(); - } - - /** - * Get a Distributed Cache object. - * Get a Distributed Cache object. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheWithHttpInfo(String msgVpnName, String cacheName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Cache Cluster object. - * Get a Cache Cluster object. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterResponse getMsgVpnDistributedCacheCluster(String msgVpnName, String cacheName, String clusterName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterWithHttpInfo(msgVpnName, cacheName, clusterName, opaquePassword, select).getBody(); - } - - /** - * Get a Cache Cluster object. - * Get a Cache Cluster object. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Home Cache Cluster object. - * Get a Home Cache Cluster object. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Home Cache Cluster object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName, opaquePassword, select).getBody(); - } - - /** - * Get a Home Cache Cluster object. - * Get a Home Cache Cluster object. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Home Cache Cluster object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Topic Prefix object. - * Get a Topic Prefix object. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic Prefix object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param topicPrefix A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String topicPrefix, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix, opaquePassword, select).getBody(); - } - - /** - * Get a Topic Prefix object. - * Get a Topic Prefix object. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic Prefix object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param topicPrefix A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName, String topicPrefix, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // verify the required parameter 'topicPrefix' is set - if (topicPrefix == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicPrefix' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - uriVariables.put("topicPrefix", topicPrefix); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Topic Prefix objects. - * Get a list of Topic Prefix objects. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Topic Prefix objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes(String msgVpnName, String cacheName, String clusterName, String homeClusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesWithHttpInfo(msgVpnName, cacheName, clusterName, homeClusterName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Topic Prefix objects. - * Get a list of Topic Prefix objects. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Topic Prefix objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param homeClusterName The name of the remote Home Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String homeClusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes"); - } - - // verify the required parameter 'homeClusterName' is set - if (homeClusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'homeClusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("homeClusterName", homeClusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Home Cache Cluster objects. - * Get a list of Home Cache Cluster objects. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Home Cache Cluster objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterGlobalCachingHomeClustersWithHttpInfo(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Home Cache Cluster objects. - * Get a list of Home Cache Cluster objects. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Home Cache Cluster objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterGlobalCachingHomeClustersWithHttpInfo(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Cache Instance object. - * Get a Cache Instance object. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterInstanceResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterInstanceResponse getMsgVpnDistributedCacheClusterInstance(String msgVpnName, String cacheName, String clusterName, String instanceName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterInstanceWithHttpInfo(msgVpnName, cacheName, clusterName, instanceName, opaquePassword, select).getBody(); - } - - /** - * Get a Cache Instance object. - * Get a Cache Instance object. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterInstanceResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterInstanceWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String instanceName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'instanceName' is set - if (instanceName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'instanceName' when calling getMsgVpnDistributedCacheClusterInstance"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("instanceName", instanceName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Cache Instance objects. - * Get a list of Cache Instance objects. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Cache Instance objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterInstancesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterInstancesResponse getMsgVpnDistributedCacheClusterInstances(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterInstancesWithHttpInfo(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Cache Instance objects. - * Get a list of Cache Instance objects. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Cache Instance objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterInstancesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterInstancesWithHttpInfo(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterInstances"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterInstances"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterInstances"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Topic object. - * Get a Topic object. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param topic The value of the Topic in the form a/b/c. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterTopicResponse getMsgVpnDistributedCacheClusterTopic(String msgVpnName, String cacheName, String clusterName, String topic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterTopicWithHttpInfo(msgVpnName, cacheName, clusterName, topic, opaquePassword, select).getBody(); - } - - /** - * Get a Topic object. - * Get a Topic object. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param topic The value of the Topic in the form a/b/c. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterTopicWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String topic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterTopic"); - } - - // verify the required parameter 'topic' is set - if (topic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topic' when calling getMsgVpnDistributedCacheClusterTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("topic", topic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Topic objects. - * Get a list of Topic objects. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterTopicsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterTopicsResponse getMsgVpnDistributedCacheClusterTopics(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCacheClusterTopicsWithHttpInfo(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Topic objects. - * Get a list of Topic objects. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterTopicsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClusterTopicsWithHttpInfo(String msgVpnName, String cacheName, String clusterName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusterTopics"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusterTopics"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling getMsgVpnDistributedCacheClusterTopics"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Cache Cluster objects. - * Get a list of Cache Cluster objects. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Cache Cluster objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClustersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClustersResponse getMsgVpnDistributedCacheClusters(String msgVpnName, String cacheName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCacheClustersWithHttpInfo(msgVpnName, cacheName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Cache Cluster objects. - * Get a list of Cache Cluster objects. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Cache Cluster objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClustersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCacheClustersWithHttpInfo(String msgVpnName, String cacheName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCacheClusters"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnDistributedCacheClusters"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Distributed Cache objects. - * Get a list of Distributed Cache objects. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Distributed Cache objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCachesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCachesResponse getMsgVpnDistributedCaches(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDistributedCachesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Distributed Cache objects. - * Get a list of Distributed Cache objects. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of Distributed Cache objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCachesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDistributedCachesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDistributedCaches"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a DMR Bridge object. - * Get a DMR Bridge object. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDmrBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDmrBridgeResponse getMsgVpnDmrBridge(String msgVpnName, String remoteNodeName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnDmrBridgeWithHttpInfo(msgVpnName, remoteNodeName, opaquePassword, select).getBody(); - } - - /** - * Get a DMR Bridge object. - * Get a DMR Bridge object. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDmrBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDmrBridgeWithHttpInfo(String msgVpnName, String remoteNodeName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDmrBridge"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling getMsgVpnDmrBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of DMR Bridge objects. - * Get a list of DMR Bridge objects. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of DMR Bridge objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDmrBridgesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDmrBridgesResponse getMsgVpnDmrBridges(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnDmrBridgesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of DMR Bridge objects. - * Get a list of DMR Bridge objects. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of DMR Bridge objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDmrBridgesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnDmrBridgesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnDmrBridges"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of JNDI Connection Factory objects. - * Get a list of JNDI Connection Factory objects. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Connection Factory objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiConnectionFactoriesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiConnectionFactoriesResponse getMsgVpnJndiConnectionFactories(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnJndiConnectionFactoriesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of JNDI Connection Factory objects. - * Get a list of JNDI Connection Factory objects. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Connection Factory objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiConnectionFactoriesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiConnectionFactoriesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiConnectionFactories"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a JNDI Connection Factory object. - * Get a JNDI Connection Factory object. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiConnectionFactoryResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiConnectionFactoryResponse getMsgVpnJndiConnectionFactory(String msgVpnName, String connectionFactoryName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnJndiConnectionFactoryWithHttpInfo(msgVpnName, connectionFactoryName, opaquePassword, select).getBody(); - } - - /** - * Get a JNDI Connection Factory object. - * Get a JNDI Connection Factory object. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiConnectionFactoryResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiConnectionFactoryWithHttpInfo(String msgVpnName, String connectionFactoryName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'connectionFactoryName' is set - if (connectionFactoryName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'connectionFactoryName' when calling getMsgVpnJndiConnectionFactory"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("connectionFactoryName", connectionFactoryName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a JNDI Queue object. - * Get a JNDI Queue object. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiQueueResponse getMsgVpnJndiQueue(String msgVpnName, String queueName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnJndiQueueWithHttpInfo(msgVpnName, queueName, opaquePassword, select).getBody(); - } - - /** - * Get a JNDI Queue object. - * Get a JNDI Queue object. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiQueueWithHttpInfo(String msgVpnName, String queueName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling getMsgVpnJndiQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues/{queueName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of JNDI Queue objects. - * Get a list of JNDI Queue objects. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Queue objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiQueuesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiQueuesResponse getMsgVpnJndiQueues(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnJndiQueuesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of JNDI Queue objects. - * Get a list of JNDI Queue objects. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Queue objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiQueuesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiQueuesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiQueues"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a JNDI Topic object. - * Get a JNDI Topic object. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiTopicResponse getMsgVpnJndiTopic(String msgVpnName, String topicName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnJndiTopicWithHttpInfo(msgVpnName, topicName, opaquePassword, select).getBody(); - } - - /** - * Get a JNDI Topic object. - * Get a JNDI Topic object. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiTopicWithHttpInfo(String msgVpnName, String topicName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiTopic"); - } - - // verify the required parameter 'topicName' is set - if (topicName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicName' when calling getMsgVpnJndiTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicName", topicName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics/{topicName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of JNDI Topic objects. - * Get a list of JNDI Topic objects. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiTopicsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiTopicsResponse getMsgVpnJndiTopics(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnJndiTopicsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of JNDI Topic objects. - * Get a list of JNDI Topic objects. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - *

200 - The list of JNDI Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiTopicsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnJndiTopicsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnJndiTopics"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an MQTT Retain Cache object. - * Get an MQTT Retain Cache object. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttRetainCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttRetainCacheResponse getMsgVpnMqttRetainCache(String msgVpnName, String cacheName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnMqttRetainCacheWithHttpInfo(msgVpnName, cacheName, opaquePassword, select).getBody(); - } - - /** - * Get an MQTT Retain Cache object. - * Get an MQTT Retain Cache object. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttRetainCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttRetainCacheWithHttpInfo(String msgVpnName, String cacheName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling getMsgVpnMqttRetainCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of MQTT Retain Cache objects. - * Get a list of MQTT Retain Cache objects. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of MQTT Retain Cache objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttRetainCachesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttRetainCachesResponse getMsgVpnMqttRetainCaches(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnMqttRetainCachesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of MQTT Retain Cache objects. - * Get a list of MQTT Retain Cache objects. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - *

200 - The list of MQTT Retain Cache objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttRetainCachesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttRetainCachesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttRetainCaches"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an MQTT Session object. - * Get an MQTT Session object. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionResponse getMsgVpnMqttSession(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String opaquePassword, List select) throws RestClientException { - return getMsgVpnMqttSessionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, opaquePassword, select).getBody(); - } - - /** - * Get an MQTT Session object. - * Get an MQTT Session object. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttSessionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling getMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling getMsgVpnMqttSession"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Subscription object. - * Get a Subscription object. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionSubscriptionResponse getMsgVpnMqttSessionSubscription(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnMqttSessionSubscriptionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Subscription object. - * Get a Subscription object. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttSessionSubscriptionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling getMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling getMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling getMsgVpnMqttSessionSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Subscription objects. - * Get a list of Subscription objects. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionSubscriptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionSubscriptionsResponse getMsgVpnMqttSessionSubscriptions(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnMqttSessionSubscriptionsWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Subscription objects. - * Get a list of Subscription objects. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionSubscriptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttSessionSubscriptionsWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttSessionSubscriptions"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling getMsgVpnMqttSessionSubscriptions"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling getMsgVpnMqttSessionSubscriptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of MQTT Session objects. - * Get a list of MQTT Session objects. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of MQTT Session objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionsResponse getMsgVpnMqttSessions(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnMqttSessionsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of MQTT Session objects. - * Get a list of MQTT Session objects. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of MQTT Session objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnMqttSessionsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnMqttSessions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Queue object. - * Get a Queue object. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueResponse getMsgVpnQueue(String msgVpnName, String queueName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnQueueWithHttpInfo(msgVpnName, queueName, opaquePassword, select).getBody(); - } - - /** - * Get a Queue object. - * Get a Queue object. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueueWithHttpInfo(String msgVpnName, String queueName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling getMsgVpnQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Queue Subscription object. - * Get a Queue Subscription object. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param subscriptionTopic The topic of the Subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueSubscriptionResponse getMsgVpnQueueSubscription(String msgVpnName, String queueName, String subscriptionTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnQueueSubscriptionWithHttpInfo(msgVpnName, queueName, subscriptionTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Queue Subscription object. - * Get a Queue Subscription object. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param subscriptionTopic The topic of the Subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueueSubscriptionWithHttpInfo(String msgVpnName, String queueName, String subscriptionTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueueSubscription"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling getMsgVpnQueueSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling getMsgVpnQueueSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Queue Subscription objects. - * Get a list of Queue Subscription objects. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueSubscriptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueSubscriptionsResponse getMsgVpnQueueSubscriptions(String msgVpnName, String queueName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnQueueSubscriptionsWithHttpInfo(msgVpnName, queueName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Queue Subscription objects. - * Get a list of Queue Subscription objects. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueSubscriptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueueSubscriptionsWithHttpInfo(String msgVpnName, String queueName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueueSubscriptions"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling getMsgVpnQueueSubscriptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Queue Template object. - * Get a Queue Template object. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueTemplateResponse getMsgVpnQueueTemplate(String msgVpnName, String queueTemplateName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnQueueTemplateWithHttpInfo(msgVpnName, queueTemplateName, opaquePassword, select).getBody(); - } - - /** - * Get a Queue Template object. - * Get a Queue Template object. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueueTemplateWithHttpInfo(String msgVpnName, String queueTemplateName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueueTemplate"); - } - - // verify the required parameter 'queueTemplateName' is set - if (queueTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueTemplateName' when calling getMsgVpnQueueTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueTemplateName", queueTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Queue Template objects. - * Get a list of Queue Template objects. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Queue Template objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueTemplatesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueTemplatesResponse getMsgVpnQueueTemplates(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnQueueTemplatesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Queue Template objects. - * Get a list of Queue Template objects. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Queue Template objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueTemplatesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueueTemplatesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueueTemplates"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Queue objects. - * Get a list of Queue objects. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueuesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueuesResponse getMsgVpnQueues(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnQueuesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Queue objects. - * Get a list of Queue objects. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueuesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueuesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueues"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Replay Log object. - * Get a Replay Log object. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogResponse getMsgVpnReplayLog(String msgVpnName, String replayLogName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnReplayLogWithHttpInfo(msgVpnName, replayLogName, opaquePassword, select).getBody(); - } - - /** - * Get a Replay Log object. - * Get a Replay Log object. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplayLogWithHttpInfo(String msgVpnName, String replayLogName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplayLog"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling getMsgVpnReplayLog"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Topic Filter Subscription object. - * Get a Topic Filter Subscription object. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Topic Filter Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param topicFilterSubscription The topic of the Subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogTopicFilterSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogTopicFilterSubscriptionResponse getMsgVpnReplayLogTopicFilterSubscription(String msgVpnName, String replayLogName, String topicFilterSubscription, String opaquePassword, List select) throws RestClientException { - return getMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(msgVpnName, replayLogName, topicFilterSubscription, opaquePassword, select).getBody(); - } - - /** - * Get a Topic Filter Subscription object. - * Get a Topic Filter Subscription object. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Topic Filter Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param topicFilterSubscription The topic of the Subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogTopicFilterSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(String msgVpnName, String replayLogName, String topicFilterSubscription, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling getMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'topicFilterSubscription' is set - if (topicFilterSubscription == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicFilterSubscription' when calling getMsgVpnReplayLogTopicFilterSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - uriVariables.put("topicFilterSubscription", topicFilterSubscription); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Topic Filter Subscription objects. - * Get a list of Topic Filter Subscription objects. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Topic Filter Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogTopicFilterSubscriptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogTopicFilterSubscriptionsResponse getMsgVpnReplayLogTopicFilterSubscriptions(String msgVpnName, String replayLogName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnReplayLogTopicFilterSubscriptionsWithHttpInfo(msgVpnName, replayLogName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Topic Filter Subscription objects. - * Get a list of Topic Filter Subscription objects. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Topic Filter Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogTopicFilterSubscriptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplayLogTopicFilterSubscriptionsWithHttpInfo(String msgVpnName, String replayLogName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplayLogTopicFilterSubscriptions"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling getMsgVpnReplayLogTopicFilterSubscriptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Replay Log objects. - * Get a list of Replay Log objects. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - *

200 - The list of Replay Log objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogsResponse getMsgVpnReplayLogs(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnReplayLogsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Replay Log objects. - * Get a list of Replay Log objects. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - *

200 - The list of Replay Log objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplayLogsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplayLogs"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Replicated Topic object. - * Get a Replicated Topic object. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplicatedTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplicatedTopicResponse getMsgVpnReplicatedTopic(String msgVpnName, String replicatedTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnReplicatedTopicWithHttpInfo(msgVpnName, replicatedTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Replicated Topic object. - * Get a Replicated Topic object. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplicatedTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplicatedTopicWithHttpInfo(String msgVpnName, String replicatedTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'replicatedTopic' is set - if (replicatedTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replicatedTopic' when calling getMsgVpnReplicatedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replicatedTopic", replicatedTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Replicated Topic objects. - * Get a list of Replicated Topic objects. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Replicated Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplicatedTopicsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplicatedTopicsResponse getMsgVpnReplicatedTopics(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnReplicatedTopicsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Replicated Topic objects. - * Get a list of Replicated Topic objects. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Replicated Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplicatedTopicsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplicatedTopicsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplicatedTopics"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a REST Delivery Point object. - * Get a REST Delivery Point object. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointResponse getMsgVpnRestDeliveryPoint(String msgVpnName, String restDeliveryPointName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointWithHttpInfo(msgVpnName, restDeliveryPointName, opaquePassword, select).getBody(); - } - - /** - * Get a REST Delivery Point object. - * Get a REST Delivery Point object. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointWithHttpInfo(String msgVpnName, String restDeliveryPointName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Queue Binding object. - * Get a Queue Binding object. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingResponse getMsgVpnRestDeliveryPointQueueBinding(String msgVpnName, String restDeliveryPointName, String queueBindingName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, opaquePassword, select).getBody(); - } - - /** - * Get a Queue Binding object. - * Get a Queue Binding object. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling getMsgVpnRestDeliveryPointQueueBinding"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Request Header object. - * Get a Request Header object. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse getMsgVpnRestDeliveryPointQueueBindingRequestHeader(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, headerName, opaquePassword, select).getBody(); - } - - /** - * Get a Request Header object. - * Get a Request Header object. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'headerName' is set - if (headerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'headerName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - uriVariables.put("headerName", headerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Request Header objects. - * Get a list of Request Header objects. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - *

200 - The list of Request Header objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse getMsgVpnRestDeliveryPointQueueBindingRequestHeaders(String msgVpnName, String restDeliveryPointName, String queueBindingName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointQueueBindingRequestHeadersWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Request Header objects. - * Get a list of Request Header objects. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - *

200 - The list of Request Header objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointQueueBindingRequestHeadersWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeaders"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeaders"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeaders"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Queue Binding objects. - * Get a list of Queue Binding objects. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue Binding objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingsResponse getMsgVpnRestDeliveryPointQueueBindings(String msgVpnName, String restDeliveryPointName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointQueueBindingsWithHttpInfo(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Queue Binding objects. - * Get a list of Queue Binding objects. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue Binding objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointQueueBindingsWithHttpInfo(String msgVpnName, String restDeliveryPointName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointQueueBindings"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointQueueBindings"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a REST Consumer object. - * Get a REST Consumer object. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerResponse getMsgVpnRestDeliveryPointRestConsumer(String msgVpnName, String restDeliveryPointName, String restConsumerName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, select).getBody(); - } - - /** - * Get a REST Consumer object. - * Get a REST Consumer object. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling getMsgVpnRestDeliveryPointRestConsumer"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Claim object. - * Get a Claim object. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - *

200 - The Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param oauthJwtClaimName The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(String msgVpnName, String restDeliveryPointName, String restConsumerName, String oauthJwtClaimName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName, opaquePassword, select).getBody(); - } - - /** - * Get a Claim object. - * Get a Claim object. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - *

200 - The Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param oauthJwtClaimName The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String oauthJwtClaimName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'oauthJwtClaimName' is set - if (oauthJwtClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthJwtClaimName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - uriVariables.put("oauthJwtClaimName", oauthJwtClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Claim objects. - * Get a list of Claim objects. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - *

200 - The list of Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims(String msgVpnName, String restDeliveryPointName, String restConsumerName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Claim objects. - * Get a list of Claim objects. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - *

200 - The list of Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Trusted Common Name object. - * Get a Trusted Common Name object. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(String msgVpnName, String restDeliveryPointName, String restConsumerName, String tlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName, opaquePassword, select).getBody(); - } - - /** - * Get a Trusted Common Name object. - * Get a Trusted Common Name object. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String tlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'tlsTrustedCommonName' is set - if (tlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'tlsTrustedCommonName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - uriVariables.put("tlsTrustedCommonName", tlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Trusted Common Name objects. - * Get a list of Trusted Common Name objects. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The list of Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames(String msgVpnName, String restDeliveryPointName, String restConsumerName, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Trusted Common Name objects. - * Get a list of Trusted Common Name objects. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The list of Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of REST Consumer objects. - * Get a list of REST Consumer objects. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of REST Consumer objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumersResponse getMsgVpnRestDeliveryPointRestConsumers(String msgVpnName, String restDeliveryPointName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumersWithHttpInfo(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of REST Consumer objects. - * Get a list of REST Consumer objects. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of REST Consumer objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumersWithHttpInfo(String msgVpnName, String restDeliveryPointName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumers"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumers"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of REST Delivery Point objects. - * Get a list of REST Delivery Point objects. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of REST Delivery Point objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointsResponse getMsgVpnRestDeliveryPoints(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of REST Delivery Point objects. - * Get a list of REST Delivery Point objects. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of REST Delivery Point objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPoints"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Sequenced Topic object. - * Get a Sequenced Topic object. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| sequencedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Sequenced Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param sequencedTopic Topic for applying sequence numbers. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnSequencedTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnSequencedTopicResponse getMsgVpnSequencedTopic(String msgVpnName, String sequencedTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnSequencedTopicWithHttpInfo(msgVpnName, sequencedTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Sequenced Topic object. - * Get a Sequenced Topic object. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| sequencedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Sequenced Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param sequencedTopic Topic for applying sequence numbers. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnSequencedTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnSequencedTopicWithHttpInfo(String msgVpnName, String sequencedTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnSequencedTopic"); - } - - // verify the required parameter 'sequencedTopic' is set - if (sequencedTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'sequencedTopic' when calling getMsgVpnSequencedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("sequencedTopic", sequencedTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Sequenced Topic objects. - * Get a list of Sequenced Topic objects. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| sequencedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Sequenced Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnSequencedTopicsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnSequencedTopicsResponse getMsgVpnSequencedTopics(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnSequencedTopicsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Sequenced Topic objects. - * Get a list of Sequenced Topic objects. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| sequencedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Sequenced Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnSequencedTopicsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnSequencedTopicsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnSequencedTopics"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/sequencedTopics", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Topic Endpoint object. - * Get a Topic Endpoint object. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointResponse getMsgVpnTopicEndpoint(String msgVpnName, String topicEndpointName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnTopicEndpointWithHttpInfo(msgVpnName, topicEndpointName, opaquePassword, select).getBody(); - } - - /** - * Get a Topic Endpoint object. - * Get a Topic Endpoint object. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnTopicEndpointWithHttpInfo(String msgVpnName, String topicEndpointName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'topicEndpointName' is set - if (topicEndpointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointName' when calling getMsgVpnTopicEndpoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointName", topicEndpointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Topic Endpoint Template object. - * Get a Topic Endpoint Template object. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointTemplateResponse getMsgVpnTopicEndpointTemplate(String msgVpnName, String topicEndpointTemplateName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnTopicEndpointTemplateWithHttpInfo(msgVpnName, topicEndpointTemplateName, opaquePassword, select).getBody(); - } - - /** - * Get a Topic Endpoint Template object. - * Get a Topic Endpoint Template object. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnTopicEndpointTemplateWithHttpInfo(String msgVpnName, String topicEndpointTemplateName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'topicEndpointTemplateName' is set - if (topicEndpointTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointTemplateName' when calling getMsgVpnTopicEndpointTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointTemplateName", topicEndpointTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Topic Endpoint Template objects. - * Get a list of Topic Endpoint Template objects. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Topic Endpoint Template objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointTemplatesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointTemplatesResponse getMsgVpnTopicEndpointTemplates(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnTopicEndpointTemplatesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Topic Endpoint Template objects. - * Get a list of Topic Endpoint Template objects. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Topic Endpoint Template objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointTemplatesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnTopicEndpointTemplatesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnTopicEndpointTemplates"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Topic Endpoint objects. - * Get a list of Topic Endpoint objects. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Topic Endpoint objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointsResponse getMsgVpnTopicEndpoints(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnTopicEndpointsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Topic Endpoint objects. - * Get a list of Topic Endpoint objects. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Topic Endpoint objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnTopicEndpointsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnTopicEndpoints"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Message VPN objects. - * Get a list of Message VPN objects. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| distributedCacheManagementEnabled|||x| msgVpnName|x||| replicationBridgeAuthenticationBasicPassword||x||x replicationBridgeAuthenticationClientCertContent||x||x replicationBridgeAuthenticationClientCertPassword||x|| replicationEnabledQueueBehavior||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Message VPN objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnsResponse getMsgVpns(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnsWithHttpInfo(count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Message VPN objects. - * Get a list of Message VPN objects. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| distributedCacheManagementEnabled|||x| msgVpnName|x||| replicationBridgeAuthenticationBasicPassword||x||x replicationBridgeAuthenticationClientCertContent||x||x replicationBridgeAuthenticationClientCertPassword||x|| replicationEnabledQueueBehavior||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Message VPN objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnsWithHttpInfo(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Message VPN object. - * Replace a Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationOauthDefaultProviderName||||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled||||||x| distributedCacheManagementEnabled||||||x| msgVpnName|x||x|||| replicationBridgeAuthenticationBasicPassword||||x|||x replicationBridgeAuthenticationClientCertContent||||x|||x replicationBridgeAuthenticationClientCertPassword||||x||| replicationEnabledQueueBehavior||||x||| restTlsServerCertEnforceTrustedCommonNameEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: alias|global/read-write authenticationBasicEnabled|global/read-write authenticationBasicProfileName|global/read-write authenticationBasicRadiusDomain|global/read-write authenticationBasicType|global/read-write authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write authenticationClientCertCertificateMatchingRulesEnabled|global/read-write authenticationClientCertEnabled|global/read-write authenticationClientCertMaxChainDepth|global/read-write authenticationClientCertRevocationCheckMode|global/read-write authenticationClientCertUsernameSource|global/read-write authenticationClientCertValidateDateEnabled|global/read-write authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write authenticationKerberosEnabled|global/read-write authenticationOauthEnabled|global/read-write bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write bridgingTlsServerCertMaxChainDepth|global/read-write bridgingTlsServerCertValidateDateEnabled|global/read-write bridgingTlsServerCertValidateNameEnabled|global/read-write dmrEnabled|global/read-write exportSubscriptionsEnabled|global/read-write maxConnectionCount|global/read-write maxEgressFlowCount|global/read-write maxEndpointCount|global/read-write maxIngressFlowCount|global/read-write maxMsgSpoolUsage|global/read-write maxSubscriptionCount|global/read-write maxTransactedSessionCount|global/read-write maxTransactionCount|global/read-write mqttRetainMaxMemory|global/read-write replicationBridgeAuthenticationBasicClientUsername|global/read-write replicationBridgeAuthenticationBasicPassword|global/read-write replicationBridgeAuthenticationClientCertContent|global/read-write replicationBridgeAuthenticationClientCertPassword|global/read-write replicationBridgeAuthenticationScheme|global/read-write replicationBridgeCompressedDataEnabled|global/read-write replicationBridgeEgressFlowWindowSize|global/read-write replicationBridgeRetryDelay|global/read-write replicationBridgeTlsEnabled|global/read-write replicationBridgeUnidirectionalClientProfileName|global/read-write replicationEnabled|global/read-write replicationEnabledQueueBehavior|global/read-write replicationQueueMaxMsgSpoolUsage|global/read-write replicationRole|global/read-write restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write restTlsServerCertMaxChainDepth|global/read-write restTlsServerCertValidateDateEnabled|global/read-write restTlsServerCertValidateNameEnabled|global/read-write sempOverMsgBusAdminClientEnabled|global/read-write sempOverMsgBusAdminDistributedCacheEnabled|global/read-write sempOverMsgBusAdminEnabled|global/read-write sempOverMsgBusEnabled|global/read-write sempOverMsgBusShowEnabled|global/read-write serviceAmqpMaxConnectionCount|global/read-write serviceAmqpPlainTextListenPort|global/read-write serviceAmqpTlsListenPort|global/read-write serviceMqttMaxConnectionCount|global/read-write serviceMqttPlainTextListenPort|global/read-write serviceMqttTlsListenPort|global/read-write serviceMqttTlsWebSocketListenPort|global/read-write serviceMqttWebSocketListenPort|global/read-write serviceRestIncomingMaxConnectionCount|global/read-write serviceRestIncomingPlainTextListenPort|global/read-write serviceRestIncomingTlsListenPort|global/read-write serviceRestOutgoingMaxConnectionCount|global/read-write serviceSmfMaxConnectionCount|global/read-write serviceWebMaxConnectionCount|global/read-write This has been available since 2.0. - *

200 - The Message VPN object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnResponse replaceMsgVpn(String msgVpnName, MsgVpn body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Message VPN object. - * Replace a Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationOauthDefaultProviderName||||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled||||||x| distributedCacheManagementEnabled||||||x| msgVpnName|x||x|||| replicationBridgeAuthenticationBasicPassword||||x|||x replicationBridgeAuthenticationClientCertContent||||x|||x replicationBridgeAuthenticationClientCertPassword||||x||| replicationEnabledQueueBehavior||||x||| restTlsServerCertEnforceTrustedCommonNameEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: alias|global/read-write authenticationBasicEnabled|global/read-write authenticationBasicProfileName|global/read-write authenticationBasicRadiusDomain|global/read-write authenticationBasicType|global/read-write authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write authenticationClientCertCertificateMatchingRulesEnabled|global/read-write authenticationClientCertEnabled|global/read-write authenticationClientCertMaxChainDepth|global/read-write authenticationClientCertRevocationCheckMode|global/read-write authenticationClientCertUsernameSource|global/read-write authenticationClientCertValidateDateEnabled|global/read-write authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write authenticationKerberosEnabled|global/read-write authenticationOauthEnabled|global/read-write bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write bridgingTlsServerCertMaxChainDepth|global/read-write bridgingTlsServerCertValidateDateEnabled|global/read-write bridgingTlsServerCertValidateNameEnabled|global/read-write dmrEnabled|global/read-write exportSubscriptionsEnabled|global/read-write maxConnectionCount|global/read-write maxEgressFlowCount|global/read-write maxEndpointCount|global/read-write maxIngressFlowCount|global/read-write maxMsgSpoolUsage|global/read-write maxSubscriptionCount|global/read-write maxTransactedSessionCount|global/read-write maxTransactionCount|global/read-write mqttRetainMaxMemory|global/read-write replicationBridgeAuthenticationBasicClientUsername|global/read-write replicationBridgeAuthenticationBasicPassword|global/read-write replicationBridgeAuthenticationClientCertContent|global/read-write replicationBridgeAuthenticationClientCertPassword|global/read-write replicationBridgeAuthenticationScheme|global/read-write replicationBridgeCompressedDataEnabled|global/read-write replicationBridgeEgressFlowWindowSize|global/read-write replicationBridgeRetryDelay|global/read-write replicationBridgeTlsEnabled|global/read-write replicationBridgeUnidirectionalClientProfileName|global/read-write replicationEnabled|global/read-write replicationEnabledQueueBehavior|global/read-write replicationQueueMaxMsgSpoolUsage|global/read-write replicationRole|global/read-write restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write restTlsServerCertMaxChainDepth|global/read-write restTlsServerCertValidateDateEnabled|global/read-write restTlsServerCertValidateNameEnabled|global/read-write sempOverMsgBusAdminClientEnabled|global/read-write sempOverMsgBusAdminDistributedCacheEnabled|global/read-write sempOverMsgBusAdminEnabled|global/read-write sempOverMsgBusEnabled|global/read-write sempOverMsgBusShowEnabled|global/read-write serviceAmqpMaxConnectionCount|global/read-write serviceAmqpPlainTextListenPort|global/read-write serviceAmqpTlsListenPort|global/read-write serviceMqttMaxConnectionCount|global/read-write serviceMqttPlainTextListenPort|global/read-write serviceMqttTlsListenPort|global/read-write serviceMqttTlsWebSocketListenPort|global/read-write serviceMqttWebSocketListenPort|global/read-write serviceRestIncomingMaxConnectionCount|global/read-write serviceRestIncomingPlainTextListenPort|global/read-write serviceRestIncomingTlsListenPort|global/read-write serviceRestOutgoingMaxConnectionCount|global/read-write serviceSmfMaxConnectionCount|global/read-write serviceWebMaxConnectionCount|global/read-write This has been available since 2.0. - *

200 - The Message VPN object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnWithHttpInfo(String msgVpnName, MsgVpn body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpn"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an ACL Profile object. - * Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileResponse replaceMsgVpnAclProfile(String msgVpnName, String aclProfileName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnAclProfileWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an ACL Profile object. - * Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnAclProfileWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnAclProfile"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling replaceMsgVpnAclProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnAclProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an OAuth Profile object. - * Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResponse replaceMsgVpnAuthenticationOauthProfile(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnAuthenticationOauthProfileWithHttpInfo(msgVpnName, oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an OAuth Profile object. - * Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnAuthenticationOauthProfileWithHttpInfo(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling replaceMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnAuthenticationOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an OAuth Provider object. - * Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- audienceClaimName||||||x| audienceClaimSource||||||x| audienceClaimValue||||||x| audienceValidationEnabled||||||x| authorizationGroupClaimName||||||x| authorizationGroupClaimSource||||||x| authorizationGroupEnabled||||||x| disconnectOnTokenExpirationEnabled||||||x| enabled||||||x| jwksRefreshInterval||||||x| jwksUri||||||x| msgVpnName|x||x|||x| oauthProviderName|x||x|||x| tokenIgnoreTimeLimitsEnabled||||||x| tokenIntrospectionParameterName||||||x| tokenIntrospectionPassword||||x||x|x tokenIntrospectionTimeout||||||x| tokenIntrospectionUri||||||x| tokenIntrospectionUsername||||||x| usernameClaimName||||||x| usernameClaimSource||||||x| usernameValidateEnabled||||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProviderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAuthenticationOauthProviderResponse replaceMsgVpnAuthenticationOauthProvider(String msgVpnName, String oauthProviderName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnAuthenticationOauthProviderWithHttpInfo(msgVpnName, oauthProviderName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an OAuth Provider object. - * Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- audienceClaimName||||||x| audienceClaimSource||||||x| audienceClaimValue||||||x| audienceValidationEnabled||||||x| authorizationGroupClaimName||||||x| authorizationGroupClaimSource||||||x| authorizationGroupEnabled||||||x| disconnectOnTokenExpirationEnabled||||||x| enabled||||||x| jwksRefreshInterval||||||x| jwksUri||||||x| msgVpnName|x||x|||x| oauthProviderName|x||x|||x| tokenIgnoreTimeLimitsEnabled||||||x| tokenIntrospectionParameterName||||||x| tokenIntrospectionPassword||||x||x|x tokenIntrospectionTimeout||||||x| tokenIntrospectionUri||||||x| tokenIntrospectionUsername||||||x| usernameClaimName||||||x| usernameClaimSource||||||x| usernameValidateEnabled||||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProviderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity replaceMsgVpnAuthenticationOauthProviderWithHttpInfo(String msgVpnName, String oauthProviderName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'oauthProviderName' is set - if (oauthProviderName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProviderName' when calling replaceMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnAuthenticationOauthProvider"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProviderName", oauthProviderName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an Authorization Group object. - * Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| authorizationGroupName|x||x|||| clientProfileName|||||x|| msgVpnName|x||x|||| orderAfterAuthorizationGroupName||||x||| orderBeforeAuthorizationGroupName||||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthorizationGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthorizationGroupResponse replaceMsgVpnAuthorizationGroup(String msgVpnName, String authorizationGroupName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnAuthorizationGroupWithHttpInfo(msgVpnName, authorizationGroupName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an Authorization Group object. - * Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| authorizationGroupName|x||x|||| clientProfileName|||||x|| msgVpnName|x||x|||| orderAfterAuthorizationGroupName||||x||| orderBeforeAuthorizationGroupName||||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthorizationGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnAuthorizationGroupWithHttpInfo(String msgVpnName, String authorizationGroupName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'authorizationGroupName' is set - if (authorizationGroupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationGroupName' when calling replaceMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnAuthorizationGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("authorizationGroupName", authorizationGroupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Bridge object. - * Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| maxTtl|||||x|| msgVpnName|x||x|||| remoteAuthenticationBasicClientUsername|||||x|| remoteAuthenticationBasicPassword||||x|x||x remoteAuthenticationClientCertContent||||x|x||x remoteAuthenticationClientCertPassword||||x|x|| remoteAuthenticationScheme|||||x|| remoteDeliverToOnePriority|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeResponse replaceMsgVpnBridge(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnBridgeWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Bridge object. - * Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| maxTtl|||||x|| msgVpnName|x||x|||| remoteAuthenticationBasicClientUsername|||||x|| remoteAuthenticationBasicPassword||||x|x||x remoteAuthenticationClientCertContent||||x|x||x remoteAuthenticationClientCertPassword||||x|x|| remoteAuthenticationScheme|||||x|| remoteDeliverToOnePriority|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnBridgeWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnBridge"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling replaceMsgVpnBridge"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling replaceMsgVpnBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Remote Message VPN object. - * Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| clientUsername|||||x|| compressedDataEnabled|||||x|| egressFlowWindowSize|||||x|| msgVpnName|x||x|||| password||||x|x||x remoteMsgVpnInterface|x||x|||| remoteMsgVpnLocation|x||x|||| remoteMsgVpnName|x||x|||| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteMsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteMsgVpnResponse replaceMsgVpnBridgeRemoteMsgVpn(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnBridgeRemoteMsgVpnWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Remote Message VPN object. - * Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| clientUsername|||||x|| compressedDataEnabled|||||x|| egressFlowWindowSize|||||x|| msgVpnName|x||x|||| password||||x|x||x remoteMsgVpnInterface|x||x|||| remoteMsgVpnLocation|x||x|||| remoteMsgVpnName|x||x|||| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteMsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnBridgeRemoteMsgVpnWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnName' is set - if (remoteMsgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnName' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnLocation' is set - if (remoteMsgVpnLocation == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnLocation' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnInterface' is set - if (remoteMsgVpnInterface == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnInterface' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnBridgeRemoteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteMsgVpnName", remoteMsgVpnName); - uriVariables.put("remoteMsgVpnLocation", remoteMsgVpnLocation); - uriVariables.put("remoteMsgVpnInterface", remoteMsgVpnInterface); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Certificate Matching Rule object. - * Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleResponse replaceMsgVpnCertMatchingRule(String msgVpnName, String ruleName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnCertMatchingRuleWithHttpInfo(msgVpnName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Certificate Matching Rule object. - * Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnCertMatchingRuleWithHttpInfo(String msgVpnName, String ruleName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling replaceMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Certificate Matching Rule Attribute Filter object. - * Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- filterName|x||x|||| msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleAttributeFilterResponse replaceMsgVpnCertMatchingRuleAttributeFilter(String msgVpnName, String ruleName, String filterName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(msgVpnName, ruleName, filterName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Certificate Matching Rule Attribute Filter object. - * Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- filterName|x||x|||| msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(String msgVpnName, String ruleName, String filterName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling replaceMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling replaceMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Client Profile object. - * Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled||||||x| apiQueueManagementCopyFromOnCreateName||||||x| apiTopicEndpointManagementCopyFromOnCreateName||||||x| clientProfileName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientProfileResponse replaceMsgVpnClientProfile(String msgVpnName, String clientProfileName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnClientProfileWithHttpInfo(msgVpnName, clientProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Client Profile object. - * Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled||||||x| apiQueueManagementCopyFromOnCreateName||||||x| apiTopicEndpointManagementCopyFromOnCreateName||||||x| clientProfileName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnClientProfileWithHttpInfo(String msgVpnName, String clientProfileName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnClientProfile"); - } - - // verify the required parameter 'clientProfileName' is set - if (clientProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientProfileName' when calling replaceMsgVpnClientProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnClientProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientProfileName", clientProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Client Username object. - * Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| clientProfileName|||||x|| clientUsername|x||x|||| msgVpnName|x||x|||| password||||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameResponse replaceMsgVpnClientUsername(String msgVpnName, String clientUsername, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnClientUsernameWithHttpInfo(msgVpnName, clientUsername, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Client Username object. - * Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| clientProfileName|||||x|| clientUsername|x||x|||| msgVpnName|x||x|||| password||||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnClientUsernameWithHttpInfo(String msgVpnName, String clientUsername, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnClientUsername"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling replaceMsgVpnClientUsername"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnClientUsername"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Distributed Cache object. - * Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| cacheVirtualRouter||x||||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheResponse replaceMsgVpnDistributedCache(String msgVpnName, String cacheName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnDistributedCacheWithHttpInfo(msgVpnName, cacheName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Distributed Cache object. - * Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| cacheVirtualRouter||x||||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnDistributedCacheWithHttpInfo(String msgVpnName, String cacheName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnDistributedCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling replaceMsgVpnDistributedCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnDistributedCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Cache Cluster object. - * Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterResponse replaceMsgVpnDistributedCacheCluster(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnDistributedCacheClusterWithHttpInfo(msgVpnName, cacheName, clusterName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Cache Cluster object. - * Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnDistributedCacheClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling replaceMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling replaceMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnDistributedCacheCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Cache Instance object. - * Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| instanceName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterInstanceResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterInstanceResponse replaceMsgVpnDistributedCacheClusterInstance(String msgVpnName, String cacheName, String clusterName, String instanceName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnDistributedCacheClusterInstanceWithHttpInfo(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Cache Instance object. - * Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| instanceName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterInstanceResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnDistributedCacheClusterInstanceWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String instanceName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling replaceMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling replaceMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'instanceName' is set - if (instanceName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'instanceName' when calling replaceMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnDistributedCacheClusterInstance"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("instanceName", instanceName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a DMR Bridge object. - * Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| remoteNodeName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDmrBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDmrBridgeResponse replaceMsgVpnDmrBridge(String msgVpnName, String remoteNodeName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnDmrBridgeWithHttpInfo(msgVpnName, remoteNodeName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a DMR Bridge object. - * Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| remoteNodeName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDmrBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnDmrBridgeWithHttpInfo(String msgVpnName, String remoteNodeName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnDmrBridge"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling replaceMsgVpnDmrBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnDmrBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a JNDI Connection Factory object. - * Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiConnectionFactoryResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiConnectionFactoryResponse replaceMsgVpnJndiConnectionFactory(String msgVpnName, String connectionFactoryName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnJndiConnectionFactoryWithHttpInfo(msgVpnName, connectionFactoryName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a JNDI Connection Factory object. - * Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiConnectionFactoryResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnJndiConnectionFactoryWithHttpInfo(String msgVpnName, String connectionFactoryName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'connectionFactoryName' is set - if (connectionFactoryName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'connectionFactoryName' when calling replaceMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnJndiConnectionFactory"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("connectionFactoryName", connectionFactoryName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a JNDI Queue object. - * Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiQueueResponse replaceMsgVpnJndiQueue(String msgVpnName, String queueName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnJndiQueueWithHttpInfo(msgVpnName, queueName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a JNDI Queue object. - * Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnJndiQueueWithHttpInfo(String msgVpnName, String queueName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnJndiQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling replaceMsgVpnJndiQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnJndiQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues/{queueName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a JNDI Topic object. - * Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiTopicResponse replaceMsgVpnJndiTopic(String msgVpnName, String topicName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnJndiTopicWithHttpInfo(msgVpnName, topicName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a JNDI Topic object. - * Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnJndiTopicWithHttpInfo(String msgVpnName, String topicName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnJndiTopic"); - } - - // verify the required parameter 'topicName' is set - if (topicName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicName' when calling replaceMsgVpnJndiTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnJndiTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicName", topicName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics/{topicName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an MQTT Retain Cache object. - * Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttRetainCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttRetainCacheResponse replaceMsgVpnMqttRetainCache(String msgVpnName, String cacheName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnMqttRetainCacheWithHttpInfo(msgVpnName, cacheName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an MQTT Retain Cache object. - * Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttRetainCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnMqttRetainCacheWithHttpInfo(String msgVpnName, String cacheName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling replaceMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnMqttRetainCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an MQTT Session object. - * Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| owner|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionResponse replaceMsgVpnMqttSession(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnMqttSessionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Replace an MQTT Session object. - * Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| owner|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnMqttSessionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling replaceMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling replaceMsgVpnMqttSession"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnMqttSession"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Subscription object. - * Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| subscriptionTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionSubscriptionResponse replaceMsgVpnMqttSessionSubscription(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnMqttSessionSubscriptionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Subscription object. - * Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| subscriptionTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnMqttSessionSubscriptionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling replaceMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling replaceMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling replaceMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnMqttSessionSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Queue object. - * Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| queueName|x||x|||| respectMsgPriorityEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueResponse replaceMsgVpnQueue(String msgVpnName, String queueName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnQueueWithHttpInfo(msgVpnName, queueName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Queue object. - * Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| queueName|x||x|||| respectMsgPriorityEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnQueueWithHttpInfo(String msgVpnName, String queueName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling replaceMsgVpnQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Queue Template object. - * Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueTemplateResponse replaceMsgVpnQueueTemplate(String msgVpnName, String queueTemplateName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnQueueTemplateWithHttpInfo(msgVpnName, queueTemplateName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Queue Template object. - * Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnQueueTemplateWithHttpInfo(String msgVpnName, String queueTemplateName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnQueueTemplate"); - } - - // verify the required parameter 'queueTemplateName' is set - if (queueTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueTemplateName' when calling replaceMsgVpnQueueTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnQueueTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueTemplateName", queueTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Replay Log object. - * Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replayLogName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogResponse replaceMsgVpnReplayLog(String msgVpnName, String replayLogName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnReplayLogWithHttpInfo(msgVpnName, replayLogName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Replay Log object. - * Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replayLogName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnReplayLogWithHttpInfo(String msgVpnName, String replayLogName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnReplayLog"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling replaceMsgVpnReplayLog"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnReplayLog"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Replicated Topic object. - * Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replicatedTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplicatedTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplicatedTopicResponse replaceMsgVpnReplicatedTopic(String msgVpnName, String replicatedTopic, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnReplicatedTopicWithHttpInfo(msgVpnName, replicatedTopic, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Replicated Topic object. - * Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replicatedTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplicatedTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnReplicatedTopicWithHttpInfo(String msgVpnName, String replicatedTopic, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'replicatedTopic' is set - if (replicatedTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replicatedTopic' when calling replaceMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnReplicatedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replicatedTopic", replicatedTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a REST Delivery Point object. - * Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientProfileName|||||x|| msgVpnName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointResponse replaceMsgVpnRestDeliveryPoint(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnRestDeliveryPointWithHttpInfo(msgVpnName, restDeliveryPointName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a REST Delivery Point object. - * Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientProfileName|||||x|| msgVpnName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnRestDeliveryPointWithHttpInfo(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling replaceMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnRestDeliveryPoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Queue Binding object. - * Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingResponse replaceMsgVpnRestDeliveryPointQueueBinding(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Queue Binding object. - * Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling replaceMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling replaceMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnRestDeliveryPointQueueBinding"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Request Header object. - * Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A request header to be added to the HTTP request. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- headerName|x||x|||| msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Request Header object. - * Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A request header to be added to the HTTP request. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- headerName|x||x|||| msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'headerName' is set - if (headerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'headerName' when calling replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - uriVariables.put("headerName", headerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a REST Consumer object. - * Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey||||x|||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| authenticationHttpBasicPassword||||x|x||x authenticationHttpBasicUsername|||||x|| authenticationHttpHeaderValue||||x|||x authenticationOauthClientId|||||x|| authenticationOauthClientScope|||||x|| authenticationOauthClientSecret||||x|x||x authenticationOauthClientTokenEndpoint|||||x|| authenticationOauthJwtSecretKey||||x|x||x authenticationOauthJwtTokenEndpoint|||||x|| authenticationScheme|||||x|| msgVpnName|x||x|||| outgoingConnectionCount|||||x|| remoteHost|||||x|| remotePort|||||x|| restConsumerName|x||x|||| restDeliveryPointName|x||x|||| tlsCipherSuiteList|||||x|| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerResponse replaceMsgVpnRestDeliveryPointRestConsumer(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a REST Consumer object. - * Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey||||x|||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| authenticationHttpBasicPassword||||x|x||x authenticationHttpBasicUsername|||||x|| authenticationHttpHeaderValue||||x|||x authenticationOauthClientId|||||x|| authenticationOauthClientScope|||||x|| authenticationOauthClientSecret||||x|x||x authenticationOauthClientTokenEndpoint|||||x|| authenticationOauthJwtSecretKey||||x|x||x authenticationOauthJwtTokenEndpoint|||||x|| authenticationScheme|||||x|| msgVpnName|x||x|||| outgoingConnectionCount|||||x|| remoteHost|||||x|| remotePort|||||x|| restConsumerName|x||x|||| restDeliveryPointName|x||x|||| tlsCipherSuiteList|||||x|| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling replaceMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling replaceMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnRestDeliveryPointRestConsumer"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Topic Endpoint object. - * Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| respectMsgPriorityEnabled|||||x|| topicEndpointName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointResponse replaceMsgVpnTopicEndpoint(String msgVpnName, String topicEndpointName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnTopicEndpointWithHttpInfo(msgVpnName, topicEndpointName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Topic Endpoint object. - * Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| respectMsgPriorityEnabled|||||x|| topicEndpointName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnTopicEndpointWithHttpInfo(String msgVpnName, String topicEndpointName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'topicEndpointName' is set - if (topicEndpointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointName' when calling replaceMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnTopicEndpoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointName", topicEndpointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Topic Endpoint Template object. - * Replace a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicEndpointTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointTemplateResponse replaceMsgVpnTopicEndpointTemplate(String msgVpnName, String topicEndpointTemplateName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnTopicEndpointTemplateWithHttpInfo(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Topic Endpoint Template object. - * Replace a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicEndpointTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnTopicEndpointTemplateWithHttpInfo(String msgVpnName, String topicEndpointTemplateName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'topicEndpointTemplateName' is set - if (topicEndpointTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointTemplateName' when calling replaceMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnTopicEndpointTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointTemplateName", topicEndpointTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Message VPN object. - * Update a Message VPN object. Any attribute missing from the request will be left unchanged. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationOauthDefaultProviderName|||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| distributedCacheManagementEnabled|||||x| msgVpnName|x|x|||| replicationBridgeAuthenticationBasicPassword|||x|||x replicationBridgeAuthenticationClientCertContent|||x|||x replicationBridgeAuthenticationClientCertPassword|||x||| replicationEnabledQueueBehavior|||x||| restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: alias|global/read-write authenticationBasicEnabled|global/read-write authenticationBasicProfileName|global/read-write authenticationBasicRadiusDomain|global/read-write authenticationBasicType|global/read-write authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write authenticationClientCertCertificateMatchingRulesEnabled|global/read-write authenticationClientCertEnabled|global/read-write authenticationClientCertMaxChainDepth|global/read-write authenticationClientCertRevocationCheckMode|global/read-write authenticationClientCertUsernameSource|global/read-write authenticationClientCertValidateDateEnabled|global/read-write authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write authenticationKerberosEnabled|global/read-write authenticationOauthEnabled|global/read-write bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write bridgingTlsServerCertMaxChainDepth|global/read-write bridgingTlsServerCertValidateDateEnabled|global/read-write bridgingTlsServerCertValidateNameEnabled|global/read-write dmrEnabled|global/read-write exportSubscriptionsEnabled|global/read-write maxConnectionCount|global/read-write maxEgressFlowCount|global/read-write maxEndpointCount|global/read-write maxIngressFlowCount|global/read-write maxMsgSpoolUsage|global/read-write maxSubscriptionCount|global/read-write maxTransactedSessionCount|global/read-write maxTransactionCount|global/read-write mqttRetainMaxMemory|global/read-write replicationBridgeAuthenticationBasicClientUsername|global/read-write replicationBridgeAuthenticationBasicPassword|global/read-write replicationBridgeAuthenticationClientCertContent|global/read-write replicationBridgeAuthenticationClientCertPassword|global/read-write replicationBridgeAuthenticationScheme|global/read-write replicationBridgeCompressedDataEnabled|global/read-write replicationBridgeEgressFlowWindowSize|global/read-write replicationBridgeRetryDelay|global/read-write replicationBridgeTlsEnabled|global/read-write replicationBridgeUnidirectionalClientProfileName|global/read-write replicationEnabled|global/read-write replicationEnabledQueueBehavior|global/read-write replicationQueueMaxMsgSpoolUsage|global/read-write replicationRole|global/read-write restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write restTlsServerCertMaxChainDepth|global/read-write restTlsServerCertValidateDateEnabled|global/read-write restTlsServerCertValidateNameEnabled|global/read-write sempOverMsgBusAdminClientEnabled|global/read-write sempOverMsgBusAdminDistributedCacheEnabled|global/read-write sempOverMsgBusAdminEnabled|global/read-write sempOverMsgBusEnabled|global/read-write sempOverMsgBusShowEnabled|global/read-write serviceAmqpMaxConnectionCount|global/read-write serviceAmqpPlainTextListenPort|global/read-write serviceAmqpTlsListenPort|global/read-write serviceMqttMaxConnectionCount|global/read-write serviceMqttPlainTextListenPort|global/read-write serviceMqttTlsListenPort|global/read-write serviceMqttTlsWebSocketListenPort|global/read-write serviceMqttWebSocketListenPort|global/read-write serviceRestIncomingMaxConnectionCount|global/read-write serviceRestIncomingPlainTextListenPort|global/read-write serviceRestIncomingTlsListenPort|global/read-write serviceRestOutgoingMaxConnectionCount|global/read-write serviceSmfMaxConnectionCount|global/read-write serviceWebMaxConnectionCount|global/read-write This has been available since 2.0. - *

200 - The Message VPN object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnResponse updateMsgVpn(String msgVpnName, MsgVpn body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Message VPN object. - * Update a Message VPN object. Any attribute missing from the request will be left unchanged. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationOauthDefaultProviderName|||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| distributedCacheManagementEnabled|||||x| msgVpnName|x|x|||| replicationBridgeAuthenticationBasicPassword|||x|||x replicationBridgeAuthenticationClientCertContent|||x|||x replicationBridgeAuthenticationClientCertPassword|||x||| replicationEnabledQueueBehavior|||x||| restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: alias|global/read-write authenticationBasicEnabled|global/read-write authenticationBasicProfileName|global/read-write authenticationBasicRadiusDomain|global/read-write authenticationBasicType|global/read-write authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write authenticationClientCertCertificateMatchingRulesEnabled|global/read-write authenticationClientCertEnabled|global/read-write authenticationClientCertMaxChainDepth|global/read-write authenticationClientCertRevocationCheckMode|global/read-write authenticationClientCertUsernameSource|global/read-write authenticationClientCertValidateDateEnabled|global/read-write authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write authenticationKerberosEnabled|global/read-write authenticationOauthEnabled|global/read-write bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write bridgingTlsServerCertMaxChainDepth|global/read-write bridgingTlsServerCertValidateDateEnabled|global/read-write bridgingTlsServerCertValidateNameEnabled|global/read-write dmrEnabled|global/read-write exportSubscriptionsEnabled|global/read-write maxConnectionCount|global/read-write maxEgressFlowCount|global/read-write maxEndpointCount|global/read-write maxIngressFlowCount|global/read-write maxMsgSpoolUsage|global/read-write maxSubscriptionCount|global/read-write maxTransactedSessionCount|global/read-write maxTransactionCount|global/read-write mqttRetainMaxMemory|global/read-write replicationBridgeAuthenticationBasicClientUsername|global/read-write replicationBridgeAuthenticationBasicPassword|global/read-write replicationBridgeAuthenticationClientCertContent|global/read-write replicationBridgeAuthenticationClientCertPassword|global/read-write replicationBridgeAuthenticationScheme|global/read-write replicationBridgeCompressedDataEnabled|global/read-write replicationBridgeEgressFlowWindowSize|global/read-write replicationBridgeRetryDelay|global/read-write replicationBridgeTlsEnabled|global/read-write replicationBridgeUnidirectionalClientProfileName|global/read-write replicationEnabled|global/read-write replicationEnabledQueueBehavior|global/read-write replicationQueueMaxMsgSpoolUsage|global/read-write replicationRole|global/read-write restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write restTlsServerCertMaxChainDepth|global/read-write restTlsServerCertValidateDateEnabled|global/read-write restTlsServerCertValidateNameEnabled|global/read-write sempOverMsgBusAdminClientEnabled|global/read-write sempOverMsgBusAdminDistributedCacheEnabled|global/read-write sempOverMsgBusAdminEnabled|global/read-write sempOverMsgBusEnabled|global/read-write sempOverMsgBusShowEnabled|global/read-write serviceAmqpMaxConnectionCount|global/read-write serviceAmqpPlainTextListenPort|global/read-write serviceAmqpTlsListenPort|global/read-write serviceMqttMaxConnectionCount|global/read-write serviceMqttPlainTextListenPort|global/read-write serviceMqttTlsListenPort|global/read-write serviceMqttTlsWebSocketListenPort|global/read-write serviceMqttWebSocketListenPort|global/read-write serviceRestIncomingMaxConnectionCount|global/read-write serviceRestIncomingPlainTextListenPort|global/read-write serviceRestIncomingTlsListenPort|global/read-write serviceRestOutgoingMaxConnectionCount|global/read-write serviceSmfMaxConnectionCount|global/read-write serviceWebMaxConnectionCount|global/read-write This has been available since 2.0. - *

200 - The Message VPN object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnWithHttpInfo(String msgVpnName, MsgVpn body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpn"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an ACL Profile object. - * Update an ACL Profile object. Any attribute missing from the request will be left unchanged. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAclProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAclProfileResponse updateMsgVpnAclProfile(String msgVpnName, String aclProfileName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnAclProfileWithHttpInfo(msgVpnName, aclProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Update an ACL Profile object. - * Update an ACL Profile object. Any attribute missing from the request will be left unchanged. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The ACL Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param aclProfileName The name of the ACL Profile. (required) - * @param body The ACL Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAclProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnAclProfileWithHttpInfo(String msgVpnName, String aclProfileName, MsgVpnAclProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnAclProfile"); - } - - // verify the required parameter 'aclProfileName' is set - if (aclProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'aclProfileName' when calling updateMsgVpnAclProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnAclProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("aclProfileName", aclProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an OAuth Profile object. - * Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthenticationOauthProfileResponse updateMsgVpnAuthenticationOauthProfile(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnAuthenticationOauthProfileWithHttpInfo(msgVpnName, oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Update an OAuth Profile object. - * Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - *

200 - The OAuth Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnAuthenticationOauthProfileWithHttpInfo(String msgVpnName, String oauthProfileName, MsgVpnAuthenticationOauthProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling updateMsgVpnAuthenticationOauthProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnAuthenticationOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an OAuth Provider object. - * Update an OAuth Provider object. Any attribute missing from the request will be left unchanged. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x|x|||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword|||x||x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthenticationOauthProviderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnAuthenticationOauthProviderResponse updateMsgVpnAuthenticationOauthProvider(String msgVpnName, String oauthProviderName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnAuthenticationOauthProviderWithHttpInfo(msgVpnName, oauthProviderName, body, opaquePassword, select).getBody(); - } - - /** - * Update an OAuth Provider object. - * Update an OAuth Provider object. Any attribute missing from the request will be left unchanged. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x|x|||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword|||x||x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - *

200 - The OAuth Provider object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param oauthProviderName The name of the OAuth Provider. (required) - * @param body The OAuth Provider object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthenticationOauthProviderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity updateMsgVpnAuthenticationOauthProviderWithHttpInfo(String msgVpnName, String oauthProviderName, MsgVpnAuthenticationOauthProvider body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'oauthProviderName' is set - if (oauthProviderName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProviderName' when calling updateMsgVpnAuthenticationOauthProvider"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnAuthenticationOauthProvider"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("oauthProviderName", oauthProviderName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an Authorization Group object. - * Update an Authorization Group object. Any attribute missing from the request will be left unchanged. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| authorizationGroupName|x|x|||| clientProfileName||||x|| msgVpnName|x|x|||| orderAfterAuthorizationGroupName|||x||| orderBeforeAuthorizationGroupName|||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnAuthorizationGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnAuthorizationGroupResponse updateMsgVpnAuthorizationGroup(String msgVpnName, String authorizationGroupName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnAuthorizationGroupWithHttpInfo(msgVpnName, authorizationGroupName, body, opaquePassword, select).getBody(); - } - - /** - * Update an Authorization Group object. - * Update an Authorization Group object. Any attribute missing from the request will be left unchanged. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| authorizationGroupName|x|x|||| clientProfileName||||x|| msgVpnName|x|x|||| orderAfterAuthorizationGroupName|||x||| orderBeforeAuthorizationGroupName|||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Authorization Group object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param authorizationGroupName The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. (required) - * @param body The Authorization Group object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnAuthorizationGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnAuthorizationGroupWithHttpInfo(String msgVpnName, String authorizationGroupName, MsgVpnAuthorizationGroup body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'authorizationGroupName' is set - if (authorizationGroupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationGroupName' when calling updateMsgVpnAuthorizationGroup"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnAuthorizationGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("authorizationGroupName", authorizationGroupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Bridge object. - * Update a Bridge object. Any attribute missing from the request will be left unchanged. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| maxTtl||||x|| msgVpnName|x|x|||| remoteAuthenticationBasicClientUsername||||x|| remoteAuthenticationBasicPassword|||x|x||x remoteAuthenticationClientCertContent|||x|x||x remoteAuthenticationClientCertPassword|||x|x|| remoteAuthenticationScheme||||x|| remoteDeliverToOnePriority||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeResponse updateMsgVpnBridge(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnBridgeWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Update a Bridge object. - * Update a Bridge object. Any attribute missing from the request will be left unchanged. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| maxTtl||||x|| msgVpnName|x|x|||| remoteAuthenticationBasicClientUsername||||x|| remoteAuthenticationBasicPassword|||x|x||x remoteAuthenticationClientCertContent|||x|x||x remoteAuthenticationClientCertPassword|||x|x|| remoteAuthenticationScheme||||x|| remoteDeliverToOnePriority||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Bridge object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param body The Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnBridgeWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, MsgVpnBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnBridge"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling updateMsgVpnBridge"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling updateMsgVpnBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Remote Message VPN object. - * Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| clientUsername||||x|| compressedDataEnabled||||x|| egressFlowWindowSize||||x|| msgVpnName|x|x|||| password|||x|x||x remoteMsgVpnInterface|x|x|||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnBridgeRemoteMsgVpnResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnBridgeRemoteMsgVpnResponse updateMsgVpnBridgeRemoteMsgVpn(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnBridgeRemoteMsgVpnWithHttpInfo(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select).getBody(); - } - - /** - * Update a Remote Message VPN object. - * Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| clientUsername||||x|| compressedDataEnabled||||x|| egressFlowWindowSize||||x|| msgVpnName|x|x|||| password|||x|x||x remoteMsgVpnInterface|x|x|||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Remote Message VPN object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param bridgeName The name of the Bridge. (required) - * @param bridgeVirtualRouter The virtual router of the Bridge. (required) - * @param remoteMsgVpnName The name of the remote Message VPN. (required) - * @param remoteMsgVpnLocation The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). (required) - * @param remoteMsgVpnInterface The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. (required) - * @param body The Remote Message VPN object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnBridgeRemoteMsgVpnResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnBridgeRemoteMsgVpnWithHttpInfo(String msgVpnName, String bridgeName, String bridgeVirtualRouter, String remoteMsgVpnName, String remoteMsgVpnLocation, String remoteMsgVpnInterface, MsgVpnBridgeRemoteMsgVpn body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeName' is set - if (bridgeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeName' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'bridgeVirtualRouter' is set - if (bridgeVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'bridgeVirtualRouter' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnName' is set - if (remoteMsgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnName' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnLocation' is set - if (remoteMsgVpnLocation == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnLocation' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'remoteMsgVpnInterface' is set - if (remoteMsgVpnInterface == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteMsgVpnInterface' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnBridgeRemoteMsgVpn"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("bridgeName", bridgeName); - uriVariables.put("bridgeVirtualRouter", bridgeVirtualRouter); - uriVariables.put("remoteMsgVpnName", remoteMsgVpnName); - uriVariables.put("remoteMsgVpnLocation", remoteMsgVpnLocation); - uriVariables.put("remoteMsgVpnInterface", remoteMsgVpnInterface); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Certificate Matching Rule object. - * Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleResponse updateMsgVpnCertMatchingRule(String msgVpnName, String ruleName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnCertMatchingRuleWithHttpInfo(msgVpnName, ruleName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Certificate Matching Rule object. - * Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Certificate Matching Rule object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param body The Certificate Matching Rule object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnCertMatchingRuleWithHttpInfo(String msgVpnName, String ruleName, MsgVpnCertMatchingRule body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling updateMsgVpnCertMatchingRule"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnCertMatchingRule"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Certificate Matching Rule Attribute Filter object. - * Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- filterName|x|x|||| msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnCertMatchingRuleAttributeFilterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnCertMatchingRuleAttributeFilterResponse updateMsgVpnCertMatchingRuleAttributeFilter(String msgVpnName, String ruleName, String filterName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(msgVpnName, ruleName, filterName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Certificate Matching Rule Attribute Filter object. - * Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- filterName|x|x|||| msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - *

200 - The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param ruleName The name of the rule. (required) - * @param filterName The name of the filter. (required) - * @param body The Certificate Matching Rule Attribute Filter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnCertMatchingRuleAttributeFilterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnCertMatchingRuleAttributeFilterWithHttpInfo(String msgVpnName, String ruleName, String filterName, MsgVpnCertMatchingRuleAttributeFilter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'ruleName' is set - if (ruleName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'ruleName' when calling updateMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'filterName' is set - if (filterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'filterName' when calling updateMsgVpnCertMatchingRuleAttributeFilter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnCertMatchingRuleAttributeFilter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("ruleName", ruleName); - uriVariables.put("filterName", filterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Client Profile object. - * Update a Client Profile object. Any attribute missing from the request will be left unchanged. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientProfileResponse updateMsgVpnClientProfile(String msgVpnName, String clientProfileName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnClientProfileWithHttpInfo(msgVpnName, clientProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Client Profile object. - * Update a Client Profile object. Any attribute missing from the request will be left unchanged. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientProfileName The name of the Client Profile. (required) - * @param body The Client Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnClientProfileWithHttpInfo(String msgVpnName, String clientProfileName, MsgVpnClientProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnClientProfile"); - } - - // verify the required parameter 'clientProfileName' is set - if (clientProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientProfileName' when calling updateMsgVpnClientProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnClientProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientProfileName", clientProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Client Username object. - * Update a Client Username object. Any attribute missing from the request will be left unchanged. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| clientProfileName||||x|| clientUsername|x|x|||| msgVpnName|x|x|||| password|||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnClientUsernameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnClientUsernameResponse updateMsgVpnClientUsername(String msgVpnName, String clientUsername, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnClientUsernameWithHttpInfo(msgVpnName, clientUsername, body, opaquePassword, select).getBody(); - } - - /** - * Update a Client Username object. - * Update a Client Username object. Any attribute missing from the request will be left unchanged. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| clientProfileName||||x|| clientUsername|x|x|||| msgVpnName|x|x|||| password|||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Client Username object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param clientUsername The name of the Client Username. (required) - * @param body The Client Username object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnClientUsernameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnClientUsernameWithHttpInfo(String msgVpnName, String clientUsername, MsgVpnClientUsername body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnClientUsername"); - } - - // verify the required parameter 'clientUsername' is set - if (clientUsername == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientUsername' when calling updateMsgVpnClientUsername"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnClientUsername"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("clientUsername", clientUsername); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Distributed Cache object. - * Update a Distributed Cache object. Any attribute missing from the request will be left unchanged. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| cacheVirtualRouter||x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheResponse updateMsgVpnDistributedCache(String msgVpnName, String cacheName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnDistributedCacheWithHttpInfo(msgVpnName, cacheName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Distributed Cache object. - * Update a Distributed Cache object. Any attribute missing from the request will be left unchanged. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| cacheVirtualRouter||x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Distributed Cache object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param body The Distributed Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnDistributedCacheWithHttpInfo(String msgVpnName, String cacheName, MsgVpnDistributedCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnDistributedCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling updateMsgVpnDistributedCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnDistributedCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Cache Cluster object. - * Update a Cache Cluster object. Any attribute missing from the request will be left unchanged. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterResponse updateMsgVpnDistributedCacheCluster(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnDistributedCacheClusterWithHttpInfo(msgVpnName, cacheName, clusterName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Cache Cluster object. - * Update a Cache Cluster object. Any attribute missing from the request will be left unchanged. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Cluster object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param body The Cache Cluster object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnDistributedCacheClusterWithHttpInfo(String msgVpnName, String cacheName, String clusterName, MsgVpnDistributedCacheCluster body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling updateMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling updateMsgVpnDistributedCacheCluster"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnDistributedCacheCluster"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Cache Instance object. - * Update a Cache Instance object. Any attribute missing from the request will be left unchanged. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| instanceName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDistributedCacheClusterInstanceResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDistributedCacheClusterInstanceResponse updateMsgVpnDistributedCacheClusterInstance(String msgVpnName, String cacheName, String clusterName, String instanceName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnDistributedCacheClusterInstanceWithHttpInfo(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Cache Instance object. - * Update a Cache Instance object. Any attribute missing from the request will be left unchanged. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| instanceName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The Cache Instance object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the Distributed Cache. (required) - * @param clusterName The name of the Cache Cluster. (required) - * @param instanceName The name of the Cache Instance. (required) - * @param body The Cache Instance object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDistributedCacheClusterInstanceResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnDistributedCacheClusterInstanceWithHttpInfo(String msgVpnName, String cacheName, String clusterName, String instanceName, MsgVpnDistributedCacheClusterInstance body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling updateMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'clusterName' is set - if (clusterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clusterName' when calling updateMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'instanceName' is set - if (instanceName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'instanceName' when calling updateMsgVpnDistributedCacheClusterInstance"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnDistributedCacheClusterInstance"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - uriVariables.put("clusterName", clusterName); - uriVariables.put("instanceName", instanceName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a DMR Bridge object. - * Update a DMR Bridge object. Any attribute missing from the request will be left unchanged. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnDmrBridgeResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnDmrBridgeResponse updateMsgVpnDmrBridge(String msgVpnName, String remoteNodeName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnDmrBridgeWithHttpInfo(msgVpnName, remoteNodeName, body, opaquePassword, select).getBody(); - } - - /** - * Update a DMR Bridge object. - * Update a DMR Bridge object. Any attribute missing from the request will be left unchanged. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The DMR Bridge object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param remoteNodeName The name of the node at the remote end of the DMR Bridge. (required) - * @param body The DMR Bridge object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnDmrBridgeResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnDmrBridgeWithHttpInfo(String msgVpnName, String remoteNodeName, MsgVpnDmrBridge body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnDmrBridge"); - } - - // verify the required parameter 'remoteNodeName' is set - if (remoteNodeName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'remoteNodeName' when calling updateMsgVpnDmrBridge"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnDmrBridge"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("remoteNodeName", remoteNodeName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a JNDI Connection Factory object. - * Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiConnectionFactoryResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiConnectionFactoryResponse updateMsgVpnJndiConnectionFactory(String msgVpnName, String connectionFactoryName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnJndiConnectionFactoryWithHttpInfo(msgVpnName, connectionFactoryName, body, opaquePassword, select).getBody(); - } - - /** - * Update a JNDI Connection Factory object. - * Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Connection Factory object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param connectionFactoryName The name of the JMS Connection Factory. (required) - * @param body The JNDI Connection Factory object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiConnectionFactoryResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnJndiConnectionFactoryWithHttpInfo(String msgVpnName, String connectionFactoryName, MsgVpnJndiConnectionFactory body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'connectionFactoryName' is set - if (connectionFactoryName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'connectionFactoryName' when calling updateMsgVpnJndiConnectionFactory"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnJndiConnectionFactory"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("connectionFactoryName", connectionFactoryName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a JNDI Queue object. - * Update a JNDI Queue object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiQueueResponse updateMsgVpnJndiQueue(String msgVpnName, String queueName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnJndiQueueWithHttpInfo(msgVpnName, queueName, body, opaquePassword, select).getBody(); - } - - /** - * Update a JNDI Queue object. - * Update a JNDI Queue object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Queue object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The JNDI name of the JMS Queue. (required) - * @param body The JNDI Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnJndiQueueWithHttpInfo(String msgVpnName, String queueName, MsgVpnJndiQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnJndiQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling updateMsgVpnJndiQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnJndiQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiQueues/{queueName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a JNDI Topic object. - * Update a JNDI Topic object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnJndiTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnJndiTopicResponse updateMsgVpnJndiTopic(String msgVpnName, String topicName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnJndiTopicWithHttpInfo(msgVpnName, topicName, body, opaquePassword, select).getBody(); - } - - /** - * Update a JNDI Topic object. - * Update a JNDI Topic object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - *

200 - The JNDI Topic object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicName The JNDI name of the JMS Topic. (required) - * @param body The JNDI Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnJndiTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnJndiTopicWithHttpInfo(String msgVpnName, String topicName, MsgVpnJndiTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnJndiTopic"); - } - - // verify the required parameter 'topicName' is set - if (topicName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicName' when calling updateMsgVpnJndiTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnJndiTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicName", topicName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/jndiTopics/{topicName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an MQTT Retain Cache object. - * Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttRetainCacheResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttRetainCacheResponse updateMsgVpnMqttRetainCache(String msgVpnName, String cacheName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnMqttRetainCacheWithHttpInfo(msgVpnName, cacheName, body, opaquePassword, select).getBody(); - } - - /** - * Update an MQTT Retain Cache object. - * Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - *

200 - The MQTT Retain Cache object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param cacheName The name of the MQTT Retain Cache. (required) - * @param body The MQTT Retain Cache object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttRetainCacheResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnMqttRetainCacheWithHttpInfo(String msgVpnName, String cacheName, MsgVpnMqttRetainCache body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'cacheName' is set - if (cacheName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'cacheName' when calling updateMsgVpnMqttRetainCache"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnMqttRetainCache"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("cacheName", cacheName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an MQTT Session object. - * Update an MQTT Session object. Any attribute missing from the request will be left unchanged. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| owner||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionResponse updateMsgVpnMqttSession(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnMqttSessionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select).getBody(); - } - - /** - * Update an MQTT Session object. - * Update an MQTT Session object. Any attribute missing from the request will be left unchanged. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| owner||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The MQTT Session object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param body The MQTT Session object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnMqttSessionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, MsgVpnMqttSession body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling updateMsgVpnMqttSession"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling updateMsgVpnMqttSession"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnMqttSession"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Subscription object. - * Update a Subscription object. Any attribute missing from the request will be left unchanged. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnMqttSessionSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnMqttSessionSubscriptionResponse updateMsgVpnMqttSessionSubscription(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnMqttSessionSubscriptionWithHttpInfo(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select).getBody(); - } - - /** - * Update a Subscription object. - * Update a Subscription object. Any attribute missing from the request will be left unchanged. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Subscription object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param mqttSessionClientId The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. (required) - * @param mqttSessionVirtualRouter The virtual router of the MQTT Session. (required) - * @param subscriptionTopic The MQTT subscription topic. (required) - * @param body The Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnMqttSessionSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnMqttSessionSubscriptionWithHttpInfo(String msgVpnName, String mqttSessionClientId, String mqttSessionVirtualRouter, String subscriptionTopic, MsgVpnMqttSessionSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionClientId' is set - if (mqttSessionClientId == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionClientId' when calling updateMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'mqttSessionVirtualRouter' is set - if (mqttSessionVirtualRouter == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'mqttSessionVirtualRouter' when calling updateMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling updateMsgVpnMqttSessionSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnMqttSessionSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("mqttSessionClientId", mqttSessionClientId); - uriVariables.put("mqttSessionVirtualRouter", mqttSessionVirtualRouter); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Queue object. - * Update a Queue object. Any attribute missing from the request will be left unchanged. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| queueName|x|x|||| respectMsgPriorityEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueResponse updateMsgVpnQueue(String msgVpnName, String queueName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnQueueWithHttpInfo(msgVpnName, queueName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Queue object. - * Update a Queue object. Any attribute missing from the request will be left unchanged. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| queueName|x|x|||| respectMsgPriorityEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnQueueWithHttpInfo(String msgVpnName, String queueName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling updateMsgVpnQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Queue Template object. - * Update a Queue Template object. Any attribute missing from the request will be left unchanged. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueTemplateResponse updateMsgVpnQueueTemplate(String msgVpnName, String queueTemplateName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnQueueTemplateWithHttpInfo(msgVpnName, queueTemplateName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Queue Template object. - * Update a Queue Template object. Any attribute missing from the request will be left unchanged. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnQueueTemplateWithHttpInfo(String msgVpnName, String queueTemplateName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnQueueTemplate"); - } - - // verify the required parameter 'queueTemplateName' is set - if (queueTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueTemplateName' when calling updateMsgVpnQueueTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnQueueTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueTemplateName", queueTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Replay Log object. - * Update a Replay Log object. Any attribute missing from the request will be left unchanged. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogResponse updateMsgVpnReplayLog(String msgVpnName, String replayLogName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnReplayLogWithHttpInfo(msgVpnName, replayLogName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Replay Log object. - * Update a Replay Log object. Any attribute missing from the request will be left unchanged. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnReplayLogWithHttpInfo(String msgVpnName, String replayLogName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnReplayLog"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling updateMsgVpnReplayLog"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnReplayLog"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Replicated Topic object. - * Update a Replicated Topic object. Any attribute missing from the request will be left unchanged. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplicatedTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplicatedTopicResponse updateMsgVpnReplicatedTopic(String msgVpnName, String replicatedTopic, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnReplicatedTopicWithHttpInfo(msgVpnName, replicatedTopic, body, opaquePassword, select).getBody(); - } - - /** - * Update a Replicated Topic object. - * Update a Replicated Topic object. Any attribute missing from the request will be left unchanged. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplicatedTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnReplicatedTopicWithHttpInfo(String msgVpnName, String replicatedTopic, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'replicatedTopic' is set - if (replicatedTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replicatedTopic' when calling updateMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnReplicatedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replicatedTopic", replicatedTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a REST Delivery Point object. - * Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientProfileName||||x|| msgVpnName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointResponse updateMsgVpnRestDeliveryPoint(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnRestDeliveryPointWithHttpInfo(msgVpnName, restDeliveryPointName, body, opaquePassword, select).getBody(); - } - - /** - * Update a REST Delivery Point object. - * Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientProfileName||||x|| msgVpnName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnRestDeliveryPointWithHttpInfo(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling updateMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnRestDeliveryPoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Queue Binding object. - * Update a Queue Binding object. Any attribute missing from the request will be left unchanged. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingResponse updateMsgVpnRestDeliveryPointQueueBinding(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Queue Binding object. - * Update a Queue Binding object. Any attribute missing from the request will be left unchanged. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling updateMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling updateMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnRestDeliveryPointQueueBinding"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Request Header object. - * Update a Request Header object. Any attribute missing from the request will be left unchanged. A request header to be added to the HTTP request. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- headerName|x|x|||| msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse updateMsgVpnRestDeliveryPointQueueBindingRequestHeader(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Request Header object. - * Update a Request Header object. Any attribute missing from the request will be left unchanged. A request header to be added to the HTTP request. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- headerName|x|x|||| msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'headerName' is set - if (headerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'headerName' when calling updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - uriVariables.put("headerName", headerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a REST Consumer object. - * Update a REST Consumer object. Any attribute missing from the request will be left unchanged. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey|||x|||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| authenticationHttpBasicPassword|||x|x||x authenticationHttpBasicUsername||||x|| authenticationHttpHeaderValue|||x|||x authenticationOauthClientId||||x|| authenticationOauthClientScope||||x|| authenticationOauthClientSecret|||x|x||x authenticationOauthClientTokenEndpoint||||x|| authenticationOauthJwtSecretKey|||x|x||x authenticationOauthJwtTokenEndpoint||||x|| authenticationScheme||||x|| msgVpnName|x|x|||| outgoingConnectionCount||||x|| remoteHost||||x|| remotePort||||x|| restConsumerName|x|x|||| restDeliveryPointName|x|x|||| tlsCipherSuiteList||||x|| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerResponse updateMsgVpnRestDeliveryPointRestConsumer(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select).getBody(); - } - - /** - * Update a REST Consumer object. - * Update a REST Consumer object. Any attribute missing from the request will be left unchanged. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey|||x|||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| authenticationHttpBasicPassword|||x|x||x authenticationHttpBasicUsername||||x|| authenticationHttpHeaderValue|||x|||x authenticationOauthClientId||||x|| authenticationOauthClientScope||||x|| authenticationOauthClientSecret|||x|x||x authenticationOauthClientTokenEndpoint||||x|| authenticationOauthJwtSecretKey|||x|x||x authenticationOauthJwtTokenEndpoint||||x|| authenticationScheme||||x|| msgVpnName|x|x|||| outgoingConnectionCount||||x|| remoteHost||||x|| remotePort||||x|| restConsumerName|x|x|||| restDeliveryPointName|x|x|||| tlsCipherSuiteList||||x|| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling updateMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling updateMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnRestDeliveryPointRestConsumer"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Topic Endpoint object. - * Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| respectMsgPriorityEnabled||||x|| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointResponse updateMsgVpnTopicEndpoint(String msgVpnName, String topicEndpointName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnTopicEndpointWithHttpInfo(msgVpnName, topicEndpointName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Topic Endpoint object. - * Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| respectMsgPriorityEnabled||||x|| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnTopicEndpointWithHttpInfo(String msgVpnName, String topicEndpointName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'topicEndpointName' is set - if (topicEndpointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointName' when calling updateMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnTopicEndpoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointName", topicEndpointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Topic Endpoint Template object. - * Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointTemplateResponse updateMsgVpnTopicEndpointTemplate(String msgVpnName, String topicEndpointTemplateName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnTopicEndpointTemplateWithHttpInfo(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Topic Endpoint Template object. - * Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnTopicEndpointTemplateWithHttpInfo(String msgVpnName, String topicEndpointTemplateName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'topicEndpointTemplateName' is set - if (topicEndpointTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointTemplateName' when calling updateMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnTopicEndpointTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointTemplateName", topicEndpointTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/OauthProfileApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/OauthProfileApi.java deleted file mode 100644 index cf760ee97..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/OauthProfileApi.java +++ /dev/null @@ -1,2890 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHost; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHostResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHostsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParameter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParameterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParametersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileApi { - private ApiClient apiClient; - - public OauthProfileApi() { - this(new ApiClient()); - } - - public OauthProfileApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create an OAuth Profile object. - * Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The OAuth Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileResponse createOauthProfile(OauthProfile body, String opaquePassword, List select) throws RestClientException { - return createOauthProfileWithHttpInfo(body, opaquePassword, select).getBody(); - } - - /** - * Create an OAuth Profile object. - * Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The OAuth Profile object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createOauthProfileWithHttpInfo(OauthProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createOauthProfile"); - } - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles", HttpMethod.POST, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Group Access Level object. - * Create a Group Access Level object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: groupName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - *

200 - The Group Access Level object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Group Access Level object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupResponse createOauthProfileAccessLevelGroup(String oauthProfileName, OauthProfileAccessLevelGroup body, String opaquePassword, List select) throws RestClientException { - return createOauthProfileAccessLevelGroupWithHttpInfo(oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Group Access Level object. - * Create a Group Access Level object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: groupName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - *

200 - The Group Access Level object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Group Access Level object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createOauthProfileAccessLevelGroupWithHttpInfo(String oauthProfileName, OauthProfileAccessLevelGroup body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createOauthProfileAccessLevelGroup"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createOauthProfileAccessLevelGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Message VPN Access-Level Exception object. - * Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: groupName|x||x||| msgVpnName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse createOauthProfileAccessLevelGroupMsgVpnAccessLevelException(String oauthProfileName, String groupName, OauthProfileAccessLevelGroupMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - return createOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, groupName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Message VPN Access-Level Exception object. - * Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: groupName|x||x||| msgVpnName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String groupName, OauthProfileAccessLevelGroupMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling createOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an Allowed Host Value object. - * Create an Allowed Host Value object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowedHost|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Allowed Host Value object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Allowed Host Value object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientAllowedHostResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientAllowedHostResponse createOauthProfileClientAllowedHost(String oauthProfileName, OauthProfileClientAllowedHost body, String opaquePassword, List select) throws RestClientException { - return createOauthProfileClientAllowedHostWithHttpInfo(oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create an Allowed Host Value object. - * Create an Allowed Host Value object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowedHost|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Allowed Host Value object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Allowed Host Value object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientAllowedHostResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createOauthProfileClientAllowedHostWithHttpInfo(String oauthProfileName, OauthProfileClientAllowedHost body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createOauthProfileClientAllowedHost"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createOauthProfileClientAllowedHost"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAllowedHosts", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create an Authorization Parameter object. - * Create an Authorization Parameter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationParameterName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Authorization Parameter object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Authorization Parameter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientAuthorizationParameterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientAuthorizationParameterResponse createOauthProfileClientAuthorizationParameter(String oauthProfileName, OauthProfileClientAuthorizationParameter body, String opaquePassword, List select) throws RestClientException { - return createOauthProfileClientAuthorizationParameterWithHttpInfo(oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create an Authorization Parameter object. - * Create an Authorization Parameter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationParameterName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Authorization Parameter object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Authorization Parameter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientAuthorizationParameterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createOauthProfileClientAuthorizationParameterWithHttpInfo(String oauthProfileName, OauthProfileClientAuthorizationParameter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createOauthProfileClientAuthorizationParameter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createOauthProfileClientAuthorizationParameter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientRequiredClaimResponse createOauthProfileClientRequiredClaim(String oauthProfileName, OauthProfileClientRequiredClaim body, String opaquePassword, List select) throws RestClientException { - return createOauthProfileClientRequiredClaimWithHttpInfo(oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createOauthProfileClientRequiredClaimWithHttpInfo(String oauthProfileName, OauthProfileClientRequiredClaim body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createOauthProfileClientRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientRequiredClaims", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Message VPN Access-Level Exception object. - * Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Default message VPN access-level exceptions. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileDefaultMsgVpnAccessLevelExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileDefaultMsgVpnAccessLevelExceptionResponse createOauthProfileDefaultMsgVpnAccessLevelException(String oauthProfileName, OauthProfileDefaultMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - return createOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Message VPN Access-Level Exception object. - * Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Default message VPN access-level exceptions. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileDefaultMsgVpnAccessLevelExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, OauthProfileDefaultMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileResourceServerRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileResourceServerRequiredClaimResponse createOauthProfileResourceServerRequiredClaim(String oauthProfileName, OauthProfileResourceServerRequiredClaim body, String opaquePassword, List select) throws RestClientException { - return createOauthProfileResourceServerRequiredClaimWithHttpInfo(oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Required Claim object. - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Required Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The Required Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileResourceServerRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createOauthProfileResourceServerRequiredClaimWithHttpInfo(String oauthProfileName, OauthProfileResourceServerRequiredClaim body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling createOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createOauthProfileResourceServerRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an OAuth Profile object. - * Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteOauthProfile(String oauthProfileName) throws RestClientException { - return deleteOauthProfileWithHttpInfo(oauthProfileName).getBody(); - } - - /** - * Delete an OAuth Profile object. - * Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteOauthProfileWithHttpInfo(String oauthProfileName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Group Access Level object. - * Delete a Group Access Level object. The deletion of instances of this object are synchronized to HA mates via config-sync. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteOauthProfileAccessLevelGroup(String oauthProfileName, String groupName) throws RestClientException { - return deleteOauthProfileAccessLevelGroupWithHttpInfo(oauthProfileName, groupName).getBody(); - } - - /** - * Delete a Group Access Level object. - * Delete a Group Access Level object. The deletion of instances of this object are synchronized to HA mates via config-sync. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteOauthProfileAccessLevelGroupWithHttpInfo(String oauthProfileName, String groupName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteOauthProfileAccessLevelGroup"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling deleteOauthProfileAccessLevelGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Message VPN Access-Level Exception object. - * Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. Message VPN access-level exceptions for members of this group. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param msgVpnName The name of the message VPN. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException(String oauthProfileName, String groupName, String msgVpnName) throws RestClientException { - return deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, groupName, msgVpnName).getBody(); - } - - /** - * Delete a Message VPN Access-Level Exception object. - * Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. Message VPN access-level exceptions for members of this group. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param msgVpnName The name of the message VPN. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String groupName, String msgVpnName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an Allowed Host Value object. - * Delete an Allowed Host Value object. The deletion of instances of this object are synchronized to HA mates via config-sync. A valid hostname for this broker in OAuth redirects. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param allowedHost An allowed value for the Host header. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteOauthProfileClientAllowedHost(String oauthProfileName, String allowedHost) throws RestClientException { - return deleteOauthProfileClientAllowedHostWithHttpInfo(oauthProfileName, allowedHost).getBody(); - } - - /** - * Delete an Allowed Host Value object. - * Delete an Allowed Host Value object. The deletion of instances of this object are synchronized to HA mates via config-sync. A valid hostname for this broker in OAuth redirects. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param allowedHost An allowed value for the Host header. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteOauthProfileClientAllowedHostWithHttpInfo(String oauthProfileName, String allowedHost) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteOauthProfileClientAllowedHost"); - } - - // verify the required parameter 'allowedHost' is set - if (allowedHost == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'allowedHost' when calling deleteOauthProfileClientAllowedHost"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("allowedHost", allowedHost); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete an Authorization Parameter object. - * Delete an Authorization Parameter object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional parameters to be passed to the OAuth authorization endpoint. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param authorizationParameterName The name of the authorization parameter. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteOauthProfileClientAuthorizationParameter(String oauthProfileName, String authorizationParameterName) throws RestClientException { - return deleteOauthProfileClientAuthorizationParameterWithHttpInfo(oauthProfileName, authorizationParameterName).getBody(); - } - - /** - * Delete an Authorization Parameter object. - * Delete an Authorization Parameter object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional parameters to be passed to the OAuth authorization endpoint. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param authorizationParameterName The name of the authorization parameter. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteOauthProfileClientAuthorizationParameterWithHttpInfo(String oauthProfileName, String authorizationParameterName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteOauthProfileClientAuthorizationParameter"); - } - - // verify the required parameter 'authorizationParameterName' is set - if (authorizationParameterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationParameterName' when calling deleteOauthProfileClientAuthorizationParameter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("authorizationParameterName", authorizationParameterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteOauthProfileClientRequiredClaim(String oauthProfileName, String clientRequiredClaimName) throws RestClientException { - return deleteOauthProfileClientRequiredClaimWithHttpInfo(oauthProfileName, clientRequiredClaimName).getBody(); - } - - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteOauthProfileClientRequiredClaimWithHttpInfo(String oauthProfileName, String clientRequiredClaimName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'clientRequiredClaimName' is set - if (clientRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientRequiredClaimName' when calling deleteOauthProfileClientRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("clientRequiredClaimName", clientRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Message VPN Access-Level Exception object. - * Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. Default message VPN access-level exceptions. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param msgVpnName The name of the message VPN. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteOauthProfileDefaultMsgVpnAccessLevelException(String oauthProfileName, String msgVpnName) throws RestClientException { - return deleteOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, msgVpnName).getBody(); - } - - /** - * Delete a Message VPN Access-Level Exception object. - * Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. Default message VPN access-level exceptions. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param msgVpnName The name of the message VPN. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String msgVpnName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteOauthProfileResourceServerRequiredClaim(String oauthProfileName, String resourceServerRequiredClaimName) throws RestClientException { - return deleteOauthProfileResourceServerRequiredClaimWithHttpInfo(oauthProfileName, resourceServerRequiredClaimName).getBody(); - } - - /** - * Delete a Required Claim object. - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteOauthProfileResourceServerRequiredClaimWithHttpInfo(String oauthProfileName, String resourceServerRequiredClaimName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling deleteOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'resourceServerRequiredClaimName' is set - if (resourceServerRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'resourceServerRequiredClaimName' when calling deleteOauthProfileResourceServerRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("resourceServerRequiredClaimName", resourceServerRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an OAuth Profile object. - * Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The OAuth Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileResponse getOauthProfile(String oauthProfileName, String opaquePassword, List select) throws RestClientException { - return getOauthProfileWithHttpInfo(oauthProfileName, opaquePassword, select).getBody(); - } - - /** - * Get an OAuth Profile object. - * Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The OAuth Profile object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileWithHttpInfo(String oauthProfileName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Group Access Level object. - * Get a Group Access Level object. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Group Access Level object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupResponse getOauthProfileAccessLevelGroup(String oauthProfileName, String groupName, String opaquePassword, List select) throws RestClientException { - return getOauthProfileAccessLevelGroupWithHttpInfo(oauthProfileName, groupName, opaquePassword, select).getBody(); - } - - /** - * Get a Group Access Level object. - * Get a Group Access Level object. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Group Access Level object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileAccessLevelGroupWithHttpInfo(String oauthProfileName, String groupName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileAccessLevelGroup"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling getOauthProfileAccessLevelGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Message VPN Access-Level Exception object. - * Get a Message VPN Access-Level Exception object. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse getOauthProfileAccessLevelGroupMsgVpnAccessLevelException(String oauthProfileName, String groupName, String msgVpnName, String opaquePassword, List select) throws RestClientException { - return getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, groupName, msgVpnName, opaquePassword, select).getBody(); - } - - /** - * Get a Message VPN Access-Level Exception object. - * Get a Message VPN Access-Level Exception object. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String groupName, String msgVpnName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling getOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Message VPN Access-Level Exception objects. - * Get a list of Message VPN Access-Level Exception objects. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Message VPN Access-Level Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions(String oauthProfileName, String groupName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsWithHttpInfo(oauthProfileName, groupName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Message VPN Access-Level Exception objects. - * Get a list of Message VPN Access-Level Exception objects. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Message VPN Access-Level Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsWithHttpInfo(String oauthProfileName, String groupName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Group Access Level objects. - * Get a list of Group Access Level objects. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Group Access Level objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupsResponse getOauthProfileAccessLevelGroups(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getOauthProfileAccessLevelGroupsWithHttpInfo(oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Group Access Level objects. - * Get a list of Group Access Level objects. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Group Access Level objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileAccessLevelGroupsWithHttpInfo(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileAccessLevelGroups"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an Allowed Host Value object. - * Get an Allowed Host Value object. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowedHost|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Allowed Host Value object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param allowedHost An allowed value for the Host header. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientAllowedHostResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientAllowedHostResponse getOauthProfileClientAllowedHost(String oauthProfileName, String allowedHost, String opaquePassword, List select) throws RestClientException { - return getOauthProfileClientAllowedHostWithHttpInfo(oauthProfileName, allowedHost, opaquePassword, select).getBody(); - } - - /** - * Get an Allowed Host Value object. - * Get an Allowed Host Value object. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowedHost|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Allowed Host Value object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param allowedHost An allowed value for the Host header. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientAllowedHostResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileClientAllowedHostWithHttpInfo(String oauthProfileName, String allowedHost, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileClientAllowedHost"); - } - - // verify the required parameter 'allowedHost' is set - if (allowedHost == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'allowedHost' when calling getOauthProfileClientAllowedHost"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("allowedHost", allowedHost); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Allowed Host Value objects. - * Get a list of Allowed Host Value objects. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowedHost|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Allowed Host Value objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientAllowedHostsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientAllowedHostsResponse getOauthProfileClientAllowedHosts(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getOauthProfileClientAllowedHostsWithHttpInfo(oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Allowed Host Value objects. - * Get a list of Allowed Host Value objects. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowedHost|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Allowed Host Value objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientAllowedHostsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileClientAllowedHostsWithHttpInfo(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileClientAllowedHosts"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAllowedHosts", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get an Authorization Parameter object. - * Get an Authorization Parameter object. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationParameterName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Authorization Parameter object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param authorizationParameterName The name of the authorization parameter. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientAuthorizationParameterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientAuthorizationParameterResponse getOauthProfileClientAuthorizationParameter(String oauthProfileName, String authorizationParameterName, String opaquePassword, List select) throws RestClientException { - return getOauthProfileClientAuthorizationParameterWithHttpInfo(oauthProfileName, authorizationParameterName, opaquePassword, select).getBody(); - } - - /** - * Get an Authorization Parameter object. - * Get an Authorization Parameter object. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationParameterName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Authorization Parameter object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param authorizationParameterName The name of the authorization parameter. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientAuthorizationParameterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileClientAuthorizationParameterWithHttpInfo(String oauthProfileName, String authorizationParameterName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileClientAuthorizationParameter"); - } - - // verify the required parameter 'authorizationParameterName' is set - if (authorizationParameterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationParameterName' when calling getOauthProfileClientAuthorizationParameter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("authorizationParameterName", authorizationParameterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Authorization Parameter objects. - * Get a list of Authorization Parameter objects. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationParameterName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Authorization Parameter objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientAuthorizationParametersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientAuthorizationParametersResponse getOauthProfileClientAuthorizationParameters(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getOauthProfileClientAuthorizationParametersWithHttpInfo(oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Authorization Parameter objects. - * Get a list of Authorization Parameter objects. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationParameterName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Authorization Parameter objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientAuthorizationParametersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileClientAuthorizationParametersWithHttpInfo(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileClientAuthorizationParameters"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientRequiredClaimResponse getOauthProfileClientRequiredClaim(String oauthProfileName, String clientRequiredClaimName, String opaquePassword, List select) throws RestClientException { - return getOauthProfileClientRequiredClaimWithHttpInfo(oauthProfileName, clientRequiredClaimName, opaquePassword, select).getBody(); - } - - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param clientRequiredClaimName The name of the ID token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileClientRequiredClaimWithHttpInfo(String oauthProfileName, String clientRequiredClaimName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileClientRequiredClaim"); - } - - // verify the required parameter 'clientRequiredClaimName' is set - if (clientRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'clientRequiredClaimName' when calling getOauthProfileClientRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("clientRequiredClaimName", clientRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientRequiredClaimsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientRequiredClaimsResponse getOauthProfileClientRequiredClaims(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getOauthProfileClientRequiredClaimsWithHttpInfo(oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientRequiredClaimsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileClientRequiredClaimsWithHttpInfo(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileClientRequiredClaims"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientRequiredClaims", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Message VPN Access-Level Exception object. - * Get a Message VPN Access-Level Exception object. Default message VPN access-level exceptions. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileDefaultMsgVpnAccessLevelExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileDefaultMsgVpnAccessLevelExceptionResponse getOauthProfileDefaultMsgVpnAccessLevelException(String oauthProfileName, String msgVpnName, String opaquePassword, List select) throws RestClientException { - return getOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, msgVpnName, opaquePassword, select).getBody(); - } - - /** - * Get a Message VPN Access-Level Exception object. - * Get a Message VPN Access-Level Exception object. Default message VPN access-level exceptions. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileDefaultMsgVpnAccessLevelExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String msgVpnName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Message VPN Access-Level Exception objects. - * Get a list of Message VPN Access-Level Exception objects. Default message VPN access-level exceptions. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Message VPN Access-Level Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse getOauthProfileDefaultMsgVpnAccessLevelExceptions(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getOauthProfileDefaultMsgVpnAccessLevelExceptionsWithHttpInfo(oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Message VPN Access-Level Exception objects. - * Get a list of Message VPN Access-Level Exception objects. Default message VPN access-level exceptions. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Message VPN Access-Level Exception objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileDefaultMsgVpnAccessLevelExceptionsWithHttpInfo(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileDefaultMsgVpnAccessLevelExceptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileResourceServerRequiredClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileResourceServerRequiredClaimResponse getOauthProfileResourceServerRequiredClaim(String oauthProfileName, String resourceServerRequiredClaimName, String opaquePassword, List select) throws RestClientException { - return getOauthProfileResourceServerRequiredClaimWithHttpInfo(oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select).getBody(); - } - - /** - * Get a Required Claim object. - * Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The Required Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param resourceServerRequiredClaimName The name of the access token claim to verify. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileResourceServerRequiredClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileResourceServerRequiredClaimWithHttpInfo(String oauthProfileName, String resourceServerRequiredClaimName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileResourceServerRequiredClaim"); - } - - // verify the required parameter 'resourceServerRequiredClaimName' is set - if (resourceServerRequiredClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'resourceServerRequiredClaimName' when calling getOauthProfileResourceServerRequiredClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("resourceServerRequiredClaimName", resourceServerRequiredClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileResourceServerRequiredClaimsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileResourceServerRequiredClaimsResponse getOauthProfileResourceServerRequiredClaims(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getOauthProfileResourceServerRequiredClaimsWithHttpInfo(oauthProfileName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Required Claim objects. - * Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of Required Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileResourceServerRequiredClaimsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfileResourceServerRequiredClaimsWithHttpInfo(String oauthProfileName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling getOauthProfileResourceServerRequiredClaims"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of OAuth Profile objects. - * Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of OAuth Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfilesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfilesResponse getOauthProfiles(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getOauthProfilesWithHttpInfo(count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of OAuth Profile objects. - * Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - *

200 - The list of OAuth Profile objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfilesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getOauthProfilesWithHttpInfo(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an OAuth Profile object. - * Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: accessLevelGroupsClaimName|global/admin clientId|global/admin clientRedirectUri|global/admin clientRequiredType|global/admin clientScope|global/admin clientSecret|global/admin clientValidateTypeEnabled|global/admin defaultGlobalAccessLevel|global/admin displayName|global/admin enabled|global/admin endpointAuthorization|global/admin endpointDiscovery|global/admin endpointDiscoveryRefreshInterval|global/admin endpointIntrospection|global/admin endpointIntrospectionTimeout|global/admin endpointJwks|global/admin endpointJwksRefreshInterval|global/admin endpointToken|global/admin endpointTokenTimeout|global/admin endpointUserinfo|global/admin endpointUserinfoTimeout|global/admin interactiveEnabled|global/admin interactivePromptForExpiredSession|global/admin interactivePromptForNewSession|global/admin issuer|global/admin oauthRole|global/admin resourceServerParseAccessTokenEnabled|global/admin resourceServerRequiredAudience|global/admin resourceServerRequiredIssuer|global/admin resourceServerRequiredScope|global/admin resourceServerRequiredType|global/admin resourceServerValidateAudienceEnabled|global/admin resourceServerValidateIssuerEnabled|global/admin resourceServerValidateScopeEnabled|global/admin resourceServerValidateTypeEnabled|global/admin sempEnabled|global/admin usernameClaimName|global/admin This has been available since 2.24. - *

200 - The OAuth Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileResponse replaceOauthProfile(String oauthProfileName, OauthProfile body, String opaquePassword, List select) throws RestClientException { - return replaceOauthProfileWithHttpInfo(oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an OAuth Profile object. - * Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: accessLevelGroupsClaimName|global/admin clientId|global/admin clientRedirectUri|global/admin clientRequiredType|global/admin clientScope|global/admin clientSecret|global/admin clientValidateTypeEnabled|global/admin defaultGlobalAccessLevel|global/admin displayName|global/admin enabled|global/admin endpointAuthorization|global/admin endpointDiscovery|global/admin endpointDiscoveryRefreshInterval|global/admin endpointIntrospection|global/admin endpointIntrospectionTimeout|global/admin endpointJwks|global/admin endpointJwksRefreshInterval|global/admin endpointToken|global/admin endpointTokenTimeout|global/admin endpointUserinfo|global/admin endpointUserinfoTimeout|global/admin interactiveEnabled|global/admin interactivePromptForExpiredSession|global/admin interactivePromptForNewSession|global/admin issuer|global/admin oauthRole|global/admin resourceServerParseAccessTokenEnabled|global/admin resourceServerRequiredAudience|global/admin resourceServerRequiredIssuer|global/admin resourceServerRequiredScope|global/admin resourceServerRequiredType|global/admin resourceServerValidateAudienceEnabled|global/admin resourceServerValidateIssuerEnabled|global/admin resourceServerValidateScopeEnabled|global/admin resourceServerValidateTypeEnabled|global/admin sempEnabled|global/admin usernameClaimName|global/admin This has been available since 2.24. - *

200 - The OAuth Profile object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceOauthProfileWithHttpInfo(String oauthProfileName, OauthProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling replaceOauthProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Group Access Level object. - * Replace a Group Access Level object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- groupName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - *

200 - The Group Access Level object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param body The Group Access Level object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupResponse replaceOauthProfileAccessLevelGroup(String oauthProfileName, String groupName, OauthProfileAccessLevelGroup body, String opaquePassword, List select) throws RestClientException { - return replaceOauthProfileAccessLevelGroupWithHttpInfo(oauthProfileName, groupName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Group Access Level object. - * Replace a Group Access Level object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- groupName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - *

200 - The Group Access Level object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param body The Group Access Level object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceOauthProfileAccessLevelGroupWithHttpInfo(String oauthProfileName, String groupName, OauthProfileAccessLevelGroup body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling replaceOauthProfileAccessLevelGroup"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling replaceOauthProfileAccessLevelGroup"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceOauthProfileAccessLevelGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Message VPN Access-Level Exception object. - * Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- groupName|x||x|||| msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException(String oauthProfileName, String groupName, String msgVpnName, OauthProfileAccessLevelGroupMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - return replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, groupName, msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Message VPN Access-Level Exception object. - * Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- groupName|x||x|||| msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String groupName, String msgVpnName, OauthProfileAccessLevelGroupMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace an Authorization Parameter object. - * Replace an Authorization Parameter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authorizationParameterName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Authorization Parameter object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param authorizationParameterName The name of the authorization parameter. (required) - * @param body The Authorization Parameter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientAuthorizationParameterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientAuthorizationParameterResponse replaceOauthProfileClientAuthorizationParameter(String oauthProfileName, String authorizationParameterName, OauthProfileClientAuthorizationParameter body, String opaquePassword, List select) throws RestClientException { - return replaceOauthProfileClientAuthorizationParameterWithHttpInfo(oauthProfileName, authorizationParameterName, body, opaquePassword, select).getBody(); - } - - /** - * Replace an Authorization Parameter object. - * Replace an Authorization Parameter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authorizationParameterName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Authorization Parameter object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param authorizationParameterName The name of the authorization parameter. (required) - * @param body The Authorization Parameter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientAuthorizationParameterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceOauthProfileClientAuthorizationParameterWithHttpInfo(String oauthProfileName, String authorizationParameterName, OauthProfileClientAuthorizationParameter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling replaceOauthProfileClientAuthorizationParameter"); - } - - // verify the required parameter 'authorizationParameterName' is set - if (authorizationParameterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationParameterName' when calling replaceOauthProfileClientAuthorizationParameter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceOauthProfileClientAuthorizationParameter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("authorizationParameterName", authorizationParameterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Message VPN Access-Level Exception object. - * Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Default message VPN access-level exceptions. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileDefaultMsgVpnAccessLevelExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileDefaultMsgVpnAccessLevelExceptionResponse replaceOauthProfileDefaultMsgVpnAccessLevelException(String oauthProfileName, String msgVpnName, OauthProfileDefaultMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - return replaceOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Message VPN Access-Level Exception object. - * Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Default message VPN access-level exceptions. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileDefaultMsgVpnAccessLevelExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String msgVpnName, OauthProfileDefaultMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling replaceOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an OAuth Profile object. - * Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: accessLevelGroupsClaimName|global/admin clientId|global/admin clientRedirectUri|global/admin clientRequiredType|global/admin clientScope|global/admin clientSecret|global/admin clientValidateTypeEnabled|global/admin defaultGlobalAccessLevel|global/admin displayName|global/admin enabled|global/admin endpointAuthorization|global/admin endpointDiscovery|global/admin endpointDiscoveryRefreshInterval|global/admin endpointIntrospection|global/admin endpointIntrospectionTimeout|global/admin endpointJwks|global/admin endpointJwksRefreshInterval|global/admin endpointToken|global/admin endpointTokenTimeout|global/admin endpointUserinfo|global/admin endpointUserinfoTimeout|global/admin interactiveEnabled|global/admin interactivePromptForExpiredSession|global/admin interactivePromptForNewSession|global/admin issuer|global/admin oauthRole|global/admin resourceServerParseAccessTokenEnabled|global/admin resourceServerRequiredAudience|global/admin resourceServerRequiredIssuer|global/admin resourceServerRequiredScope|global/admin resourceServerRequiredType|global/admin resourceServerValidateAudienceEnabled|global/admin resourceServerValidateIssuerEnabled|global/admin resourceServerValidateScopeEnabled|global/admin resourceServerValidateTypeEnabled|global/admin sempEnabled|global/admin usernameClaimName|global/admin This has been available since 2.24. - *

200 - The OAuth Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileResponse updateOauthProfile(String oauthProfileName, OauthProfile body, String opaquePassword, List select) throws RestClientException { - return updateOauthProfileWithHttpInfo(oauthProfileName, body, opaquePassword, select).getBody(); - } - - /** - * Update an OAuth Profile object. - * Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: accessLevelGroupsClaimName|global/admin clientId|global/admin clientRedirectUri|global/admin clientRequiredType|global/admin clientScope|global/admin clientSecret|global/admin clientValidateTypeEnabled|global/admin defaultGlobalAccessLevel|global/admin displayName|global/admin enabled|global/admin endpointAuthorization|global/admin endpointDiscovery|global/admin endpointDiscoveryRefreshInterval|global/admin endpointIntrospection|global/admin endpointIntrospectionTimeout|global/admin endpointJwks|global/admin endpointJwksRefreshInterval|global/admin endpointToken|global/admin endpointTokenTimeout|global/admin endpointUserinfo|global/admin endpointUserinfoTimeout|global/admin interactiveEnabled|global/admin interactivePromptForExpiredSession|global/admin interactivePromptForNewSession|global/admin issuer|global/admin oauthRole|global/admin resourceServerParseAccessTokenEnabled|global/admin resourceServerRequiredAudience|global/admin resourceServerRequiredIssuer|global/admin resourceServerRequiredScope|global/admin resourceServerRequiredType|global/admin resourceServerValidateAudienceEnabled|global/admin resourceServerValidateIssuerEnabled|global/admin resourceServerValidateScopeEnabled|global/admin resourceServerValidateTypeEnabled|global/admin sempEnabled|global/admin usernameClaimName|global/admin This has been available since 2.24. - *

200 - The OAuth Profile object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param body The OAuth Profile object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateOauthProfileWithHttpInfo(String oauthProfileName, OauthProfile body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling updateOauthProfile"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateOauthProfile"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Group Access Level object. - * Update a Group Access Level object. Any attribute missing from the request will be left unchanged. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- groupName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - *

200 - The Group Access Level object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param body The Group Access Level object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupResponse updateOauthProfileAccessLevelGroup(String oauthProfileName, String groupName, OauthProfileAccessLevelGroup body, String opaquePassword, List select) throws RestClientException { - return updateOauthProfileAccessLevelGroupWithHttpInfo(oauthProfileName, groupName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Group Access Level object. - * Update a Group Access Level object. Any attribute missing from the request will be left unchanged. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- groupName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - *

200 - The Group Access Level object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param body The Group Access Level object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateOauthProfileAccessLevelGroupWithHttpInfo(String oauthProfileName, String groupName, OauthProfileAccessLevelGroup body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling updateOauthProfileAccessLevelGroup"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling updateOauthProfileAccessLevelGroup"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateOauthProfileAccessLevelGroup"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Message VPN Access-Level Exception object. - * Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- groupName|x|x|||| msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException(String oauthProfileName, String groupName, String msgVpnName, OauthProfileAccessLevelGroupMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - return updateOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, groupName, msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Message VPN Access-Level Exception object. - * Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- groupName|x|x|||| msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param groupName The name of the group. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String groupName, String msgVpnName, OauthProfileAccessLevelGroupMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'groupName' is set - if (groupName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'groupName' when calling updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("groupName", groupName); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update an Authorization Parameter object. - * Update an Authorization Parameter object. Any attribute missing from the request will be left unchanged. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authorizationParameterName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Authorization Parameter object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param authorizationParameterName The name of the authorization parameter. (required) - * @param body The Authorization Parameter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileClientAuthorizationParameterResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileClientAuthorizationParameterResponse updateOauthProfileClientAuthorizationParameter(String oauthProfileName, String authorizationParameterName, OauthProfileClientAuthorizationParameter body, String opaquePassword, List select) throws RestClientException { - return updateOauthProfileClientAuthorizationParameterWithHttpInfo(oauthProfileName, authorizationParameterName, body, opaquePassword, select).getBody(); - } - - /** - * Update an Authorization Parameter object. - * Update an Authorization Parameter object. Any attribute missing from the request will be left unchanged. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authorizationParameterName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - *

200 - The Authorization Parameter object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param authorizationParameterName The name of the authorization parameter. (required) - * @param body The Authorization Parameter object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileClientAuthorizationParameterResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateOauthProfileClientAuthorizationParameterWithHttpInfo(String oauthProfileName, String authorizationParameterName, OauthProfileClientAuthorizationParameter body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling updateOauthProfileClientAuthorizationParameter"); - } - - // verify the required parameter 'authorizationParameterName' is set - if (authorizationParameterName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'authorizationParameterName' when calling updateOauthProfileClientAuthorizationParameter"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateOauthProfileClientAuthorizationParameter"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("authorizationParameterName", authorizationParameterName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Message VPN Access-Level Exception object. - * Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. Default message VPN access-level exceptions. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return OauthProfileDefaultMsgVpnAccessLevelExceptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public OauthProfileDefaultMsgVpnAccessLevelExceptionResponse updateOauthProfileDefaultMsgVpnAccessLevelException(String oauthProfileName, String msgVpnName, OauthProfileDefaultMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - return updateOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(oauthProfileName, msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Message VPN Access-Level Exception object. - * Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. Default message VPN access-level exceptions. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - *

200 - The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param oauthProfileName The name of the OAuth profile. (required) - * @param msgVpnName The name of the message VPN. (required) - * @param body The Message VPN Access-Level Exception object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<OauthProfileDefaultMsgVpnAccessLevelExceptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateOauthProfileDefaultMsgVpnAccessLevelExceptionWithHttpInfo(String oauthProfileName, String msgVpnName, OauthProfileDefaultMsgVpnAccessLevelException body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'oauthProfileName' is set - if (oauthProfileName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthProfileName' when calling updateOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateOauthProfileDefaultMsgVpnAccessLevelException"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("oauthProfileName", oauthProfileName); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/QueueApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/QueueApi.java deleted file mode 100644 index 133ced43b..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/QueueApi.java +++ /dev/null @@ -1,754 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueuesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class QueueApi { - private ApiClient apiClient; - - public QueueApi() { - this(new ApiClient()); - } - - public QueueApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Queue object. - * Create a Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueResponse createMsgVpnQueue(String msgVpnName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnQueueWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Queue object. - * Create a Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnQueueWithHttpInfo(String msgVpnName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Queue Subscription object. - * Create a Queue Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueSubscriptionResponse createMsgVpnQueueSubscription(String msgVpnName, String queueName, MsgVpnQueueSubscription body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnQueueSubscriptionWithHttpInfo(msgVpnName, queueName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Queue Subscription object. - * Create a Queue Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnQueueSubscriptionWithHttpInfo(String msgVpnName, String queueName, MsgVpnQueueSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnQueueSubscription"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling createMsgVpnQueueSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnQueueSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Queue object. - * Delete a Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnQueue(String msgVpnName, String queueName) throws RestClientException { - return deleteMsgVpnQueueWithHttpInfo(msgVpnName, queueName).getBody(); - } - - /** - * Delete a Queue object. - * Delete a Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnQueueWithHttpInfo(String msgVpnName, String queueName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling deleteMsgVpnQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Queue Subscription object. - * Delete a Queue Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param subscriptionTopic The topic of the Subscription. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnQueueSubscription(String msgVpnName, String queueName, String subscriptionTopic) throws RestClientException { - return deleteMsgVpnQueueSubscriptionWithHttpInfo(msgVpnName, queueName, subscriptionTopic).getBody(); - } - - /** - * Delete a Queue Subscription object. - * Delete a Queue Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param subscriptionTopic The topic of the Subscription. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnQueueSubscriptionWithHttpInfo(String msgVpnName, String queueName, String subscriptionTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnQueueSubscription"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling deleteMsgVpnQueueSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling deleteMsgVpnQueueSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Queue object. - * Get a Queue object. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueResponse getMsgVpnQueue(String msgVpnName, String queueName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnQueueWithHttpInfo(msgVpnName, queueName, opaquePassword, select).getBody(); - } - - /** - * Get a Queue object. - * Get a Queue object. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueueWithHttpInfo(String msgVpnName, String queueName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling getMsgVpnQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Queue Subscription object. - * Get a Queue Subscription object. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param subscriptionTopic The topic of the Subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueSubscriptionResponse getMsgVpnQueueSubscription(String msgVpnName, String queueName, String subscriptionTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnQueueSubscriptionWithHttpInfo(msgVpnName, queueName, subscriptionTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Queue Subscription object. - * Get a Queue Subscription object. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param subscriptionTopic The topic of the Subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueueSubscriptionWithHttpInfo(String msgVpnName, String queueName, String subscriptionTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueueSubscription"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling getMsgVpnQueueSubscription"); - } - - // verify the required parameter 'subscriptionTopic' is set - if (subscriptionTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'subscriptionTopic' when calling getMsgVpnQueueSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - uriVariables.put("subscriptionTopic", subscriptionTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Queue Subscription objects. - * Get a list of Queue Subscription objects. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueSubscriptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueSubscriptionsResponse getMsgVpnQueueSubscriptions(String msgVpnName, String queueName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnQueueSubscriptionsWithHttpInfo(msgVpnName, queueName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Queue Subscription objects. - * Get a list of Queue Subscription objects. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueSubscriptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueueSubscriptionsWithHttpInfo(String msgVpnName, String queueName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueueSubscriptions"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling getMsgVpnQueueSubscriptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Queue objects. - * Get a list of Queue objects. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueuesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueuesResponse getMsgVpnQueues(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnQueuesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Queue objects. - * Get a list of Queue objects. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueuesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueuesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueues"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Queue object. - * Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| queueName|x||x|||| respectMsgPriorityEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueResponse replaceMsgVpnQueue(String msgVpnName, String queueName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnQueueWithHttpInfo(msgVpnName, queueName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Queue object. - * Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| queueName|x||x|||| respectMsgPriorityEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnQueueWithHttpInfo(String msgVpnName, String queueName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling replaceMsgVpnQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Queue object. - * Update a Queue object. Any attribute missing from the request will be left unchanged. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| queueName|x|x|||| respectMsgPriorityEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueResponse updateMsgVpnQueue(String msgVpnName, String queueName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnQueueWithHttpInfo(msgVpnName, queueName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Queue object. - * Update a Queue object. Any attribute missing from the request will be left unchanged. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| queueName|x|x|||| respectMsgPriorityEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueName The name of the Queue. (required) - * @param body The Queue object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnQueueWithHttpInfo(String msgVpnName, String queueName, MsgVpnQueue body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnQueue"); - } - - // verify the required parameter 'queueName' is set - if (queueName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueName' when calling updateMsgVpnQueue"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnQueue"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueName", queueName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queues/{queueName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/QueueTemplateApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/QueueTemplateApi.java deleted file mode 100644 index 6e0f47a32..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/QueueTemplateApi.java +++ /dev/null @@ -1,460 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplateResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplatesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class QueueTemplateApi { - private ApiClient apiClient; - - public QueueTemplateApi() { - this(new ApiClient()); - } - - public QueueTemplateApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Queue Template object. - * Create a Queue Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueTemplateResponse createMsgVpnQueueTemplate(String msgVpnName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnQueueTemplateWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Queue Template object. - * Create a Queue Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnQueueTemplateWithHttpInfo(String msgVpnName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnQueueTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnQueueTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Queue Template object. - * Delete a Queue Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnQueueTemplate(String msgVpnName, String queueTemplateName) throws RestClientException { - return deleteMsgVpnQueueTemplateWithHttpInfo(msgVpnName, queueTemplateName).getBody(); - } - - /** - * Delete a Queue Template object. - * Delete a Queue Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnQueueTemplateWithHttpInfo(String msgVpnName, String queueTemplateName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnQueueTemplate"); - } - - // verify the required parameter 'queueTemplateName' is set - if (queueTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueTemplateName' when calling deleteMsgVpnQueueTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueTemplateName", queueTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Queue Template object. - * Get a Queue Template object. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueTemplateResponse getMsgVpnQueueTemplate(String msgVpnName, String queueTemplateName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnQueueTemplateWithHttpInfo(msgVpnName, queueTemplateName, opaquePassword, select).getBody(); - } - - /** - * Get a Queue Template object. - * Get a Queue Template object. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueueTemplateWithHttpInfo(String msgVpnName, String queueTemplateName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueueTemplate"); - } - - // verify the required parameter 'queueTemplateName' is set - if (queueTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueTemplateName' when calling getMsgVpnQueueTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueTemplateName", queueTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Queue Template objects. - * Get a list of Queue Template objects. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Queue Template objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueTemplatesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueTemplatesResponse getMsgVpnQueueTemplates(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnQueueTemplatesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Queue Template objects. - * Get a list of Queue Template objects. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Queue Template objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueTemplatesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnQueueTemplatesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnQueueTemplates"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Queue Template object. - * Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueTemplateResponse replaceMsgVpnQueueTemplate(String msgVpnName, String queueTemplateName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnQueueTemplateWithHttpInfo(msgVpnName, queueTemplateName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Queue Template object. - * Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnQueueTemplateWithHttpInfo(String msgVpnName, String queueTemplateName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnQueueTemplate"); - } - - // verify the required parameter 'queueTemplateName' is set - if (queueTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueTemplateName' when calling replaceMsgVpnQueueTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnQueueTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueTemplateName", queueTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Queue Template object. - * Update a Queue Template object. Any attribute missing from the request will be left unchanged. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnQueueTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnQueueTemplateResponse updateMsgVpnQueueTemplate(String msgVpnName, String queueTemplateName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnQueueTemplateWithHttpInfo(msgVpnName, queueTemplateName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Queue Template object. - * Update a Queue Template object. Any attribute missing from the request will be left unchanged. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Queue Template object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param queueTemplateName The name of the Queue Template. (required) - * @param body The Queue Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnQueueTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnQueueTemplateWithHttpInfo(String msgVpnName, String queueTemplateName, MsgVpnQueueTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnQueueTemplate"); - } - - // verify the required parameter 'queueTemplateName' is set - if (queueTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueTemplateName' when calling updateMsgVpnQueueTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnQueueTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("queueTemplateName", queueTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ReplayLogApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ReplayLogApi.java deleted file mode 100644 index aab00e1d2..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ReplayLogApi.java +++ /dev/null @@ -1,754 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLog; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class ReplayLogApi { - private ApiClient apiClient; - - public ReplayLogApi() { - this(new ApiClient()); - } - - public ReplayLogApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Replay Log object. - * Create a Replay Log object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogResponse createMsgVpnReplayLog(String msgVpnName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnReplayLogWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Replay Log object. - * Create a Replay Log object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnReplayLogWithHttpInfo(String msgVpnName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnReplayLog"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnReplayLog"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Topic Filter Subscription object. - * Create a Topic Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x||x||| topicFilterSubscription|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Topic Filter Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Topic Filter Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogTopicFilterSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogTopicFilterSubscriptionResponse createMsgVpnReplayLogTopicFilterSubscription(String msgVpnName, String replayLogName, MsgVpnReplayLogTopicFilterSubscription body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(msgVpnName, replayLogName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Topic Filter Subscription object. - * Create a Topic Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x||x||| topicFilterSubscription|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The Topic Filter Subscription object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Topic Filter Subscription object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogTopicFilterSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(String msgVpnName, String replayLogName, MsgVpnReplayLogTopicFilterSubscription body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling createMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnReplayLogTopicFilterSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Replay Log object. - * Delete a Replay Log object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnReplayLog(String msgVpnName, String replayLogName) throws RestClientException { - return deleteMsgVpnReplayLogWithHttpInfo(msgVpnName, replayLogName).getBody(); - } - - /** - * Delete a Replay Log object. - * Delete a Replay Log object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnReplayLogWithHttpInfo(String msgVpnName, String replayLogName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnReplayLog"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling deleteMsgVpnReplayLog"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Topic Filter Subscription object. - * Delete a Topic Filter Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param topicFilterSubscription The topic of the Subscription. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnReplayLogTopicFilterSubscription(String msgVpnName, String replayLogName, String topicFilterSubscription) throws RestClientException { - return deleteMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(msgVpnName, replayLogName, topicFilterSubscription).getBody(); - } - - /** - * Delete a Topic Filter Subscription object. - * Delete a Topic Filter Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param topicFilterSubscription The topic of the Subscription. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(String msgVpnName, String replayLogName, String topicFilterSubscription) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling deleteMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'topicFilterSubscription' is set - if (topicFilterSubscription == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicFilterSubscription' when calling deleteMsgVpnReplayLogTopicFilterSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - uriVariables.put("topicFilterSubscription", topicFilterSubscription); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Replay Log object. - * Get a Replay Log object. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogResponse getMsgVpnReplayLog(String msgVpnName, String replayLogName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnReplayLogWithHttpInfo(msgVpnName, replayLogName, opaquePassword, select).getBody(); - } - - /** - * Get a Replay Log object. - * Get a Replay Log object. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplayLogWithHttpInfo(String msgVpnName, String replayLogName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplayLog"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling getMsgVpnReplayLog"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Topic Filter Subscription object. - * Get a Topic Filter Subscription object. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Topic Filter Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param topicFilterSubscription The topic of the Subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogTopicFilterSubscriptionResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogTopicFilterSubscriptionResponse getMsgVpnReplayLogTopicFilterSubscription(String msgVpnName, String replayLogName, String topicFilterSubscription, String opaquePassword, List select) throws RestClientException { - return getMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(msgVpnName, replayLogName, topicFilterSubscription, opaquePassword, select).getBody(); - } - - /** - * Get a Topic Filter Subscription object. - * Get a Topic Filter Subscription object. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The Topic Filter Subscription object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param topicFilterSubscription The topic of the Subscription. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogTopicFilterSubscriptionResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplayLogTopicFilterSubscriptionWithHttpInfo(String msgVpnName, String replayLogName, String topicFilterSubscription, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling getMsgVpnReplayLogTopicFilterSubscription"); - } - - // verify the required parameter 'topicFilterSubscription' is set - if (topicFilterSubscription == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicFilterSubscription' when calling getMsgVpnReplayLogTopicFilterSubscription"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - uriVariables.put("topicFilterSubscription", topicFilterSubscription); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Topic Filter Subscription objects. - * Get a list of Topic Filter Subscription objects. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Topic Filter Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogTopicFilterSubscriptionsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogTopicFilterSubscriptionsResponse getMsgVpnReplayLogTopicFilterSubscriptions(String msgVpnName, String replayLogName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnReplayLogTopicFilterSubscriptionsWithHttpInfo(msgVpnName, replayLogName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Topic Filter Subscription objects. - * Get a list of Topic Filter Subscription objects. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - *

200 - The list of Topic Filter Subscription objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogTopicFilterSubscriptionsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplayLogTopicFilterSubscriptionsWithHttpInfo(String msgVpnName, String replayLogName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplayLogTopicFilterSubscriptions"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling getMsgVpnReplayLogTopicFilterSubscriptions"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Replay Log objects. - * Get a list of Replay Log objects. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - *

200 - The list of Replay Log objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogsResponse getMsgVpnReplayLogs(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnReplayLogsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Replay Log objects. - * Get a list of Replay Log objects. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - *

200 - The list of Replay Log objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplayLogsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplayLogs"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Replay Log object. - * Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replayLogName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogResponse replaceMsgVpnReplayLog(String msgVpnName, String replayLogName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnReplayLogWithHttpInfo(msgVpnName, replayLogName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Replay Log object. - * Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replayLogName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnReplayLogWithHttpInfo(String msgVpnName, String replayLogName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnReplayLog"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling replaceMsgVpnReplayLog"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnReplayLog"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Replay Log object. - * Update a Replay Log object. Any attribute missing from the request will be left unchanged. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplayLogResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplayLogResponse updateMsgVpnReplayLog(String msgVpnName, String replayLogName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnReplayLogWithHttpInfo(msgVpnName, replayLogName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Replay Log object. - * Update a Replay Log object. Any attribute missing from the request will be left unchanged. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - *

200 - The Replay Log object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replayLogName The name of the Replay Log. (required) - * @param body The Replay Log object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplayLogResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnReplayLogWithHttpInfo(String msgVpnName, String replayLogName, MsgVpnReplayLog body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnReplayLog"); - } - - // verify the required parameter 'replayLogName' is set - if (replayLogName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replayLogName' when calling updateMsgVpnReplayLog"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnReplayLog"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replayLogName", replayLogName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replayLogs/{replayLogName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ReplicatedTopicApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ReplicatedTopicApi.java deleted file mode 100644 index d31a781bc..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ReplicatedTopicApi.java +++ /dev/null @@ -1,460 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class ReplicatedTopicApi { - private ApiClient apiClient; - - public ReplicatedTopicApi() { - this(new ApiClient()); - } - - public ReplicatedTopicApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Replicated Topic object. - * Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplicatedTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplicatedTopicResponse createMsgVpnReplicatedTopic(String msgVpnName, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnReplicatedTopicWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Replicated Topic object. - * Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplicatedTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnReplicatedTopicWithHttpInfo(String msgVpnName, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnReplicatedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Replicated Topic object. - * Delete a Replicated Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnReplicatedTopic(String msgVpnName, String replicatedTopic) throws RestClientException { - return deleteMsgVpnReplicatedTopicWithHttpInfo(msgVpnName, replicatedTopic).getBody(); - } - - /** - * Delete a Replicated Topic object. - * Delete a Replicated Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnReplicatedTopicWithHttpInfo(String msgVpnName, String replicatedTopic) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'replicatedTopic' is set - if (replicatedTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replicatedTopic' when calling deleteMsgVpnReplicatedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replicatedTopic", replicatedTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Replicated Topic object. - * Get a Replicated Topic object. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplicatedTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplicatedTopicResponse getMsgVpnReplicatedTopic(String msgVpnName, String replicatedTopic, String opaquePassword, List select) throws RestClientException { - return getMsgVpnReplicatedTopicWithHttpInfo(msgVpnName, replicatedTopic, opaquePassword, select).getBody(); - } - - /** - * Get a Replicated Topic object. - * Get a Replicated Topic object. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplicatedTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplicatedTopicWithHttpInfo(String msgVpnName, String replicatedTopic, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'replicatedTopic' is set - if (replicatedTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replicatedTopic' when calling getMsgVpnReplicatedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replicatedTopic", replicatedTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Replicated Topic objects. - * Get a list of Replicated Topic objects. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Replicated Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplicatedTopicsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplicatedTopicsResponse getMsgVpnReplicatedTopics(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnReplicatedTopicsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Replicated Topic objects. - * Get a list of Replicated Topic objects. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Replicated Topic objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplicatedTopicsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnReplicatedTopicsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnReplicatedTopics"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Replicated Topic object. - * Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replicatedTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplicatedTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplicatedTopicResponse replaceMsgVpnReplicatedTopic(String msgVpnName, String replicatedTopic, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnReplicatedTopicWithHttpInfo(msgVpnName, replicatedTopic, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Replicated Topic object. - * Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replicatedTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplicatedTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnReplicatedTopicWithHttpInfo(String msgVpnName, String replicatedTopic, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'replicatedTopic' is set - if (replicatedTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replicatedTopic' when calling replaceMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnReplicatedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replicatedTopic", replicatedTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Replicated Topic object. - * Update a Replicated Topic object. Any attribute missing from the request will be left unchanged. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnReplicatedTopicResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnReplicatedTopicResponse updateMsgVpnReplicatedTopic(String msgVpnName, String replicatedTopic, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnReplicatedTopicWithHttpInfo(msgVpnName, replicatedTopic, body, opaquePassword, select).getBody(); - } - - /** - * Update a Replicated Topic object. - * Update a Replicated Topic object. Any attribute missing from the request will be left unchanged. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Replicated Topic object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param replicatedTopic The topic for applying replication. Published messages matching this topic will be replicated to the standby site. (required) - * @param body The Replicated Topic object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnReplicatedTopicResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnReplicatedTopicWithHttpInfo(String msgVpnName, String replicatedTopic, MsgVpnReplicatedTopic body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'replicatedTopic' is set - if (replicatedTopic == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'replicatedTopic' when calling updateMsgVpnReplicatedTopic"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnReplicatedTopic"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("replicatedTopic", replicatedTopic); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/RestDeliveryPointApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/RestDeliveryPointApi.java deleted file mode 100644 index 1a5c3f08a..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/RestDeliveryPointApi.java +++ /dev/null @@ -1,2550 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBinding; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeader; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumer; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class RestDeliveryPointApi { - private ApiClient apiClient; - - public RestDeliveryPointApi() { - this(new ApiClient()); - } - - public RestDeliveryPointApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a REST Delivery Point object. - * Create a REST Delivery Point object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointResponse createMsgVpnRestDeliveryPoint(String msgVpnName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a REST Delivery Point object. - * Create a REST Delivery Point object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnRestDeliveryPointWithHttpInfo(String msgVpnName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Queue Binding object. - * Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueBindingName|x|x|||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingResponse createMsgVpnRestDeliveryPointQueueBinding(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(msgVpnName, restDeliveryPointName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Queue Binding object. - * Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueBindingName|x|x|||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling createMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPointQueueBinding"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Request Header object. - * Create a Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: headerName|x|x|||| msgVpnName|x||x||| queueBindingName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse createMsgVpnRestDeliveryPointQueueBindingRequestHeader(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Request Header object. - * Create a Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: headerName|x|x|||| msgVpnName|x||x||| queueBindingName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling createMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling createMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a REST Consumer object. - * Create a REST Consumer object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| authenticationHttpBasicPassword||||x||x authenticationHttpHeaderValue||||x||x authenticationOauthClientSecret||||x||x authenticationOauthJwtSecretKey||||x||x msgVpnName|x||x||| restConsumerName|x|x|||| restDeliveryPointName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerResponse createMsgVpnRestDeliveryPointRestConsumer(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(msgVpnName, restDeliveryPointName, body, opaquePassword, select).getBody(); - } - - /** - * Create a REST Consumer object. - * Create a REST Consumer object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| authenticationHttpBasicPassword||||x||x authenticationHttpHeaderValue||||x||x authenticationOauthClientSecret||||x||x authenticationOauthJwtSecretKey||||x||x msgVpnName|x||x||| restConsumerName|x|x|||| restDeliveryPointName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling createMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPointRestConsumer"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Claim object. - * Create a Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthJwtClaimName|x|x|||| oauthJwtClaimValue||x|||| restConsumerName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - *

200 - The Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Claim object. - * Create a Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthJwtClaimName|x|x|||| oauthJwtClaimValue||x|||| restConsumerName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - *

200 - The Claim object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The Claim object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Create a Trusted Common Name object. - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||x| restConsumerName|x||x||x| restDeliveryPointName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Trusted Common Name object. - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||x| restConsumerName|x||x||x| restDeliveryPointName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The Trusted Common Name object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a REST Delivery Point object. - * Delete a REST Delivery Point object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPoint(String msgVpnName, String restDeliveryPointName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointWithHttpInfo(msgVpnName, restDeliveryPointName).getBody(); - } - - /** - * Delete a REST Delivery Point object. - * Delete a REST Delivery Point object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnRestDeliveryPointWithHttpInfo(String msgVpnName, String restDeliveryPointName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Queue Binding object. - * Delete a Queue Binding object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointQueueBinding(String msgVpnName, String restDeliveryPointName, String queueBindingName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName).getBody(); - } - - /** - * Delete a Queue Binding object. - * Delete a Queue Binding object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling deleteMsgVpnRestDeliveryPointQueueBinding"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Request Header object. - * Delete a Request Header object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, headerName).getBody(); - } - - /** - * Delete a Request Header object. - * Delete a Request Header object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'headerName' is set - if (headerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'headerName' when calling deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - uriVariables.put("headerName", headerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a REST Consumer object. - * Delete a REST Consumer object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumer(String msgVpnName, String restDeliveryPointName, String restConsumerName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName).getBody(); - } - - /** - * Delete a REST Consumer object. - * Delete a REST Consumer object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling deleteMsgVpnRestDeliveryPointRestConsumer"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Claim object. - * Delete a Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param oauthJwtClaimName The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(String msgVpnName, String restDeliveryPointName, String restConsumerName, String oauthJwtClaimName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName).getBody(); - } - - /** - * Delete a Claim object. - * Delete a Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param oauthJwtClaimName The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String oauthJwtClaimName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'oauthJwtClaimName' is set - if (oauthJwtClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthJwtClaimName' when calling deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - uriVariables.put("oauthJwtClaimName", oauthJwtClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Trusted Common Name object. - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SempMetaOnlyResponse deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(String msgVpnName, String restDeliveryPointName, String restConsumerName, String tlsTrustedCommonName) throws RestClientException { - return deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName).getBody(); - } - - /** - * Delete a Trusted Common Name object. - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String tlsTrustedCommonName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'tlsTrustedCommonName' is set - if (tlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'tlsTrustedCommonName' when calling deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - uriVariables.put("tlsTrustedCommonName", tlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a REST Delivery Point object. - * Get a REST Delivery Point object. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointResponse getMsgVpnRestDeliveryPoint(String msgVpnName, String restDeliveryPointName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointWithHttpInfo(msgVpnName, restDeliveryPointName, opaquePassword, select).getBody(); - } - - /** - * Get a REST Delivery Point object. - * Get a REST Delivery Point object. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointWithHttpInfo(String msgVpnName, String restDeliveryPointName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Queue Binding object. - * Get a Queue Binding object. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingResponse getMsgVpnRestDeliveryPointQueueBinding(String msgVpnName, String restDeliveryPointName, String queueBindingName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, opaquePassword, select).getBody(); - } - - /** - * Get a Queue Binding object. - * Get a Queue Binding object. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling getMsgVpnRestDeliveryPointQueueBinding"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Request Header object. - * Get a Request Header object. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse getMsgVpnRestDeliveryPointQueueBindingRequestHeader(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, headerName, opaquePassword, select).getBody(); - } - - /** - * Get a Request Header object. - * Get a Request Header object. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'headerName' is set - if (headerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'headerName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - uriVariables.put("headerName", headerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Request Header objects. - * Get a list of Request Header objects. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - *

200 - The list of Request Header objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse getMsgVpnRestDeliveryPointQueueBindingRequestHeaders(String msgVpnName, String restDeliveryPointName, String queueBindingName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointQueueBindingRequestHeadersWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Request Header objects. - * Get a list of Request Header objects. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - *

200 - The list of Request Header objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointQueueBindingRequestHeadersWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeaders"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeaders"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling getMsgVpnRestDeliveryPointQueueBindingRequestHeaders"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Queue Binding objects. - * Get a list of Queue Binding objects. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue Binding objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingsResponse getMsgVpnRestDeliveryPointQueueBindings(String msgVpnName, String restDeliveryPointName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointQueueBindingsWithHttpInfo(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Queue Binding objects. - * Get a list of Queue Binding objects. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of Queue Binding objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointQueueBindingsWithHttpInfo(String msgVpnName, String restDeliveryPointName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointQueueBindings"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointQueueBindings"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a REST Consumer object. - * Get a REST Consumer object. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerResponse getMsgVpnRestDeliveryPointRestConsumer(String msgVpnName, String restDeliveryPointName, String restConsumerName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, select).getBody(); - } - - /** - * Get a REST Consumer object. - * Get a REST Consumer object. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling getMsgVpnRestDeliveryPointRestConsumer"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Claim object. - * Get a Claim object. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - *

200 - The Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param oauthJwtClaimName The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(String msgVpnName, String restDeliveryPointName, String restConsumerName, String oauthJwtClaimName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName, opaquePassword, select).getBody(); - } - - /** - * Get a Claim object. - * Get a Claim object. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - *

200 - The Claim object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param oauthJwtClaimName The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String oauthJwtClaimName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // verify the required parameter 'oauthJwtClaimName' is set - if (oauthJwtClaimName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'oauthJwtClaimName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - uriVariables.put("oauthJwtClaimName", oauthJwtClaimName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Claim objects. - * Get a list of Claim objects. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - *

200 - The list of Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims(String msgVpnName, String restDeliveryPointName, String restConsumerName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Claim objects. - * Get a list of Claim objects. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - *

200 - The list of Claim objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Trusted Common Name object. - * Get a Trusted Common Name object. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(String msgVpnName, String restDeliveryPointName, String restConsumerName, String tlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName, opaquePassword, select).getBody(); - } - - /** - * Get a Trusted Common Name object. - * Get a Trusted Common Name object. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The Trusted Common Name object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param tlsTrustedCommonName The expected trusted common name of the remote certificate. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String tlsTrustedCommonName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // verify the required parameter 'tlsTrustedCommonName' is set - if (tlsTrustedCommonName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'tlsTrustedCommonName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - uriVariables.put("tlsTrustedCommonName", tlsTrustedCommonName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Trusted Common Name objects. - * Get a list of Trusted Common Name objects. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The list of Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames(String msgVpnName, String restDeliveryPointName, String restConsumerName, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Trusted Common Name objects. - * Get a list of Trusted Common Name objects. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - *

200 - The list of Trusted Common Name objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of REST Consumer objects. - * Get a list of REST Consumer objects. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of REST Consumer objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumersResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumersResponse getMsgVpnRestDeliveryPointRestConsumers(String msgVpnName, String restDeliveryPointName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointRestConsumersWithHttpInfo(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of REST Consumer objects. - * Get a list of REST Consumer objects. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of REST Consumer objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumersResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointRestConsumersWithHttpInfo(String msgVpnName, String restDeliveryPointName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPointRestConsumers"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling getMsgVpnRestDeliveryPointRestConsumers"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of REST Delivery Point objects. - * Get a list of REST Delivery Point objects. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of REST Delivery Point objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointsResponse getMsgVpnRestDeliveryPoints(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnRestDeliveryPointsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of REST Delivery Point objects. - * Get a list of REST Delivery Point objects. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - *

200 - The list of REST Delivery Point objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnRestDeliveryPointsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnRestDeliveryPoints"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a REST Delivery Point object. - * Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientProfileName|||||x|| msgVpnName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointResponse replaceMsgVpnRestDeliveryPoint(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnRestDeliveryPointWithHttpInfo(msgVpnName, restDeliveryPointName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a REST Delivery Point object. - * Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientProfileName|||||x|| msgVpnName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnRestDeliveryPointWithHttpInfo(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling replaceMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnRestDeliveryPoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Queue Binding object. - * Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingResponse replaceMsgVpnRestDeliveryPointQueueBinding(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Queue Binding object. - * Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling replaceMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling replaceMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnRestDeliveryPointQueueBinding"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Request Header object. - * Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A request header to be added to the HTTP request. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- headerName|x||x|||| msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Request Header object. - * Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A request header to be added to the HTTP request. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- headerName|x||x|||| msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'headerName' is set - if (headerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'headerName' when calling replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - uriVariables.put("headerName", headerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a REST Consumer object. - * Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey||||x|||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| authenticationHttpBasicPassword||||x|x||x authenticationHttpBasicUsername|||||x|| authenticationHttpHeaderValue||||x|||x authenticationOauthClientId|||||x|| authenticationOauthClientScope|||||x|| authenticationOauthClientSecret||||x|x||x authenticationOauthClientTokenEndpoint|||||x|| authenticationOauthJwtSecretKey||||x|x||x authenticationOauthJwtTokenEndpoint|||||x|| authenticationScheme|||||x|| msgVpnName|x||x|||| outgoingConnectionCount|||||x|| remoteHost|||||x|| remotePort|||||x|| restConsumerName|x||x|||| restDeliveryPointName|x||x|||| tlsCipherSuiteList|||||x|| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerResponse replaceMsgVpnRestDeliveryPointRestConsumer(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a REST Consumer object. - * Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey||||x|||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| authenticationHttpBasicPassword||||x|x||x authenticationHttpBasicUsername|||||x|| authenticationHttpHeaderValue||||x|||x authenticationOauthClientId|||||x|| authenticationOauthClientScope|||||x|| authenticationOauthClientSecret||||x|x||x authenticationOauthClientTokenEndpoint|||||x|| authenticationOauthJwtSecretKey||||x|x||x authenticationOauthJwtTokenEndpoint|||||x|| authenticationScheme|||||x|| msgVpnName|x||x|||| outgoingConnectionCount|||||x|| remoteHost|||||x|| remotePort|||||x|| restConsumerName|x||x|||| restDeliveryPointName|x||x|||| tlsCipherSuiteList|||||x|| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling replaceMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling replaceMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnRestDeliveryPointRestConsumer"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a REST Delivery Point object. - * Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientProfileName||||x|| msgVpnName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointResponse updateMsgVpnRestDeliveryPoint(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnRestDeliveryPointWithHttpInfo(msgVpnName, restDeliveryPointName, body, opaquePassword, select).getBody(); - } - - /** - * Update a REST Delivery Point object. - * Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientProfileName||||x|| msgVpnName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Delivery Point object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param body The REST Delivery Point object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnRestDeliveryPointWithHttpInfo(String msgVpnName, String restDeliveryPointName, MsgVpnRestDeliveryPoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling updateMsgVpnRestDeliveryPoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnRestDeliveryPoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Queue Binding object. - * Update a Queue Binding object. Any attribute missing from the request will be left unchanged. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingResponse updateMsgVpnRestDeliveryPointQueueBinding(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Queue Binding object. - * Update a Queue Binding object. Any attribute missing from the request will be left unchanged. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The Queue Binding object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param body The Queue Binding object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnRestDeliveryPointQueueBindingWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, MsgVpnRestDeliveryPointQueueBinding body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling updateMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling updateMsgVpnRestDeliveryPointQueueBinding"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnRestDeliveryPointQueueBinding"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Request Header object. - * Update a Request Header object. Any attribute missing from the request will be left unchanged. A request header to be added to the HTTP request. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- headerName|x|x|||| msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse updateMsgVpnRestDeliveryPointQueueBindingRequestHeader(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Request Header object. - * Update a Request Header object. Any attribute missing from the request will be left unchanged. A request header to be added to the HTTP request. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- headerName|x|x|||| msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - *

200 - The Request Header object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param queueBindingName The name of a queue in the Message VPN. (required) - * @param headerName The name of the HTTP request header. (required) - * @param body The Request Header object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnRestDeliveryPointQueueBindingRequestHeaderWithHttpInfo(String msgVpnName, String restDeliveryPointName, String queueBindingName, String headerName, MsgVpnRestDeliveryPointQueueBindingRequestHeader body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'queueBindingName' is set - if (queueBindingName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'queueBindingName' when calling updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'headerName' is set - if (headerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'headerName' when calling updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnRestDeliveryPointQueueBindingRequestHeader"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("queueBindingName", queueBindingName); - uriVariables.put("headerName", headerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a REST Consumer object. - * Update a REST Consumer object. Any attribute missing from the request will be left unchanged. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey|||x|||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| authenticationHttpBasicPassword|||x|x||x authenticationHttpBasicUsername||||x|| authenticationHttpHeaderValue|||x|||x authenticationOauthClientId||||x|| authenticationOauthClientScope||||x|| authenticationOauthClientSecret|||x|x||x authenticationOauthClientTokenEndpoint||||x|| authenticationOauthJwtSecretKey|||x|x||x authenticationOauthJwtTokenEndpoint||||x|| authenticationScheme||||x|| msgVpnName|x|x|||| outgoingConnectionCount||||x|| remoteHost||||x|| remotePort||||x|| restConsumerName|x|x|||| restDeliveryPointName|x|x|||| tlsCipherSuiteList||||x|| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnRestDeliveryPointRestConsumerResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnRestDeliveryPointRestConsumerResponse updateMsgVpnRestDeliveryPointRestConsumer(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select).getBody(); - } - - /** - * Update a REST Consumer object. - * Update a REST Consumer object. Any attribute missing from the request will be left unchanged. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey|||x|||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| authenticationHttpBasicPassword|||x|x||x authenticationHttpBasicUsername||||x|| authenticationHttpHeaderValue|||x|||x authenticationOauthClientId||||x|| authenticationOauthClientScope||||x|| authenticationOauthClientSecret|||x|x||x authenticationOauthClientTokenEndpoint||||x|| authenticationOauthJwtSecretKey|||x|x||x authenticationOauthJwtTokenEndpoint||||x|| authenticationScheme||||x|| msgVpnName|x|x|||| outgoingConnectionCount||||x|| remoteHost||||x|| remotePort||||x|| restConsumerName|x|x|||| restDeliveryPointName|x|x|||| tlsCipherSuiteList||||x|| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - *

200 - The REST Consumer object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param restDeliveryPointName The name of the REST Delivery Point. (required) - * @param restConsumerName The name of the REST Consumer. (required) - * @param body The REST Consumer object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnRestDeliveryPointRestConsumerResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnRestDeliveryPointRestConsumerWithHttpInfo(String msgVpnName, String restDeliveryPointName, String restConsumerName, MsgVpnRestDeliveryPointRestConsumer body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restDeliveryPointName' is set - if (restDeliveryPointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restDeliveryPointName' when calling updateMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'restConsumerName' is set - if (restConsumerName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'restConsumerName' when calling updateMsgVpnRestDeliveryPointRestConsumer"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnRestDeliveryPointRestConsumer"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("restDeliveryPointName", restDeliveryPointName); - uriVariables.put("restConsumerName", restConsumerName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/SystemInformationApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/SystemInformationApi.java deleted file mode 100644 index 3edc8fe91..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/SystemInformationApi.java +++ /dev/null @@ -1,101 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SystemInformationResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class SystemInformationApi { - private ApiClient apiClient; - - public SystemInformationApi() { - this(new ApiClient()); - } - - public SystemInformationApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Get a System Information object. - * Get a System Information object. The System Information object provides metadata about the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: platform|||x| sempVersion|||x| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been deprecated since 2.2. /systemInformation was replaced by /about/api. - *

200 - The System Information object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return SystemInformationResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public SystemInformationResponse getSystemInformation(String opaquePassword, List select) throws RestClientException { - return getSystemInformationWithHttpInfo(opaquePassword, select).getBody(); - } - - /** - * Get a System Information object. - * Get a System Information object. The System Information object provides metadata about the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: platform|||x| sempVersion|||x| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been deprecated since 2.2. /systemInformation was replaced by /about/api. - *

200 - The System Information object's attributes, and the request metadata. - *

0 - The error response. - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<SystemInformationResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - * @deprecated - */ - @Deprecated - public ResponseEntity getSystemInformationWithHttpInfo(String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/systemInformation", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/TopicEndpointApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/TopicEndpointApi.java deleted file mode 100644 index 1546a3bf4..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/TopicEndpointApi.java +++ /dev/null @@ -1,460 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class TopicEndpointApi { - private ApiClient apiClient; - - public TopicEndpointApi() { - this(new ApiClient()); - } - - public TopicEndpointApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Topic Endpoint object. - * Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointResponse createMsgVpnTopicEndpoint(String msgVpnName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnTopicEndpointWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Topic Endpoint object. - * Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnTopicEndpointWithHttpInfo(String msgVpnName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnTopicEndpoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Topic Endpoint object. - * Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnTopicEndpoint(String msgVpnName, String topicEndpointName) throws RestClientException { - return deleteMsgVpnTopicEndpointWithHttpInfo(msgVpnName, topicEndpointName).getBody(); - } - - /** - * Delete a Topic Endpoint object. - * Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnTopicEndpointWithHttpInfo(String msgVpnName, String topicEndpointName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'topicEndpointName' is set - if (topicEndpointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointName' when calling deleteMsgVpnTopicEndpoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointName", topicEndpointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Topic Endpoint object. - * Get a Topic Endpoint object. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointResponse getMsgVpnTopicEndpoint(String msgVpnName, String topicEndpointName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnTopicEndpointWithHttpInfo(msgVpnName, topicEndpointName, opaquePassword, select).getBody(); - } - - /** - * Get a Topic Endpoint object. - * Get a Topic Endpoint object. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnTopicEndpointWithHttpInfo(String msgVpnName, String topicEndpointName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'topicEndpointName' is set - if (topicEndpointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointName' when calling getMsgVpnTopicEndpoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointName", topicEndpointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Topic Endpoint objects. - * Get a list of Topic Endpoint objects. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Topic Endpoint objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointsResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointsResponse getMsgVpnTopicEndpoints(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnTopicEndpointsWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Topic Endpoint objects. - * Get a list of Topic Endpoint objects. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - *

200 - The list of Topic Endpoint objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointsResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnTopicEndpointsWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnTopicEndpoints"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Topic Endpoint object. - * Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| respectMsgPriorityEnabled|||||x|| topicEndpointName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointResponse replaceMsgVpnTopicEndpoint(String msgVpnName, String topicEndpointName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnTopicEndpointWithHttpInfo(msgVpnName, topicEndpointName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Topic Endpoint object. - * Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| respectMsgPriorityEnabled|||||x|| topicEndpointName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnTopicEndpointWithHttpInfo(String msgVpnName, String topicEndpointName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'topicEndpointName' is set - if (topicEndpointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointName' when calling replaceMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnTopicEndpoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointName", topicEndpointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Topic Endpoint object. - * Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| respectMsgPriorityEnabled||||x|| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointResponse updateMsgVpnTopicEndpoint(String msgVpnName, String topicEndpointName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnTopicEndpointWithHttpInfo(msgVpnName, topicEndpointName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Topic Endpoint object. - * Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| respectMsgPriorityEnabled||||x|| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - *

200 - The Topic Endpoint object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointName The name of the Topic Endpoint. (required) - * @param body The Topic Endpoint object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnTopicEndpointWithHttpInfo(String msgVpnName, String topicEndpointName, MsgVpnTopicEndpoint body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'topicEndpointName' is set - if (topicEndpointName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointName' when calling updateMsgVpnTopicEndpoint"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnTopicEndpoint"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointName", topicEndpointName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/TopicEndpointTemplateApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/TopicEndpointTemplateApi.java deleted file mode 100644 index 37c04efeb..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/TopicEndpointTemplateApi.java +++ /dev/null @@ -1,460 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplateResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplatesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class TopicEndpointTemplateApi { - private ApiClient apiClient; - - public TopicEndpointTemplateApi() { - this(new ApiClient()); - } - - public TopicEndpointTemplateApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Topic Endpoint Template object. - * Create a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointTemplateResponse createMsgVpnTopicEndpointTemplate(String msgVpnName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - return createMsgVpnTopicEndpointTemplateWithHttpInfo(msgVpnName, body, opaquePassword, select).getBody(); - } - - /** - * Create a Topic Endpoint Template object. - * Create a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createMsgVpnTopicEndpointTemplateWithHttpInfo(String msgVpnName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling createMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createMsgVpnTopicEndpointTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates", HttpMethod.POST, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Topic Endpoint Template object. - * Delete a Topic Endpoint Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteMsgVpnTopicEndpointTemplate(String msgVpnName, String topicEndpointTemplateName) throws RestClientException { - return deleteMsgVpnTopicEndpointTemplateWithHttpInfo(msgVpnName, topicEndpointTemplateName).getBody(); - } - - /** - * Delete a Topic Endpoint Template object. - * Delete a Topic Endpoint Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteMsgVpnTopicEndpointTemplateWithHttpInfo(String msgVpnName, String topicEndpointTemplateName) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling deleteMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'topicEndpointTemplateName' is set - if (topicEndpointTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointTemplateName' when calling deleteMsgVpnTopicEndpointTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointTemplateName", topicEndpointTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Topic Endpoint Template object. - * Get a Topic Endpoint Template object. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointTemplateResponse getMsgVpnTopicEndpointTemplate(String msgVpnName, String topicEndpointTemplateName, String opaquePassword, List select) throws RestClientException { - return getMsgVpnTopicEndpointTemplateWithHttpInfo(msgVpnName, topicEndpointTemplateName, opaquePassword, select).getBody(); - } - - /** - * Get a Topic Endpoint Template object. - * Get a Topic Endpoint Template object. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnTopicEndpointTemplateWithHttpInfo(String msgVpnName, String topicEndpointTemplateName, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'topicEndpointTemplateName' is set - if (topicEndpointTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointTemplateName' when calling getMsgVpnTopicEndpointTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointTemplateName", topicEndpointTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Topic Endpoint Template objects. - * Get a list of Topic Endpoint Template objects. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Topic Endpoint Template objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointTemplatesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointTemplatesResponse getMsgVpnTopicEndpointTemplates(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getMsgVpnTopicEndpointTemplatesWithHttpInfo(msgVpnName, count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Topic Endpoint Template objects. - * Get a list of Topic Endpoint Template objects. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - *

200 - The list of Topic Endpoint Template objects' attributes, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointTemplatesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getMsgVpnTopicEndpointTemplatesWithHttpInfo(String msgVpnName, Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling getMsgVpnTopicEndpointTemplates"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Topic Endpoint Template object. - * Replace a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicEndpointTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointTemplateResponse replaceMsgVpnTopicEndpointTemplate(String msgVpnName, String topicEndpointTemplateName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - return replaceMsgVpnTopicEndpointTemplateWithHttpInfo(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Topic Endpoint Template object. - * Replace a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicEndpointTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceMsgVpnTopicEndpointTemplateWithHttpInfo(String msgVpnName, String topicEndpointTemplateName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling replaceMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'topicEndpointTemplateName' is set - if (topicEndpointTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointTemplateName' when calling replaceMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceMsgVpnTopicEndpointTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointTemplateName", topicEndpointTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Topic Endpoint Template object. - * Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return MsgVpnTopicEndpointTemplateResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public MsgVpnTopicEndpointTemplateResponse updateMsgVpnTopicEndpointTemplate(String msgVpnName, String topicEndpointTemplateName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - return updateMsgVpnTopicEndpointTemplateWithHttpInfo(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select).getBody(); - } - - /** - * Update a Topic Endpoint Template object. - * Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - *

200 - The Topic Endpoint Template object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param msgVpnName The name of the Message VPN. (required) - * @param topicEndpointTemplateName The name of the Topic Endpoint Template. (required) - * @param body The Topic Endpoint Template object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<MsgVpnTopicEndpointTemplateResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateMsgVpnTopicEndpointTemplateWithHttpInfo(String msgVpnName, String topicEndpointTemplateName, MsgVpnTopicEndpointTemplate body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'msgVpnName' is set - if (msgVpnName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'msgVpnName' when calling updateMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'topicEndpointTemplateName' is set - if (topicEndpointTemplateName == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'topicEndpointTemplateName' when calling updateMsgVpnTopicEndpointTemplate"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateMsgVpnTopicEndpointTemplate"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("msgVpnName", msgVpnName); - uriVariables.put("topicEndpointTemplateName", topicEndpointTemplateName); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/VirtualHostnameApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/VirtualHostnameApi.java deleted file mode 100644 index f2a8ab439..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/VirtualHostnameApi.java +++ /dev/null @@ -1,408 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.ApiClient; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostname; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostnameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostnamesResponse; - -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Locale; -import java.util.Map; -import java.util.stream.Collectors; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.core.io.FileSystemResource; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class VirtualHostnameApi { - private ApiClient apiClient; - - public VirtualHostnameApi() { - this(new ApiClient()); - } - - public VirtualHostnameApi(ApiClient apiClient) { - this.apiClient = apiClient; - } - - public ApiClient getApiClient() { - return apiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.apiClient = apiClient; - } - - /** - * Create a Virtual Hostname object. - * Create a Virtual Hostname object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: virtualHostname|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - *

200 - The Virtual Hostname object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Virtual Hostname object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return VirtualHostnameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public VirtualHostnameResponse createVirtualHostname(VirtualHostname body, String opaquePassword, List select) throws RestClientException { - return createVirtualHostnameWithHttpInfo(body, opaquePassword, select).getBody(); - } - - /** - * Create a Virtual Hostname object. - * Create a Virtual Hostname object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: virtualHostname|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - *

200 - The Virtual Hostname object's attributes after being created, and the request metadata. - *

0 - The error response. - * @param body The Virtual Hostname object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<VirtualHostnameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity createVirtualHostnameWithHttpInfo(VirtualHostname body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling createVirtualHostname"); - } - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/virtualHostnames", HttpMethod.POST, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Delete a Virtual Hostname object. - * Delete a Virtual Hostname object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - *

200 - The request metadata. - *

0 - The error response. - * @param virtualHostname The virtual hostname. (required) - * @return SempMetaOnlyResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public SempMetaOnlyResponse deleteVirtualHostname(String virtualHostname) throws RestClientException { - return deleteVirtualHostnameWithHttpInfo(virtualHostname).getBody(); - } - - /** - * Delete a Virtual Hostname object. - * Delete a Virtual Hostname object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - *

200 - The request metadata. - *

0 - The error response. - * @param virtualHostname The virtual hostname. (required) - * @return ResponseEntity<SempMetaOnlyResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity deleteVirtualHostnameWithHttpInfo(String virtualHostname) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'virtualHostname' is set - if (virtualHostname == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'virtualHostname' when calling deleteVirtualHostname"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("virtualHostname", virtualHostname); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/virtualHostnames/{virtualHostname}", HttpMethod.DELETE, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a Virtual Hostname object. - * Get a Virtual Hostname object. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: virtualHostname|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.17. - *

200 - The Virtual Hostname object's attributes, and the request metadata. - *

0 - The error response. - * @param virtualHostname The virtual hostname. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return VirtualHostnameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public VirtualHostnameResponse getVirtualHostname(String virtualHostname, String opaquePassword, List select) throws RestClientException { - return getVirtualHostnameWithHttpInfo(virtualHostname, opaquePassword, select).getBody(); - } - - /** - * Get a Virtual Hostname object. - * Get a Virtual Hostname object. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: virtualHostname|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.17. - *

200 - The Virtual Hostname object's attributes, and the request metadata. - *

0 - The error response. - * @param virtualHostname The virtual hostname. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<VirtualHostnameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getVirtualHostnameWithHttpInfo(String virtualHostname, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = null; - - // verify the required parameter 'virtualHostname' is set - if (virtualHostname == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'virtualHostname' when calling getVirtualHostname"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("virtualHostname", virtualHostname); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/virtualHostnames/{virtualHostname}", HttpMethod.GET, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Get a list of Virtual Hostname objects. - * Get a list of Virtual Hostname objects. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: virtualHostname|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.17. - *

200 - The list of Virtual Hostname objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return VirtualHostnamesResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public VirtualHostnamesResponse getVirtualHostnames(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - return getVirtualHostnamesWithHttpInfo(count, cursor, opaquePassword, where, select).getBody(); - } - - /** - * Get a list of Virtual Hostname objects. - * Get a list of Virtual Hostname objects. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: virtualHostname|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.17. - *

200 - The list of Virtual Hostname objects' attributes, and the request metadata. - *

0 - The error response. - * @param count Limit the count of objects in the response. See the documentation for the `count` parameter. (optional, default to 10) - * @param cursor The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter. (optional) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param where Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<VirtualHostnamesResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity getVirtualHostnamesWithHttpInfo(Integer count, String cursor, String opaquePassword, List where, List select) throws RestClientException { - Object localVarPostBody = null; - - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "count", count)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "cursor", cursor)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "where", where)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/virtualHostnames", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Replace a Virtual Hostname object. - * Replace a Virtual Hostname object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- virtualHostname|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - *

200 - The Virtual Hostname object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param virtualHostname The virtual hostname. (required) - * @param body The Virtual Hostname object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return VirtualHostnameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public VirtualHostnameResponse replaceVirtualHostname(String virtualHostname, VirtualHostname body, String opaquePassword, List select) throws RestClientException { - return replaceVirtualHostnameWithHttpInfo(virtualHostname, body, opaquePassword, select).getBody(); - } - - /** - * Replace a Virtual Hostname object. - * Replace a Virtual Hostname object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- virtualHostname|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - *

200 - The Virtual Hostname object's attributes after being replaced, and the request metadata. - *

0 - The error response. - * @param virtualHostname The virtual hostname. (required) - * @param body The Virtual Hostname object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<VirtualHostnameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity replaceVirtualHostnameWithHttpInfo(String virtualHostname, VirtualHostname body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'virtualHostname' is set - if (virtualHostname == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'virtualHostname' when calling replaceVirtualHostname"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling replaceVirtualHostname"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("virtualHostname", virtualHostname); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/virtualHostnames/{virtualHostname}", HttpMethod.PUT, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } - /** - * Update a Virtual Hostname object. - * Update a Virtual Hostname object. Any attribute missing from the request will be left unchanged. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- virtualHostname|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - *

200 - The Virtual Hostname object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param virtualHostname The virtual hostname. (required) - * @param body The Virtual Hostname object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return VirtualHostnameResponse - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public VirtualHostnameResponse updateVirtualHostname(String virtualHostname, VirtualHostname body, String opaquePassword, List select) throws RestClientException { - return updateVirtualHostnameWithHttpInfo(virtualHostname, body, opaquePassword, select).getBody(); - } - - /** - * Update a Virtual Hostname object. - * Update a Virtual Hostname object. Any attribute missing from the request will be left unchanged. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- virtualHostname|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - *

200 - The Virtual Hostname object's attributes after being updated, and the request metadata. - *

0 - The error response. - * @param virtualHostname The virtual hostname. (required) - * @param body The Virtual Hostname object's attributes. (required) - * @param opaquePassword Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter. (optional) - * @param select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter. (optional) - * @return ResponseEntity<VirtualHostnameResponse> - * @throws RestClientException if an error occurs while attempting to invoke the API - */ - public ResponseEntity updateVirtualHostnameWithHttpInfo(String virtualHostname, VirtualHostname body, String opaquePassword, List select) throws RestClientException { - Object localVarPostBody = body; - - // verify the required parameter 'virtualHostname' is set - if (virtualHostname == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'virtualHostname' when calling updateVirtualHostname"); - } - - // verify the required parameter 'body' is set - if (body == null) { - throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'body' when calling updateVirtualHostname"); - } - - // create path and map variables - final Map uriVariables = new HashMap(); - uriVariables.put("virtualHostname", virtualHostname); - - final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); - final HttpHeaders localVarHeaderParams = new HttpHeaders(); - final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); - final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); - - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(null, "opaquePassword", opaquePassword)); - localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "select", select)); - - final String[] localVarAccepts = { - "application/json" - }; - final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - final String[] localVarContentTypes = { - "application/json" - }; - final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - - String[] localVarAuthNames = new String[] { "basicAuth" }; - - ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; - return apiClient.invokeAPI("/virtualHostnames/{virtualHostname}", HttpMethod.PATCH, uriVariables, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/ApiClient.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/ApiClient.java deleted file mode 100644 index a92a8a449..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/ApiClient.java +++ /dev/null @@ -1,757 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker; - -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.core.ParameterizedTypeReference; -import org.springframework.http.HttpHeaders; -import org.springframework.http.HttpMethod; -import org.springframework.http.HttpRequest; -import org.springframework.http.HttpStatus; -import org.springframework.http.InvalidMediaTypeException; -import org.springframework.http.MediaType; -import org.springframework.http.RequestEntity; -import org.springframework.http.RequestEntity.BodyBuilder; -import org.springframework.http.ResponseEntity; -import org.springframework.http.client.BufferingClientHttpRequestFactory; -import org.springframework.http.client.ClientHttpRequestExecution; -import org.springframework.http.client.ClientHttpRequestInterceptor; -import org.springframework.http.client.ClientHttpResponse; -import org.springframework.http.client.HttpComponentsClientHttpRequestFactory; -import org.springframework.stereotype.Component; -import org.springframework.util.CollectionUtils; -import org.springframework.util.LinkedMultiValueMap; -import org.springframework.util.MultiValueMap; -import org.springframework.util.StringUtils; -import org.springframework.web.client.RestClientException; -import org.springframework.web.client.RestTemplate; -import org.springframework.web.util.UriComponentsBuilder; -import org.springframework.web.util.DefaultUriBuilderFactory; -import org.openapitools.jackson.nullable.JsonNullableModule; - - -import java.io.BufferedReader; -import java.io.IOException; -import java.io.InputStream; -import java.io.InputStreamReader; -import java.io.UnsupportedEncodingException; -import java.net.URI; -import java.net.URISyntaxException; -import java.net.URLEncoder; -import java.nio.charset.StandardCharsets; -import java.text.DateFormat; -import java.text.ParseException; -import java.util.Arrays; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Collections; -import java.util.Date; -import java.util.HashMap; -import java.util.Iterator; -import java.util.List; -import java.util.Map; -import java.util.Map.Entry; -import java.util.TimeZone; -import java.time.OffsetDateTime; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.Authentication; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth.HttpBasicAuth; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class ApiClient extends JavaTimeFormatter { - public enum CollectionFormat { - CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null); - - private final String separator; - - private CollectionFormat(String separator) { - this.separator = separator; - } - - private String collectionToString(Collection collection) { - return StringUtils.collectionToDelimitedString(collection, separator); - } - } - - private boolean debugging = false; - - private HttpHeaders defaultHeaders = new HttpHeaders(); - private MultiValueMap defaultCookies = new LinkedMultiValueMap(); - - private String basePath = "http://www.solace.com/SEMP/v2/config"; - - private RestTemplate restTemplate; - - private Map authentications; - - private DateFormat dateFormat; - - public ApiClient() { - this.restTemplate = buildRestTemplate(); - init(); - } - - public ApiClient(RestTemplate restTemplate) { - this.restTemplate = restTemplate; - init(); - } - - protected void init() { - // Use RFC3339 format for date and datetime. - // See http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14 - this.dateFormat = new RFC3339DateFormat(); - - // Use UTC as the default time zone. - this.dateFormat.setTimeZone(TimeZone.getTimeZone("UTC")); - - // Set default User-Agent. - setUserAgent("Java-SDK"); - - // Setup authentications (key: authentication name, value: authentication). - authentications = new HashMap(); - authentications.put("basicAuth", new HttpBasicAuth()); - // Prevent the authentications from being modified. - authentications = Collections.unmodifiableMap(authentications); - } - - /** - * Get the current base path - * - * @return String the base path - */ - public String getBasePath() { - return basePath; - } - - /** - * Set the base path, which should include the host - * - * @param basePath the base path - * @return ApiClient this client - */ - public ApiClient setBasePath(String basePath) { - this.basePath = basePath; - return this; - } - - /** - * Get authentications (key: authentication name, value: authentication). - * - * @return Map the currently configured authentication types - */ - public Map getAuthentications() { - return authentications; - } - - /** - * Get authentication for the given name. - * - * @param authName The authentication name - * @return The authentication, null if not found - */ - public Authentication getAuthentication(String authName) { - return authentications.get(authName); - } - - - /** - * Helper method to set username for the first HTTP basic authentication. - * - * @param username Username - */ - public void setUsername(String username) { - for (Authentication auth : authentications.values()) { - if (auth instanceof HttpBasicAuth) { - ((HttpBasicAuth) auth).setUsername(username); - return; - } - } - throw new RuntimeException("No HTTP basic authentication configured!"); - } - - /** - * Helper method to set password for the first HTTP basic authentication. - * @param password Password - */ - public void setPassword(String password) { - for (Authentication auth : authentications.values()) { - if (auth instanceof HttpBasicAuth) { - ((HttpBasicAuth) auth).setPassword(password); - return; - } - } - throw new RuntimeException("No HTTP basic authentication configured!"); - } - - - - - /** - * Set the User-Agent header's value (by adding to the default header map). - * - * @param userAgent the user agent string - * @return ApiClient this client - */ - public ApiClient setUserAgent(String userAgent) { - addDefaultHeader("User-Agent", userAgent); - return this; - } - - /** - * Add a default header. - * - * @param name The header's name - * @param value The header's value - * @return ApiClient this client - */ - public ApiClient addDefaultHeader(String name, String value) { - if (defaultHeaders.containsKey(name)) { - defaultHeaders.remove(name); - } - defaultHeaders.add(name, value); - return this; - } - - /** - * Add a default cookie. - * - * @param name The cookie's name - * @param value The cookie's value - * @return ApiClient this client - */ - public ApiClient addDefaultCookie(String name, String value) { - if (defaultCookies.containsKey(name)) { - defaultCookies.remove(name); - } - defaultCookies.add(name, value); - return this; - } - - public void setDebugging(boolean debugging) { - List currentInterceptors = this.restTemplate.getInterceptors(); - if (debugging) { - if (currentInterceptors == null) { - currentInterceptors = new ArrayList(); - } - ClientHttpRequestInterceptor interceptor = new ApiClientHttpRequestInterceptor(); - currentInterceptors.add(interceptor); - this.restTemplate.setInterceptors(currentInterceptors); - } else { - if (currentInterceptors != null && !currentInterceptors.isEmpty()) { - Iterator iter = currentInterceptors.iterator(); - while (iter.hasNext()) { - ClientHttpRequestInterceptor interceptor = iter.next(); - if (interceptor instanceof ApiClientHttpRequestInterceptor) { - iter.remove(); - } - } - this.restTemplate.setInterceptors(currentInterceptors); - } - } - this.debugging = debugging; - } - - /** - * Check that whether debugging is enabled for this API client. - * @return boolean true if this client is enabled for debugging, false otherwise - */ - public boolean isDebugging() { - return debugging; - } - - /** - * Get the date format used to parse/format date parameters. - * @return DateFormat format - */ - public DateFormat getDateFormat() { - return dateFormat; - } - - /** - * Set the date format used to parse/format date parameters. - * @param dateFormat Date format - * @return API client - */ - public ApiClient setDateFormat(DateFormat dateFormat) { - this.dateFormat = dateFormat; - return this; - } - - /** - * Parse the given string into Date object. - * - * @param str the string to parse - * @return the Date parsed from the string - */ - public Date parseDate(String str) { - try { - return dateFormat.parse(str); - } catch (ParseException e) { - throw new RuntimeException(e); - } - } - - /** - * Format the given Date object into string. - * - * @param date the date to format - * @return the formatted date as string - */ - public String formatDate(Date date) { - return dateFormat.format(date); - } - - /** - * Format the given parameter object into string. - * - * @param param the object to convert - * @return String the parameter represented as a String - */ - public String parameterToString(Object param) { - if (param == null) { - return ""; - } else if (param instanceof Date) { - return formatDate( (Date) param); - } else if (param instanceof OffsetDateTime) { - return formatOffsetDateTime((OffsetDateTime) param); - } else if (param instanceof Collection) { - StringBuilder b = new StringBuilder(); - for (Object o : (Collection) param) { - if (b.length() > 0) { - b.append(","); - } - b.append(String.valueOf(o)); - } - return b.toString(); - } else { - return String.valueOf(param); - } - } - - /** - * Formats the specified collection path parameter to a string value. - * - * @param collectionFormat The collection format of the parameter. - * @param values The values of the parameter. - * @return String representation of the parameter - */ - public String collectionPathParameterToString(CollectionFormat collectionFormat, Collection values) { - // create the value based on the collection format - if (CollectionFormat.MULTI.equals(collectionFormat)) { - // not valid for path params - return parameterToString(values); - } - - // collectionFormat is assumed to be "csv" by default - if (collectionFormat == null) { - collectionFormat = CollectionFormat.CSV; - } - - return collectionFormat.collectionToString(values); - } - - /** - * Converts a parameter to a {@link MultiValueMap} for use in REST requests - * - * @param collectionFormat The format to convert to - * @param name The name of the parameter - * @param value The parameter's value - * @return a Map containing the String value(s) of the input parameter - */ - public MultiValueMap parameterToMultiValueMap(CollectionFormat collectionFormat, String name, Object value) { - final MultiValueMap params = new LinkedMultiValueMap(); - - if (name == null || name.isEmpty() || value == null) { - return params; - } - - if (collectionFormat == null) { - collectionFormat = CollectionFormat.CSV; - } - - if (value instanceof Map) { - @SuppressWarnings("unchecked") - final Map valuesMap = (Map) value; - for (final Entry entry : valuesMap.entrySet()) { - params.add(entry.getKey(), parameterToString(entry.getValue())); - } - return params; - } - - Collection valueCollection = null; - if (value instanceof Collection) { - valueCollection = (Collection) value; - } else { - params.add(name, parameterToString(value)); - return params; - } - - if (valueCollection.isEmpty()) { - return params; - } - - if (collectionFormat.equals(CollectionFormat.MULTI)) { - for (Object item : valueCollection) { - params.add(name, parameterToString(item)); - } - return params; - } - - List values = new ArrayList(); - for (Object o : valueCollection) { - values.add(parameterToString(o)); - } - params.add(name, collectionFormat.collectionToString(values)); - - return params; - } - - /** - * Check if the given {@code String} is a JSON MIME. - * - * @param mediaType the input MediaType - * @return boolean true if the MediaType represents JSON, false otherwise - */ - public boolean isJsonMime(String mediaType) { - // "* / *" is default to JSON - if ("*/*".equals(mediaType)) { - return true; - } - - try { - return isJsonMime(MediaType.parseMediaType(mediaType)); - } catch (InvalidMediaTypeException e) { - } - return false; - } - - /** - * Check if the given MIME is a JSON MIME. - * JSON MIME examples: - * application/json - * application/json; charset=UTF8 - * APPLICATION/JSON - * - * @param mediaType the input MediaType - * @return boolean true if the MediaType represents JSON, false otherwise - */ - public boolean isJsonMime(MediaType mediaType) { - return mediaType != null && (MediaType.APPLICATION_JSON.isCompatibleWith(mediaType) || mediaType.getSubtype().matches("^.*\\+json[;]?\\s*$")); - } - - /** - * Check if the given {@code String} is a Problem JSON MIME (RFC-7807). - * - * @param mediaType the input MediaType - * @return boolean true if the MediaType represents Problem JSON, false otherwise - */ - public boolean isProblemJsonMime(String mediaType) { - return "application/problem+json".equalsIgnoreCase(mediaType); - } - - /** - * Select the Accept header's value from the given accepts array: - * if JSON exists in the given array, use it; - * otherwise use all of them (joining into a string) - * - * @param accepts The accepts array to select from - * @return List The list of MediaTypes to use for the Accept header - */ - public List selectHeaderAccept(String[] accepts) { - if (accepts.length == 0) { - return null; - } - for (String accept : accepts) { - MediaType mediaType = MediaType.parseMediaType(accept); - if (isJsonMime(mediaType) && !isProblemJsonMime(accept)) { - return Collections.singletonList(mediaType); - } - } - return MediaType.parseMediaTypes(StringUtils.arrayToCommaDelimitedString(accepts)); - } - - /** - * Select the Content-Type header's value from the given array: - * if JSON exists in the given array, use it; - * otherwise use the first one of the array. - * - * @param contentTypes The Content-Type array to select from - * @return MediaType The Content-Type header to use. If the given array is empty, JSON will be used. - */ - public MediaType selectHeaderContentType(String[] contentTypes) { - if (contentTypes.length == 0) { - return MediaType.APPLICATION_JSON; - } - for (String contentType : contentTypes) { - MediaType mediaType = MediaType.parseMediaType(contentType); - if (isJsonMime(mediaType)) { - return mediaType; - } - } - return MediaType.parseMediaType(contentTypes[0]); - } - - /** - * Select the body to use for the request - * - * @param obj the body object - * @param formParams the form parameters - * @param contentType the content type of the request - * @return Object the selected body - */ - protected Object selectBody(Object obj, MultiValueMap formParams, MediaType contentType) { - boolean isForm = MediaType.MULTIPART_FORM_DATA.isCompatibleWith(contentType) || MediaType.APPLICATION_FORM_URLENCODED.isCompatibleWith(contentType); - return isForm ? formParams : obj; - } - - /** - * Expand path template with variables - * - * @param pathTemplate path template with placeholders - * @param variables variables to replace - * @return path with placeholders replaced by variables - */ - public String expandPath(String pathTemplate, Map variables) { - return restTemplate.getUriTemplateHandler().expand(pathTemplate, variables).toString(); - } - - /** - * Include queryParams in uriParams taking into account the paramName - * - * @param queryParams The query parameters - * @param uriParams The path parameters - * return templatized query string - */ - public String generateQueryUri(MultiValueMap queryParams, Map uriParams) { - StringBuilder queryBuilder = new StringBuilder(); - queryParams.forEach((name, values) -> { - try { - final String encodedName = URLEncoder.encode(name.toString(), "UTF-8"); - if (CollectionUtils.isEmpty(values)) { - if (queryBuilder.length() != 0) { - queryBuilder.append('&'); - } - queryBuilder.append(encodedName); - } else { - int valueItemCounter = 0; - for (Object value : values) { - if (queryBuilder.length() != 0) { - queryBuilder.append('&'); - } - queryBuilder.append(encodedName); - if (value != null) { - String templatizedKey = encodedName + valueItemCounter++; - uriParams.put(templatizedKey, value.toString()); - queryBuilder.append('=').append("{").append(templatizedKey).append("}"); - } - } - } - } catch (UnsupportedEncodingException e) { - - } - }); - return queryBuilder.toString(); - - } - - /** - * Invoke API by sending HTTP request with the given options. - * - * @param the return type to use - * @param path The sub-path of the HTTP URL - * @param method The request method - * @param pathParams The path parameters - * @param queryParams The query parameters - * @param body The request body object - * @param headerParams The header parameters - * @param cookieParams The cookie parameters - * @param formParams The form parameters - * @param accept The request's Accept header - * @param contentType The request's Content-Type header - * @param authNames The authentications to apply - * @param returnType The return type into which to deserialize the response - * @return ResponseEntity<T> The response of the chosen type - */ - public ResponseEntity invokeAPI(String path, HttpMethod method, Map pathParams, MultiValueMap queryParams, Object body, HttpHeaders headerParams, MultiValueMap cookieParams, MultiValueMap formParams, List accept, MediaType contentType, String[] authNames, ParameterizedTypeReference returnType) throws RestClientException { - updateParamsForAuth(authNames, queryParams, headerParams, cookieParams); - - Map uriParams = new HashMap<>(); - uriParams.putAll(pathParams); - - String finalUri = path; - - if (queryParams != null && !queryParams.isEmpty()) { - //Include queryParams in uriParams taking into account the paramName - String queryUri = generateQueryUri(queryParams, uriParams); - //Append to finalUri the templatized query string like "?param1={param1Value}&....... - finalUri += "?" + queryUri; - } - String expandedPath = this.expandPath(finalUri, uriParams); - final UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(basePath).path(expandedPath); - - URI uri; - try { - uri = new URI(builder.build().toUriString()); - } catch (URISyntaxException ex) { - throw new RestClientException("Could not build URL: " + builder.toUriString(), ex); - } - - final BodyBuilder requestBuilder = RequestEntity.method(method, uri); - if (accept != null) { - requestBuilder.accept(accept.toArray(new MediaType[accept.size()])); - } - if (contentType != null) { - requestBuilder.contentType(contentType); - } - - addHeadersToRequest(headerParams, requestBuilder); - addHeadersToRequest(defaultHeaders, requestBuilder); - addCookiesToRequest(cookieParams, requestBuilder); - addCookiesToRequest(defaultCookies, requestBuilder); - - RequestEntity requestEntity = requestBuilder.body(selectBody(body, formParams, contentType)); - - ResponseEntity responseEntity = restTemplate.exchange(requestEntity, returnType); - - if (responseEntity.getStatusCode().is2xxSuccessful()) { - return responseEntity; - } else { - // The error handler built into the RestTemplate should handle 400 and 500 series errors. - throw new RestClientException("API returned " + responseEntity.getStatusCode() + " and it wasn't handled by the RestTemplate error handler"); - } - } - - /** - * Add headers to the request that is being built - * @param headers The headers to add - * @param requestBuilder The current request - */ - protected void addHeadersToRequest(HttpHeaders headers, BodyBuilder requestBuilder) { - for (Entry> entry : headers.entrySet()) { - List values = entry.getValue(); - for (String value : values) { - if (value != null) { - requestBuilder.header(entry.getKey(), value); - } - } - } - } - - /** - * Add cookies to the request that is being built - * - * @param cookies The cookies to add - * @param requestBuilder The current request - */ - protected void addCookiesToRequest(MultiValueMap cookies, BodyBuilder requestBuilder) { - if (!cookies.isEmpty()) { - requestBuilder.header("Cookie", buildCookieHeader(cookies)); - } - } - - /** - * Build cookie header. Keeps a single value per cookie (as per - * RFC6265 section 5.3). - * - * @param cookies map all cookies - * @return header string for cookies. - */ - private String buildCookieHeader(MultiValueMap cookies) { - final StringBuilder cookieValue = new StringBuilder(); - String delimiter = ""; - for (final Map.Entry> entry : cookies.entrySet()) { - final String value = entry.getValue().get(entry.getValue().size() - 1); - cookieValue.append(String.format("%s%s=%s", delimiter, entry.getKey(), value)); - delimiter = "; "; - } - return cookieValue.toString(); - } - - /** - * Build the RestTemplate used to make HTTP requests. - * @return RestTemplate - */ - protected RestTemplate buildRestTemplate() { - RestTemplate restTemplate = new RestTemplate(); - // This allows us to read the response more than once - Necessary for debugging. - restTemplate.setRequestFactory(new BufferingClientHttpRequestFactory(new HttpComponentsClientHttpRequestFactory())); - - // disable default URL encoding - DefaultUriBuilderFactory uriBuilderFactory = new DefaultUriBuilderFactory(); - uriBuilderFactory.setEncodingMode(DefaultUriBuilderFactory.EncodingMode.VALUES_ONLY); - restTemplate.setUriTemplateHandler(uriBuilderFactory); - return restTemplate; - } - - /** - * Update query and header parameters based on authentication settings. - * - * @param authNames The authentications to apply - * @param queryParams The query parameters - * @param headerParams The header parameters - */ - protected void updateParamsForAuth(String[] authNames, MultiValueMap queryParams, HttpHeaders headerParams, MultiValueMap cookieParams) { - for (String authName : authNames) { - Authentication auth = authentications.get(authName); - if (auth == null) { - throw new RestClientException("Authentication undefined: " + authName); - } - auth.applyToParams(queryParams, headerParams, cookieParams); - } - } - - private class ApiClientHttpRequestInterceptor implements ClientHttpRequestInterceptor { - private final Log log = LogFactory.getLog(ApiClientHttpRequestInterceptor.class); - - @Override - public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException { - logRequest(request, body); - ClientHttpResponse response = execution.execute(request, body); - logResponse(response); - return response; - } - - private void logRequest(HttpRequest request, byte[] body) throws UnsupportedEncodingException { - log.info("URI: " + request.getURI()); - log.info("HTTP Method: " + request.getMethod()); - log.info("HTTP Headers: " + headersToString(request.getHeaders())); - log.info("Request Body: " + new String(body, StandardCharsets.UTF_8)); - } - - private void logResponse(ClientHttpResponse response) throws IOException { - log.info("HTTP Status Code: " + response.getRawStatusCode()); - log.info("Status Text: " + response.getStatusText()); - log.info("HTTP Headers: " + headersToString(response.getHeaders())); - log.info("Response Body: " + bodyToString(response.getBody())); - } - - private String headersToString(HttpHeaders headers) { - if(headers == null || headers.isEmpty()) { - return ""; - } - StringBuilder builder = new StringBuilder(); - for (Entry> entry : headers.entrySet()) { - builder.append(entry.getKey()).append("=["); - for (String value : entry.getValue()) { - builder.append(value).append(","); - } - builder.setLength(builder.length() - 1); // Get rid of trailing comma - builder.append("],"); - } - builder.setLength(builder.length() - 1); // Get rid of trailing comma - return builder.toString(); - } - - private String bodyToString(InputStream body) throws IOException { - StringBuilder builder = new StringBuilder(); - BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(body, StandardCharsets.UTF_8)); - String line = bufferedReader.readLine(); - while (line != null) { - builder.append(line).append(System.lineSeparator()); - line = bufferedReader.readLine(); - } - bufferedReader.close(); - return builder.toString(); - } - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/JavaTimeFormatter.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/JavaTimeFormatter.java deleted file mode 100644 index a1f256c78..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/JavaTimeFormatter.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker; - -import java.time.OffsetDateTime; -import java.time.format.DateTimeFormatter; -import java.time.format.DateTimeParseException; - -/** - * Class that add parsing/formatting support for Java 8+ {@code OffsetDateTime} class. - * It's generated for java clients when {@code AbstractJavaCodegen#dateLibrary} specified as {@code java8}. - */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class JavaTimeFormatter { - - private DateTimeFormatter offsetDateTimeFormatter = DateTimeFormatter.ISO_OFFSET_DATE_TIME; - - /** - * Get the date format used to parse/format {@code OffsetDateTime} parameters. - * @return DateTimeFormatter - */ - public DateTimeFormatter getOffsetDateTimeFormatter() { - return offsetDateTimeFormatter; - } - - /** - * Set the date format used to parse/format {@code OffsetDateTime} parameters. - * @param offsetDateTimeFormatter {@code DateTimeFormatter} - */ - public void setOffsetDateTimeFormatter(DateTimeFormatter offsetDateTimeFormatter) { - this.offsetDateTimeFormatter = offsetDateTimeFormatter; - } - - /** - * Parse the given string into {@code OffsetDateTime} object. - * @param str String - * @return {@code OffsetDateTime} - */ - public OffsetDateTime parseOffsetDateTime(String str) { - try { - return OffsetDateTime.parse(str, offsetDateTimeFormatter); - } catch (DateTimeParseException e) { - throw new RuntimeException(e); - } - } - /** - * Format the given {@code OffsetDateTime} object into string. - * @param offsetDateTime {@code OffsetDateTime} - * @return {@code OffsetDateTime} in string format - */ - public String formatOffsetDateTime(OffsetDateTime offsetDateTime) { - return offsetDateTimeFormatter.format(offsetDateTime); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/RFC3339DateFormat.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/RFC3339DateFormat.java deleted file mode 100644 index 6d1101652..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/RFC3339DateFormat.java +++ /dev/null @@ -1,57 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker; - -import com.fasterxml.jackson.databind.util.StdDateFormat; - -import java.text.DateFormat; -import java.text.FieldPosition; -import java.text.ParsePosition; -import java.util.Date; -import java.text.DecimalFormat; -import java.util.GregorianCalendar; -import java.util.TimeZone; - -public class RFC3339DateFormat extends DateFormat { - private static final long serialVersionUID = 1L; - private static final TimeZone TIMEZONE_Z = TimeZone.getTimeZone("UTC"); - - private final StdDateFormat fmt = new StdDateFormat() - .withTimeZone(TIMEZONE_Z) - .withColonInTimeZone(true); - - public RFC3339DateFormat() { - this.calendar = new GregorianCalendar(); - this.numberFormat = new DecimalFormat(); - } - - @Override - public Date parse(String source) { - return parse(source, new ParsePosition(0)); - } - - @Override - public Date parse(String source, ParsePosition pos) { - return fmt.parse(source, pos); - } - - @Override - public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition) { - return fmt.format(date, toAppendTo, fieldPosition); - } - - @Override - public Object clone() { - return super.clone(); - } -} \ No newline at end of file diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/ServerConfiguration.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/ServerConfiguration.java deleted file mode 100644 index 4b2d1e472..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/ServerConfiguration.java +++ /dev/null @@ -1,58 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker; - -import java.util.Map; - -/** - * Representing a Server configuration. - */ -public class ServerConfiguration { - public String URL; - public String description; - public Map variables; - - /** - * @param URL A URL to the target host. - * @param description A description of the host designated by the URL. - * @param variables A map between a variable name and its value. The value is used for substitution in the server's URL template. - */ - public ServerConfiguration(String URL, String description, Map variables) { - this.URL = URL; - this.description = description; - this.variables = variables; - } - - /** - * Format URL template using given variables. - * - * @param variables A map between a variable name and its value. - * @return Formatted URL. - */ - public String URL(Map variables) { - String url = this.URL; - - // go through variables and replace placeholders - for (Map.Entry variable: this.variables.entrySet()) { - String name = variable.getKey(); - ServerVariable serverVariable = variable.getValue(); - String value = serverVariable.defaultValue; - - if (variables != null && variables.containsKey(name)) { - value = variables.get(name); - if (serverVariable.enumValues.size() > 0 && !serverVariable.enumValues.contains(value)) { - throw new IllegalArgumentException("The variable " + name + " in the server URL has invalid value " + value + "."); - } - } - url = url.replace("{" + name + "}", value); - } - return url; - } - - /** - * Format URL template using default server variables. - * - * @return Formatted URL. - */ - public String URL() { - return URL(null); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/ServerVariable.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/ServerVariable.java deleted file mode 100644 index fb4236095..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/ServerVariable.java +++ /dev/null @@ -1,23 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker; - -import java.util.HashSet; - -/** - * Representing a Server Variable for server URL template substitution. - */ -public class ServerVariable { - public String description; - public String defaultValue; - public HashSet enumValues = null; - - /** - * @param description A description for the server variable. - * @param defaultValue The default value to use for substitution. - * @param enumValues An enumeration of string values to be used if the substitution options are from a limited set. - */ - public ServerVariable(String description, String defaultValue, HashSet enumValues) { - this.description = description; - this.defaultValue = defaultValue; - this.enumValues = enumValues; - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/auth/ApiKeyAuth.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/auth/ApiKeyAuth.java deleted file mode 100644 index 9d9b7b327..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/auth/ApiKeyAuth.java +++ /dev/null @@ -1,62 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth; - -import org.springframework.http.HttpHeaders; -import org.springframework.util.MultiValueMap; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class ApiKeyAuth implements Authentication { - private final String location; - private final String paramName; - - private String apiKey; - private String apiKeyPrefix; - - public ApiKeyAuth(String location, String paramName) { - this.location = location; - this.paramName = paramName; - } - - public String getLocation() { - return location; - } - - public String getParamName() { - return paramName; - } - - public String getApiKey() { - return apiKey; - } - - public void setApiKey(String apiKey) { - this.apiKey = apiKey; - } - - public String getApiKeyPrefix() { - return apiKeyPrefix; - } - - public void setApiKeyPrefix(String apiKeyPrefix) { - this.apiKeyPrefix = apiKeyPrefix; - } - - @Override - public void applyToParams(MultiValueMap queryParams, HttpHeaders headerParams, MultiValueMap cookieParams) { - if (apiKey == null) { - return; - } - String value; - if (apiKeyPrefix != null) { - value = apiKeyPrefix + " " + apiKey; - } else { - value = apiKey; - } - if (location.equals("query")) { - queryParams.add(paramName, value); - } else if (location.equals("header")) { - headerParams.add(paramName, value); - } else if (location.equals("cookie")) { - cookieParams.add(paramName, value); - } - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/auth/Authentication.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/auth/Authentication.java deleted file mode 100644 index 3f0acbd3f..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/auth/Authentication.java +++ /dev/null @@ -1,14 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth; - -import org.springframework.http.HttpHeaders; -import org.springframework.util.MultiValueMap; - -public interface Authentication { - /** - * Apply authentication settings to header and / or query parameters. - * @param queryParams The query parameters for the request - * @param headerParams The header parameters for the request - * @param cookieParams The cookie parameters for the request - */ - public void applyToParams(MultiValueMap queryParams, HttpHeaders headerParams, MultiValueMap cookieParams); -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/auth/HttpBasicAuth.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/auth/HttpBasicAuth.java deleted file mode 100644 index d3745ead1..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/auth/HttpBasicAuth.java +++ /dev/null @@ -1,39 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth; - -import java.io.UnsupportedEncodingException; -import java.nio.charset.StandardCharsets; -import java.util.Base64; - -import org.springframework.http.HttpHeaders; -import org.springframework.util.MultiValueMap; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class HttpBasicAuth implements Authentication { - private String username; - private String password; - - public String getUsername() { - return username; - } - - public void setUsername(String username) { - this.username = username; - } - - public String getPassword() { - return password; - } - - public void setPassword(String password) { - this.password = password; - } - - @Override - public void applyToParams(MultiValueMap queryParams, HttpHeaders headerParams, MultiValueMap cookieParams) { - if (username == null && password == null) { - return; - } - String str = (username == null ? "" : username) + ":" + (password == null ? "" : password); - headerParams.add(HttpHeaders.AUTHORIZATION, "Basic " + Base64.getEncoder().encodeToString(str.getBytes(StandardCharsets.UTF_8))); - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/auth/HttpBearerAuth.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/auth/HttpBearerAuth.java deleted file mode 100644 index 9a5e4b458..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/invoker/auth/HttpBearerAuth.java +++ /dev/null @@ -1,37 +0,0 @@ -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.invoker.auth; - -import java.io.UnsupportedEncodingException; -import java.nio.charset.StandardCharsets; - -import org.springframework.http.HttpHeaders; -import org.springframework.util.MultiValueMap; - -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class HttpBearerAuth implements Authentication { - private final String scheme; - private String bearerToken; - - public HttpBearerAuth(String scheme) { - this.scheme = scheme; - } - - public String getBearerToken() { - return bearerToken; - } - - public void setBearerToken(String bearerToken) { - this.bearerToken = bearerToken; - } - - @Override - public void applyToParams(MultiValueMap queryParams, HttpHeaders headerParams, MultiValueMap cookieParams) { - if (bearerToken == null) { - return; - } - headerParams.add(HttpHeaders.AUTHORIZATION, (scheme != null ? upperCaseBearer(scheme) + " " : "") + bearerToken); - } - - private static String upperCaseBearer(String scheme) { - return ("bearer".equalsIgnoreCase(scheme)) ? "Bearer" : scheme; - } -} diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApi.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApi.java deleted file mode 100644 index 56dc7f350..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApi.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * AboutApi - */ -@JsonPropertyOrder({ - AboutApi.JSON_PROPERTY_PLATFORM, - AboutApi.JSON_PROPERTY_SEMP_VERSION -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AboutApi { - public static final String JSON_PROPERTY_PLATFORM = "platform"; - private String platform; - - public static final String JSON_PROPERTY_SEMP_VERSION = "sempVersion"; - private String sempVersion; - - public AboutApi() { - } - - public AboutApi platform(String platform) { - - this.platform = platform; - return this; - } - - /** - * The platform running the SEMP API. - * @return platform - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PLATFORM) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getPlatform() { - return platform; - } - - - @JsonProperty(JSON_PROPERTY_PLATFORM) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPlatform(String platform) { - this.platform = platform; - } - - - public AboutApi sempVersion(String sempVersion) { - - this.sempVersion = sempVersion; - return this; - } - - /** - * The version of the SEMP API. - * @return sempVersion - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SEMP_VERSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSempVersion() { - return sempVersion; - } - - - @JsonProperty(JSON_PROPERTY_SEMP_VERSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSempVersion(String sempVersion) { - this.sempVersion = sempVersion; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - AboutApi aboutApi = (AboutApi) o; - return Objects.equals(this.platform, aboutApi.platform) && - Objects.equals(this.sempVersion, aboutApi.sempVersion); - } - - @Override - public int hashCode() { - return Objects.hash(platform, sempVersion); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class AboutApi {\n"); - sb.append(" platform: ").append(toIndentedString(platform)).append("\n"); - sb.append(" sempVersion: ").append(toIndentedString(sempVersion)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiLinks.java deleted file mode 100644 index 6f88db5a1..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * AboutApiLinks - */ -@JsonPropertyOrder({ - AboutApiLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AboutApiLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public AboutApiLinks() { - } - - public AboutApiLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this API Description object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - AboutApiLinks aboutApiLinks = (AboutApiLinks) o; - return Objects.equals(this.uri, aboutApiLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class AboutApiLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiResponse.java deleted file mode 100644 index 328f2c595..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutApi; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutApiLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * AboutApiResponse - */ -@JsonPropertyOrder({ - AboutApiResponse.JSON_PROPERTY_DATA, - AboutApiResponse.JSON_PROPERTY_LINKS, - AboutApiResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AboutApiResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private AboutApi data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private AboutApiLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public AboutApiResponse() { - } - - public AboutApiResponse data(AboutApi data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AboutApi getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(AboutApi data) { - this.data = data; - } - - - public AboutApiResponse links(AboutApiLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AboutApiLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(AboutApiLinks links) { - this.links = links; - } - - - public AboutApiResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - AboutApiResponse aboutApiResponse = (AboutApiResponse) o; - return Objects.equals(this.data, aboutApiResponse.data) && - Objects.equals(this.links, aboutApiResponse.links) && - Objects.equals(this.meta, aboutApiResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class AboutApiResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutLinks.java deleted file mode 100644 index a19842504..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutLinks.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * AboutLinks - */ -@JsonPropertyOrder({ - AboutLinks.JSON_PROPERTY_API_URI, - AboutLinks.JSON_PROPERTY_URI, - AboutLinks.JSON_PROPERTY_USER_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AboutLinks { - public static final String JSON_PROPERTY_API_URI = "apiUri"; - private String apiUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public static final String JSON_PROPERTY_USER_URI = "userUri"; - private String userUri; - - public AboutLinks() { - } - - public AboutLinks apiUri(String apiUri) { - - this.apiUri = apiUri; - return this; - } - - /** - * The URI of this About's API Description object. Available since 2.2. - * @return apiUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_API_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getApiUri() { - return apiUri; - } - - - @JsonProperty(JSON_PROPERTY_API_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setApiUri(String apiUri) { - this.apiUri = apiUri; - } - - - public AboutLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this About object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - - public AboutLinks userUri(String userUri) { - - this.userUri = userUri; - return this; - } - - /** - * The URI of this About's User object. Available since 2.2. - * @return userUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_USER_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUserUri() { - return userUri; - } - - - @JsonProperty(JSON_PROPERTY_USER_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUserUri(String userUri) { - this.userUri = userUri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - AboutLinks aboutLinks = (AboutLinks) o; - return Objects.equals(this.apiUri, aboutLinks.apiUri) && - Objects.equals(this.uri, aboutLinks.uri) && - Objects.equals(this.userUri, aboutLinks.userUri); - } - - @Override - public int hashCode() { - return Objects.hash(apiUri, uri, userUri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class AboutLinks {\n"); - sb.append(" apiUri: ").append(toIndentedString(apiUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append(" userUri: ").append(toIndentedString(userUri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutResponse.java deleted file mode 100644 index d38a4750e..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutResponse.java +++ /dev/null @@ -1,170 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * AboutResponse - */ -@JsonPropertyOrder({ - AboutResponse.JSON_PROPERTY_DATA, - AboutResponse.JSON_PROPERTY_LINKS, - AboutResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AboutResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private Object data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private AboutLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public AboutResponse() { - } - - public AboutResponse data(Object data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(Object data) { - this.data = data; - } - - - public AboutResponse links(AboutLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AboutLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(AboutLinks links) { - this.links = links; - } - - - public AboutResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - AboutResponse aboutResponse = (AboutResponse) o; - return Objects.equals(this.data, aboutResponse.data) && - Objects.equals(this.links, aboutResponse.links) && - Objects.equals(this.meta, aboutResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class AboutResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUser.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUser.java deleted file mode 100644 index 848da4d1a..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUser.java +++ /dev/null @@ -1,367 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * AboutUser - */ -@JsonPropertyOrder({ - AboutUser.JSON_PROPERTY_GLOBAL_ACCESS_LEVEL, - AboutUser.JSON_PROPERTY_SESSION_ACTIVE, - AboutUser.JSON_PROPERTY_SESSION_CREATE_TIME, - AboutUser.JSON_PROPERTY_SESSION_CURRENT_TIME, - AboutUser.JSON_PROPERTY_SESSION_HARD_EXPIRY_TIME, - AboutUser.JSON_PROPERTY_SESSION_ID, - AboutUser.JSON_PROPERTY_SESSION_IDLE_EXPIRY_TIME, - AboutUser.JSON_PROPERTY_USERNAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AboutUser { - /** - * The global access level of the User. The allowed values and their meaning are: <pre> \"admin\" - Full administrative access. \"none\" - No access. \"read-only\" - Read only access. \"read-write\" - Read and write access. </pre> - */ - public enum GlobalAccessLevelEnum { - ADMIN("admin"), - - NONE("none"), - - READ_ONLY("read-only"), - - READ_WRITE("read-write"); - - private String value; - - GlobalAccessLevelEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static GlobalAccessLevelEnum fromValue(String value) { - for (GlobalAccessLevelEnum b : GlobalAccessLevelEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_GLOBAL_ACCESS_LEVEL = "globalAccessLevel"; - private GlobalAccessLevelEnum globalAccessLevel; - - public static final String JSON_PROPERTY_SESSION_ACTIVE = "sessionActive"; - private Boolean sessionActive; - - public static final String JSON_PROPERTY_SESSION_CREATE_TIME = "sessionCreateTime"; - private Integer sessionCreateTime; - - public static final String JSON_PROPERTY_SESSION_CURRENT_TIME = "sessionCurrentTime"; - private Integer sessionCurrentTime; - - public static final String JSON_PROPERTY_SESSION_HARD_EXPIRY_TIME = "sessionHardExpiryTime"; - private Integer sessionHardExpiryTime; - - public static final String JSON_PROPERTY_SESSION_ID = "sessionId"; - private String sessionId; - - public static final String JSON_PROPERTY_SESSION_IDLE_EXPIRY_TIME = "sessionIdleExpiryTime"; - private Integer sessionIdleExpiryTime; - - public static final String JSON_PROPERTY_USERNAME = "username"; - private String username; - - public AboutUser() { - } - - public AboutUser globalAccessLevel(GlobalAccessLevelEnum globalAccessLevel) { - - this.globalAccessLevel = globalAccessLevel; - return this; - } - - /** - * The global access level of the User. The allowed values and their meaning are: <pre> \"admin\" - Full administrative access. \"none\" - No access. \"read-only\" - Read only access. \"read-write\" - Read and write access. </pre> - * @return globalAccessLevel - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GLOBAL_ACCESS_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public GlobalAccessLevelEnum getGlobalAccessLevel() { - return globalAccessLevel; - } - - - @JsonProperty(JSON_PROPERTY_GLOBAL_ACCESS_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGlobalAccessLevel(GlobalAccessLevelEnum globalAccessLevel) { - this.globalAccessLevel = globalAccessLevel; - } - - - public AboutUser sessionActive(Boolean sessionActive) { - - this.sessionActive = sessionActive; - return this; - } - - /** - * Indicates whether a session is active for this request. Available since 2.24. - * @return sessionActive - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SESSION_ACTIVE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getSessionActive() { - return sessionActive; - } - - - @JsonProperty(JSON_PROPERTY_SESSION_ACTIVE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSessionActive(Boolean sessionActive) { - this.sessionActive = sessionActive; - } - - - public AboutUser sessionCreateTime(Integer sessionCreateTime) { - - this.sessionCreateTime = sessionCreateTime; - return this; - } - - /** - * The timestamp of when the session was created. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21. - * @return sessionCreateTime - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SESSION_CREATE_TIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getSessionCreateTime() { - return sessionCreateTime; - } - - - @JsonProperty(JSON_PROPERTY_SESSION_CREATE_TIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSessionCreateTime(Integer sessionCreateTime) { - this.sessionCreateTime = sessionCreateTime; - } - - - public AboutUser sessionCurrentTime(Integer sessionCurrentTime) { - - this.sessionCurrentTime = sessionCurrentTime; - return this; - } - - /** - * The current server timestamp. This is provided as a reference point for the other timestamps provided. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21. - * @return sessionCurrentTime - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SESSION_CURRENT_TIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getSessionCurrentTime() { - return sessionCurrentTime; - } - - - @JsonProperty(JSON_PROPERTY_SESSION_CURRENT_TIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSessionCurrentTime(Integer sessionCurrentTime) { - this.sessionCurrentTime = sessionCurrentTime; - } - - - public AboutUser sessionHardExpiryTime(Integer sessionHardExpiryTime) { - - this.sessionHardExpiryTime = sessionHardExpiryTime; - return this; - } - - /** - * The hard expiry time for the session. After this time the session will be invalid, regardless of activity. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21. - * @return sessionHardExpiryTime - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SESSION_HARD_EXPIRY_TIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getSessionHardExpiryTime() { - return sessionHardExpiryTime; - } - - - @JsonProperty(JSON_PROPERTY_SESSION_HARD_EXPIRY_TIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSessionHardExpiryTime(Integer sessionHardExpiryTime) { - this.sessionHardExpiryTime = sessionHardExpiryTime; - } - - - public AboutUser sessionId(String sessionId) { - - this.sessionId = sessionId; - return this; - } - - /** - * An identifier for the session to differentiate this session from other sessions for the same user. This value is not guaranteed to be unique between active sessions for different users. This attribute may not be returned in a GET. Available since 2.21. - * @return sessionId - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SESSION_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSessionId() { - return sessionId; - } - - - @JsonProperty(JSON_PROPERTY_SESSION_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSessionId(String sessionId) { - this.sessionId = sessionId; - } - - - public AboutUser sessionIdleExpiryTime(Integer sessionIdleExpiryTime) { - - this.sessionIdleExpiryTime = sessionIdleExpiryTime; - return this; - } - - /** - * The session idle expiry time. After this time the session will be invalid if there has been no activity. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21. - * @return sessionIdleExpiryTime - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SESSION_IDLE_EXPIRY_TIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getSessionIdleExpiryTime() { - return sessionIdleExpiryTime; - } - - - @JsonProperty(JSON_PROPERTY_SESSION_IDLE_EXPIRY_TIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSessionIdleExpiryTime(Integer sessionIdleExpiryTime) { - this.sessionIdleExpiryTime = sessionIdleExpiryTime; - } - - - public AboutUser username(String username) { - - this.username = username; - return this; - } - - /** - * The username of the User. Available since 2.21. - * @return username - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUsername() { - return username; - } - - - @JsonProperty(JSON_PROPERTY_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUsername(String username) { - this.username = username; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - AboutUser aboutUser = (AboutUser) o; - return Objects.equals(this.globalAccessLevel, aboutUser.globalAccessLevel) && - Objects.equals(this.sessionActive, aboutUser.sessionActive) && - Objects.equals(this.sessionCreateTime, aboutUser.sessionCreateTime) && - Objects.equals(this.sessionCurrentTime, aboutUser.sessionCurrentTime) && - Objects.equals(this.sessionHardExpiryTime, aboutUser.sessionHardExpiryTime) && - Objects.equals(this.sessionId, aboutUser.sessionId) && - Objects.equals(this.sessionIdleExpiryTime, aboutUser.sessionIdleExpiryTime) && - Objects.equals(this.username, aboutUser.username); - } - - @Override - public int hashCode() { - return Objects.hash(globalAccessLevel, sessionActive, sessionCreateTime, sessionCurrentTime, sessionHardExpiryTime, sessionId, sessionIdleExpiryTime, username); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class AboutUser {\n"); - sb.append(" globalAccessLevel: ").append(toIndentedString(globalAccessLevel)).append("\n"); - sb.append(" sessionActive: ").append(toIndentedString(sessionActive)).append("\n"); - sb.append(" sessionCreateTime: ").append(toIndentedString(sessionCreateTime)).append("\n"); - sb.append(" sessionCurrentTime: ").append(toIndentedString(sessionCurrentTime)).append("\n"); - sb.append(" sessionHardExpiryTime: ").append(toIndentedString(sessionHardExpiryTime)).append("\n"); - sb.append(" sessionId: ").append(toIndentedString(sessionId)).append("\n"); - sb.append(" sessionIdleExpiryTime: ").append(toIndentedString(sessionIdleExpiryTime)).append("\n"); - sb.append(" username: ").append(toIndentedString(username)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserLinks.java deleted file mode 100644 index 0e0f66041..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserLinks.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * AboutUserLinks - */ -@JsonPropertyOrder({ - AboutUserLinks.JSON_PROPERTY_MSG_VPNS_URI, - AboutUserLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AboutUserLinks { - public static final String JSON_PROPERTY_MSG_VPNS_URI = "msgVpnsUri"; - private String msgVpnsUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public AboutUserLinks() { - } - - public AboutUserLinks msgVpnsUri(String msgVpnsUri) { - - this.msgVpnsUri = msgVpnsUri; - return this; - } - - /** - * The URI of this User's collection of User Message VPN objects. - * @return msgVpnsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPNS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnsUri() { - return msgVpnsUri; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPNS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnsUri(String msgVpnsUri) { - this.msgVpnsUri = msgVpnsUri; - } - - - public AboutUserLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this User object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - AboutUserLinks aboutUserLinks = (AboutUserLinks) o; - return Objects.equals(this.msgVpnsUri, aboutUserLinks.msgVpnsUri) && - Objects.equals(this.uri, aboutUserLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(msgVpnsUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class AboutUserLinks {\n"); - sb.append(" msgVpnsUri: ").append(toIndentedString(msgVpnsUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpn.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpn.java deleted file mode 100644 index 372cf828d..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpn.java +++ /dev/null @@ -1,173 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * AboutUserMsgVpn - */ -@JsonPropertyOrder({ - AboutUserMsgVpn.JSON_PROPERTY_ACCESS_LEVEL, - AboutUserMsgVpn.JSON_PROPERTY_MSG_VPN_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AboutUserMsgVpn { - /** - * The Message VPN access level of the User. The allowed values and their meaning are: <pre> \"none\" - No access. \"read-only\" - Read only access. \"read-write\" - Read and write access. </pre> - */ - public enum AccessLevelEnum { - NONE("none"), - - READ_ONLY("read-only"), - - READ_WRITE("read-write"); - - private String value; - - AccessLevelEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AccessLevelEnum fromValue(String value) { - for (AccessLevelEnum b : AccessLevelEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_ACCESS_LEVEL = "accessLevel"; - private AccessLevelEnum accessLevel; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public AboutUserMsgVpn() { - } - - public AboutUserMsgVpn accessLevel(AccessLevelEnum accessLevel) { - - this.accessLevel = accessLevel; - return this; - } - - /** - * The Message VPN access level of the User. The allowed values and their meaning are: <pre> \"none\" - No access. \"read-only\" - Read only access. \"read-write\" - Read and write access. </pre> - * @return accessLevel - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACCESS_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AccessLevelEnum getAccessLevel() { - return accessLevel; - } - - - @JsonProperty(JSON_PROPERTY_ACCESS_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccessLevel(AccessLevelEnum accessLevel) { - this.accessLevel = accessLevel; - } - - - public AboutUserMsgVpn msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - AboutUserMsgVpn aboutUserMsgVpn = (AboutUserMsgVpn) o; - return Objects.equals(this.accessLevel, aboutUserMsgVpn.accessLevel) && - Objects.equals(this.msgVpnName, aboutUserMsgVpn.msgVpnName); - } - - @Override - public int hashCode() { - return Objects.hash(accessLevel, msgVpnName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class AboutUserMsgVpn {\n"); - sb.append(" accessLevel: ").append(toIndentedString(accessLevel)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnLinks.java deleted file mode 100644 index 853a33fd1..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * AboutUserMsgVpnLinks - */ -@JsonPropertyOrder({ - AboutUserMsgVpnLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AboutUserMsgVpnLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public AboutUserMsgVpnLinks() { - } - - public AboutUserMsgVpnLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this User Message VPN object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - AboutUserMsgVpnLinks aboutUserMsgVpnLinks = (AboutUserMsgVpnLinks) o; - return Objects.equals(this.uri, aboutUserMsgVpnLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class AboutUserMsgVpnLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnResponse.java deleted file mode 100644 index 21b4cc92a..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserMsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserMsgVpnLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * AboutUserMsgVpnResponse - */ -@JsonPropertyOrder({ - AboutUserMsgVpnResponse.JSON_PROPERTY_DATA, - AboutUserMsgVpnResponse.JSON_PROPERTY_LINKS, - AboutUserMsgVpnResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AboutUserMsgVpnResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private AboutUserMsgVpn data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private AboutUserMsgVpnLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public AboutUserMsgVpnResponse() { - } - - public AboutUserMsgVpnResponse data(AboutUserMsgVpn data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AboutUserMsgVpn getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(AboutUserMsgVpn data) { - this.data = data; - } - - - public AboutUserMsgVpnResponse links(AboutUserMsgVpnLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AboutUserMsgVpnLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(AboutUserMsgVpnLinks links) { - this.links = links; - } - - - public AboutUserMsgVpnResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - AboutUserMsgVpnResponse aboutUserMsgVpnResponse = (AboutUserMsgVpnResponse) o; - return Objects.equals(this.data, aboutUserMsgVpnResponse.data) && - Objects.equals(this.links, aboutUserMsgVpnResponse.links) && - Objects.equals(this.meta, aboutUserMsgVpnResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class AboutUserMsgVpnResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnsResponse.java deleted file mode 100644 index 74720d075..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserMsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserMsgVpnLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * AboutUserMsgVpnsResponse - */ -@JsonPropertyOrder({ - AboutUserMsgVpnsResponse.JSON_PROPERTY_DATA, - AboutUserMsgVpnsResponse.JSON_PROPERTY_LINKS, - AboutUserMsgVpnsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AboutUserMsgVpnsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public AboutUserMsgVpnsResponse() { - } - - public AboutUserMsgVpnsResponse data(List data) { - - this.data = data; - return this; - } - - public AboutUserMsgVpnsResponse addDataItem(AboutUserMsgVpn dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public AboutUserMsgVpnsResponse links(List links) { - - this.links = links; - return this; - } - - public AboutUserMsgVpnsResponse addLinksItem(AboutUserMsgVpnLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public AboutUserMsgVpnsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - AboutUserMsgVpnsResponse aboutUserMsgVpnsResponse = (AboutUserMsgVpnsResponse) o; - return Objects.equals(this.data, aboutUserMsgVpnsResponse.data) && - Objects.equals(this.links, aboutUserMsgVpnsResponse.links) && - Objects.equals(this.meta, aboutUserMsgVpnsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class AboutUserMsgVpnsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserResponse.java deleted file mode 100644 index 9fa42a43e..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUser; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * AboutUserResponse - */ -@JsonPropertyOrder({ - AboutUserResponse.JSON_PROPERTY_DATA, - AboutUserResponse.JSON_PROPERTY_LINKS, - AboutUserResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class AboutUserResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private AboutUser data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private AboutUserLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public AboutUserResponse() { - } - - public AboutUserResponse data(AboutUser data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AboutUser getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(AboutUser data) { - this.data = data; - } - - - public AboutUserResponse links(AboutUserLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AboutUserLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(AboutUserLinks links) { - this.links = links; - } - - - public AboutUserResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - AboutUserResponse aboutUserResponse = (AboutUserResponse) o; - return Objects.equals(this.data, aboutUserResponse.data) && - Objects.equals(this.links, aboutUserResponse.links) && - Objects.equals(this.meta, aboutUserResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class AboutUserResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/Broker.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/Broker.java deleted file mode 100644 index 485b4d974..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/Broker.java +++ /dev/null @@ -1,2836 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThresholdByPercent; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * Broker - */ -@JsonPropertyOrder({ - Broker.JSON_PROPERTY_AUTH_CLIENT_CERT_REVOCATION_CHECK_MODE, - Broker.JSON_PROPERTY_CONFIG_SYNC_AUTHENTICATION_CLIENT_CERT_MAX_CHAIN_DEPTH, - Broker.JSON_PROPERTY_CONFIG_SYNC_AUTHENTICATION_CLIENT_CERT_VALIDATE_DATE_ENABLED, - Broker.JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_INITIAL_CONGESTION_WINDOW, - Broker.JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_KEEPALIVE_COUNT, - Broker.JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_KEEPALIVE_IDLE, - Broker.JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_KEEPALIVE_INTERVAL, - Broker.JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_MAX_WINDOW, - Broker.JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_MSS, - Broker.JSON_PROPERTY_CONFIG_SYNC_ENABLED, - Broker.JSON_PROPERTY_CONFIG_SYNC_SYNCHRONIZE_USERNAME_ENABLED, - Broker.JSON_PROPERTY_CONFIG_SYNC_TLS_ENABLED, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_SCHEDULE_DAY_LIST, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_SCHEDULE_ENABLED, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_SCHEDULE_TIME_LIST, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_THRESHOLD_ENABLED, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_THRESHOLD_FRAGMENTATION_PERCENTAGE, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_THRESHOLD_MIN_INTERVAL, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_THRESHOLD_USAGE_PERCENTAGE, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_ENABLED, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_EVENT_CACHE_USAGE_THRESHOLD, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_EVENT_DELIVERED_UNACKED_THRESHOLD, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_EVENT_DISK_USAGE_THRESHOLD, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_EVENT_EGRESS_FLOW_COUNT_THRESHOLD, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_EVENT_ENDPOINT_COUNT_THRESHOLD, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_EVENT_INGRESS_FLOW_COUNT_THRESHOLD, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_EVENT_MSG_COUNT_THRESHOLD, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_EVENT_MSG_SPOOL_FILE_COUNT_THRESHOLD, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_EVENT_MSG_SPOOL_USAGE_THRESHOLD, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_EVENT_TRANSACTED_SESSION_COUNT_THRESHOLD, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_EVENT_TRANSACTED_SESSION_RESOURCE_COUNT_THRESHOLD, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_EVENT_TRANSACTION_COUNT_THRESHOLD, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_MAX_CACHE_USAGE, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_MAX_MSG_SPOOL_USAGE, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_MSG_SPOOL_SYNC_MIRRORED_MSG_ACK_TIMEOUT, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_MSG_SPOOL_SYNC_MIRRORED_SPOOL_FILE_ACK_TIMEOUT, - Broker.JSON_PROPERTY_GUARANTEED_MSGING_TRANSACTION_REPLICATION_COMPATIBILITY_MODE, - Broker.JSON_PROPERTY_OAUTH_PROFILE_DEFAULT, - Broker.JSON_PROPERTY_SERVICE_AMQP_ENABLED, - Broker.JSON_PROPERTY_SERVICE_AMQP_TLS_LISTEN_PORT, - Broker.JSON_PROPERTY_SERVICE_EVENT_CONNECTION_COUNT_THRESHOLD, - Broker.JSON_PROPERTY_SERVICE_HEALTH_CHECK_ENABLED, - Broker.JSON_PROPERTY_SERVICE_HEALTH_CHECK_LISTEN_PORT, - Broker.JSON_PROPERTY_SERVICE_MATE_LINK_ENABLED, - Broker.JSON_PROPERTY_SERVICE_MATE_LINK_LISTEN_PORT, - Broker.JSON_PROPERTY_SERVICE_MQTT_ENABLED, - Broker.JSON_PROPERTY_SERVICE_MSG_BACKBONE_ENABLED, - Broker.JSON_PROPERTY_SERVICE_REDUNDANCY_ENABLED, - Broker.JSON_PROPERTY_SERVICE_REDUNDANCY_FIRST_LISTEN_PORT, - Broker.JSON_PROPERTY_SERVICE_REST_EVENT_OUTGOING_CONNECTION_COUNT_THRESHOLD, - Broker.JSON_PROPERTY_SERVICE_REST_INCOMING_ENABLED, - Broker.JSON_PROPERTY_SERVICE_REST_OUTGOING_ENABLED, - Broker.JSON_PROPERTY_SERVICE_SEMP_CORS_ALLOW_ANY_HOST_ENABLED, - Broker.JSON_PROPERTY_SERVICE_SEMP_LEGACY_TIMEOUT_ENABLED, - Broker.JSON_PROPERTY_SERVICE_SEMP_PLAIN_TEXT_ENABLED, - Broker.JSON_PROPERTY_SERVICE_SEMP_PLAIN_TEXT_LISTEN_PORT, - Broker.JSON_PROPERTY_SERVICE_SEMP_SESSION_IDLE_TIMEOUT, - Broker.JSON_PROPERTY_SERVICE_SEMP_SESSION_MAX_LIFETIME, - Broker.JSON_PROPERTY_SERVICE_SEMP_TLS_ENABLED, - Broker.JSON_PROPERTY_SERVICE_SEMP_TLS_LISTEN_PORT, - Broker.JSON_PROPERTY_SERVICE_SMF_COMPRESSION_LISTEN_PORT, - Broker.JSON_PROPERTY_SERVICE_SMF_ENABLED, - Broker.JSON_PROPERTY_SERVICE_SMF_EVENT_CONNECTION_COUNT_THRESHOLD, - Broker.JSON_PROPERTY_SERVICE_SMF_PLAIN_TEXT_LISTEN_PORT, - Broker.JSON_PROPERTY_SERVICE_SMF_ROUTING_CONTROL_LISTEN_PORT, - Broker.JSON_PROPERTY_SERVICE_SMF_TLS_LISTEN_PORT, - Broker.JSON_PROPERTY_SERVICE_TLS_EVENT_CONNECTION_COUNT_THRESHOLD, - Broker.JSON_PROPERTY_SERVICE_WEB_TRANSPORT_ENABLED, - Broker.JSON_PROPERTY_SERVICE_WEB_TRANSPORT_PLAIN_TEXT_LISTEN_PORT, - Broker.JSON_PROPERTY_SERVICE_WEB_TRANSPORT_TLS_LISTEN_PORT, - Broker.JSON_PROPERTY_SERVICE_WEB_TRANSPORT_WEB_URL_SUFFIX, - Broker.JSON_PROPERTY_TLS_BLOCK_VERSION11_ENABLED, - Broker.JSON_PROPERTY_TLS_CIPHER_SUITE_MANAGEMENT_LIST, - Broker.JSON_PROPERTY_TLS_CIPHER_SUITE_MSG_BACKBONE_LIST, - Broker.JSON_PROPERTY_TLS_CIPHER_SUITE_SECURE_SHELL_LIST, - Broker.JSON_PROPERTY_TLS_CRIME_EXPLOIT_PROTECTION_ENABLED, - Broker.JSON_PROPERTY_TLS_SERVER_CERT_CONTENT, - Broker.JSON_PROPERTY_TLS_SERVER_CERT_PASSWORD, - Broker.JSON_PROPERTY_TLS_STANDARD_DOMAIN_CERTIFICATE_AUTHORITIES_ENABLED, - Broker.JSON_PROPERTY_TLS_TICKET_LIFETIME, - Broker.JSON_PROPERTY_WEB_MANAGER_ALLOW_UNENCRYPTED_WIZARDS_ENABLED, - Broker.JSON_PROPERTY_WEB_MANAGER_CUSTOMIZATION, - Broker.JSON_PROPERTY_WEB_MANAGER_REDIRECT_HTTP_ENABLED, - Broker.JSON_PROPERTY_WEB_MANAGER_REDIRECT_HTTP_OVERRIDE_TLS_PORT -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class Broker { - /** - * The client certificate revocation checking mode used when a client authenticates with a client certificate. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - Do not perform any certificate revocation checking. \"ocsp\" - Use the Open Certificate Status Protcol (OCSP) for certificate revocation checking. \"crl\" - Use Certificate Revocation Lists (CRL) for certificate revocation checking. \"ocsp-crl\" - Use OCSP first, but if OCSP fails to return an unambiguous result, then check via CRL. </pre> - */ - public enum AuthClientCertRevocationCheckModeEnum { - NONE("none"), - - OCSP("ocsp"), - - CRL("crl"), - - OCSP_CRL("ocsp-crl"); - - private String value; - - AuthClientCertRevocationCheckModeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AuthClientCertRevocationCheckModeEnum fromValue(String value) { - for (AuthClientCertRevocationCheckModeEnum b : AuthClientCertRevocationCheckModeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_AUTH_CLIENT_CERT_REVOCATION_CHECK_MODE = "authClientCertRevocationCheckMode"; - private AuthClientCertRevocationCheckModeEnum authClientCertRevocationCheckMode; - - public static final String JSON_PROPERTY_CONFIG_SYNC_AUTHENTICATION_CLIENT_CERT_MAX_CHAIN_DEPTH = "configSyncAuthenticationClientCertMaxChainDepth"; - private Long configSyncAuthenticationClientCertMaxChainDepth; - - public static final String JSON_PROPERTY_CONFIG_SYNC_AUTHENTICATION_CLIENT_CERT_VALIDATE_DATE_ENABLED = "configSyncAuthenticationClientCertValidateDateEnabled"; - private Boolean configSyncAuthenticationClientCertValidateDateEnabled; - - public static final String JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_INITIAL_CONGESTION_WINDOW = "configSyncClientProfileTcpInitialCongestionWindow"; - private Long configSyncClientProfileTcpInitialCongestionWindow; - - public static final String JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_KEEPALIVE_COUNT = "configSyncClientProfileTcpKeepaliveCount"; - private Long configSyncClientProfileTcpKeepaliveCount; - - public static final String JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_KEEPALIVE_IDLE = "configSyncClientProfileTcpKeepaliveIdle"; - private Long configSyncClientProfileTcpKeepaliveIdle; - - public static final String JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_KEEPALIVE_INTERVAL = "configSyncClientProfileTcpKeepaliveInterval"; - private Long configSyncClientProfileTcpKeepaliveInterval; - - public static final String JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_MAX_WINDOW = "configSyncClientProfileTcpMaxWindow"; - private Long configSyncClientProfileTcpMaxWindow; - - public static final String JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_MSS = "configSyncClientProfileTcpMss"; - private Long configSyncClientProfileTcpMss; - - public static final String JSON_PROPERTY_CONFIG_SYNC_ENABLED = "configSyncEnabled"; - private Boolean configSyncEnabled; - - public static final String JSON_PROPERTY_CONFIG_SYNC_SYNCHRONIZE_USERNAME_ENABLED = "configSyncSynchronizeUsernameEnabled"; - private Boolean configSyncSynchronizeUsernameEnabled; - - public static final String JSON_PROPERTY_CONFIG_SYNC_TLS_ENABLED = "configSyncTlsEnabled"; - private Boolean configSyncTlsEnabled; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_SCHEDULE_DAY_LIST = "guaranteedMsgingDefragmentationScheduleDayList"; - private String guaranteedMsgingDefragmentationScheduleDayList; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_SCHEDULE_ENABLED = "guaranteedMsgingDefragmentationScheduleEnabled"; - private Boolean guaranteedMsgingDefragmentationScheduleEnabled; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_SCHEDULE_TIME_LIST = "guaranteedMsgingDefragmentationScheduleTimeList"; - private String guaranteedMsgingDefragmentationScheduleTimeList; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_THRESHOLD_ENABLED = "guaranteedMsgingDefragmentationThresholdEnabled"; - private Boolean guaranteedMsgingDefragmentationThresholdEnabled; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_THRESHOLD_FRAGMENTATION_PERCENTAGE = "guaranteedMsgingDefragmentationThresholdFragmentationPercentage"; - private Long guaranteedMsgingDefragmentationThresholdFragmentationPercentage; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_THRESHOLD_MIN_INTERVAL = "guaranteedMsgingDefragmentationThresholdMinInterval"; - private Long guaranteedMsgingDefragmentationThresholdMinInterval; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_THRESHOLD_USAGE_PERCENTAGE = "guaranteedMsgingDefragmentationThresholdUsagePercentage"; - private Long guaranteedMsgingDefragmentationThresholdUsagePercentage; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_ENABLED = "guaranteedMsgingEnabled"; - private Boolean guaranteedMsgingEnabled; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_EVENT_CACHE_USAGE_THRESHOLD = "guaranteedMsgingEventCacheUsageThreshold"; - private EventThreshold guaranteedMsgingEventCacheUsageThreshold; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_EVENT_DELIVERED_UNACKED_THRESHOLD = "guaranteedMsgingEventDeliveredUnackedThreshold"; - private EventThresholdByPercent guaranteedMsgingEventDeliveredUnackedThreshold; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_EVENT_DISK_USAGE_THRESHOLD = "guaranteedMsgingEventDiskUsageThreshold"; - private EventThresholdByPercent guaranteedMsgingEventDiskUsageThreshold; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_EVENT_EGRESS_FLOW_COUNT_THRESHOLD = "guaranteedMsgingEventEgressFlowCountThreshold"; - private EventThreshold guaranteedMsgingEventEgressFlowCountThreshold; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_EVENT_ENDPOINT_COUNT_THRESHOLD = "guaranteedMsgingEventEndpointCountThreshold"; - private EventThreshold guaranteedMsgingEventEndpointCountThreshold; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_EVENT_INGRESS_FLOW_COUNT_THRESHOLD = "guaranteedMsgingEventIngressFlowCountThreshold"; - private EventThreshold guaranteedMsgingEventIngressFlowCountThreshold; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_EVENT_MSG_COUNT_THRESHOLD = "guaranteedMsgingEventMsgCountThreshold"; - private EventThresholdByPercent guaranteedMsgingEventMsgCountThreshold; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_EVENT_MSG_SPOOL_FILE_COUNT_THRESHOLD = "guaranteedMsgingEventMsgSpoolFileCountThreshold"; - private EventThresholdByPercent guaranteedMsgingEventMsgSpoolFileCountThreshold; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_EVENT_MSG_SPOOL_USAGE_THRESHOLD = "guaranteedMsgingEventMsgSpoolUsageThreshold"; - private EventThreshold guaranteedMsgingEventMsgSpoolUsageThreshold; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_EVENT_TRANSACTED_SESSION_COUNT_THRESHOLD = "guaranteedMsgingEventTransactedSessionCountThreshold"; - private EventThreshold guaranteedMsgingEventTransactedSessionCountThreshold; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_EVENT_TRANSACTED_SESSION_RESOURCE_COUNT_THRESHOLD = "guaranteedMsgingEventTransactedSessionResourceCountThreshold"; - private EventThresholdByPercent guaranteedMsgingEventTransactedSessionResourceCountThreshold; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_EVENT_TRANSACTION_COUNT_THRESHOLD = "guaranteedMsgingEventTransactionCountThreshold"; - private EventThreshold guaranteedMsgingEventTransactionCountThreshold; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_MAX_CACHE_USAGE = "guaranteedMsgingMaxCacheUsage"; - private Integer guaranteedMsgingMaxCacheUsage; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_MAX_MSG_SPOOL_USAGE = "guaranteedMsgingMaxMsgSpoolUsage"; - private Long guaranteedMsgingMaxMsgSpoolUsage; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_MSG_SPOOL_SYNC_MIRRORED_MSG_ACK_TIMEOUT = "guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout"; - private Long guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout; - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_MSG_SPOOL_SYNC_MIRRORED_SPOOL_FILE_ACK_TIMEOUT = "guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout"; - private Long guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout; - - /** - * The replication compatibility mode for the router. The default value is `\"legacy\"`. The allowed values and their meaning are:\"legacy\" - All transactions originated by clients are replicated to the standby site without using transactions.\"transacted\" - All transactions originated by clients are replicated to the standby site using transactions. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"legacy\"`. The allowed values and their meaning are: <pre> \"legacy\" - All transactions originated by clients are replicated to the standby site without using transactions. \"transacted\" - All transactions originated by clients are replicated to the standby site using transactions. </pre> Available since 2.18. - */ - public enum GuaranteedMsgingTransactionReplicationCompatibilityModeEnum { - LEGACY("legacy"), - - TRANSACTED("transacted"); - - private String value; - - GuaranteedMsgingTransactionReplicationCompatibilityModeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static GuaranteedMsgingTransactionReplicationCompatibilityModeEnum fromValue(String value) { - for (GuaranteedMsgingTransactionReplicationCompatibilityModeEnum b : GuaranteedMsgingTransactionReplicationCompatibilityModeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_GUARANTEED_MSGING_TRANSACTION_REPLICATION_COMPATIBILITY_MODE = "guaranteedMsgingTransactionReplicationCompatibilityMode"; - private GuaranteedMsgingTransactionReplicationCompatibilityModeEnum guaranteedMsgingTransactionReplicationCompatibilityMode; - - public static final String JSON_PROPERTY_OAUTH_PROFILE_DEFAULT = "oauthProfileDefault"; - private String oauthProfileDefault; - - public static final String JSON_PROPERTY_SERVICE_AMQP_ENABLED = "serviceAmqpEnabled"; - private Boolean serviceAmqpEnabled; - - public static final String JSON_PROPERTY_SERVICE_AMQP_TLS_LISTEN_PORT = "serviceAmqpTlsListenPort"; - private Long serviceAmqpTlsListenPort; - - public static final String JSON_PROPERTY_SERVICE_EVENT_CONNECTION_COUNT_THRESHOLD = "serviceEventConnectionCountThreshold"; - private EventThreshold serviceEventConnectionCountThreshold; - - public static final String JSON_PROPERTY_SERVICE_HEALTH_CHECK_ENABLED = "serviceHealthCheckEnabled"; - private Boolean serviceHealthCheckEnabled; - - public static final String JSON_PROPERTY_SERVICE_HEALTH_CHECK_LISTEN_PORT = "serviceHealthCheckListenPort"; - private Long serviceHealthCheckListenPort; - - public static final String JSON_PROPERTY_SERVICE_MATE_LINK_ENABLED = "serviceMateLinkEnabled"; - private Boolean serviceMateLinkEnabled; - - public static final String JSON_PROPERTY_SERVICE_MATE_LINK_LISTEN_PORT = "serviceMateLinkListenPort"; - private Long serviceMateLinkListenPort; - - public static final String JSON_PROPERTY_SERVICE_MQTT_ENABLED = "serviceMqttEnabled"; - private Boolean serviceMqttEnabled; - - public static final String JSON_PROPERTY_SERVICE_MSG_BACKBONE_ENABLED = "serviceMsgBackboneEnabled"; - private Boolean serviceMsgBackboneEnabled; - - public static final String JSON_PROPERTY_SERVICE_REDUNDANCY_ENABLED = "serviceRedundancyEnabled"; - private Boolean serviceRedundancyEnabled; - - public static final String JSON_PROPERTY_SERVICE_REDUNDANCY_FIRST_LISTEN_PORT = "serviceRedundancyFirstListenPort"; - private Long serviceRedundancyFirstListenPort; - - public static final String JSON_PROPERTY_SERVICE_REST_EVENT_OUTGOING_CONNECTION_COUNT_THRESHOLD = "serviceRestEventOutgoingConnectionCountThreshold"; - private EventThreshold serviceRestEventOutgoingConnectionCountThreshold; - - public static final String JSON_PROPERTY_SERVICE_REST_INCOMING_ENABLED = "serviceRestIncomingEnabled"; - private Boolean serviceRestIncomingEnabled; - - public static final String JSON_PROPERTY_SERVICE_REST_OUTGOING_ENABLED = "serviceRestOutgoingEnabled"; - private Boolean serviceRestOutgoingEnabled; - - public static final String JSON_PROPERTY_SERVICE_SEMP_CORS_ALLOW_ANY_HOST_ENABLED = "serviceSempCorsAllowAnyHostEnabled"; - private Boolean serviceSempCorsAllowAnyHostEnabled; - - public static final String JSON_PROPERTY_SERVICE_SEMP_LEGACY_TIMEOUT_ENABLED = "serviceSempLegacyTimeoutEnabled"; - private Boolean serviceSempLegacyTimeoutEnabled; - - public static final String JSON_PROPERTY_SERVICE_SEMP_PLAIN_TEXT_ENABLED = "serviceSempPlainTextEnabled"; - private Boolean serviceSempPlainTextEnabled; - - public static final String JSON_PROPERTY_SERVICE_SEMP_PLAIN_TEXT_LISTEN_PORT = "serviceSempPlainTextListenPort"; - private Long serviceSempPlainTextListenPort; - - public static final String JSON_PROPERTY_SERVICE_SEMP_SESSION_IDLE_TIMEOUT = "serviceSempSessionIdleTimeout"; - private Integer serviceSempSessionIdleTimeout; - - public static final String JSON_PROPERTY_SERVICE_SEMP_SESSION_MAX_LIFETIME = "serviceSempSessionMaxLifetime"; - private Integer serviceSempSessionMaxLifetime; - - public static final String JSON_PROPERTY_SERVICE_SEMP_TLS_ENABLED = "serviceSempTlsEnabled"; - private Boolean serviceSempTlsEnabled; - - public static final String JSON_PROPERTY_SERVICE_SEMP_TLS_LISTEN_PORT = "serviceSempTlsListenPort"; - private Long serviceSempTlsListenPort; - - public static final String JSON_PROPERTY_SERVICE_SMF_COMPRESSION_LISTEN_PORT = "serviceSmfCompressionListenPort"; - private Long serviceSmfCompressionListenPort; - - public static final String JSON_PROPERTY_SERVICE_SMF_ENABLED = "serviceSmfEnabled"; - private Boolean serviceSmfEnabled; - - public static final String JSON_PROPERTY_SERVICE_SMF_EVENT_CONNECTION_COUNT_THRESHOLD = "serviceSmfEventConnectionCountThreshold"; - private EventThreshold serviceSmfEventConnectionCountThreshold; - - public static final String JSON_PROPERTY_SERVICE_SMF_PLAIN_TEXT_LISTEN_PORT = "serviceSmfPlainTextListenPort"; - private Long serviceSmfPlainTextListenPort; - - public static final String JSON_PROPERTY_SERVICE_SMF_ROUTING_CONTROL_LISTEN_PORT = "serviceSmfRoutingControlListenPort"; - private Long serviceSmfRoutingControlListenPort; - - public static final String JSON_PROPERTY_SERVICE_SMF_TLS_LISTEN_PORT = "serviceSmfTlsListenPort"; - private Long serviceSmfTlsListenPort; - - public static final String JSON_PROPERTY_SERVICE_TLS_EVENT_CONNECTION_COUNT_THRESHOLD = "serviceTlsEventConnectionCountThreshold"; - private EventThreshold serviceTlsEventConnectionCountThreshold; - - public static final String JSON_PROPERTY_SERVICE_WEB_TRANSPORT_ENABLED = "serviceWebTransportEnabled"; - private Boolean serviceWebTransportEnabled; - - public static final String JSON_PROPERTY_SERVICE_WEB_TRANSPORT_PLAIN_TEXT_LISTEN_PORT = "serviceWebTransportPlainTextListenPort"; - private Long serviceWebTransportPlainTextListenPort; - - public static final String JSON_PROPERTY_SERVICE_WEB_TRANSPORT_TLS_LISTEN_PORT = "serviceWebTransportTlsListenPort"; - private Long serviceWebTransportTlsListenPort; - - public static final String JSON_PROPERTY_SERVICE_WEB_TRANSPORT_WEB_URL_SUFFIX = "serviceWebTransportWebUrlSuffix"; - private String serviceWebTransportWebUrlSuffix; - - public static final String JSON_PROPERTY_TLS_BLOCK_VERSION11_ENABLED = "tlsBlockVersion11Enabled"; - private Boolean tlsBlockVersion11Enabled; - - public static final String JSON_PROPERTY_TLS_CIPHER_SUITE_MANAGEMENT_LIST = "tlsCipherSuiteManagementList"; - private String tlsCipherSuiteManagementList; - - public static final String JSON_PROPERTY_TLS_CIPHER_SUITE_MSG_BACKBONE_LIST = "tlsCipherSuiteMsgBackboneList"; - private String tlsCipherSuiteMsgBackboneList; - - public static final String JSON_PROPERTY_TLS_CIPHER_SUITE_SECURE_SHELL_LIST = "tlsCipherSuiteSecureShellList"; - private String tlsCipherSuiteSecureShellList; - - public static final String JSON_PROPERTY_TLS_CRIME_EXPLOIT_PROTECTION_ENABLED = "tlsCrimeExploitProtectionEnabled"; - private Boolean tlsCrimeExploitProtectionEnabled; - - public static final String JSON_PROPERTY_TLS_SERVER_CERT_CONTENT = "tlsServerCertContent"; - private String tlsServerCertContent; - - public static final String JSON_PROPERTY_TLS_SERVER_CERT_PASSWORD = "tlsServerCertPassword"; - private String tlsServerCertPassword; - - public static final String JSON_PROPERTY_TLS_STANDARD_DOMAIN_CERTIFICATE_AUTHORITIES_ENABLED = "tlsStandardDomainCertificateAuthoritiesEnabled"; - private Boolean tlsStandardDomainCertificateAuthoritiesEnabled; - - public static final String JSON_PROPERTY_TLS_TICKET_LIFETIME = "tlsTicketLifetime"; - private Integer tlsTicketLifetime; - - public static final String JSON_PROPERTY_WEB_MANAGER_ALLOW_UNENCRYPTED_WIZARDS_ENABLED = "webManagerAllowUnencryptedWizardsEnabled"; - private Boolean webManagerAllowUnencryptedWizardsEnabled; - - public static final String JSON_PROPERTY_WEB_MANAGER_CUSTOMIZATION = "webManagerCustomization"; - private String webManagerCustomization; - - public static final String JSON_PROPERTY_WEB_MANAGER_REDIRECT_HTTP_ENABLED = "webManagerRedirectHttpEnabled"; - private Boolean webManagerRedirectHttpEnabled; - - public static final String JSON_PROPERTY_WEB_MANAGER_REDIRECT_HTTP_OVERRIDE_TLS_PORT = "webManagerRedirectHttpOverrideTlsPort"; - private Integer webManagerRedirectHttpOverrideTlsPort; - - public Broker() { - } - - public Broker authClientCertRevocationCheckMode(AuthClientCertRevocationCheckModeEnum authClientCertRevocationCheckMode) { - - this.authClientCertRevocationCheckMode = authClientCertRevocationCheckMode; - return this; - } - - /** - * The client certificate revocation checking mode used when a client authenticates with a client certificate. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - Do not perform any certificate revocation checking. \"ocsp\" - Use the Open Certificate Status Protcol (OCSP) for certificate revocation checking. \"crl\" - Use Certificate Revocation Lists (CRL) for certificate revocation checking. \"ocsp-crl\" - Use OCSP first, but if OCSP fails to return an unambiguous result, then check via CRL. </pre> - * @return authClientCertRevocationCheckMode - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTH_CLIENT_CERT_REVOCATION_CHECK_MODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AuthClientCertRevocationCheckModeEnum getAuthClientCertRevocationCheckMode() { - return authClientCertRevocationCheckMode; - } - - - @JsonProperty(JSON_PROPERTY_AUTH_CLIENT_CERT_REVOCATION_CHECK_MODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthClientCertRevocationCheckMode(AuthClientCertRevocationCheckModeEnum authClientCertRevocationCheckMode) { - this.authClientCertRevocationCheckMode = authClientCertRevocationCheckMode; - } - - - public Broker configSyncAuthenticationClientCertMaxChainDepth(Long configSyncAuthenticationClientCertMaxChainDepth) { - - this.configSyncAuthenticationClientCertMaxChainDepth = configSyncAuthenticationClientCertMaxChainDepth; - return this; - } - - /** - * The maximum depth for a client certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. The default value is `3`. Available since 2.22. - * @return configSyncAuthenticationClientCertMaxChainDepth - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_AUTHENTICATION_CLIENT_CERT_MAX_CHAIN_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getConfigSyncAuthenticationClientCertMaxChainDepth() { - return configSyncAuthenticationClientCertMaxChainDepth; - } - - - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_AUTHENTICATION_CLIENT_CERT_MAX_CHAIN_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConfigSyncAuthenticationClientCertMaxChainDepth(Long configSyncAuthenticationClientCertMaxChainDepth) { - this.configSyncAuthenticationClientCertMaxChainDepth = configSyncAuthenticationClientCertMaxChainDepth; - } - - - public Broker configSyncAuthenticationClientCertValidateDateEnabled(Boolean configSyncAuthenticationClientCertValidateDateEnabled) { - - this.configSyncAuthenticationClientCertValidateDateEnabled = configSyncAuthenticationClientCertValidateDateEnabled; - return this; - } - - /** - * Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the authentication certificate(s). The default value is `true`. Available since 2.22. - * @return configSyncAuthenticationClientCertValidateDateEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_AUTHENTICATION_CLIENT_CERT_VALIDATE_DATE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getConfigSyncAuthenticationClientCertValidateDateEnabled() { - return configSyncAuthenticationClientCertValidateDateEnabled; - } - - - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_AUTHENTICATION_CLIENT_CERT_VALIDATE_DATE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConfigSyncAuthenticationClientCertValidateDateEnabled(Boolean configSyncAuthenticationClientCertValidateDateEnabled) { - this.configSyncAuthenticationClientCertValidateDateEnabled = configSyncAuthenticationClientCertValidateDateEnabled; - } - - - public Broker configSyncClientProfileTcpInitialCongestionWindow(Long configSyncClientProfileTcpInitialCongestionWindow) { - - this.configSyncClientProfileTcpInitialCongestionWindow = configSyncClientProfileTcpInitialCongestionWindow; - return this; - } - - /** - * The TCP initial congestion window size for Config Sync clients, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. The default value is `2`. Available since 2.22. - * @return configSyncClientProfileTcpInitialCongestionWindow - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_INITIAL_CONGESTION_WINDOW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getConfigSyncClientProfileTcpInitialCongestionWindow() { - return configSyncClientProfileTcpInitialCongestionWindow; - } - - - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_INITIAL_CONGESTION_WINDOW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConfigSyncClientProfileTcpInitialCongestionWindow(Long configSyncClientProfileTcpInitialCongestionWindow) { - this.configSyncClientProfileTcpInitialCongestionWindow = configSyncClientProfileTcpInitialCongestionWindow; - } - - - public Broker configSyncClientProfileTcpKeepaliveCount(Long configSyncClientProfileTcpKeepaliveCount) { - - this.configSyncClientProfileTcpKeepaliveCount = configSyncClientProfileTcpKeepaliveCount; - return this; - } - - /** - * The number of TCP keepalive retransmissions to a client using the Client Profile before declaring that it is not available. The default value is `5`. Available since 2.22. - * @return configSyncClientProfileTcpKeepaliveCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_KEEPALIVE_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getConfigSyncClientProfileTcpKeepaliveCount() { - return configSyncClientProfileTcpKeepaliveCount; - } - - - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_KEEPALIVE_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConfigSyncClientProfileTcpKeepaliveCount(Long configSyncClientProfileTcpKeepaliveCount) { - this.configSyncClientProfileTcpKeepaliveCount = configSyncClientProfileTcpKeepaliveCount; - } - - - public Broker configSyncClientProfileTcpKeepaliveIdle(Long configSyncClientProfileTcpKeepaliveIdle) { - - this.configSyncClientProfileTcpKeepaliveIdle = configSyncClientProfileTcpKeepaliveIdle; - return this; - } - - /** - * The amount of time a client connection using the Client Profile must remain idle before TCP begins sending keepalive probes, in seconds. The default value is `3`. Available since 2.22. - * @return configSyncClientProfileTcpKeepaliveIdle - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_KEEPALIVE_IDLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getConfigSyncClientProfileTcpKeepaliveIdle() { - return configSyncClientProfileTcpKeepaliveIdle; - } - - - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_KEEPALIVE_IDLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConfigSyncClientProfileTcpKeepaliveIdle(Long configSyncClientProfileTcpKeepaliveIdle) { - this.configSyncClientProfileTcpKeepaliveIdle = configSyncClientProfileTcpKeepaliveIdle; - } - - - public Broker configSyncClientProfileTcpKeepaliveInterval(Long configSyncClientProfileTcpKeepaliveInterval) { - - this.configSyncClientProfileTcpKeepaliveInterval = configSyncClientProfileTcpKeepaliveInterval; - return this; - } - - /** - * The amount of time between TCP keepalive retransmissions to a client using the Client Profile when no acknowledgement is received, in seconds. The default value is `1`. Available since 2.22. - * @return configSyncClientProfileTcpKeepaliveInterval - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_KEEPALIVE_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getConfigSyncClientProfileTcpKeepaliveInterval() { - return configSyncClientProfileTcpKeepaliveInterval; - } - - - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_KEEPALIVE_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConfigSyncClientProfileTcpKeepaliveInterval(Long configSyncClientProfileTcpKeepaliveInterval) { - this.configSyncClientProfileTcpKeepaliveInterval = configSyncClientProfileTcpKeepaliveInterval; - } - - - public Broker configSyncClientProfileTcpMaxWindow(Long configSyncClientProfileTcpMaxWindow) { - - this.configSyncClientProfileTcpMaxWindow = configSyncClientProfileTcpMaxWindow; - return this; - } - - /** - * The TCP maximum window size for clients using the Client Profile, in kilobytes. Changes are applied to all existing connections. The default value is `256`. Available since 2.22. - * @return configSyncClientProfileTcpMaxWindow - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_MAX_WINDOW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getConfigSyncClientProfileTcpMaxWindow() { - return configSyncClientProfileTcpMaxWindow; - } - - - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_MAX_WINDOW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConfigSyncClientProfileTcpMaxWindow(Long configSyncClientProfileTcpMaxWindow) { - this.configSyncClientProfileTcpMaxWindow = configSyncClientProfileTcpMaxWindow; - } - - - public Broker configSyncClientProfileTcpMss(Long configSyncClientProfileTcpMss) { - - this.configSyncClientProfileTcpMss = configSyncClientProfileTcpMss; - return this; - } - - /** - * The TCP maximum segment size for clients using the Client Profile, in bytes. Changes are applied to all existing connections. The default value is `1460`. Available since 2.22. - * @return configSyncClientProfileTcpMss - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_MSS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getConfigSyncClientProfileTcpMss() { - return configSyncClientProfileTcpMss; - } - - - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_CLIENT_PROFILE_TCP_MSS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConfigSyncClientProfileTcpMss(Long configSyncClientProfileTcpMss) { - this.configSyncClientProfileTcpMss = configSyncClientProfileTcpMss; - } - - - public Broker configSyncEnabled(Boolean configSyncEnabled) { - - this.configSyncEnabled = configSyncEnabled; - return this; - } - - /** - * Enable or disable configuration synchronization for High Availability or Disaster Recovery. The default value is `false`. Available since 2.22. - * @return configSyncEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getConfigSyncEnabled() { - return configSyncEnabled; - } - - - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConfigSyncEnabled(Boolean configSyncEnabled) { - this.configSyncEnabled = configSyncEnabled; - } - - - public Broker configSyncSynchronizeUsernameEnabled(Boolean configSyncSynchronizeUsernameEnabled) { - - this.configSyncSynchronizeUsernameEnabled = configSyncSynchronizeUsernameEnabled; - return this; - } - - /** - * Enable or disable the synchronizing of usernames within High Availability groups. The transition from not synchronizing to synchronizing will cause the High Availability mate to fall out of sync. Recommendation: leave this as enabled. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.22. - * @return configSyncSynchronizeUsernameEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_SYNCHRONIZE_USERNAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getConfigSyncSynchronizeUsernameEnabled() { - return configSyncSynchronizeUsernameEnabled; - } - - - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_SYNCHRONIZE_USERNAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConfigSyncSynchronizeUsernameEnabled(Boolean configSyncSynchronizeUsernameEnabled) { - this.configSyncSynchronizeUsernameEnabled = configSyncSynchronizeUsernameEnabled; - } - - - public Broker configSyncTlsEnabled(Boolean configSyncTlsEnabled) { - - this.configSyncTlsEnabled = configSyncTlsEnabled; - return this; - } - - /** - * Enable or disable the use of TLS encryption of the configuration synchronization communications between brokers in High Availability groups and/or Disaster Recovery sites. The default value is `false`. Available since 2.22. - * @return configSyncTlsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getConfigSyncTlsEnabled() { - return configSyncTlsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_CONFIG_SYNC_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConfigSyncTlsEnabled(Boolean configSyncTlsEnabled) { - this.configSyncTlsEnabled = configSyncTlsEnabled; - } - - - public Broker guaranteedMsgingDefragmentationScheduleDayList(String guaranteedMsgingDefragmentationScheduleDayList) { - - this.guaranteedMsgingDefragmentationScheduleDayList = guaranteedMsgingDefragmentationScheduleDayList; - return this; - } - - /** - * The days of the week to schedule defragmentation runs, specified as \"daily\" or as a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri, or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. Please note \"Sun,Mon,Tue,Wed,Thu,Fri,Sat\" is not allowed, use \"daily\" instead. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"daily\"`. Available since 2.25. - * @return guaranteedMsgingDefragmentationScheduleDayList - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_SCHEDULE_DAY_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getGuaranteedMsgingDefragmentationScheduleDayList() { - return guaranteedMsgingDefragmentationScheduleDayList; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_SCHEDULE_DAY_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingDefragmentationScheduleDayList(String guaranteedMsgingDefragmentationScheduleDayList) { - this.guaranteedMsgingDefragmentationScheduleDayList = guaranteedMsgingDefragmentationScheduleDayList; - } - - - public Broker guaranteedMsgingDefragmentationScheduleEnabled(Boolean guaranteedMsgingDefragmentationScheduleEnabled) { - - this.guaranteedMsgingDefragmentationScheduleEnabled = guaranteedMsgingDefragmentationScheduleEnabled; - return this; - } - - /** - * Enable or disable schedule-based defragmentation of Guaranteed Messaging spool files. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.25. - * @return guaranteedMsgingDefragmentationScheduleEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_SCHEDULE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getGuaranteedMsgingDefragmentationScheduleEnabled() { - return guaranteedMsgingDefragmentationScheduleEnabled; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_SCHEDULE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingDefragmentationScheduleEnabled(Boolean guaranteedMsgingDefragmentationScheduleEnabled) { - this.guaranteedMsgingDefragmentationScheduleEnabled = guaranteedMsgingDefragmentationScheduleEnabled; - } - - - public Broker guaranteedMsgingDefragmentationScheduleTimeList(String guaranteedMsgingDefragmentationScheduleTimeList) { - - this.guaranteedMsgingDefragmentationScheduleTimeList = guaranteedMsgingDefragmentationScheduleTimeList; - return this; - } - - /** - * The times of the day to schedule defragmentation runs, specified as \"hourly\" or as a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"0:00\"`. Available since 2.25. - * @return guaranteedMsgingDefragmentationScheduleTimeList - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_SCHEDULE_TIME_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getGuaranteedMsgingDefragmentationScheduleTimeList() { - return guaranteedMsgingDefragmentationScheduleTimeList; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_SCHEDULE_TIME_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingDefragmentationScheduleTimeList(String guaranteedMsgingDefragmentationScheduleTimeList) { - this.guaranteedMsgingDefragmentationScheduleTimeList = guaranteedMsgingDefragmentationScheduleTimeList; - } - - - public Broker guaranteedMsgingDefragmentationThresholdEnabled(Boolean guaranteedMsgingDefragmentationThresholdEnabled) { - - this.guaranteedMsgingDefragmentationThresholdEnabled = guaranteedMsgingDefragmentationThresholdEnabled; - return this; - } - - /** - * Enable or disable threshold-based defragmentation of Guaranteed Messaging spool files. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.25. - * @return guaranteedMsgingDefragmentationThresholdEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_THRESHOLD_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getGuaranteedMsgingDefragmentationThresholdEnabled() { - return guaranteedMsgingDefragmentationThresholdEnabled; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_THRESHOLD_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingDefragmentationThresholdEnabled(Boolean guaranteedMsgingDefragmentationThresholdEnabled) { - this.guaranteedMsgingDefragmentationThresholdEnabled = guaranteedMsgingDefragmentationThresholdEnabled; - } - - - public Broker guaranteedMsgingDefragmentationThresholdFragmentationPercentage(Long guaranteedMsgingDefragmentationThresholdFragmentationPercentage) { - - this.guaranteedMsgingDefragmentationThresholdFragmentationPercentage = guaranteedMsgingDefragmentationThresholdFragmentationPercentage; - return this; - } - - /** - * Percentage of spool fragmentation needed to trigger defragmentation run. The minimum value allowed is 30%. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `50`. Available since 2.25. - * @return guaranteedMsgingDefragmentationThresholdFragmentationPercentage - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_THRESHOLD_FRAGMENTATION_PERCENTAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getGuaranteedMsgingDefragmentationThresholdFragmentationPercentage() { - return guaranteedMsgingDefragmentationThresholdFragmentationPercentage; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_THRESHOLD_FRAGMENTATION_PERCENTAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingDefragmentationThresholdFragmentationPercentage(Long guaranteedMsgingDefragmentationThresholdFragmentationPercentage) { - this.guaranteedMsgingDefragmentationThresholdFragmentationPercentage = guaranteedMsgingDefragmentationThresholdFragmentationPercentage; - } - - - public Broker guaranteedMsgingDefragmentationThresholdMinInterval(Long guaranteedMsgingDefragmentationThresholdMinInterval) { - - this.guaranteedMsgingDefragmentationThresholdMinInterval = guaranteedMsgingDefragmentationThresholdMinInterval; - return this; - } - - /** - * Minimum interval of time (in minutes) between defragmentation runs triggered by thresholds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `15`. Available since 2.25. - * @return guaranteedMsgingDefragmentationThresholdMinInterval - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_THRESHOLD_MIN_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getGuaranteedMsgingDefragmentationThresholdMinInterval() { - return guaranteedMsgingDefragmentationThresholdMinInterval; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_THRESHOLD_MIN_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingDefragmentationThresholdMinInterval(Long guaranteedMsgingDefragmentationThresholdMinInterval) { - this.guaranteedMsgingDefragmentationThresholdMinInterval = guaranteedMsgingDefragmentationThresholdMinInterval; - } - - - public Broker guaranteedMsgingDefragmentationThresholdUsagePercentage(Long guaranteedMsgingDefragmentationThresholdUsagePercentage) { - - this.guaranteedMsgingDefragmentationThresholdUsagePercentage = guaranteedMsgingDefragmentationThresholdUsagePercentage; - return this; - } - - /** - * Percentage of spool usage needed to trigger defragmentation run. The minimum value allowed is 30%. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `50`. Available since 2.25. - * @return guaranteedMsgingDefragmentationThresholdUsagePercentage - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_THRESHOLD_USAGE_PERCENTAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getGuaranteedMsgingDefragmentationThresholdUsagePercentage() { - return guaranteedMsgingDefragmentationThresholdUsagePercentage; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_DEFRAGMENTATION_THRESHOLD_USAGE_PERCENTAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingDefragmentationThresholdUsagePercentage(Long guaranteedMsgingDefragmentationThresholdUsagePercentage) { - this.guaranteedMsgingDefragmentationThresholdUsagePercentage = guaranteedMsgingDefragmentationThresholdUsagePercentage; - } - - - public Broker guaranteedMsgingEnabled(Boolean guaranteedMsgingEnabled) { - - this.guaranteedMsgingEnabled = guaranteedMsgingEnabled; - return this; - } - - /** - * Enable or disable Guaranteed Messaging. The default value is `false`. Available since 2.18. - * @return guaranteedMsgingEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getGuaranteedMsgingEnabled() { - return guaranteedMsgingEnabled; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingEnabled(Boolean guaranteedMsgingEnabled) { - this.guaranteedMsgingEnabled = guaranteedMsgingEnabled; - } - - - public Broker guaranteedMsgingEventCacheUsageThreshold(EventThreshold guaranteedMsgingEventCacheUsageThreshold) { - - this.guaranteedMsgingEventCacheUsageThreshold = guaranteedMsgingEventCacheUsageThreshold; - return this; - } - - /** - * Get guaranteedMsgingEventCacheUsageThreshold - * @return guaranteedMsgingEventCacheUsageThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_CACHE_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getGuaranteedMsgingEventCacheUsageThreshold() { - return guaranteedMsgingEventCacheUsageThreshold; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_CACHE_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingEventCacheUsageThreshold(EventThreshold guaranteedMsgingEventCacheUsageThreshold) { - this.guaranteedMsgingEventCacheUsageThreshold = guaranteedMsgingEventCacheUsageThreshold; - } - - - public Broker guaranteedMsgingEventDeliveredUnackedThreshold(EventThresholdByPercent guaranteedMsgingEventDeliveredUnackedThreshold) { - - this.guaranteedMsgingEventDeliveredUnackedThreshold = guaranteedMsgingEventDeliveredUnackedThreshold; - return this; - } - - /** - * Get guaranteedMsgingEventDeliveredUnackedThreshold - * @return guaranteedMsgingEventDeliveredUnackedThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_DELIVERED_UNACKED_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThresholdByPercent getGuaranteedMsgingEventDeliveredUnackedThreshold() { - return guaranteedMsgingEventDeliveredUnackedThreshold; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_DELIVERED_UNACKED_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingEventDeliveredUnackedThreshold(EventThresholdByPercent guaranteedMsgingEventDeliveredUnackedThreshold) { - this.guaranteedMsgingEventDeliveredUnackedThreshold = guaranteedMsgingEventDeliveredUnackedThreshold; - } - - - public Broker guaranteedMsgingEventDiskUsageThreshold(EventThresholdByPercent guaranteedMsgingEventDiskUsageThreshold) { - - this.guaranteedMsgingEventDiskUsageThreshold = guaranteedMsgingEventDiskUsageThreshold; - return this; - } - - /** - * Get guaranteedMsgingEventDiskUsageThreshold - * @return guaranteedMsgingEventDiskUsageThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_DISK_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThresholdByPercent getGuaranteedMsgingEventDiskUsageThreshold() { - return guaranteedMsgingEventDiskUsageThreshold; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_DISK_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingEventDiskUsageThreshold(EventThresholdByPercent guaranteedMsgingEventDiskUsageThreshold) { - this.guaranteedMsgingEventDiskUsageThreshold = guaranteedMsgingEventDiskUsageThreshold; - } - - - public Broker guaranteedMsgingEventEgressFlowCountThreshold(EventThreshold guaranteedMsgingEventEgressFlowCountThreshold) { - - this.guaranteedMsgingEventEgressFlowCountThreshold = guaranteedMsgingEventEgressFlowCountThreshold; - return this; - } - - /** - * Get guaranteedMsgingEventEgressFlowCountThreshold - * @return guaranteedMsgingEventEgressFlowCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_EGRESS_FLOW_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getGuaranteedMsgingEventEgressFlowCountThreshold() { - return guaranteedMsgingEventEgressFlowCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_EGRESS_FLOW_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingEventEgressFlowCountThreshold(EventThreshold guaranteedMsgingEventEgressFlowCountThreshold) { - this.guaranteedMsgingEventEgressFlowCountThreshold = guaranteedMsgingEventEgressFlowCountThreshold; - } - - - public Broker guaranteedMsgingEventEndpointCountThreshold(EventThreshold guaranteedMsgingEventEndpointCountThreshold) { - - this.guaranteedMsgingEventEndpointCountThreshold = guaranteedMsgingEventEndpointCountThreshold; - return this; - } - - /** - * Get guaranteedMsgingEventEndpointCountThreshold - * @return guaranteedMsgingEventEndpointCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_ENDPOINT_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getGuaranteedMsgingEventEndpointCountThreshold() { - return guaranteedMsgingEventEndpointCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_ENDPOINT_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingEventEndpointCountThreshold(EventThreshold guaranteedMsgingEventEndpointCountThreshold) { - this.guaranteedMsgingEventEndpointCountThreshold = guaranteedMsgingEventEndpointCountThreshold; - } - - - public Broker guaranteedMsgingEventIngressFlowCountThreshold(EventThreshold guaranteedMsgingEventIngressFlowCountThreshold) { - - this.guaranteedMsgingEventIngressFlowCountThreshold = guaranteedMsgingEventIngressFlowCountThreshold; - return this; - } - - /** - * Get guaranteedMsgingEventIngressFlowCountThreshold - * @return guaranteedMsgingEventIngressFlowCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_INGRESS_FLOW_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getGuaranteedMsgingEventIngressFlowCountThreshold() { - return guaranteedMsgingEventIngressFlowCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_INGRESS_FLOW_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingEventIngressFlowCountThreshold(EventThreshold guaranteedMsgingEventIngressFlowCountThreshold) { - this.guaranteedMsgingEventIngressFlowCountThreshold = guaranteedMsgingEventIngressFlowCountThreshold; - } - - - public Broker guaranteedMsgingEventMsgCountThreshold(EventThresholdByPercent guaranteedMsgingEventMsgCountThreshold) { - - this.guaranteedMsgingEventMsgCountThreshold = guaranteedMsgingEventMsgCountThreshold; - return this; - } - - /** - * Get guaranteedMsgingEventMsgCountThreshold - * @return guaranteedMsgingEventMsgCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_MSG_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThresholdByPercent getGuaranteedMsgingEventMsgCountThreshold() { - return guaranteedMsgingEventMsgCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_MSG_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingEventMsgCountThreshold(EventThresholdByPercent guaranteedMsgingEventMsgCountThreshold) { - this.guaranteedMsgingEventMsgCountThreshold = guaranteedMsgingEventMsgCountThreshold; - } - - - public Broker guaranteedMsgingEventMsgSpoolFileCountThreshold(EventThresholdByPercent guaranteedMsgingEventMsgSpoolFileCountThreshold) { - - this.guaranteedMsgingEventMsgSpoolFileCountThreshold = guaranteedMsgingEventMsgSpoolFileCountThreshold; - return this; - } - - /** - * Get guaranteedMsgingEventMsgSpoolFileCountThreshold - * @return guaranteedMsgingEventMsgSpoolFileCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_MSG_SPOOL_FILE_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThresholdByPercent getGuaranteedMsgingEventMsgSpoolFileCountThreshold() { - return guaranteedMsgingEventMsgSpoolFileCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_MSG_SPOOL_FILE_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingEventMsgSpoolFileCountThreshold(EventThresholdByPercent guaranteedMsgingEventMsgSpoolFileCountThreshold) { - this.guaranteedMsgingEventMsgSpoolFileCountThreshold = guaranteedMsgingEventMsgSpoolFileCountThreshold; - } - - - public Broker guaranteedMsgingEventMsgSpoolUsageThreshold(EventThreshold guaranteedMsgingEventMsgSpoolUsageThreshold) { - - this.guaranteedMsgingEventMsgSpoolUsageThreshold = guaranteedMsgingEventMsgSpoolUsageThreshold; - return this; - } - - /** - * Get guaranteedMsgingEventMsgSpoolUsageThreshold - * @return guaranteedMsgingEventMsgSpoolUsageThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_MSG_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getGuaranteedMsgingEventMsgSpoolUsageThreshold() { - return guaranteedMsgingEventMsgSpoolUsageThreshold; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_MSG_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingEventMsgSpoolUsageThreshold(EventThreshold guaranteedMsgingEventMsgSpoolUsageThreshold) { - this.guaranteedMsgingEventMsgSpoolUsageThreshold = guaranteedMsgingEventMsgSpoolUsageThreshold; - } - - - public Broker guaranteedMsgingEventTransactedSessionCountThreshold(EventThreshold guaranteedMsgingEventTransactedSessionCountThreshold) { - - this.guaranteedMsgingEventTransactedSessionCountThreshold = guaranteedMsgingEventTransactedSessionCountThreshold; - return this; - } - - /** - * Get guaranteedMsgingEventTransactedSessionCountThreshold - * @return guaranteedMsgingEventTransactedSessionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_TRANSACTED_SESSION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getGuaranteedMsgingEventTransactedSessionCountThreshold() { - return guaranteedMsgingEventTransactedSessionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_TRANSACTED_SESSION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingEventTransactedSessionCountThreshold(EventThreshold guaranteedMsgingEventTransactedSessionCountThreshold) { - this.guaranteedMsgingEventTransactedSessionCountThreshold = guaranteedMsgingEventTransactedSessionCountThreshold; - } - - - public Broker guaranteedMsgingEventTransactedSessionResourceCountThreshold(EventThresholdByPercent guaranteedMsgingEventTransactedSessionResourceCountThreshold) { - - this.guaranteedMsgingEventTransactedSessionResourceCountThreshold = guaranteedMsgingEventTransactedSessionResourceCountThreshold; - return this; - } - - /** - * Get guaranteedMsgingEventTransactedSessionResourceCountThreshold - * @return guaranteedMsgingEventTransactedSessionResourceCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_TRANSACTED_SESSION_RESOURCE_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThresholdByPercent getGuaranteedMsgingEventTransactedSessionResourceCountThreshold() { - return guaranteedMsgingEventTransactedSessionResourceCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_TRANSACTED_SESSION_RESOURCE_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingEventTransactedSessionResourceCountThreshold(EventThresholdByPercent guaranteedMsgingEventTransactedSessionResourceCountThreshold) { - this.guaranteedMsgingEventTransactedSessionResourceCountThreshold = guaranteedMsgingEventTransactedSessionResourceCountThreshold; - } - - - public Broker guaranteedMsgingEventTransactionCountThreshold(EventThreshold guaranteedMsgingEventTransactionCountThreshold) { - - this.guaranteedMsgingEventTransactionCountThreshold = guaranteedMsgingEventTransactionCountThreshold; - return this; - } - - /** - * Get guaranteedMsgingEventTransactionCountThreshold - * @return guaranteedMsgingEventTransactionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_TRANSACTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getGuaranteedMsgingEventTransactionCountThreshold() { - return guaranteedMsgingEventTransactionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_EVENT_TRANSACTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingEventTransactionCountThreshold(EventThreshold guaranteedMsgingEventTransactionCountThreshold) { - this.guaranteedMsgingEventTransactionCountThreshold = guaranteedMsgingEventTransactionCountThreshold; - } - - - public Broker guaranteedMsgingMaxCacheUsage(Integer guaranteedMsgingMaxCacheUsage) { - - this.guaranteedMsgingMaxCacheUsage = guaranteedMsgingMaxCacheUsage; - return this; - } - - /** - * Guaranteed messaging cache usage limit. Expressed as a maximum percentage of the NAB's egress queueing. resources that the guaranteed message cache is allowed to use. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `10`. Available since 2.18. - * @return guaranteedMsgingMaxCacheUsage - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_MAX_CACHE_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getGuaranteedMsgingMaxCacheUsage() { - return guaranteedMsgingMaxCacheUsage; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_MAX_CACHE_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingMaxCacheUsage(Integer guaranteedMsgingMaxCacheUsage) { - this.guaranteedMsgingMaxCacheUsage = guaranteedMsgingMaxCacheUsage; - } - - - public Broker guaranteedMsgingMaxMsgSpoolUsage(Long guaranteedMsgingMaxMsgSpoolUsage) { - - this.guaranteedMsgingMaxMsgSpoolUsage = guaranteedMsgingMaxMsgSpoolUsage; - return this; - } - - /** - * The maximum total message spool usage allowed across all VPNs on this broker, in megabytes. Recommendation: the maximum value should be less than 90% of the disk space allocated for the guaranteed message spool. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1500`. Available since 2.18. - * @return guaranteedMsgingMaxMsgSpoolUsage - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_MAX_MSG_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getGuaranteedMsgingMaxMsgSpoolUsage() { - return guaranteedMsgingMaxMsgSpoolUsage; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_MAX_MSG_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingMaxMsgSpoolUsage(Long guaranteedMsgingMaxMsgSpoolUsage) { - this.guaranteedMsgingMaxMsgSpoolUsage = guaranteedMsgingMaxMsgSpoolUsage; - } - - - public Broker guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout(Long guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout) { - - this.guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout = guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout; - return this; - } - - /** - * The maximum time, in milliseconds, that can be tolerated for remote acknowledgement of synchronization messages before which the remote system will be considered out of sync. The default value is `10000`. Available since 2.18. - * @return guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_MSG_SPOOL_SYNC_MIRRORED_MSG_ACK_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getGuaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout() { - return guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_MSG_SPOOL_SYNC_MIRRORED_MSG_ACK_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout(Long guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout) { - this.guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout = guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout; - } - - - public Broker guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout(Long guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout) { - - this.guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout = guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout; - return this; - } - - /** - * The maximum time, in milliseconds, that can be tolerated for remote disk writes before which the remote system will be considered out of sync. The default value is `10000`. Available since 2.18. - * @return guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_MSG_SPOOL_SYNC_MIRRORED_SPOOL_FILE_ACK_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getGuaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout() { - return guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_MSG_SPOOL_SYNC_MIRRORED_SPOOL_FILE_ACK_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout(Long guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout) { - this.guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout = guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout; - } - - - public Broker guaranteedMsgingTransactionReplicationCompatibilityMode(GuaranteedMsgingTransactionReplicationCompatibilityModeEnum guaranteedMsgingTransactionReplicationCompatibilityMode) { - - this.guaranteedMsgingTransactionReplicationCompatibilityMode = guaranteedMsgingTransactionReplicationCompatibilityMode; - return this; - } - - /** - * The replication compatibility mode for the router. The default value is `\"legacy\"`. The allowed values and their meaning are:\"legacy\" - All transactions originated by clients are replicated to the standby site without using transactions.\"transacted\" - All transactions originated by clients are replicated to the standby site using transactions. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"legacy\"`. The allowed values and their meaning are: <pre> \"legacy\" - All transactions originated by clients are replicated to the standby site without using transactions. \"transacted\" - All transactions originated by clients are replicated to the standby site using transactions. </pre> Available since 2.18. - * @return guaranteedMsgingTransactionReplicationCompatibilityMode - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_TRANSACTION_REPLICATION_COMPATIBILITY_MODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public GuaranteedMsgingTransactionReplicationCompatibilityModeEnum getGuaranteedMsgingTransactionReplicationCompatibilityMode() { - return guaranteedMsgingTransactionReplicationCompatibilityMode; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_MSGING_TRANSACTION_REPLICATION_COMPATIBILITY_MODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedMsgingTransactionReplicationCompatibilityMode(GuaranteedMsgingTransactionReplicationCompatibilityModeEnum guaranteedMsgingTransactionReplicationCompatibilityMode) { - this.guaranteedMsgingTransactionReplicationCompatibilityMode = guaranteedMsgingTransactionReplicationCompatibilityMode; - } - - - public Broker oauthProfileDefault(String oauthProfileDefault) { - - this.oauthProfileDefault = oauthProfileDefault; - return this; - } - - /** - * The default OAuth profile for OAuth authenticated SEMP requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Available since 2.24. - * @return oauthProfileDefault - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_DEFAULT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthProfileDefault() { - return oauthProfileDefault; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_DEFAULT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthProfileDefault(String oauthProfileDefault) { - this.oauthProfileDefault = oauthProfileDefault; - } - - - public Broker serviceAmqpEnabled(Boolean serviceAmqpEnabled) { - - this.serviceAmqpEnabled = serviceAmqpEnabled; - return this; - } - - /** - * Enable or disable the AMQP service. When disabled new AMQP Clients may not connect through the global or per-VPN AMQP listen-ports, and all currently connected AMQP Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17. - * @return serviceAmqpEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_AMQP_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceAmqpEnabled() { - return serviceAmqpEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_AMQP_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceAmqpEnabled(Boolean serviceAmqpEnabled) { - this.serviceAmqpEnabled = serviceAmqpEnabled; - } - - - public Broker serviceAmqpTlsListenPort(Long serviceAmqpTlsListenPort) { - - this.serviceAmqpTlsListenPort = serviceAmqpTlsListenPort; - return this; - } - - /** - * TCP port number that AMQP clients can use to connect to the broker using raw TCP over TLS. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since 2.17. - * @return serviceAmqpTlsListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_AMQP_TLS_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceAmqpTlsListenPort() { - return serviceAmqpTlsListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_AMQP_TLS_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceAmqpTlsListenPort(Long serviceAmqpTlsListenPort) { - this.serviceAmqpTlsListenPort = serviceAmqpTlsListenPort; - } - - - public Broker serviceEventConnectionCountThreshold(EventThreshold serviceEventConnectionCountThreshold) { - - this.serviceEventConnectionCountThreshold = serviceEventConnectionCountThreshold; - return this; - } - - /** - * Get serviceEventConnectionCountThreshold - * @return serviceEventConnectionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_EVENT_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getServiceEventConnectionCountThreshold() { - return serviceEventConnectionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_EVENT_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceEventConnectionCountThreshold(EventThreshold serviceEventConnectionCountThreshold) { - this.serviceEventConnectionCountThreshold = serviceEventConnectionCountThreshold; - } - - - public Broker serviceHealthCheckEnabled(Boolean serviceHealthCheckEnabled) { - - this.serviceHealthCheckEnabled = serviceHealthCheckEnabled; - return this; - } - - /** - * Enable or disable the health-check service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17. - * @return serviceHealthCheckEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_HEALTH_CHECK_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceHealthCheckEnabled() { - return serviceHealthCheckEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_HEALTH_CHECK_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceHealthCheckEnabled(Boolean serviceHealthCheckEnabled) { - this.serviceHealthCheckEnabled = serviceHealthCheckEnabled; - } - - - public Broker serviceHealthCheckListenPort(Long serviceHealthCheckListenPort) { - - this.serviceHealthCheckListenPort = serviceHealthCheckListenPort; - return this; - } - - /** - * The port number for the health-check service. The port must be unique across the message backbone. The health-check service must be disabled to change the port. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5550`. Available since 2.17. - * @return serviceHealthCheckListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_HEALTH_CHECK_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceHealthCheckListenPort() { - return serviceHealthCheckListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_HEALTH_CHECK_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceHealthCheckListenPort(Long serviceHealthCheckListenPort) { - this.serviceHealthCheckListenPort = serviceHealthCheckListenPort; - } - - - public Broker serviceMateLinkEnabled(Boolean serviceMateLinkEnabled) { - - this.serviceMateLinkEnabled = serviceMateLinkEnabled; - return this; - } - - /** - * Enable or disable the mate-link service. The default value is `true`. Available since 2.17. - * @return serviceMateLinkEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_MATE_LINK_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceMateLinkEnabled() { - return serviceMateLinkEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_MATE_LINK_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceMateLinkEnabled(Boolean serviceMateLinkEnabled) { - this.serviceMateLinkEnabled = serviceMateLinkEnabled; - } - - - public Broker serviceMateLinkListenPort(Long serviceMateLinkListenPort) { - - this.serviceMateLinkListenPort = serviceMateLinkListenPort; - return this; - } - - /** - * The port number for the mate-link service. The port must be unique across the message backbone. The mate-link service must be disabled to change the port. The default value is `8741`. Available since 2.17. - * @return serviceMateLinkListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_MATE_LINK_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceMateLinkListenPort() { - return serviceMateLinkListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_MATE_LINK_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceMateLinkListenPort(Long serviceMateLinkListenPort) { - this.serviceMateLinkListenPort = serviceMateLinkListenPort; - } - - - public Broker serviceMqttEnabled(Boolean serviceMqttEnabled) { - - this.serviceMqttEnabled = serviceMqttEnabled; - return this; - } - - /** - * Enable or disable the MQTT service. When disabled new MQTT Clients may not connect through the per-VPN MQTT listen-ports, and all currently connected MQTT Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17. - * @return serviceMqttEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceMqttEnabled() { - return serviceMqttEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceMqttEnabled(Boolean serviceMqttEnabled) { - this.serviceMqttEnabled = serviceMqttEnabled; - } - - - public Broker serviceMsgBackboneEnabled(Boolean serviceMsgBackboneEnabled) { - - this.serviceMsgBackboneEnabled = serviceMsgBackboneEnabled; - return this; - } - - /** - * Enable or disable the msg-backbone service. When disabled new Clients may not connect through global or per-VPN listen-ports, and all currently connected Clients are immediately disconnected. The default value is `true`. Available since 2.17. - * @return serviceMsgBackboneEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_MSG_BACKBONE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceMsgBackboneEnabled() { - return serviceMsgBackboneEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_MSG_BACKBONE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceMsgBackboneEnabled(Boolean serviceMsgBackboneEnabled) { - this.serviceMsgBackboneEnabled = serviceMsgBackboneEnabled; - } - - - public Broker serviceRedundancyEnabled(Boolean serviceRedundancyEnabled) { - - this.serviceRedundancyEnabled = serviceRedundancyEnabled; - return this; - } - - /** - * Enable or disable the redundancy service. The default value is `true`. Available since 2.17. - * @return serviceRedundancyEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_REDUNDANCY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceRedundancyEnabled() { - return serviceRedundancyEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_REDUNDANCY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceRedundancyEnabled(Boolean serviceRedundancyEnabled) { - this.serviceRedundancyEnabled = serviceRedundancyEnabled; - } - - - public Broker serviceRedundancyFirstListenPort(Long serviceRedundancyFirstListenPort) { - - this.serviceRedundancyFirstListenPort = serviceRedundancyFirstListenPort; - return this; - } - - /** - * The first listen-port used for the redundancy service. Redundancy uses this port and the subsequent 2 ports. These port must be unique across the message backbone. The redundancy service must be disabled to change this port. The default value is `8300`. Available since 2.17. - * @return serviceRedundancyFirstListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_REDUNDANCY_FIRST_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceRedundancyFirstListenPort() { - return serviceRedundancyFirstListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_REDUNDANCY_FIRST_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceRedundancyFirstListenPort(Long serviceRedundancyFirstListenPort) { - this.serviceRedundancyFirstListenPort = serviceRedundancyFirstListenPort; - } - - - public Broker serviceRestEventOutgoingConnectionCountThreshold(EventThreshold serviceRestEventOutgoingConnectionCountThreshold) { - - this.serviceRestEventOutgoingConnectionCountThreshold = serviceRestEventOutgoingConnectionCountThreshold; - return this; - } - - /** - * Get serviceRestEventOutgoingConnectionCountThreshold - * @return serviceRestEventOutgoingConnectionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_REST_EVENT_OUTGOING_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getServiceRestEventOutgoingConnectionCountThreshold() { - return serviceRestEventOutgoingConnectionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_REST_EVENT_OUTGOING_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceRestEventOutgoingConnectionCountThreshold(EventThreshold serviceRestEventOutgoingConnectionCountThreshold) { - this.serviceRestEventOutgoingConnectionCountThreshold = serviceRestEventOutgoingConnectionCountThreshold; - } - - - public Broker serviceRestIncomingEnabled(Boolean serviceRestIncomingEnabled) { - - this.serviceRestIncomingEnabled = serviceRestIncomingEnabled; - return this; - } - - /** - * Enable or disable the REST service incoming connections on the router. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17. - * @return serviceRestIncomingEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_REST_INCOMING_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceRestIncomingEnabled() { - return serviceRestIncomingEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_REST_INCOMING_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceRestIncomingEnabled(Boolean serviceRestIncomingEnabled) { - this.serviceRestIncomingEnabled = serviceRestIncomingEnabled; - } - - - public Broker serviceRestOutgoingEnabled(Boolean serviceRestOutgoingEnabled) { - - this.serviceRestOutgoingEnabled = serviceRestOutgoingEnabled; - return this; - } - - /** - * Enable or disable the REST service outgoing connections on the router. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17. - * @return serviceRestOutgoingEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_REST_OUTGOING_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceRestOutgoingEnabled() { - return serviceRestOutgoingEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_REST_OUTGOING_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceRestOutgoingEnabled(Boolean serviceRestOutgoingEnabled) { - this.serviceRestOutgoingEnabled = serviceRestOutgoingEnabled; - } - - - public Broker serviceSempCorsAllowAnyHostEnabled(Boolean serviceSempCorsAllowAnyHostEnabled) { - - this.serviceSempCorsAllowAnyHostEnabled = serviceSempCorsAllowAnyHostEnabled; - return this; - } - - /** - * Enable or disable cross origin resource requests for the SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.24. - * @return serviceSempCorsAllowAnyHostEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SEMP_CORS_ALLOW_ANY_HOST_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceSempCorsAllowAnyHostEnabled() { - return serviceSempCorsAllowAnyHostEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SEMP_CORS_ALLOW_ANY_HOST_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSempCorsAllowAnyHostEnabled(Boolean serviceSempCorsAllowAnyHostEnabled) { - this.serviceSempCorsAllowAnyHostEnabled = serviceSempCorsAllowAnyHostEnabled; - } - - - public Broker serviceSempLegacyTimeoutEnabled(Boolean serviceSempLegacyTimeoutEnabled) { - - this.serviceSempLegacyTimeoutEnabled = serviceSempLegacyTimeoutEnabled; - return this; - } - - /** - * Enable or disable extended SEMP timeouts for paged GETs. When a request times out, it returns the current page of content, even if the page is not full. When enabled, the timeout is 60 seconds. When disabled, the timeout is 5 seconds. The recommended setting is disabled (no legacy-timeout). This parameter is intended as a temporary workaround to be used until SEMP clients can handle short pages. This setting will be removed in a future release. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.18. - * @return serviceSempLegacyTimeoutEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SEMP_LEGACY_TIMEOUT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceSempLegacyTimeoutEnabled() { - return serviceSempLegacyTimeoutEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SEMP_LEGACY_TIMEOUT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSempLegacyTimeoutEnabled(Boolean serviceSempLegacyTimeoutEnabled) { - this.serviceSempLegacyTimeoutEnabled = serviceSempLegacyTimeoutEnabled; - } - - - public Broker serviceSempPlainTextEnabled(Boolean serviceSempPlainTextEnabled) { - - this.serviceSempPlainTextEnabled = serviceSempPlainTextEnabled; - return this; - } - - /** - * Enable or disable plain-text SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.17. - * @return serviceSempPlainTextEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SEMP_PLAIN_TEXT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceSempPlainTextEnabled() { - return serviceSempPlainTextEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SEMP_PLAIN_TEXT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSempPlainTextEnabled(Boolean serviceSempPlainTextEnabled) { - this.serviceSempPlainTextEnabled = serviceSempPlainTextEnabled; - } - - - public Broker serviceSempPlainTextListenPort(Long serviceSempPlainTextListenPort) { - - this.serviceSempPlainTextListenPort = serviceSempPlainTextListenPort; - return this; - } - - /** - * The TCP port for plain-text SEMP client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `80`. Available since 2.17. - * @return serviceSempPlainTextListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SEMP_PLAIN_TEXT_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceSempPlainTextListenPort() { - return serviceSempPlainTextListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SEMP_PLAIN_TEXT_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSempPlainTextListenPort(Long serviceSempPlainTextListenPort) { - this.serviceSempPlainTextListenPort = serviceSempPlainTextListenPort; - } - - - public Broker serviceSempSessionIdleTimeout(Integer serviceSempSessionIdleTimeout) { - - this.serviceSempSessionIdleTimeout = serviceSempSessionIdleTimeout; - return this; - } - - /** - * The session idle timeout, in minutes. Sessions will be invalidated if there is no activity in this period of time. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `15`. Available since 2.21. - * @return serviceSempSessionIdleTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SEMP_SESSION_IDLE_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getServiceSempSessionIdleTimeout() { - return serviceSempSessionIdleTimeout; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SEMP_SESSION_IDLE_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSempSessionIdleTimeout(Integer serviceSempSessionIdleTimeout) { - this.serviceSempSessionIdleTimeout = serviceSempSessionIdleTimeout; - } - - - public Broker serviceSempSessionMaxLifetime(Integer serviceSempSessionMaxLifetime) { - - this.serviceSempSessionMaxLifetime = serviceSempSessionMaxLifetime; - return this; - } - - /** - * The maximum lifetime of a session, in minutes. Sessions will be invalidated after this period of time, regardless of activity. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `43200`. Available since 2.21. - * @return serviceSempSessionMaxLifetime - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SEMP_SESSION_MAX_LIFETIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getServiceSempSessionMaxLifetime() { - return serviceSempSessionMaxLifetime; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SEMP_SESSION_MAX_LIFETIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSempSessionMaxLifetime(Integer serviceSempSessionMaxLifetime) { - this.serviceSempSessionMaxLifetime = serviceSempSessionMaxLifetime; - } - - - public Broker serviceSempTlsEnabled(Boolean serviceSempTlsEnabled) { - - this.serviceSempTlsEnabled = serviceSempTlsEnabled; - return this; - } - - /** - * Enable or disable TLS SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.17. - * @return serviceSempTlsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SEMP_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceSempTlsEnabled() { - return serviceSempTlsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SEMP_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSempTlsEnabled(Boolean serviceSempTlsEnabled) { - this.serviceSempTlsEnabled = serviceSempTlsEnabled; - } - - - public Broker serviceSempTlsListenPort(Long serviceSempTlsListenPort) { - - this.serviceSempTlsListenPort = serviceSempTlsListenPort; - return this; - } - - /** - * The TCP port for TLS SEMP client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1943`. Available since 2.17. - * @return serviceSempTlsListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SEMP_TLS_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceSempTlsListenPort() { - return serviceSempTlsListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SEMP_TLS_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSempTlsListenPort(Long serviceSempTlsListenPort) { - this.serviceSempTlsListenPort = serviceSempTlsListenPort; - } - - - public Broker serviceSmfCompressionListenPort(Long serviceSmfCompressionListenPort) { - - this.serviceSmfCompressionListenPort = serviceSmfCompressionListenPort; - return this; - } - - /** - * TCP port number that SMF clients can use to connect to the broker using raw compression TCP. The default value is `55003`. Available since 2.17. - * @return serviceSmfCompressionListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_COMPRESSION_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceSmfCompressionListenPort() { - return serviceSmfCompressionListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_COMPRESSION_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSmfCompressionListenPort(Long serviceSmfCompressionListenPort) { - this.serviceSmfCompressionListenPort = serviceSmfCompressionListenPort; - } - - - public Broker serviceSmfEnabled(Boolean serviceSmfEnabled) { - - this.serviceSmfEnabled = serviceSmfEnabled; - return this; - } - - /** - * Enable or disable the SMF service. When disabled new SMF Clients may not connect through the global listen-ports, and all currently connected SMF Clients are immediately disconnected. The default value is `true`. Available since 2.17. - * @return serviceSmfEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceSmfEnabled() { - return serviceSmfEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSmfEnabled(Boolean serviceSmfEnabled) { - this.serviceSmfEnabled = serviceSmfEnabled; - } - - - public Broker serviceSmfEventConnectionCountThreshold(EventThreshold serviceSmfEventConnectionCountThreshold) { - - this.serviceSmfEventConnectionCountThreshold = serviceSmfEventConnectionCountThreshold; - return this; - } - - /** - * Get serviceSmfEventConnectionCountThreshold - * @return serviceSmfEventConnectionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_EVENT_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getServiceSmfEventConnectionCountThreshold() { - return serviceSmfEventConnectionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_EVENT_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSmfEventConnectionCountThreshold(EventThreshold serviceSmfEventConnectionCountThreshold) { - this.serviceSmfEventConnectionCountThreshold = serviceSmfEventConnectionCountThreshold; - } - - - public Broker serviceSmfPlainTextListenPort(Long serviceSmfPlainTextListenPort) { - - this.serviceSmfPlainTextListenPort = serviceSmfPlainTextListenPort; - return this; - } - - /** - * TCP port number that SMF clients can use to connect to the broker using raw TCP. The default value is `55555`. Available since 2.17. - * @return serviceSmfPlainTextListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_PLAIN_TEXT_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceSmfPlainTextListenPort() { - return serviceSmfPlainTextListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_PLAIN_TEXT_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSmfPlainTextListenPort(Long serviceSmfPlainTextListenPort) { - this.serviceSmfPlainTextListenPort = serviceSmfPlainTextListenPort; - } - - - public Broker serviceSmfRoutingControlListenPort(Long serviceSmfRoutingControlListenPort) { - - this.serviceSmfRoutingControlListenPort = serviceSmfRoutingControlListenPort; - return this; - } - - /** - * TCP port number that SMF clients can use to connect to the broker using raw routing control TCP. The default value is `55556`. Available since 2.17. - * @return serviceSmfRoutingControlListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_ROUTING_CONTROL_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceSmfRoutingControlListenPort() { - return serviceSmfRoutingControlListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_ROUTING_CONTROL_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSmfRoutingControlListenPort(Long serviceSmfRoutingControlListenPort) { - this.serviceSmfRoutingControlListenPort = serviceSmfRoutingControlListenPort; - } - - - public Broker serviceSmfTlsListenPort(Long serviceSmfTlsListenPort) { - - this.serviceSmfTlsListenPort = serviceSmfTlsListenPort; - return this; - } - - /** - * TCP port number that SMF clients can use to connect to the broker using raw TCP over TLS. The default value is `55443`. Available since 2.17. - * @return serviceSmfTlsListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_TLS_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceSmfTlsListenPort() { - return serviceSmfTlsListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_TLS_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSmfTlsListenPort(Long serviceSmfTlsListenPort) { - this.serviceSmfTlsListenPort = serviceSmfTlsListenPort; - } - - - public Broker serviceTlsEventConnectionCountThreshold(EventThreshold serviceTlsEventConnectionCountThreshold) { - - this.serviceTlsEventConnectionCountThreshold = serviceTlsEventConnectionCountThreshold; - return this; - } - - /** - * Get serviceTlsEventConnectionCountThreshold - * @return serviceTlsEventConnectionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_TLS_EVENT_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getServiceTlsEventConnectionCountThreshold() { - return serviceTlsEventConnectionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_TLS_EVENT_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceTlsEventConnectionCountThreshold(EventThreshold serviceTlsEventConnectionCountThreshold) { - this.serviceTlsEventConnectionCountThreshold = serviceTlsEventConnectionCountThreshold; - } - - - public Broker serviceWebTransportEnabled(Boolean serviceWebTransportEnabled) { - - this.serviceWebTransportEnabled = serviceWebTransportEnabled; - return this; - } - - /** - * Enable or disable the web-transport service. When disabled new web-transport Clients may not connect through the global listen-ports, and all currently connected web-transport Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17. - * @return serviceWebTransportEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_TRANSPORT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceWebTransportEnabled() { - return serviceWebTransportEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_TRANSPORT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceWebTransportEnabled(Boolean serviceWebTransportEnabled) { - this.serviceWebTransportEnabled = serviceWebTransportEnabled; - } - - - public Broker serviceWebTransportPlainTextListenPort(Long serviceWebTransportPlainTextListenPort) { - - this.serviceWebTransportPlainTextListenPort = serviceWebTransportPlainTextListenPort; - return this; - } - - /** - * The TCP port for plain-text WEB client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `8008`. Available since 2.17. - * @return serviceWebTransportPlainTextListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_TRANSPORT_PLAIN_TEXT_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceWebTransportPlainTextListenPort() { - return serviceWebTransportPlainTextListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_TRANSPORT_PLAIN_TEXT_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceWebTransportPlainTextListenPort(Long serviceWebTransportPlainTextListenPort) { - this.serviceWebTransportPlainTextListenPort = serviceWebTransportPlainTextListenPort; - } - - - public Broker serviceWebTransportTlsListenPort(Long serviceWebTransportTlsListenPort) { - - this.serviceWebTransportTlsListenPort = serviceWebTransportTlsListenPort; - return this; - } - - /** - * The TCP port for TLS WEB client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1443`. Available since 2.17. - * @return serviceWebTransportTlsListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_TRANSPORT_TLS_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceWebTransportTlsListenPort() { - return serviceWebTransportTlsListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_TRANSPORT_TLS_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceWebTransportTlsListenPort(Long serviceWebTransportTlsListenPort) { - this.serviceWebTransportTlsListenPort = serviceWebTransportTlsListenPort; - } - - - public Broker serviceWebTransportWebUrlSuffix(String serviceWebTransportWebUrlSuffix) { - - this.serviceWebTransportWebUrlSuffix = serviceWebTransportWebUrlSuffix; - return this; - } - - /** - * Used to specify the Web URL suffix that will be used by Web clients when communicating with the broker. The default value is `\"\"`. Available since 2.17. - * @return serviceWebTransportWebUrlSuffix - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_TRANSPORT_WEB_URL_SUFFIX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getServiceWebTransportWebUrlSuffix() { - return serviceWebTransportWebUrlSuffix; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_TRANSPORT_WEB_URL_SUFFIX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceWebTransportWebUrlSuffix(String serviceWebTransportWebUrlSuffix) { - this.serviceWebTransportWebUrlSuffix = serviceWebTransportWebUrlSuffix; - } - - - public Broker tlsBlockVersion11Enabled(Boolean tlsBlockVersion11Enabled) { - - this.tlsBlockVersion11Enabled = tlsBlockVersion11Enabled; - return this; - } - - /** - * Enable or disable the blocking of TLS version 1.1 connections. When blocked, all existing incoming and outgoing TLS 1.1 connections with Clients, SEMP users, and LDAP servers remain connected while new connections are blocked. Note that support for TLS 1.1 will eventually be discontinued, at which time TLS 1.1 connections will be blocked regardless of this setting. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - * @return tlsBlockVersion11Enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_BLOCK_VERSION11_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTlsBlockVersion11Enabled() { - return tlsBlockVersion11Enabled; - } - - - @JsonProperty(JSON_PROPERTY_TLS_BLOCK_VERSION11_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsBlockVersion11Enabled(Boolean tlsBlockVersion11Enabled) { - this.tlsBlockVersion11Enabled = tlsBlockVersion11Enabled; - } - - - public Broker tlsCipherSuiteManagementList(String tlsCipherSuiteManagementList) { - - this.tlsCipherSuiteManagementList = tlsCipherSuiteManagementList; - return this; - } - - /** - * The colon-separated list of cipher suites used for TLS management connections (e.g. SEMP, LDAP). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`. - * @return tlsCipherSuiteManagementList - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_CIPHER_SUITE_MANAGEMENT_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTlsCipherSuiteManagementList() { - return tlsCipherSuiteManagementList; - } - - - @JsonProperty(JSON_PROPERTY_TLS_CIPHER_SUITE_MANAGEMENT_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsCipherSuiteManagementList(String tlsCipherSuiteManagementList) { - this.tlsCipherSuiteManagementList = tlsCipherSuiteManagementList; - } - - - public Broker tlsCipherSuiteMsgBackboneList(String tlsCipherSuiteMsgBackboneList) { - - this.tlsCipherSuiteMsgBackboneList = tlsCipherSuiteMsgBackboneList; - return this; - } - - /** - * The colon-separated list of cipher suites used for TLS data connections (e.g. client pub/sub). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`. - * @return tlsCipherSuiteMsgBackboneList - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_CIPHER_SUITE_MSG_BACKBONE_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTlsCipherSuiteMsgBackboneList() { - return tlsCipherSuiteMsgBackboneList; - } - - - @JsonProperty(JSON_PROPERTY_TLS_CIPHER_SUITE_MSG_BACKBONE_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsCipherSuiteMsgBackboneList(String tlsCipherSuiteMsgBackboneList) { - this.tlsCipherSuiteMsgBackboneList = tlsCipherSuiteMsgBackboneList; - } - - - public Broker tlsCipherSuiteSecureShellList(String tlsCipherSuiteSecureShellList) { - - this.tlsCipherSuiteSecureShellList = tlsCipherSuiteSecureShellList; - return this; - } - - /** - * The colon-separated list of cipher suites used for TLS secure shell connections (e.g. SSH, SFTP, SCP). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`. - * @return tlsCipherSuiteSecureShellList - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_CIPHER_SUITE_SECURE_SHELL_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTlsCipherSuiteSecureShellList() { - return tlsCipherSuiteSecureShellList; - } - - - @JsonProperty(JSON_PROPERTY_TLS_CIPHER_SUITE_SECURE_SHELL_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsCipherSuiteSecureShellList(String tlsCipherSuiteSecureShellList) { - this.tlsCipherSuiteSecureShellList = tlsCipherSuiteSecureShellList; - } - - - public Broker tlsCrimeExploitProtectionEnabled(Boolean tlsCrimeExploitProtectionEnabled) { - - this.tlsCrimeExploitProtectionEnabled = tlsCrimeExploitProtectionEnabled; - return this; - } - - /** - * Enable or disable protection against the CRIME exploit. When enabled, TLS+compressed messaging performance is degraded. This protection should only be disabled if sufficient ACL and authentication features are being employed such that a potential attacker does not have sufficient access to trigger the exploit. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - * @return tlsCrimeExploitProtectionEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_CRIME_EXPLOIT_PROTECTION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTlsCrimeExploitProtectionEnabled() { - return tlsCrimeExploitProtectionEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TLS_CRIME_EXPLOIT_PROTECTION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsCrimeExploitProtectionEnabled(Boolean tlsCrimeExploitProtectionEnabled) { - this.tlsCrimeExploitProtectionEnabled = tlsCrimeExploitProtectionEnabled; - } - - - public Broker tlsServerCertContent(String tlsServerCertContent) { - - this.tlsServerCertContent = tlsServerCertContent; - return this; - } - - /** - * The PEM formatted content for the server certificate used for TLS connections. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. - * @return tlsServerCertContent - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_SERVER_CERT_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTlsServerCertContent() { - return tlsServerCertContent; - } - - - @JsonProperty(JSON_PROPERTY_TLS_SERVER_CERT_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsServerCertContent(String tlsServerCertContent) { - this.tlsServerCertContent = tlsServerCertContent; - } - - - public Broker tlsServerCertPassword(String tlsServerCertPassword) { - - this.tlsServerCertPassword = tlsServerCertPassword; - return this; - } - - /** - * The password for the server certificate used for TLS connections. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. - * @return tlsServerCertPassword - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_SERVER_CERT_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTlsServerCertPassword() { - return tlsServerCertPassword; - } - - - @JsonProperty(JSON_PROPERTY_TLS_SERVER_CERT_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsServerCertPassword(String tlsServerCertPassword) { - this.tlsServerCertPassword = tlsServerCertPassword; - } - - - public Broker tlsStandardDomainCertificateAuthoritiesEnabled(Boolean tlsStandardDomainCertificateAuthoritiesEnabled) { - - this.tlsStandardDomainCertificateAuthoritiesEnabled = tlsStandardDomainCertificateAuthoritiesEnabled; - return this; - } - - /** - * Enable or disable the standard domain certificate authority list. The default value is `true`. Available since 2.19. - * @return tlsStandardDomainCertificateAuthoritiesEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_STANDARD_DOMAIN_CERTIFICATE_AUTHORITIES_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTlsStandardDomainCertificateAuthoritiesEnabled() { - return tlsStandardDomainCertificateAuthoritiesEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TLS_STANDARD_DOMAIN_CERTIFICATE_AUTHORITIES_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsStandardDomainCertificateAuthoritiesEnabled(Boolean tlsStandardDomainCertificateAuthoritiesEnabled) { - this.tlsStandardDomainCertificateAuthoritiesEnabled = tlsStandardDomainCertificateAuthoritiesEnabled; - } - - - public Broker tlsTicketLifetime(Integer tlsTicketLifetime) { - - this.tlsTicketLifetime = tlsTicketLifetime; - return this; - } - - /** - * The TLS ticket lifetime in seconds. When a client connects with TLS, a session with a session ticket is created using the TLS ticket lifetime which determines how long the client has to resume the session. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`. - * @return tlsTicketLifetime - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_TICKET_LIFETIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getTlsTicketLifetime() { - return tlsTicketLifetime; - } - - - @JsonProperty(JSON_PROPERTY_TLS_TICKET_LIFETIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsTicketLifetime(Integer tlsTicketLifetime) { - this.tlsTicketLifetime = tlsTicketLifetime; - } - - - public Broker webManagerAllowUnencryptedWizardsEnabled(Boolean webManagerAllowUnencryptedWizardsEnabled) { - - this.webManagerAllowUnencryptedWizardsEnabled = webManagerAllowUnencryptedWizardsEnabled; - return this; - } - - /** - * Enable or disable the use of unencrypted wizards in the Web-based Manager UI. This setting should be left at its default on all production systems or other systems that need to be secure. Enabling this option will permit the broker to forward plain-text data to other brokers, making important information or credentials available for snooping. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.28. - * @return webManagerAllowUnencryptedWizardsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_WEB_MANAGER_ALLOW_UNENCRYPTED_WIZARDS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getWebManagerAllowUnencryptedWizardsEnabled() { - return webManagerAllowUnencryptedWizardsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_WEB_MANAGER_ALLOW_UNENCRYPTED_WIZARDS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWebManagerAllowUnencryptedWizardsEnabled(Boolean webManagerAllowUnencryptedWizardsEnabled) { - this.webManagerAllowUnencryptedWizardsEnabled = webManagerAllowUnencryptedWizardsEnabled; - } - - - public Broker webManagerCustomization(String webManagerCustomization) { - - this.webManagerCustomization = webManagerCustomization; - return this; - } - - /** - * Reserved for internal use by Solace. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Available since 2.25. - * @return webManagerCustomization - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_WEB_MANAGER_CUSTOMIZATION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getWebManagerCustomization() { - return webManagerCustomization; - } - - - @JsonProperty(JSON_PROPERTY_WEB_MANAGER_CUSTOMIZATION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWebManagerCustomization(String webManagerCustomization) { - this.webManagerCustomization = webManagerCustomization; - } - - - public Broker webManagerRedirectHttpEnabled(Boolean webManagerRedirectHttpEnabled) { - - this.webManagerRedirectHttpEnabled = webManagerRedirectHttpEnabled; - return this; - } - - /** - * Enable or disable redirection of HTTP requests for the broker manager to HTTPS. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.24. - * @return webManagerRedirectHttpEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_WEB_MANAGER_REDIRECT_HTTP_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getWebManagerRedirectHttpEnabled() { - return webManagerRedirectHttpEnabled; - } - - - @JsonProperty(JSON_PROPERTY_WEB_MANAGER_REDIRECT_HTTP_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWebManagerRedirectHttpEnabled(Boolean webManagerRedirectHttpEnabled) { - this.webManagerRedirectHttpEnabled = webManagerRedirectHttpEnabled; - } - - - public Broker webManagerRedirectHttpOverrideTlsPort(Integer webManagerRedirectHttpOverrideTlsPort) { - - this.webManagerRedirectHttpOverrideTlsPort = webManagerRedirectHttpOverrideTlsPort; - return this; - } - - /** - * The HTTPS port that HTTP requests will be redirected towards in a HTTP 301 redirect response. Zero is a special value that means use the value specified for the SEMP TLS port value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since 2.24. - * @return webManagerRedirectHttpOverrideTlsPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_WEB_MANAGER_REDIRECT_HTTP_OVERRIDE_TLS_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getWebManagerRedirectHttpOverrideTlsPort() { - return webManagerRedirectHttpOverrideTlsPort; - } - - - @JsonProperty(JSON_PROPERTY_WEB_MANAGER_REDIRECT_HTTP_OVERRIDE_TLS_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWebManagerRedirectHttpOverrideTlsPort(Integer webManagerRedirectHttpOverrideTlsPort) { - this.webManagerRedirectHttpOverrideTlsPort = webManagerRedirectHttpOverrideTlsPort; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Broker broker = (Broker) o; - return Objects.equals(this.authClientCertRevocationCheckMode, broker.authClientCertRevocationCheckMode) && - Objects.equals(this.configSyncAuthenticationClientCertMaxChainDepth, broker.configSyncAuthenticationClientCertMaxChainDepth) && - Objects.equals(this.configSyncAuthenticationClientCertValidateDateEnabled, broker.configSyncAuthenticationClientCertValidateDateEnabled) && - Objects.equals(this.configSyncClientProfileTcpInitialCongestionWindow, broker.configSyncClientProfileTcpInitialCongestionWindow) && - Objects.equals(this.configSyncClientProfileTcpKeepaliveCount, broker.configSyncClientProfileTcpKeepaliveCount) && - Objects.equals(this.configSyncClientProfileTcpKeepaliveIdle, broker.configSyncClientProfileTcpKeepaliveIdle) && - Objects.equals(this.configSyncClientProfileTcpKeepaliveInterval, broker.configSyncClientProfileTcpKeepaliveInterval) && - Objects.equals(this.configSyncClientProfileTcpMaxWindow, broker.configSyncClientProfileTcpMaxWindow) && - Objects.equals(this.configSyncClientProfileTcpMss, broker.configSyncClientProfileTcpMss) && - Objects.equals(this.configSyncEnabled, broker.configSyncEnabled) && - Objects.equals(this.configSyncSynchronizeUsernameEnabled, broker.configSyncSynchronizeUsernameEnabled) && - Objects.equals(this.configSyncTlsEnabled, broker.configSyncTlsEnabled) && - Objects.equals(this.guaranteedMsgingDefragmentationScheduleDayList, broker.guaranteedMsgingDefragmentationScheduleDayList) && - Objects.equals(this.guaranteedMsgingDefragmentationScheduleEnabled, broker.guaranteedMsgingDefragmentationScheduleEnabled) && - Objects.equals(this.guaranteedMsgingDefragmentationScheduleTimeList, broker.guaranteedMsgingDefragmentationScheduleTimeList) && - Objects.equals(this.guaranteedMsgingDefragmentationThresholdEnabled, broker.guaranteedMsgingDefragmentationThresholdEnabled) && - Objects.equals(this.guaranteedMsgingDefragmentationThresholdFragmentationPercentage, broker.guaranteedMsgingDefragmentationThresholdFragmentationPercentage) && - Objects.equals(this.guaranteedMsgingDefragmentationThresholdMinInterval, broker.guaranteedMsgingDefragmentationThresholdMinInterval) && - Objects.equals(this.guaranteedMsgingDefragmentationThresholdUsagePercentage, broker.guaranteedMsgingDefragmentationThresholdUsagePercentage) && - Objects.equals(this.guaranteedMsgingEnabled, broker.guaranteedMsgingEnabled) && - Objects.equals(this.guaranteedMsgingEventCacheUsageThreshold, broker.guaranteedMsgingEventCacheUsageThreshold) && - Objects.equals(this.guaranteedMsgingEventDeliveredUnackedThreshold, broker.guaranteedMsgingEventDeliveredUnackedThreshold) && - Objects.equals(this.guaranteedMsgingEventDiskUsageThreshold, broker.guaranteedMsgingEventDiskUsageThreshold) && - Objects.equals(this.guaranteedMsgingEventEgressFlowCountThreshold, broker.guaranteedMsgingEventEgressFlowCountThreshold) && - Objects.equals(this.guaranteedMsgingEventEndpointCountThreshold, broker.guaranteedMsgingEventEndpointCountThreshold) && - Objects.equals(this.guaranteedMsgingEventIngressFlowCountThreshold, broker.guaranteedMsgingEventIngressFlowCountThreshold) && - Objects.equals(this.guaranteedMsgingEventMsgCountThreshold, broker.guaranteedMsgingEventMsgCountThreshold) && - Objects.equals(this.guaranteedMsgingEventMsgSpoolFileCountThreshold, broker.guaranteedMsgingEventMsgSpoolFileCountThreshold) && - Objects.equals(this.guaranteedMsgingEventMsgSpoolUsageThreshold, broker.guaranteedMsgingEventMsgSpoolUsageThreshold) && - Objects.equals(this.guaranteedMsgingEventTransactedSessionCountThreshold, broker.guaranteedMsgingEventTransactedSessionCountThreshold) && - Objects.equals(this.guaranteedMsgingEventTransactedSessionResourceCountThreshold, broker.guaranteedMsgingEventTransactedSessionResourceCountThreshold) && - Objects.equals(this.guaranteedMsgingEventTransactionCountThreshold, broker.guaranteedMsgingEventTransactionCountThreshold) && - Objects.equals(this.guaranteedMsgingMaxCacheUsage, broker.guaranteedMsgingMaxCacheUsage) && - Objects.equals(this.guaranteedMsgingMaxMsgSpoolUsage, broker.guaranteedMsgingMaxMsgSpoolUsage) && - Objects.equals(this.guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout, broker.guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout) && - Objects.equals(this.guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout, broker.guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout) && - Objects.equals(this.guaranteedMsgingTransactionReplicationCompatibilityMode, broker.guaranteedMsgingTransactionReplicationCompatibilityMode) && - Objects.equals(this.oauthProfileDefault, broker.oauthProfileDefault) && - Objects.equals(this.serviceAmqpEnabled, broker.serviceAmqpEnabled) && - Objects.equals(this.serviceAmqpTlsListenPort, broker.serviceAmqpTlsListenPort) && - Objects.equals(this.serviceEventConnectionCountThreshold, broker.serviceEventConnectionCountThreshold) && - Objects.equals(this.serviceHealthCheckEnabled, broker.serviceHealthCheckEnabled) && - Objects.equals(this.serviceHealthCheckListenPort, broker.serviceHealthCheckListenPort) && - Objects.equals(this.serviceMateLinkEnabled, broker.serviceMateLinkEnabled) && - Objects.equals(this.serviceMateLinkListenPort, broker.serviceMateLinkListenPort) && - Objects.equals(this.serviceMqttEnabled, broker.serviceMqttEnabled) && - Objects.equals(this.serviceMsgBackboneEnabled, broker.serviceMsgBackboneEnabled) && - Objects.equals(this.serviceRedundancyEnabled, broker.serviceRedundancyEnabled) && - Objects.equals(this.serviceRedundancyFirstListenPort, broker.serviceRedundancyFirstListenPort) && - Objects.equals(this.serviceRestEventOutgoingConnectionCountThreshold, broker.serviceRestEventOutgoingConnectionCountThreshold) && - Objects.equals(this.serviceRestIncomingEnabled, broker.serviceRestIncomingEnabled) && - Objects.equals(this.serviceRestOutgoingEnabled, broker.serviceRestOutgoingEnabled) && - Objects.equals(this.serviceSempCorsAllowAnyHostEnabled, broker.serviceSempCorsAllowAnyHostEnabled) && - Objects.equals(this.serviceSempLegacyTimeoutEnabled, broker.serviceSempLegacyTimeoutEnabled) && - Objects.equals(this.serviceSempPlainTextEnabled, broker.serviceSempPlainTextEnabled) && - Objects.equals(this.serviceSempPlainTextListenPort, broker.serviceSempPlainTextListenPort) && - Objects.equals(this.serviceSempSessionIdleTimeout, broker.serviceSempSessionIdleTimeout) && - Objects.equals(this.serviceSempSessionMaxLifetime, broker.serviceSempSessionMaxLifetime) && - Objects.equals(this.serviceSempTlsEnabled, broker.serviceSempTlsEnabled) && - Objects.equals(this.serviceSempTlsListenPort, broker.serviceSempTlsListenPort) && - Objects.equals(this.serviceSmfCompressionListenPort, broker.serviceSmfCompressionListenPort) && - Objects.equals(this.serviceSmfEnabled, broker.serviceSmfEnabled) && - Objects.equals(this.serviceSmfEventConnectionCountThreshold, broker.serviceSmfEventConnectionCountThreshold) && - Objects.equals(this.serviceSmfPlainTextListenPort, broker.serviceSmfPlainTextListenPort) && - Objects.equals(this.serviceSmfRoutingControlListenPort, broker.serviceSmfRoutingControlListenPort) && - Objects.equals(this.serviceSmfTlsListenPort, broker.serviceSmfTlsListenPort) && - Objects.equals(this.serviceTlsEventConnectionCountThreshold, broker.serviceTlsEventConnectionCountThreshold) && - Objects.equals(this.serviceWebTransportEnabled, broker.serviceWebTransportEnabled) && - Objects.equals(this.serviceWebTransportPlainTextListenPort, broker.serviceWebTransportPlainTextListenPort) && - Objects.equals(this.serviceWebTransportTlsListenPort, broker.serviceWebTransportTlsListenPort) && - Objects.equals(this.serviceWebTransportWebUrlSuffix, broker.serviceWebTransportWebUrlSuffix) && - Objects.equals(this.tlsBlockVersion11Enabled, broker.tlsBlockVersion11Enabled) && - Objects.equals(this.tlsCipherSuiteManagementList, broker.tlsCipherSuiteManagementList) && - Objects.equals(this.tlsCipherSuiteMsgBackboneList, broker.tlsCipherSuiteMsgBackboneList) && - Objects.equals(this.tlsCipherSuiteSecureShellList, broker.tlsCipherSuiteSecureShellList) && - Objects.equals(this.tlsCrimeExploitProtectionEnabled, broker.tlsCrimeExploitProtectionEnabled) && - Objects.equals(this.tlsServerCertContent, broker.tlsServerCertContent) && - Objects.equals(this.tlsServerCertPassword, broker.tlsServerCertPassword) && - Objects.equals(this.tlsStandardDomainCertificateAuthoritiesEnabled, broker.tlsStandardDomainCertificateAuthoritiesEnabled) && - Objects.equals(this.tlsTicketLifetime, broker.tlsTicketLifetime) && - Objects.equals(this.webManagerAllowUnencryptedWizardsEnabled, broker.webManagerAllowUnencryptedWizardsEnabled) && - Objects.equals(this.webManagerCustomization, broker.webManagerCustomization) && - Objects.equals(this.webManagerRedirectHttpEnabled, broker.webManagerRedirectHttpEnabled) && - Objects.equals(this.webManagerRedirectHttpOverrideTlsPort, broker.webManagerRedirectHttpOverrideTlsPort); - } - - @Override - public int hashCode() { - return Objects.hash(authClientCertRevocationCheckMode, configSyncAuthenticationClientCertMaxChainDepth, configSyncAuthenticationClientCertValidateDateEnabled, configSyncClientProfileTcpInitialCongestionWindow, configSyncClientProfileTcpKeepaliveCount, configSyncClientProfileTcpKeepaliveIdle, configSyncClientProfileTcpKeepaliveInterval, configSyncClientProfileTcpMaxWindow, configSyncClientProfileTcpMss, configSyncEnabled, configSyncSynchronizeUsernameEnabled, configSyncTlsEnabled, guaranteedMsgingDefragmentationScheduleDayList, guaranteedMsgingDefragmentationScheduleEnabled, guaranteedMsgingDefragmentationScheduleTimeList, guaranteedMsgingDefragmentationThresholdEnabled, guaranteedMsgingDefragmentationThresholdFragmentationPercentage, guaranteedMsgingDefragmentationThresholdMinInterval, guaranteedMsgingDefragmentationThresholdUsagePercentage, guaranteedMsgingEnabled, guaranteedMsgingEventCacheUsageThreshold, guaranteedMsgingEventDeliveredUnackedThreshold, guaranteedMsgingEventDiskUsageThreshold, guaranteedMsgingEventEgressFlowCountThreshold, guaranteedMsgingEventEndpointCountThreshold, guaranteedMsgingEventIngressFlowCountThreshold, guaranteedMsgingEventMsgCountThreshold, guaranteedMsgingEventMsgSpoolFileCountThreshold, guaranteedMsgingEventMsgSpoolUsageThreshold, guaranteedMsgingEventTransactedSessionCountThreshold, guaranteedMsgingEventTransactedSessionResourceCountThreshold, guaranteedMsgingEventTransactionCountThreshold, guaranteedMsgingMaxCacheUsage, guaranteedMsgingMaxMsgSpoolUsage, guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout, guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout, guaranteedMsgingTransactionReplicationCompatibilityMode, oauthProfileDefault, serviceAmqpEnabled, serviceAmqpTlsListenPort, serviceEventConnectionCountThreshold, serviceHealthCheckEnabled, serviceHealthCheckListenPort, serviceMateLinkEnabled, serviceMateLinkListenPort, serviceMqttEnabled, serviceMsgBackboneEnabled, serviceRedundancyEnabled, serviceRedundancyFirstListenPort, serviceRestEventOutgoingConnectionCountThreshold, serviceRestIncomingEnabled, serviceRestOutgoingEnabled, serviceSempCorsAllowAnyHostEnabled, serviceSempLegacyTimeoutEnabled, serviceSempPlainTextEnabled, serviceSempPlainTextListenPort, serviceSempSessionIdleTimeout, serviceSempSessionMaxLifetime, serviceSempTlsEnabled, serviceSempTlsListenPort, serviceSmfCompressionListenPort, serviceSmfEnabled, serviceSmfEventConnectionCountThreshold, serviceSmfPlainTextListenPort, serviceSmfRoutingControlListenPort, serviceSmfTlsListenPort, serviceTlsEventConnectionCountThreshold, serviceWebTransportEnabled, serviceWebTransportPlainTextListenPort, serviceWebTransportTlsListenPort, serviceWebTransportWebUrlSuffix, tlsBlockVersion11Enabled, tlsCipherSuiteManagementList, tlsCipherSuiteMsgBackboneList, tlsCipherSuiteSecureShellList, tlsCrimeExploitProtectionEnabled, tlsServerCertContent, tlsServerCertPassword, tlsStandardDomainCertificateAuthoritiesEnabled, tlsTicketLifetime, webManagerAllowUnencryptedWizardsEnabled, webManagerCustomization, webManagerRedirectHttpEnabled, webManagerRedirectHttpOverrideTlsPort); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Broker {\n"); - sb.append(" authClientCertRevocationCheckMode: ").append(toIndentedString(authClientCertRevocationCheckMode)).append("\n"); - sb.append(" configSyncAuthenticationClientCertMaxChainDepth: ").append(toIndentedString(configSyncAuthenticationClientCertMaxChainDepth)).append("\n"); - sb.append(" configSyncAuthenticationClientCertValidateDateEnabled: ").append(toIndentedString(configSyncAuthenticationClientCertValidateDateEnabled)).append("\n"); - sb.append(" configSyncClientProfileTcpInitialCongestionWindow: ").append(toIndentedString(configSyncClientProfileTcpInitialCongestionWindow)).append("\n"); - sb.append(" configSyncClientProfileTcpKeepaliveCount: ").append(toIndentedString(configSyncClientProfileTcpKeepaliveCount)).append("\n"); - sb.append(" configSyncClientProfileTcpKeepaliveIdle: ").append(toIndentedString(configSyncClientProfileTcpKeepaliveIdle)).append("\n"); - sb.append(" configSyncClientProfileTcpKeepaliveInterval: ").append(toIndentedString(configSyncClientProfileTcpKeepaliveInterval)).append("\n"); - sb.append(" configSyncClientProfileTcpMaxWindow: ").append(toIndentedString(configSyncClientProfileTcpMaxWindow)).append("\n"); - sb.append(" configSyncClientProfileTcpMss: ").append(toIndentedString(configSyncClientProfileTcpMss)).append("\n"); - sb.append(" configSyncEnabled: ").append(toIndentedString(configSyncEnabled)).append("\n"); - sb.append(" configSyncSynchronizeUsernameEnabled: ").append(toIndentedString(configSyncSynchronizeUsernameEnabled)).append("\n"); - sb.append(" configSyncTlsEnabled: ").append(toIndentedString(configSyncTlsEnabled)).append("\n"); - sb.append(" guaranteedMsgingDefragmentationScheduleDayList: ").append(toIndentedString(guaranteedMsgingDefragmentationScheduleDayList)).append("\n"); - sb.append(" guaranteedMsgingDefragmentationScheduleEnabled: ").append(toIndentedString(guaranteedMsgingDefragmentationScheduleEnabled)).append("\n"); - sb.append(" guaranteedMsgingDefragmentationScheduleTimeList: ").append(toIndentedString(guaranteedMsgingDefragmentationScheduleTimeList)).append("\n"); - sb.append(" guaranteedMsgingDefragmentationThresholdEnabled: ").append(toIndentedString(guaranteedMsgingDefragmentationThresholdEnabled)).append("\n"); - sb.append(" guaranteedMsgingDefragmentationThresholdFragmentationPercentage: ").append(toIndentedString(guaranteedMsgingDefragmentationThresholdFragmentationPercentage)).append("\n"); - sb.append(" guaranteedMsgingDefragmentationThresholdMinInterval: ").append(toIndentedString(guaranteedMsgingDefragmentationThresholdMinInterval)).append("\n"); - sb.append(" guaranteedMsgingDefragmentationThresholdUsagePercentage: ").append(toIndentedString(guaranteedMsgingDefragmentationThresholdUsagePercentage)).append("\n"); - sb.append(" guaranteedMsgingEnabled: ").append(toIndentedString(guaranteedMsgingEnabled)).append("\n"); - sb.append(" guaranteedMsgingEventCacheUsageThreshold: ").append(toIndentedString(guaranteedMsgingEventCacheUsageThreshold)).append("\n"); - sb.append(" guaranteedMsgingEventDeliveredUnackedThreshold: ").append(toIndentedString(guaranteedMsgingEventDeliveredUnackedThreshold)).append("\n"); - sb.append(" guaranteedMsgingEventDiskUsageThreshold: ").append(toIndentedString(guaranteedMsgingEventDiskUsageThreshold)).append("\n"); - sb.append(" guaranteedMsgingEventEgressFlowCountThreshold: ").append(toIndentedString(guaranteedMsgingEventEgressFlowCountThreshold)).append("\n"); - sb.append(" guaranteedMsgingEventEndpointCountThreshold: ").append(toIndentedString(guaranteedMsgingEventEndpointCountThreshold)).append("\n"); - sb.append(" guaranteedMsgingEventIngressFlowCountThreshold: ").append(toIndentedString(guaranteedMsgingEventIngressFlowCountThreshold)).append("\n"); - sb.append(" guaranteedMsgingEventMsgCountThreshold: ").append(toIndentedString(guaranteedMsgingEventMsgCountThreshold)).append("\n"); - sb.append(" guaranteedMsgingEventMsgSpoolFileCountThreshold: ").append(toIndentedString(guaranteedMsgingEventMsgSpoolFileCountThreshold)).append("\n"); - sb.append(" guaranteedMsgingEventMsgSpoolUsageThreshold: ").append(toIndentedString(guaranteedMsgingEventMsgSpoolUsageThreshold)).append("\n"); - sb.append(" guaranteedMsgingEventTransactedSessionCountThreshold: ").append(toIndentedString(guaranteedMsgingEventTransactedSessionCountThreshold)).append("\n"); - sb.append(" guaranteedMsgingEventTransactedSessionResourceCountThreshold: ").append(toIndentedString(guaranteedMsgingEventTransactedSessionResourceCountThreshold)).append("\n"); - sb.append(" guaranteedMsgingEventTransactionCountThreshold: ").append(toIndentedString(guaranteedMsgingEventTransactionCountThreshold)).append("\n"); - sb.append(" guaranteedMsgingMaxCacheUsage: ").append(toIndentedString(guaranteedMsgingMaxCacheUsage)).append("\n"); - sb.append(" guaranteedMsgingMaxMsgSpoolUsage: ").append(toIndentedString(guaranteedMsgingMaxMsgSpoolUsage)).append("\n"); - sb.append(" guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout: ").append(toIndentedString(guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout)).append("\n"); - sb.append(" guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout: ").append(toIndentedString(guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout)).append("\n"); - sb.append(" guaranteedMsgingTransactionReplicationCompatibilityMode: ").append(toIndentedString(guaranteedMsgingTransactionReplicationCompatibilityMode)).append("\n"); - sb.append(" oauthProfileDefault: ").append(toIndentedString(oauthProfileDefault)).append("\n"); - sb.append(" serviceAmqpEnabled: ").append(toIndentedString(serviceAmqpEnabled)).append("\n"); - sb.append(" serviceAmqpTlsListenPort: ").append(toIndentedString(serviceAmqpTlsListenPort)).append("\n"); - sb.append(" serviceEventConnectionCountThreshold: ").append(toIndentedString(serviceEventConnectionCountThreshold)).append("\n"); - sb.append(" serviceHealthCheckEnabled: ").append(toIndentedString(serviceHealthCheckEnabled)).append("\n"); - sb.append(" serviceHealthCheckListenPort: ").append(toIndentedString(serviceHealthCheckListenPort)).append("\n"); - sb.append(" serviceMateLinkEnabled: ").append(toIndentedString(serviceMateLinkEnabled)).append("\n"); - sb.append(" serviceMateLinkListenPort: ").append(toIndentedString(serviceMateLinkListenPort)).append("\n"); - sb.append(" serviceMqttEnabled: ").append(toIndentedString(serviceMqttEnabled)).append("\n"); - sb.append(" serviceMsgBackboneEnabled: ").append(toIndentedString(serviceMsgBackboneEnabled)).append("\n"); - sb.append(" serviceRedundancyEnabled: ").append(toIndentedString(serviceRedundancyEnabled)).append("\n"); - sb.append(" serviceRedundancyFirstListenPort: ").append(toIndentedString(serviceRedundancyFirstListenPort)).append("\n"); - sb.append(" serviceRestEventOutgoingConnectionCountThreshold: ").append(toIndentedString(serviceRestEventOutgoingConnectionCountThreshold)).append("\n"); - sb.append(" serviceRestIncomingEnabled: ").append(toIndentedString(serviceRestIncomingEnabled)).append("\n"); - sb.append(" serviceRestOutgoingEnabled: ").append(toIndentedString(serviceRestOutgoingEnabled)).append("\n"); - sb.append(" serviceSempCorsAllowAnyHostEnabled: ").append(toIndentedString(serviceSempCorsAllowAnyHostEnabled)).append("\n"); - sb.append(" serviceSempLegacyTimeoutEnabled: ").append(toIndentedString(serviceSempLegacyTimeoutEnabled)).append("\n"); - sb.append(" serviceSempPlainTextEnabled: ").append(toIndentedString(serviceSempPlainTextEnabled)).append("\n"); - sb.append(" serviceSempPlainTextListenPort: ").append(toIndentedString(serviceSempPlainTextListenPort)).append("\n"); - sb.append(" serviceSempSessionIdleTimeout: ").append(toIndentedString(serviceSempSessionIdleTimeout)).append("\n"); - sb.append(" serviceSempSessionMaxLifetime: ").append(toIndentedString(serviceSempSessionMaxLifetime)).append("\n"); - sb.append(" serviceSempTlsEnabled: ").append(toIndentedString(serviceSempTlsEnabled)).append("\n"); - sb.append(" serviceSempTlsListenPort: ").append(toIndentedString(serviceSempTlsListenPort)).append("\n"); - sb.append(" serviceSmfCompressionListenPort: ").append(toIndentedString(serviceSmfCompressionListenPort)).append("\n"); - sb.append(" serviceSmfEnabled: ").append(toIndentedString(serviceSmfEnabled)).append("\n"); - sb.append(" serviceSmfEventConnectionCountThreshold: ").append(toIndentedString(serviceSmfEventConnectionCountThreshold)).append("\n"); - sb.append(" serviceSmfPlainTextListenPort: ").append(toIndentedString(serviceSmfPlainTextListenPort)).append("\n"); - sb.append(" serviceSmfRoutingControlListenPort: ").append(toIndentedString(serviceSmfRoutingControlListenPort)).append("\n"); - sb.append(" serviceSmfTlsListenPort: ").append(toIndentedString(serviceSmfTlsListenPort)).append("\n"); - sb.append(" serviceTlsEventConnectionCountThreshold: ").append(toIndentedString(serviceTlsEventConnectionCountThreshold)).append("\n"); - sb.append(" serviceWebTransportEnabled: ").append(toIndentedString(serviceWebTransportEnabled)).append("\n"); - sb.append(" serviceWebTransportPlainTextListenPort: ").append(toIndentedString(serviceWebTransportPlainTextListenPort)).append("\n"); - sb.append(" serviceWebTransportTlsListenPort: ").append(toIndentedString(serviceWebTransportTlsListenPort)).append("\n"); - sb.append(" serviceWebTransportWebUrlSuffix: ").append(toIndentedString(serviceWebTransportWebUrlSuffix)).append("\n"); - sb.append(" tlsBlockVersion11Enabled: ").append(toIndentedString(tlsBlockVersion11Enabled)).append("\n"); - sb.append(" tlsCipherSuiteManagementList: ").append(toIndentedString(tlsCipherSuiteManagementList)).append("\n"); - sb.append(" tlsCipherSuiteMsgBackboneList: ").append(toIndentedString(tlsCipherSuiteMsgBackboneList)).append("\n"); - sb.append(" tlsCipherSuiteSecureShellList: ").append(toIndentedString(tlsCipherSuiteSecureShellList)).append("\n"); - sb.append(" tlsCrimeExploitProtectionEnabled: ").append(toIndentedString(tlsCrimeExploitProtectionEnabled)).append("\n"); - sb.append(" tlsServerCertContent: ").append(toIndentedString(tlsServerCertContent)).append("\n"); - sb.append(" tlsServerCertPassword: ").append(toIndentedString(tlsServerCertPassword)).append("\n"); - sb.append(" tlsStandardDomainCertificateAuthoritiesEnabled: ").append(toIndentedString(tlsStandardDomainCertificateAuthoritiesEnabled)).append("\n"); - sb.append(" tlsTicketLifetime: ").append(toIndentedString(tlsTicketLifetime)).append("\n"); - sb.append(" webManagerAllowUnencryptedWizardsEnabled: ").append(toIndentedString(webManagerAllowUnencryptedWizardsEnabled)).append("\n"); - sb.append(" webManagerCustomization: ").append(toIndentedString(webManagerCustomization)).append("\n"); - sb.append(" webManagerRedirectHttpEnabled: ").append(toIndentedString(webManagerRedirectHttpEnabled)).append("\n"); - sb.append(" webManagerRedirectHttpOverrideTlsPort: ").append(toIndentedString(webManagerRedirectHttpOverrideTlsPort)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerLinks.java deleted file mode 100644 index 3bfbb1cfd..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerLinks.java +++ /dev/null @@ -1,392 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * BrokerLinks - */ -@JsonPropertyOrder({ - BrokerLinks.JSON_PROPERTY_ABOUT_URI, - BrokerLinks.JSON_PROPERTY_CERT_AUTHORITIES_URI, - BrokerLinks.JSON_PROPERTY_CLIENT_CERT_AUTHORITIES_URI, - BrokerLinks.JSON_PROPERTY_DMR_CLUSTERS_URI, - BrokerLinks.JSON_PROPERTY_DOMAIN_CERT_AUTHORITIES_URI, - BrokerLinks.JSON_PROPERTY_MSG_VPNS_URI, - BrokerLinks.JSON_PROPERTY_OAUTH_PROFILES_URI, - BrokerLinks.JSON_PROPERTY_SYSTEM_INFORMATION_URI, - BrokerLinks.JSON_PROPERTY_URI, - BrokerLinks.JSON_PROPERTY_VIRTUAL_HOSTNAMES_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class BrokerLinks { - public static final String JSON_PROPERTY_ABOUT_URI = "aboutUri"; - private String aboutUri; - - public static final String JSON_PROPERTY_CERT_AUTHORITIES_URI = "certAuthoritiesUri"; - private String certAuthoritiesUri; - - public static final String JSON_PROPERTY_CLIENT_CERT_AUTHORITIES_URI = "clientCertAuthoritiesUri"; - private String clientCertAuthoritiesUri; - - public static final String JSON_PROPERTY_DMR_CLUSTERS_URI = "dmrClustersUri"; - private String dmrClustersUri; - - public static final String JSON_PROPERTY_DOMAIN_CERT_AUTHORITIES_URI = "domainCertAuthoritiesUri"; - private String domainCertAuthoritiesUri; - - public static final String JSON_PROPERTY_MSG_VPNS_URI = "msgVpnsUri"; - private String msgVpnsUri; - - public static final String JSON_PROPERTY_OAUTH_PROFILES_URI = "oauthProfilesUri"; - private String oauthProfilesUri; - - public static final String JSON_PROPERTY_SYSTEM_INFORMATION_URI = "systemInformationUri"; - private String systemInformationUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public static final String JSON_PROPERTY_VIRTUAL_HOSTNAMES_URI = "virtualHostnamesUri"; - private String virtualHostnamesUri; - - public BrokerLinks() { - } - - public BrokerLinks aboutUri(String aboutUri) { - - this.aboutUri = aboutUri; - return this; - } - - /** - * The URI of this Broker's About object. - * @return aboutUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ABOUT_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAboutUri() { - return aboutUri; - } - - - @JsonProperty(JSON_PROPERTY_ABOUT_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAboutUri(String aboutUri) { - this.aboutUri = aboutUri; - } - - - public BrokerLinks certAuthoritiesUri(String certAuthoritiesUri) { - - this.certAuthoritiesUri = certAuthoritiesUri; - return this; - } - - /** - * The URI of this Broker's collection of Certificate Authority objects. Deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - * @return certAuthoritiesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CERT_AUTHORITIES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCertAuthoritiesUri() { - return certAuthoritiesUri; - } - - - @JsonProperty(JSON_PROPERTY_CERT_AUTHORITIES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCertAuthoritiesUri(String certAuthoritiesUri) { - this.certAuthoritiesUri = certAuthoritiesUri; - } - - - public BrokerLinks clientCertAuthoritiesUri(String clientCertAuthoritiesUri) { - - this.clientCertAuthoritiesUri = clientCertAuthoritiesUri; - return this; - } - - /** - * The URI of this Broker's collection of Client Certificate Authority objects. Available since 2.19. - * @return clientCertAuthoritiesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_CERT_AUTHORITIES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientCertAuthoritiesUri() { - return clientCertAuthoritiesUri; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_CERT_AUTHORITIES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientCertAuthoritiesUri(String clientCertAuthoritiesUri) { - this.clientCertAuthoritiesUri = clientCertAuthoritiesUri; - } - - - public BrokerLinks dmrClustersUri(String dmrClustersUri) { - - this.dmrClustersUri = dmrClustersUri; - return this; - } - - /** - * The URI of this Broker's collection of Cluster objects. Available since 2.11. - * @return dmrClustersUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DMR_CLUSTERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDmrClustersUri() { - return dmrClustersUri; - } - - - @JsonProperty(JSON_PROPERTY_DMR_CLUSTERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDmrClustersUri(String dmrClustersUri) { - this.dmrClustersUri = dmrClustersUri; - } - - - public BrokerLinks domainCertAuthoritiesUri(String domainCertAuthoritiesUri) { - - this.domainCertAuthoritiesUri = domainCertAuthoritiesUri; - return this; - } - - /** - * The URI of this Broker's collection of Domain Certificate Authority objects. Available since 2.19. - * @return domainCertAuthoritiesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DOMAIN_CERT_AUTHORITIES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDomainCertAuthoritiesUri() { - return domainCertAuthoritiesUri; - } - - - @JsonProperty(JSON_PROPERTY_DOMAIN_CERT_AUTHORITIES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDomainCertAuthoritiesUri(String domainCertAuthoritiesUri) { - this.domainCertAuthoritiesUri = domainCertAuthoritiesUri; - } - - - public BrokerLinks msgVpnsUri(String msgVpnsUri) { - - this.msgVpnsUri = msgVpnsUri; - return this; - } - - /** - * The URI of this Broker's collection of Message VPN objects. Available since 2.0. - * @return msgVpnsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPNS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnsUri() { - return msgVpnsUri; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPNS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnsUri(String msgVpnsUri) { - this.msgVpnsUri = msgVpnsUri; - } - - - public BrokerLinks oauthProfilesUri(String oauthProfilesUri) { - - this.oauthProfilesUri = oauthProfilesUri; - return this; - } - - /** - * The URI of this Broker's collection of OAuth Profile objects. Available since 2.24. - * @return oauthProfilesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthProfilesUri() { - return oauthProfilesUri; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthProfilesUri(String oauthProfilesUri) { - this.oauthProfilesUri = oauthProfilesUri; - } - - - public BrokerLinks systemInformationUri(String systemInformationUri) { - - this.systemInformationUri = systemInformationUri; - return this; - } - - /** - * The URI of this Broker's System Information object. Deprecated since 2.2. /systemInformation was replaced by /about/api. - * @return systemInformationUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SYSTEM_INFORMATION_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSystemInformationUri() { - return systemInformationUri; - } - - - @JsonProperty(JSON_PROPERTY_SYSTEM_INFORMATION_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSystemInformationUri(String systemInformationUri) { - this.systemInformationUri = systemInformationUri; - } - - - public BrokerLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Broker object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - - public BrokerLinks virtualHostnamesUri(String virtualHostnamesUri) { - - this.virtualHostnamesUri = virtualHostnamesUri; - return this; - } - - /** - * The URI of this Broker's collection of Virtual Hostname objects. Available since 2.17. - * @return virtualHostnamesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_VIRTUAL_HOSTNAMES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getVirtualHostnamesUri() { - return virtualHostnamesUri; - } - - - @JsonProperty(JSON_PROPERTY_VIRTUAL_HOSTNAMES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setVirtualHostnamesUri(String virtualHostnamesUri) { - this.virtualHostnamesUri = virtualHostnamesUri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - BrokerLinks brokerLinks = (BrokerLinks) o; - return Objects.equals(this.aboutUri, brokerLinks.aboutUri) && - Objects.equals(this.certAuthoritiesUri, brokerLinks.certAuthoritiesUri) && - Objects.equals(this.clientCertAuthoritiesUri, brokerLinks.clientCertAuthoritiesUri) && - Objects.equals(this.dmrClustersUri, brokerLinks.dmrClustersUri) && - Objects.equals(this.domainCertAuthoritiesUri, brokerLinks.domainCertAuthoritiesUri) && - Objects.equals(this.msgVpnsUri, brokerLinks.msgVpnsUri) && - Objects.equals(this.oauthProfilesUri, brokerLinks.oauthProfilesUri) && - Objects.equals(this.systemInformationUri, brokerLinks.systemInformationUri) && - Objects.equals(this.uri, brokerLinks.uri) && - Objects.equals(this.virtualHostnamesUri, brokerLinks.virtualHostnamesUri); - } - - @Override - public int hashCode() { - return Objects.hash(aboutUri, certAuthoritiesUri, clientCertAuthoritiesUri, dmrClustersUri, domainCertAuthoritiesUri, msgVpnsUri, oauthProfilesUri, systemInformationUri, uri, virtualHostnamesUri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class BrokerLinks {\n"); - sb.append(" aboutUri: ").append(toIndentedString(aboutUri)).append("\n"); - sb.append(" certAuthoritiesUri: ").append(toIndentedString(certAuthoritiesUri)).append("\n"); - sb.append(" clientCertAuthoritiesUri: ").append(toIndentedString(clientCertAuthoritiesUri)).append("\n"); - sb.append(" dmrClustersUri: ").append(toIndentedString(dmrClustersUri)).append("\n"); - sb.append(" domainCertAuthoritiesUri: ").append(toIndentedString(domainCertAuthoritiesUri)).append("\n"); - sb.append(" msgVpnsUri: ").append(toIndentedString(msgVpnsUri)).append("\n"); - sb.append(" oauthProfilesUri: ").append(toIndentedString(oauthProfilesUri)).append("\n"); - sb.append(" systemInformationUri: ").append(toIndentedString(systemInformationUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append(" virtualHostnamesUri: ").append(toIndentedString(virtualHostnamesUri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerResponse.java deleted file mode 100644 index 0559b1a25..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.Broker; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.BrokerLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * BrokerResponse - */ -@JsonPropertyOrder({ - BrokerResponse.JSON_PROPERTY_DATA, - BrokerResponse.JSON_PROPERTY_LINKS, - BrokerResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class BrokerResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private Broker data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private BrokerLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public BrokerResponse() { - } - - public BrokerResponse data(Broker data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Broker getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(Broker data) { - this.data = data; - } - - - public BrokerResponse links(BrokerLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public BrokerLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(BrokerLinks links) { - this.links = links; - } - - - public BrokerResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - BrokerResponse brokerResponse = (BrokerResponse) o; - return Objects.equals(this.data, brokerResponse.data) && - Objects.equals(this.links, brokerResponse.links) && - Objects.equals(this.meta, brokerResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class BrokerResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthoritiesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthoritiesResponse.java deleted file mode 100644 index 087eca246..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthoritiesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * CertAuthoritiesResponse - */ -@JsonPropertyOrder({ - CertAuthoritiesResponse.JSON_PROPERTY_DATA, - CertAuthoritiesResponse.JSON_PROPERTY_LINKS, - CertAuthoritiesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class CertAuthoritiesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public CertAuthoritiesResponse() { - } - - public CertAuthoritiesResponse data(List data) { - - this.data = data; - return this; - } - - public CertAuthoritiesResponse addDataItem(CertAuthority dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public CertAuthoritiesResponse links(List links) { - - this.links = links; - return this; - } - - public CertAuthoritiesResponse addLinksItem(CertAuthorityLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public CertAuthoritiesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CertAuthoritiesResponse certAuthoritiesResponse = (CertAuthoritiesResponse) o; - return Objects.equals(this.data, certAuthoritiesResponse.data) && - Objects.equals(this.links, certAuthoritiesResponse.links) && - Objects.equals(this.meta, certAuthoritiesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CertAuthoritiesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthority.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthority.java deleted file mode 100644 index 7507baa7d..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthority.java +++ /dev/null @@ -1,360 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * CertAuthority - */ -@JsonPropertyOrder({ - CertAuthority.JSON_PROPERTY_CERT_AUTHORITY_NAME, - CertAuthority.JSON_PROPERTY_CERT_CONTENT, - CertAuthority.JSON_PROPERTY_CRL_DAY_LIST, - CertAuthority.JSON_PROPERTY_CRL_TIME_LIST, - CertAuthority.JSON_PROPERTY_CRL_URL, - CertAuthority.JSON_PROPERTY_OCSP_NON_RESPONDER_CERT_ENABLED, - CertAuthority.JSON_PROPERTY_OCSP_OVERRIDE_URL, - CertAuthority.JSON_PROPERTY_OCSP_TIMEOUT, - CertAuthority.JSON_PROPERTY_REVOCATION_CHECK_ENABLED -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class CertAuthority { - public static final String JSON_PROPERTY_CERT_AUTHORITY_NAME = "certAuthorityName"; - private String certAuthorityName; - - public static final String JSON_PROPERTY_CERT_CONTENT = "certContent"; - private String certContent; - - public static final String JSON_PROPERTY_CRL_DAY_LIST = "crlDayList"; - private String crlDayList; - - public static final String JSON_PROPERTY_CRL_TIME_LIST = "crlTimeList"; - private String crlTimeList; - - public static final String JSON_PROPERTY_CRL_URL = "crlUrl"; - private String crlUrl; - - public static final String JSON_PROPERTY_OCSP_NON_RESPONDER_CERT_ENABLED = "ocspNonResponderCertEnabled"; - private Boolean ocspNonResponderCertEnabled; - - public static final String JSON_PROPERTY_OCSP_OVERRIDE_URL = "ocspOverrideUrl"; - private String ocspOverrideUrl; - - public static final String JSON_PROPERTY_OCSP_TIMEOUT = "ocspTimeout"; - private Long ocspTimeout; - - public static final String JSON_PROPERTY_REVOCATION_CHECK_ENABLED = "revocationCheckEnabled"; - private Boolean revocationCheckEnabled; - - public CertAuthority() { - } - - public CertAuthority certAuthorityName(String certAuthorityName) { - - this.certAuthorityName = certAuthorityName; - return this; - } - - /** - * The name of the Certificate Authority. Deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - * @return certAuthorityName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CERT_AUTHORITY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCertAuthorityName() { - return certAuthorityName; - } - - - @JsonProperty(JSON_PROPERTY_CERT_AUTHORITY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCertAuthorityName(String certAuthorityName) { - this.certAuthorityName = certAuthorityName; - } - - - public CertAuthority certContent(String certContent) { - - this.certContent = certContent; - return this; - } - - /** - * The PEM formatted content for the trusted root certificate of a Certificate Authority. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. - * @return certContent - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CERT_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCertContent() { - return certContent; - } - - - @JsonProperty(JSON_PROPERTY_CERT_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCertContent(String certContent) { - this.certContent = certContent; - } - - - public CertAuthority crlDayList(String crlDayList) { - - this.crlDayList = crlDayList; - return this; - } - - /** - * The scheduled CRL refresh day(s), specified as \"daily\" or a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"daily\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. - * @return crlDayList - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CRL_DAY_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCrlDayList() { - return crlDayList; - } - - - @JsonProperty(JSON_PROPERTY_CRL_DAY_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCrlDayList(String crlDayList) { - this.crlDayList = crlDayList; - } - - - public CertAuthority crlTimeList(String crlTimeList) { - - this.crlTimeList = crlTimeList; - return this; - } - - /** - * The scheduled CRL refresh time(s), specified as \"hourly\" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times must be in sorted order from 0:00 to 23:59. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"3:00\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. - * @return crlTimeList - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CRL_TIME_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCrlTimeList() { - return crlTimeList; - } - - - @JsonProperty(JSON_PROPERTY_CRL_TIME_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCrlTimeList(String crlTimeList) { - this.crlTimeList = crlTimeList; - } - - - public CertAuthority crlUrl(String crlUrl) { - - this.crlUrl = crlUrl; - return this; - } - - /** - * The URL for the CRL source. This is a required attribute for CRL to be operational and the URL must be complete with http:// included. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. - * @return crlUrl - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CRL_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCrlUrl() { - return crlUrl; - } - - - @JsonProperty(JSON_PROPERTY_CRL_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCrlUrl(String crlUrl) { - this.crlUrl = crlUrl; - } - - - public CertAuthority ocspNonResponderCertEnabled(Boolean ocspNonResponderCertEnabled) { - - this.ocspNonResponderCertEnabled = ocspNonResponderCertEnabled; - return this; - } - - /** - * Enable or disable allowing a non-responder certificate to sign an OCSP response. Typically used with an OCSP override URL in cases where a single certificate is used to sign client certificates and OCSP responses. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. - * @return ocspNonResponderCertEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OCSP_NON_RESPONDER_CERT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getOcspNonResponderCertEnabled() { - return ocspNonResponderCertEnabled; - } - - - @JsonProperty(JSON_PROPERTY_OCSP_NON_RESPONDER_CERT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOcspNonResponderCertEnabled(Boolean ocspNonResponderCertEnabled) { - this.ocspNonResponderCertEnabled = ocspNonResponderCertEnabled; - } - - - public CertAuthority ocspOverrideUrl(String ocspOverrideUrl) { - - this.ocspOverrideUrl = ocspOverrideUrl; - return this; - } - - /** - * The OCSP responder URL to use for overriding the one supplied in the client certificate. The URL must be complete with http:// included. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. - * @return ocspOverrideUrl - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OCSP_OVERRIDE_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOcspOverrideUrl() { - return ocspOverrideUrl; - } - - - @JsonProperty(JSON_PROPERTY_OCSP_OVERRIDE_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOcspOverrideUrl(String ocspOverrideUrl) { - this.ocspOverrideUrl = ocspOverrideUrl; - } - - - public CertAuthority ocspTimeout(Long ocspTimeout) { - - this.ocspTimeout = ocspTimeout; - return this; - } - - /** - * The timeout in seconds to receive a response from the OCSP responder after sending a request or making the initial connection attempt. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. - * @return ocspTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OCSP_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getOcspTimeout() { - return ocspTimeout; - } - - - @JsonProperty(JSON_PROPERTY_OCSP_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOcspTimeout(Long ocspTimeout) { - this.ocspTimeout = ocspTimeout; - } - - - public CertAuthority revocationCheckEnabled(Boolean revocationCheckEnabled) { - - this.revocationCheckEnabled = revocationCheckEnabled; - return this; - } - - /** - * Enable or disable Certificate Authority revocation checking. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities. - * @return revocationCheckEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REVOCATION_CHECK_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRevocationCheckEnabled() { - return revocationCheckEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REVOCATION_CHECK_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRevocationCheckEnabled(Boolean revocationCheckEnabled) { - this.revocationCheckEnabled = revocationCheckEnabled; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CertAuthority certAuthority = (CertAuthority) o; - return Objects.equals(this.certAuthorityName, certAuthority.certAuthorityName) && - Objects.equals(this.certContent, certAuthority.certContent) && - Objects.equals(this.crlDayList, certAuthority.crlDayList) && - Objects.equals(this.crlTimeList, certAuthority.crlTimeList) && - Objects.equals(this.crlUrl, certAuthority.crlUrl) && - Objects.equals(this.ocspNonResponderCertEnabled, certAuthority.ocspNonResponderCertEnabled) && - Objects.equals(this.ocspOverrideUrl, certAuthority.ocspOverrideUrl) && - Objects.equals(this.ocspTimeout, certAuthority.ocspTimeout) && - Objects.equals(this.revocationCheckEnabled, certAuthority.revocationCheckEnabled); - } - - @Override - public int hashCode() { - return Objects.hash(certAuthorityName, certContent, crlDayList, crlTimeList, crlUrl, ocspNonResponderCertEnabled, ocspOverrideUrl, ocspTimeout, revocationCheckEnabled); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CertAuthority {\n"); - sb.append(" certAuthorityName: ").append(toIndentedString(certAuthorityName)).append("\n"); - sb.append(" certContent: ").append(toIndentedString(certContent)).append("\n"); - sb.append(" crlDayList: ").append(toIndentedString(crlDayList)).append("\n"); - sb.append(" crlTimeList: ").append(toIndentedString(crlTimeList)).append("\n"); - sb.append(" crlUrl: ").append(toIndentedString(crlUrl)).append("\n"); - sb.append(" ocspNonResponderCertEnabled: ").append(toIndentedString(ocspNonResponderCertEnabled)).append("\n"); - sb.append(" ocspOverrideUrl: ").append(toIndentedString(ocspOverrideUrl)).append("\n"); - sb.append(" ocspTimeout: ").append(toIndentedString(ocspTimeout)).append("\n"); - sb.append(" revocationCheckEnabled: ").append(toIndentedString(revocationCheckEnabled)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityLinks.java deleted file mode 100644 index bd268c913..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityLinks.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * CertAuthorityLinks - */ -@JsonPropertyOrder({ - CertAuthorityLinks.JSON_PROPERTY_OCSP_TLS_TRUSTED_COMMON_NAMES_URI, - CertAuthorityLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class CertAuthorityLinks { - public static final String JSON_PROPERTY_OCSP_TLS_TRUSTED_COMMON_NAMES_URI = "ocspTlsTrustedCommonNamesUri"; - private String ocspTlsTrustedCommonNamesUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public CertAuthorityLinks() { - } - - public CertAuthorityLinks ocspTlsTrustedCommonNamesUri(String ocspTlsTrustedCommonNamesUri) { - - this.ocspTlsTrustedCommonNamesUri = ocspTlsTrustedCommonNamesUri; - return this; - } - - /** - * The URI of this Certificate Authority's collection of OCSP Responder Trusted Common Name objects. Deprecated since 2.19. Replaced by clientCertAuthorities. - * @return ocspTlsTrustedCommonNamesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OCSP_TLS_TRUSTED_COMMON_NAMES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOcspTlsTrustedCommonNamesUri() { - return ocspTlsTrustedCommonNamesUri; - } - - - @JsonProperty(JSON_PROPERTY_OCSP_TLS_TRUSTED_COMMON_NAMES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOcspTlsTrustedCommonNamesUri(String ocspTlsTrustedCommonNamesUri) { - this.ocspTlsTrustedCommonNamesUri = ocspTlsTrustedCommonNamesUri; - } - - - public CertAuthorityLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Certificate Authority object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CertAuthorityLinks certAuthorityLinks = (CertAuthorityLinks) o; - return Objects.equals(this.ocspTlsTrustedCommonNamesUri, certAuthorityLinks.ocspTlsTrustedCommonNamesUri) && - Objects.equals(this.uri, certAuthorityLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(ocspTlsTrustedCommonNamesUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CertAuthorityLinks {\n"); - sb.append(" ocspTlsTrustedCommonNamesUri: ").append(toIndentedString(ocspTlsTrustedCommonNamesUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonName.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonName.java deleted file mode 100644 index 1a25c8036..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonName.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * CertAuthorityOcspTlsTrustedCommonName - */ -@JsonPropertyOrder({ - CertAuthorityOcspTlsTrustedCommonName.JSON_PROPERTY_CERT_AUTHORITY_NAME, - CertAuthorityOcspTlsTrustedCommonName.JSON_PROPERTY_OCSP_TLS_TRUSTED_COMMON_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class CertAuthorityOcspTlsTrustedCommonName { - public static final String JSON_PROPERTY_CERT_AUTHORITY_NAME = "certAuthorityName"; - private String certAuthorityName; - - public static final String JSON_PROPERTY_OCSP_TLS_TRUSTED_COMMON_NAME = "ocspTlsTrustedCommonName"; - private String ocspTlsTrustedCommonName; - - public CertAuthorityOcspTlsTrustedCommonName() { - } - - public CertAuthorityOcspTlsTrustedCommonName certAuthorityName(String certAuthorityName) { - - this.certAuthorityName = certAuthorityName; - return this; - } - - /** - * The name of the Certificate Authority. Deprecated since 2.19. Replaced by clientCertAuthorities. - * @return certAuthorityName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CERT_AUTHORITY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCertAuthorityName() { - return certAuthorityName; - } - - - @JsonProperty(JSON_PROPERTY_CERT_AUTHORITY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCertAuthorityName(String certAuthorityName) { - this.certAuthorityName = certAuthorityName; - } - - - public CertAuthorityOcspTlsTrustedCommonName ocspTlsTrustedCommonName(String ocspTlsTrustedCommonName) { - - this.ocspTlsTrustedCommonName = ocspTlsTrustedCommonName; - return this; - } - - /** - * The expected Trusted Common Name of the OCSP responder remote certificate. Deprecated since 2.19. Replaced by clientCertAuthorities. - * @return ocspTlsTrustedCommonName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OCSP_TLS_TRUSTED_COMMON_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOcspTlsTrustedCommonName() { - return ocspTlsTrustedCommonName; - } - - - @JsonProperty(JSON_PROPERTY_OCSP_TLS_TRUSTED_COMMON_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOcspTlsTrustedCommonName(String ocspTlsTrustedCommonName) { - this.ocspTlsTrustedCommonName = ocspTlsTrustedCommonName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CertAuthorityOcspTlsTrustedCommonName certAuthorityOcspTlsTrustedCommonName = (CertAuthorityOcspTlsTrustedCommonName) o; - return Objects.equals(this.certAuthorityName, certAuthorityOcspTlsTrustedCommonName.certAuthorityName) && - Objects.equals(this.ocspTlsTrustedCommonName, certAuthorityOcspTlsTrustedCommonName.ocspTlsTrustedCommonName); - } - - @Override - public int hashCode() { - return Objects.hash(certAuthorityName, ocspTlsTrustedCommonName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CertAuthorityOcspTlsTrustedCommonName {\n"); - sb.append(" certAuthorityName: ").append(toIndentedString(certAuthorityName)).append("\n"); - sb.append(" ocspTlsTrustedCommonName: ").append(toIndentedString(ocspTlsTrustedCommonName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameLinks.java deleted file mode 100644 index fd1a3b19a..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * CertAuthorityOcspTlsTrustedCommonNameLinks - */ -@JsonPropertyOrder({ - CertAuthorityOcspTlsTrustedCommonNameLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class CertAuthorityOcspTlsTrustedCommonNameLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public CertAuthorityOcspTlsTrustedCommonNameLinks() { - } - - public CertAuthorityOcspTlsTrustedCommonNameLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this OCSP Responder Trusted Common Name object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CertAuthorityOcspTlsTrustedCommonNameLinks certAuthorityOcspTlsTrustedCommonNameLinks = (CertAuthorityOcspTlsTrustedCommonNameLinks) o; - return Objects.equals(this.uri, certAuthorityOcspTlsTrustedCommonNameLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CertAuthorityOcspTlsTrustedCommonNameLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameResponse.java deleted file mode 100644 index 51fe0639b..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * CertAuthorityOcspTlsTrustedCommonNameResponse - */ -@JsonPropertyOrder({ - CertAuthorityOcspTlsTrustedCommonNameResponse.JSON_PROPERTY_DATA, - CertAuthorityOcspTlsTrustedCommonNameResponse.JSON_PROPERTY_LINKS, - CertAuthorityOcspTlsTrustedCommonNameResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class CertAuthorityOcspTlsTrustedCommonNameResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private CertAuthorityOcspTlsTrustedCommonName data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private CertAuthorityOcspTlsTrustedCommonNameLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public CertAuthorityOcspTlsTrustedCommonNameResponse() { - } - - public CertAuthorityOcspTlsTrustedCommonNameResponse data(CertAuthorityOcspTlsTrustedCommonName data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public CertAuthorityOcspTlsTrustedCommonName getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(CertAuthorityOcspTlsTrustedCommonName data) { - this.data = data; - } - - - public CertAuthorityOcspTlsTrustedCommonNameResponse links(CertAuthorityOcspTlsTrustedCommonNameLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public CertAuthorityOcspTlsTrustedCommonNameLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(CertAuthorityOcspTlsTrustedCommonNameLinks links) { - this.links = links; - } - - - public CertAuthorityOcspTlsTrustedCommonNameResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CertAuthorityOcspTlsTrustedCommonNameResponse certAuthorityOcspTlsTrustedCommonNameResponse = (CertAuthorityOcspTlsTrustedCommonNameResponse) o; - return Objects.equals(this.data, certAuthorityOcspTlsTrustedCommonNameResponse.data) && - Objects.equals(this.links, certAuthorityOcspTlsTrustedCommonNameResponse.links) && - Objects.equals(this.meta, certAuthorityOcspTlsTrustedCommonNameResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CertAuthorityOcspTlsTrustedCommonNameResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNamesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNamesResponse.java deleted file mode 100644 index d35acd390..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNamesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * CertAuthorityOcspTlsTrustedCommonNamesResponse - */ -@JsonPropertyOrder({ - CertAuthorityOcspTlsTrustedCommonNamesResponse.JSON_PROPERTY_DATA, - CertAuthorityOcspTlsTrustedCommonNamesResponse.JSON_PROPERTY_LINKS, - CertAuthorityOcspTlsTrustedCommonNamesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class CertAuthorityOcspTlsTrustedCommonNamesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public CertAuthorityOcspTlsTrustedCommonNamesResponse() { - } - - public CertAuthorityOcspTlsTrustedCommonNamesResponse data(List data) { - - this.data = data; - return this; - } - - public CertAuthorityOcspTlsTrustedCommonNamesResponse addDataItem(CertAuthorityOcspTlsTrustedCommonName dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public CertAuthorityOcspTlsTrustedCommonNamesResponse links(List links) { - - this.links = links; - return this; - } - - public CertAuthorityOcspTlsTrustedCommonNamesResponse addLinksItem(CertAuthorityOcspTlsTrustedCommonNameLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public CertAuthorityOcspTlsTrustedCommonNamesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CertAuthorityOcspTlsTrustedCommonNamesResponse certAuthorityOcspTlsTrustedCommonNamesResponse = (CertAuthorityOcspTlsTrustedCommonNamesResponse) o; - return Objects.equals(this.data, certAuthorityOcspTlsTrustedCommonNamesResponse.data) && - Objects.equals(this.links, certAuthorityOcspTlsTrustedCommonNamesResponse.links) && - Objects.equals(this.meta, certAuthorityOcspTlsTrustedCommonNamesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CertAuthorityOcspTlsTrustedCommonNamesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityResponse.java deleted file mode 100644 index db10a6bf7..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * CertAuthorityResponse - */ -@JsonPropertyOrder({ - CertAuthorityResponse.JSON_PROPERTY_DATA, - CertAuthorityResponse.JSON_PROPERTY_LINKS, - CertAuthorityResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class CertAuthorityResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private CertAuthority data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private CertAuthorityLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public CertAuthorityResponse() { - } - - public CertAuthorityResponse data(CertAuthority data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public CertAuthority getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(CertAuthority data) { - this.data = data; - } - - - public CertAuthorityResponse links(CertAuthorityLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public CertAuthorityLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(CertAuthorityLinks links) { - this.links = links; - } - - - public CertAuthorityResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CertAuthorityResponse certAuthorityResponse = (CertAuthorityResponse) o; - return Objects.equals(this.data, certAuthorityResponse.data) && - Objects.equals(this.links, certAuthorityResponse.links) && - Objects.equals(this.meta, certAuthorityResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CertAuthorityResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthoritiesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthoritiesResponse.java deleted file mode 100644 index b07b18bcc..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthoritiesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * ClientCertAuthoritiesResponse - */ -@JsonPropertyOrder({ - ClientCertAuthoritiesResponse.JSON_PROPERTY_DATA, - ClientCertAuthoritiesResponse.JSON_PROPERTY_LINKS, - ClientCertAuthoritiesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class ClientCertAuthoritiesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public ClientCertAuthoritiesResponse() { - } - - public ClientCertAuthoritiesResponse data(List data) { - - this.data = data; - return this; - } - - public ClientCertAuthoritiesResponse addDataItem(ClientCertAuthority dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public ClientCertAuthoritiesResponse links(List links) { - - this.links = links; - return this; - } - - public ClientCertAuthoritiesResponse addLinksItem(ClientCertAuthorityLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public ClientCertAuthoritiesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ClientCertAuthoritiesResponse clientCertAuthoritiesResponse = (ClientCertAuthoritiesResponse) o; - return Objects.equals(this.data, clientCertAuthoritiesResponse.data) && - Objects.equals(this.links, clientCertAuthoritiesResponse.links) && - Objects.equals(this.meta, clientCertAuthoritiesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ClientCertAuthoritiesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthority.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthority.java deleted file mode 100644 index 4d0cb1571..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthority.java +++ /dev/null @@ -1,360 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * ClientCertAuthority - */ -@JsonPropertyOrder({ - ClientCertAuthority.JSON_PROPERTY_CERT_AUTHORITY_NAME, - ClientCertAuthority.JSON_PROPERTY_CERT_CONTENT, - ClientCertAuthority.JSON_PROPERTY_CRL_DAY_LIST, - ClientCertAuthority.JSON_PROPERTY_CRL_TIME_LIST, - ClientCertAuthority.JSON_PROPERTY_CRL_URL, - ClientCertAuthority.JSON_PROPERTY_OCSP_NON_RESPONDER_CERT_ENABLED, - ClientCertAuthority.JSON_PROPERTY_OCSP_OVERRIDE_URL, - ClientCertAuthority.JSON_PROPERTY_OCSP_TIMEOUT, - ClientCertAuthority.JSON_PROPERTY_REVOCATION_CHECK_ENABLED -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class ClientCertAuthority { - public static final String JSON_PROPERTY_CERT_AUTHORITY_NAME = "certAuthorityName"; - private String certAuthorityName; - - public static final String JSON_PROPERTY_CERT_CONTENT = "certContent"; - private String certContent; - - public static final String JSON_PROPERTY_CRL_DAY_LIST = "crlDayList"; - private String crlDayList; - - public static final String JSON_PROPERTY_CRL_TIME_LIST = "crlTimeList"; - private String crlTimeList; - - public static final String JSON_PROPERTY_CRL_URL = "crlUrl"; - private String crlUrl; - - public static final String JSON_PROPERTY_OCSP_NON_RESPONDER_CERT_ENABLED = "ocspNonResponderCertEnabled"; - private Boolean ocspNonResponderCertEnabled; - - public static final String JSON_PROPERTY_OCSP_OVERRIDE_URL = "ocspOverrideUrl"; - private String ocspOverrideUrl; - - public static final String JSON_PROPERTY_OCSP_TIMEOUT = "ocspTimeout"; - private Long ocspTimeout; - - public static final String JSON_PROPERTY_REVOCATION_CHECK_ENABLED = "revocationCheckEnabled"; - private Boolean revocationCheckEnabled; - - public ClientCertAuthority() { - } - - public ClientCertAuthority certAuthorityName(String certAuthorityName) { - - this.certAuthorityName = certAuthorityName; - return this; - } - - /** - * The name of the Certificate Authority. - * @return certAuthorityName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CERT_AUTHORITY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCertAuthorityName() { - return certAuthorityName; - } - - - @JsonProperty(JSON_PROPERTY_CERT_AUTHORITY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCertAuthorityName(String certAuthorityName) { - this.certAuthorityName = certAuthorityName; - } - - - public ClientCertAuthority certContent(String certContent) { - - this.certContent = certContent; - return this; - } - - /** - * The PEM formatted content for the trusted root certificate of a client Certificate Authority. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return certContent - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CERT_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCertContent() { - return certContent; - } - - - @JsonProperty(JSON_PROPERTY_CERT_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCertContent(String certContent) { - this.certContent = certContent; - } - - - public ClientCertAuthority crlDayList(String crlDayList) { - - this.crlDayList = crlDayList; - return this; - } - - /** - * The scheduled CRL refresh day(s), specified as \"daily\" or a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. The empty-string (\"\") can also be specified, indicating no schedule is configured (\"crlTimeList\" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"daily\"`. - * @return crlDayList - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CRL_DAY_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCrlDayList() { - return crlDayList; - } - - - @JsonProperty(JSON_PROPERTY_CRL_DAY_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCrlDayList(String crlDayList) { - this.crlDayList = crlDayList; - } - - - public ClientCertAuthority crlTimeList(String crlTimeList) { - - this.crlTimeList = crlTimeList; - return this; - } - - /** - * The scheduled CRL refresh time(s), specified as \"hourly\" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. The empty-string (\"\") can also be specified, indicating no schedule is configured (\"crlDayList\" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"3:00\"`. - * @return crlTimeList - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CRL_TIME_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCrlTimeList() { - return crlTimeList; - } - - - @JsonProperty(JSON_PROPERTY_CRL_TIME_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCrlTimeList(String crlTimeList) { - this.crlTimeList = crlTimeList; - } - - - public ClientCertAuthority crlUrl(String crlUrl) { - - this.crlUrl = crlUrl; - return this; - } - - /** - * The URL for the CRL source. This is a required attribute for CRL to be operational and the URL must be complete with http:// included. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return crlUrl - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CRL_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCrlUrl() { - return crlUrl; - } - - - @JsonProperty(JSON_PROPERTY_CRL_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCrlUrl(String crlUrl) { - this.crlUrl = crlUrl; - } - - - public ClientCertAuthority ocspNonResponderCertEnabled(Boolean ocspNonResponderCertEnabled) { - - this.ocspNonResponderCertEnabled = ocspNonResponderCertEnabled; - return this; - } - - /** - * Enable or disable allowing a non-responder certificate to sign an OCSP response. Typically used with an OCSP override URL in cases where a single certificate is used to sign client certificates and OCSP responses. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - * @return ocspNonResponderCertEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OCSP_NON_RESPONDER_CERT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getOcspNonResponderCertEnabled() { - return ocspNonResponderCertEnabled; - } - - - @JsonProperty(JSON_PROPERTY_OCSP_NON_RESPONDER_CERT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOcspNonResponderCertEnabled(Boolean ocspNonResponderCertEnabled) { - this.ocspNonResponderCertEnabled = ocspNonResponderCertEnabled; - } - - - public ClientCertAuthority ocspOverrideUrl(String ocspOverrideUrl) { - - this.ocspOverrideUrl = ocspOverrideUrl; - return this; - } - - /** - * The OCSP responder URL to use for overriding the one supplied in the client certificate. The URL must be complete with http:// included. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return ocspOverrideUrl - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OCSP_OVERRIDE_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOcspOverrideUrl() { - return ocspOverrideUrl; - } - - - @JsonProperty(JSON_PROPERTY_OCSP_OVERRIDE_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOcspOverrideUrl(String ocspOverrideUrl) { - this.ocspOverrideUrl = ocspOverrideUrl; - } - - - public ClientCertAuthority ocspTimeout(Long ocspTimeout) { - - this.ocspTimeout = ocspTimeout; - return this; - } - - /** - * The timeout in seconds to receive a response from the OCSP responder after sending a request or making the initial connection attempt. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`. - * @return ocspTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OCSP_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getOcspTimeout() { - return ocspTimeout; - } - - - @JsonProperty(JSON_PROPERTY_OCSP_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOcspTimeout(Long ocspTimeout) { - this.ocspTimeout = ocspTimeout; - } - - - public ClientCertAuthority revocationCheckEnabled(Boolean revocationCheckEnabled) { - - this.revocationCheckEnabled = revocationCheckEnabled; - return this; - } - - /** - * Enable or disable Certificate Authority revocation checking. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - * @return revocationCheckEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REVOCATION_CHECK_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRevocationCheckEnabled() { - return revocationCheckEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REVOCATION_CHECK_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRevocationCheckEnabled(Boolean revocationCheckEnabled) { - this.revocationCheckEnabled = revocationCheckEnabled; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ClientCertAuthority clientCertAuthority = (ClientCertAuthority) o; - return Objects.equals(this.certAuthorityName, clientCertAuthority.certAuthorityName) && - Objects.equals(this.certContent, clientCertAuthority.certContent) && - Objects.equals(this.crlDayList, clientCertAuthority.crlDayList) && - Objects.equals(this.crlTimeList, clientCertAuthority.crlTimeList) && - Objects.equals(this.crlUrl, clientCertAuthority.crlUrl) && - Objects.equals(this.ocspNonResponderCertEnabled, clientCertAuthority.ocspNonResponderCertEnabled) && - Objects.equals(this.ocspOverrideUrl, clientCertAuthority.ocspOverrideUrl) && - Objects.equals(this.ocspTimeout, clientCertAuthority.ocspTimeout) && - Objects.equals(this.revocationCheckEnabled, clientCertAuthority.revocationCheckEnabled); - } - - @Override - public int hashCode() { - return Objects.hash(certAuthorityName, certContent, crlDayList, crlTimeList, crlUrl, ocspNonResponderCertEnabled, ocspOverrideUrl, ocspTimeout, revocationCheckEnabled); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ClientCertAuthority {\n"); - sb.append(" certAuthorityName: ").append(toIndentedString(certAuthorityName)).append("\n"); - sb.append(" certContent: ").append(toIndentedString(certContent)).append("\n"); - sb.append(" crlDayList: ").append(toIndentedString(crlDayList)).append("\n"); - sb.append(" crlTimeList: ").append(toIndentedString(crlTimeList)).append("\n"); - sb.append(" crlUrl: ").append(toIndentedString(crlUrl)).append("\n"); - sb.append(" ocspNonResponderCertEnabled: ").append(toIndentedString(ocspNonResponderCertEnabled)).append("\n"); - sb.append(" ocspOverrideUrl: ").append(toIndentedString(ocspOverrideUrl)).append("\n"); - sb.append(" ocspTimeout: ").append(toIndentedString(ocspTimeout)).append("\n"); - sb.append(" revocationCheckEnabled: ").append(toIndentedString(revocationCheckEnabled)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityLinks.java deleted file mode 100644 index 688bf4f82..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityLinks.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * ClientCertAuthorityLinks - */ -@JsonPropertyOrder({ - ClientCertAuthorityLinks.JSON_PROPERTY_OCSP_TLS_TRUSTED_COMMON_NAMES_URI, - ClientCertAuthorityLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class ClientCertAuthorityLinks { - public static final String JSON_PROPERTY_OCSP_TLS_TRUSTED_COMMON_NAMES_URI = "ocspTlsTrustedCommonNamesUri"; - private String ocspTlsTrustedCommonNamesUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public ClientCertAuthorityLinks() { - } - - public ClientCertAuthorityLinks ocspTlsTrustedCommonNamesUri(String ocspTlsTrustedCommonNamesUri) { - - this.ocspTlsTrustedCommonNamesUri = ocspTlsTrustedCommonNamesUri; - return this; - } - - /** - * The URI of this Client Certificate Authority's collection of OCSP Responder Trusted Common Name objects. - * @return ocspTlsTrustedCommonNamesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OCSP_TLS_TRUSTED_COMMON_NAMES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOcspTlsTrustedCommonNamesUri() { - return ocspTlsTrustedCommonNamesUri; - } - - - @JsonProperty(JSON_PROPERTY_OCSP_TLS_TRUSTED_COMMON_NAMES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOcspTlsTrustedCommonNamesUri(String ocspTlsTrustedCommonNamesUri) { - this.ocspTlsTrustedCommonNamesUri = ocspTlsTrustedCommonNamesUri; - } - - - public ClientCertAuthorityLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Client Certificate Authority object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ClientCertAuthorityLinks clientCertAuthorityLinks = (ClientCertAuthorityLinks) o; - return Objects.equals(this.ocspTlsTrustedCommonNamesUri, clientCertAuthorityLinks.ocspTlsTrustedCommonNamesUri) && - Objects.equals(this.uri, clientCertAuthorityLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(ocspTlsTrustedCommonNamesUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ClientCertAuthorityLinks {\n"); - sb.append(" ocspTlsTrustedCommonNamesUri: ").append(toIndentedString(ocspTlsTrustedCommonNamesUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonName.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonName.java deleted file mode 100644 index 51ad14cc3..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonName.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * ClientCertAuthorityOcspTlsTrustedCommonName - */ -@JsonPropertyOrder({ - ClientCertAuthorityOcspTlsTrustedCommonName.JSON_PROPERTY_CERT_AUTHORITY_NAME, - ClientCertAuthorityOcspTlsTrustedCommonName.JSON_PROPERTY_OCSP_TLS_TRUSTED_COMMON_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class ClientCertAuthorityOcspTlsTrustedCommonName { - public static final String JSON_PROPERTY_CERT_AUTHORITY_NAME = "certAuthorityName"; - private String certAuthorityName; - - public static final String JSON_PROPERTY_OCSP_TLS_TRUSTED_COMMON_NAME = "ocspTlsTrustedCommonName"; - private String ocspTlsTrustedCommonName; - - public ClientCertAuthorityOcspTlsTrustedCommonName() { - } - - public ClientCertAuthorityOcspTlsTrustedCommonName certAuthorityName(String certAuthorityName) { - - this.certAuthorityName = certAuthorityName; - return this; - } - - /** - * The name of the Certificate Authority. - * @return certAuthorityName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CERT_AUTHORITY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCertAuthorityName() { - return certAuthorityName; - } - - - @JsonProperty(JSON_PROPERTY_CERT_AUTHORITY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCertAuthorityName(String certAuthorityName) { - this.certAuthorityName = certAuthorityName; - } - - - public ClientCertAuthorityOcspTlsTrustedCommonName ocspTlsTrustedCommonName(String ocspTlsTrustedCommonName) { - - this.ocspTlsTrustedCommonName = ocspTlsTrustedCommonName; - return this; - } - - /** - * The expected Trusted Common Name of the OCSP responder remote certificate. - * @return ocspTlsTrustedCommonName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OCSP_TLS_TRUSTED_COMMON_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOcspTlsTrustedCommonName() { - return ocspTlsTrustedCommonName; - } - - - @JsonProperty(JSON_PROPERTY_OCSP_TLS_TRUSTED_COMMON_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOcspTlsTrustedCommonName(String ocspTlsTrustedCommonName) { - this.ocspTlsTrustedCommonName = ocspTlsTrustedCommonName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ClientCertAuthorityOcspTlsTrustedCommonName clientCertAuthorityOcspTlsTrustedCommonName = (ClientCertAuthorityOcspTlsTrustedCommonName) o; - return Objects.equals(this.certAuthorityName, clientCertAuthorityOcspTlsTrustedCommonName.certAuthorityName) && - Objects.equals(this.ocspTlsTrustedCommonName, clientCertAuthorityOcspTlsTrustedCommonName.ocspTlsTrustedCommonName); - } - - @Override - public int hashCode() { - return Objects.hash(certAuthorityName, ocspTlsTrustedCommonName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ClientCertAuthorityOcspTlsTrustedCommonName {\n"); - sb.append(" certAuthorityName: ").append(toIndentedString(certAuthorityName)).append("\n"); - sb.append(" ocspTlsTrustedCommonName: ").append(toIndentedString(ocspTlsTrustedCommonName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameLinks.java deleted file mode 100644 index 1ca56f55e..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * ClientCertAuthorityOcspTlsTrustedCommonNameLinks - */ -@JsonPropertyOrder({ - ClientCertAuthorityOcspTlsTrustedCommonNameLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class ClientCertAuthorityOcspTlsTrustedCommonNameLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public ClientCertAuthorityOcspTlsTrustedCommonNameLinks() { - } - - public ClientCertAuthorityOcspTlsTrustedCommonNameLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this OCSP Responder Trusted Common Name object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ClientCertAuthorityOcspTlsTrustedCommonNameLinks clientCertAuthorityOcspTlsTrustedCommonNameLinks = (ClientCertAuthorityOcspTlsTrustedCommonNameLinks) o; - return Objects.equals(this.uri, clientCertAuthorityOcspTlsTrustedCommonNameLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ClientCertAuthorityOcspTlsTrustedCommonNameLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameResponse.java deleted file mode 100644 index 694b9c591..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * ClientCertAuthorityOcspTlsTrustedCommonNameResponse - */ -@JsonPropertyOrder({ - ClientCertAuthorityOcspTlsTrustedCommonNameResponse.JSON_PROPERTY_DATA, - ClientCertAuthorityOcspTlsTrustedCommonNameResponse.JSON_PROPERTY_LINKS, - ClientCertAuthorityOcspTlsTrustedCommonNameResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class ClientCertAuthorityOcspTlsTrustedCommonNameResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private ClientCertAuthorityOcspTlsTrustedCommonName data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private ClientCertAuthorityOcspTlsTrustedCommonNameLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public ClientCertAuthorityOcspTlsTrustedCommonNameResponse() { - } - - public ClientCertAuthorityOcspTlsTrustedCommonNameResponse data(ClientCertAuthorityOcspTlsTrustedCommonName data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ClientCertAuthorityOcspTlsTrustedCommonName getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(ClientCertAuthorityOcspTlsTrustedCommonName data) { - this.data = data; - } - - - public ClientCertAuthorityOcspTlsTrustedCommonNameResponse links(ClientCertAuthorityOcspTlsTrustedCommonNameLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ClientCertAuthorityOcspTlsTrustedCommonNameLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(ClientCertAuthorityOcspTlsTrustedCommonNameLinks links) { - this.links = links; - } - - - public ClientCertAuthorityOcspTlsTrustedCommonNameResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ClientCertAuthorityOcspTlsTrustedCommonNameResponse clientCertAuthorityOcspTlsTrustedCommonNameResponse = (ClientCertAuthorityOcspTlsTrustedCommonNameResponse) o; - return Objects.equals(this.data, clientCertAuthorityOcspTlsTrustedCommonNameResponse.data) && - Objects.equals(this.links, clientCertAuthorityOcspTlsTrustedCommonNameResponse.links) && - Objects.equals(this.meta, clientCertAuthorityOcspTlsTrustedCommonNameResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ClientCertAuthorityOcspTlsTrustedCommonNameResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNamesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNamesResponse.java deleted file mode 100644 index 0700b8c2c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNamesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * ClientCertAuthorityOcspTlsTrustedCommonNamesResponse - */ -@JsonPropertyOrder({ - ClientCertAuthorityOcspTlsTrustedCommonNamesResponse.JSON_PROPERTY_DATA, - ClientCertAuthorityOcspTlsTrustedCommonNamesResponse.JSON_PROPERTY_LINKS, - ClientCertAuthorityOcspTlsTrustedCommonNamesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class ClientCertAuthorityOcspTlsTrustedCommonNamesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public ClientCertAuthorityOcspTlsTrustedCommonNamesResponse() { - } - - public ClientCertAuthorityOcspTlsTrustedCommonNamesResponse data(List data) { - - this.data = data; - return this; - } - - public ClientCertAuthorityOcspTlsTrustedCommonNamesResponse addDataItem(ClientCertAuthorityOcspTlsTrustedCommonName dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public ClientCertAuthorityOcspTlsTrustedCommonNamesResponse links(List links) { - - this.links = links; - return this; - } - - public ClientCertAuthorityOcspTlsTrustedCommonNamesResponse addLinksItem(ClientCertAuthorityOcspTlsTrustedCommonNameLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public ClientCertAuthorityOcspTlsTrustedCommonNamesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ClientCertAuthorityOcspTlsTrustedCommonNamesResponse clientCertAuthorityOcspTlsTrustedCommonNamesResponse = (ClientCertAuthorityOcspTlsTrustedCommonNamesResponse) o; - return Objects.equals(this.data, clientCertAuthorityOcspTlsTrustedCommonNamesResponse.data) && - Objects.equals(this.links, clientCertAuthorityOcspTlsTrustedCommonNamesResponse.links) && - Objects.equals(this.meta, clientCertAuthorityOcspTlsTrustedCommonNamesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ClientCertAuthorityOcspTlsTrustedCommonNamesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityResponse.java deleted file mode 100644 index 48f762008..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * ClientCertAuthorityResponse - */ -@JsonPropertyOrder({ - ClientCertAuthorityResponse.JSON_PROPERTY_DATA, - ClientCertAuthorityResponse.JSON_PROPERTY_LINKS, - ClientCertAuthorityResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class ClientCertAuthorityResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private ClientCertAuthority data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private ClientCertAuthorityLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public ClientCertAuthorityResponse() { - } - - public ClientCertAuthorityResponse data(ClientCertAuthority data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ClientCertAuthority getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(ClientCertAuthority data) { - this.data = data; - } - - - public ClientCertAuthorityResponse links(ClientCertAuthorityLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ClientCertAuthorityLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(ClientCertAuthorityLinks links) { - this.links = links; - } - - - public ClientCertAuthorityResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ClientCertAuthorityResponse clientCertAuthorityResponse = (ClientCertAuthorityResponse) o; - return Objects.equals(this.data, clientCertAuthorityResponse.data) && - Objects.equals(this.links, clientCertAuthorityResponse.links) && - Objects.equals(this.meta, clientCertAuthorityResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ClientCertAuthorityResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrCluster.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrCluster.java deleted file mode 100644 index 8af2dafc8..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrCluster.java +++ /dev/null @@ -1,555 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrCluster - */ -@JsonPropertyOrder({ - DmrCluster.JSON_PROPERTY_AUTHENTICATION_BASIC_ENABLED, - DmrCluster.JSON_PROPERTY_AUTHENTICATION_BASIC_PASSWORD, - DmrCluster.JSON_PROPERTY_AUTHENTICATION_BASIC_TYPE, - DmrCluster.JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_CONTENT, - DmrCluster.JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_ENABLED, - DmrCluster.JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_PASSWORD, - DmrCluster.JSON_PROPERTY_DIRECT_ONLY_ENABLED, - DmrCluster.JSON_PROPERTY_DMR_CLUSTER_NAME, - DmrCluster.JSON_PROPERTY_ENABLED, - DmrCluster.JSON_PROPERTY_NODE_NAME, - DmrCluster.JSON_PROPERTY_TLS_SERVER_CERT_ENFORCE_TRUSTED_COMMON_NAME_ENABLED, - DmrCluster.JSON_PROPERTY_TLS_SERVER_CERT_MAX_CHAIN_DEPTH, - DmrCluster.JSON_PROPERTY_TLS_SERVER_CERT_VALIDATE_DATE_ENABLED, - DmrCluster.JSON_PROPERTY_TLS_SERVER_CERT_VALIDATE_NAME_ENABLED -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrCluster { - public static final String JSON_PROPERTY_AUTHENTICATION_BASIC_ENABLED = "authenticationBasicEnabled"; - private Boolean authenticationBasicEnabled; - - public static final String JSON_PROPERTY_AUTHENTICATION_BASIC_PASSWORD = "authenticationBasicPassword"; - private String authenticationBasicPassword; - - /** - * The type of basic authentication to use for Cluster Links. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"internal\"`. The allowed values and their meaning are: <pre> \"internal\" - Use locally configured password. \"none\" - No authentication. </pre> - */ - public enum AuthenticationBasicTypeEnum { - INTERNAL("internal"), - - NONE("none"); - - private String value; - - AuthenticationBasicTypeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AuthenticationBasicTypeEnum fromValue(String value) { - for (AuthenticationBasicTypeEnum b : AuthenticationBasicTypeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_AUTHENTICATION_BASIC_TYPE = "authenticationBasicType"; - private AuthenticationBasicTypeEnum authenticationBasicType; - - public static final String JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_CONTENT = "authenticationClientCertContent"; - private String authenticationClientCertContent; - - public static final String JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_ENABLED = "authenticationClientCertEnabled"; - private Boolean authenticationClientCertEnabled; - - public static final String JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_PASSWORD = "authenticationClientCertPassword"; - private String authenticationClientCertPassword; - - public static final String JSON_PROPERTY_DIRECT_ONLY_ENABLED = "directOnlyEnabled"; - private Boolean directOnlyEnabled; - - public static final String JSON_PROPERTY_DMR_CLUSTER_NAME = "dmrClusterName"; - private String dmrClusterName; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_NODE_NAME = "nodeName"; - private String nodeName; - - public static final String JSON_PROPERTY_TLS_SERVER_CERT_ENFORCE_TRUSTED_COMMON_NAME_ENABLED = "tlsServerCertEnforceTrustedCommonNameEnabled"; - private Boolean tlsServerCertEnforceTrustedCommonNameEnabled; - - public static final String JSON_PROPERTY_TLS_SERVER_CERT_MAX_CHAIN_DEPTH = "tlsServerCertMaxChainDepth"; - private Long tlsServerCertMaxChainDepth; - - public static final String JSON_PROPERTY_TLS_SERVER_CERT_VALIDATE_DATE_ENABLED = "tlsServerCertValidateDateEnabled"; - private Boolean tlsServerCertValidateDateEnabled; - - public static final String JSON_PROPERTY_TLS_SERVER_CERT_VALIDATE_NAME_ENABLED = "tlsServerCertValidateNameEnabled"; - private Boolean tlsServerCertValidateNameEnabled; - - public DmrCluster() { - } - - public DmrCluster authenticationBasicEnabled(Boolean authenticationBasicEnabled) { - - this.authenticationBasicEnabled = authenticationBasicEnabled; - return this; - } - - /** - * Enable or disable basic authentication for Cluster Links. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - * @return authenticationBasicEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_BASIC_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAuthenticationBasicEnabled() { - return authenticationBasicEnabled; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_BASIC_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationBasicEnabled(Boolean authenticationBasicEnabled) { - this.authenticationBasicEnabled = authenticationBasicEnabled; - } - - - public DmrCluster authenticationBasicPassword(String authenticationBasicPassword) { - - this.authenticationBasicPassword = authenticationBasicPassword; - return this; - } - - /** - * The password used to authenticate incoming Cluster Links when using basic internal authentication. The same password is also used by outgoing Cluster Links if a per-Link password is not configured. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return authenticationBasicPassword - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_BASIC_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationBasicPassword() { - return authenticationBasicPassword; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_BASIC_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationBasicPassword(String authenticationBasicPassword) { - this.authenticationBasicPassword = authenticationBasicPassword; - } - - - public DmrCluster authenticationBasicType(AuthenticationBasicTypeEnum authenticationBasicType) { - - this.authenticationBasicType = authenticationBasicType; - return this; - } - - /** - * The type of basic authentication to use for Cluster Links. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"internal\"`. The allowed values and their meaning are: <pre> \"internal\" - Use locally configured password. \"none\" - No authentication. </pre> - * @return authenticationBasicType - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_BASIC_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AuthenticationBasicTypeEnum getAuthenticationBasicType() { - return authenticationBasicType; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_BASIC_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationBasicType(AuthenticationBasicTypeEnum authenticationBasicType) { - this.authenticationBasicType = authenticationBasicType; - } - - - public DmrCluster authenticationClientCertContent(String authenticationClientCertContent) { - - this.authenticationClientCertContent = authenticationClientCertContent; - return this; - } - - /** - * The PEM formatted content for the client certificate used to login to the remote node. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. - * @return authenticationClientCertContent - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationClientCertContent() { - return authenticationClientCertContent; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationClientCertContent(String authenticationClientCertContent) { - this.authenticationClientCertContent = authenticationClientCertContent; - } - - - public DmrCluster authenticationClientCertEnabled(Boolean authenticationClientCertEnabled) { - - this.authenticationClientCertEnabled = authenticationClientCertEnabled; - return this; - } - - /** - * Enable or disable client certificate authentication for Cluster Links. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - * @return authenticationClientCertEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAuthenticationClientCertEnabled() { - return authenticationClientCertEnabled; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationClientCertEnabled(Boolean authenticationClientCertEnabled) { - this.authenticationClientCertEnabled = authenticationClientCertEnabled; - } - - - public DmrCluster authenticationClientCertPassword(String authenticationClientCertPassword) { - - this.authenticationClientCertPassword = authenticationClientCertPassword; - return this; - } - - /** - * The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. - * @return authenticationClientCertPassword - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationClientCertPassword() { - return authenticationClientCertPassword; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationClientCertPassword(String authenticationClientCertPassword) { - this.authenticationClientCertPassword = authenticationClientCertPassword; - } - - - public DmrCluster directOnlyEnabled(Boolean directOnlyEnabled) { - - this.directOnlyEnabled = directOnlyEnabled; - return this; - } - - /** - * Enable or disable direct messaging only. Guaranteed messages will not be transmitted through the cluster. The default value is `false`. - * @return directOnlyEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DIRECT_ONLY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getDirectOnlyEnabled() { - return directOnlyEnabled; - } - - - @JsonProperty(JSON_PROPERTY_DIRECT_ONLY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDirectOnlyEnabled(Boolean directOnlyEnabled) { - this.directOnlyEnabled = directOnlyEnabled; - } - - - public DmrCluster dmrClusterName(String dmrClusterName) { - - this.dmrClusterName = dmrClusterName; - return this; - } - - /** - * The name of the Cluster. - * @return dmrClusterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DMR_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDmrClusterName() { - return dmrClusterName; - } - - - @JsonProperty(JSON_PROPERTY_DMR_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDmrClusterName(String dmrClusterName) { - this.dmrClusterName = dmrClusterName; - } - - - public DmrCluster enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the Cluster. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public DmrCluster nodeName(String nodeName) { - - this.nodeName = nodeName; - return this; - } - - /** - * The name of this node in the Cluster. This is the name that this broker (or redundant group of brokers) is know by to other nodes in the Cluster. The name is chosen automatically to be either this broker's Router Name or Mate Router Name, depending on which Active Standby Role (primary or backup) this broker plays in its redundancy group. - * @return nodeName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_NODE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getNodeName() { - return nodeName; - } - - - @JsonProperty(JSON_PROPERTY_NODE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setNodeName(String nodeName) { - this.nodeName = nodeName; - } - - - public DmrCluster tlsServerCertEnforceTrustedCommonNameEnabled(Boolean tlsServerCertEnforceTrustedCommonNameEnabled) { - - this.tlsServerCertEnforceTrustedCommonNameEnabled = tlsServerCertEnforceTrustedCommonNameEnabled; - return this; - } - - /** - * Enable or disable the enforcing of the common name provided by the remote broker against the list of trusted common names configured for the Link. If enabled, the certificate's common name must match one of the trusted common names for the Link to be accepted. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * @return tlsServerCertEnforceTrustedCommonNameEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_SERVER_CERT_ENFORCE_TRUSTED_COMMON_NAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTlsServerCertEnforceTrustedCommonNameEnabled() { - return tlsServerCertEnforceTrustedCommonNameEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TLS_SERVER_CERT_ENFORCE_TRUSTED_COMMON_NAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsServerCertEnforceTrustedCommonNameEnabled(Boolean tlsServerCertEnforceTrustedCommonNameEnabled) { - this.tlsServerCertEnforceTrustedCommonNameEnabled = tlsServerCertEnforceTrustedCommonNameEnabled; - } - - - public DmrCluster tlsServerCertMaxChainDepth(Long tlsServerCertMaxChainDepth) { - - this.tlsServerCertMaxChainDepth = tlsServerCertMaxChainDepth; - return this; - } - - /** - * The maximum allowed depth of a certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`. - * @return tlsServerCertMaxChainDepth - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_SERVER_CERT_MAX_CHAIN_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getTlsServerCertMaxChainDepth() { - return tlsServerCertMaxChainDepth; - } - - - @JsonProperty(JSON_PROPERTY_TLS_SERVER_CERT_MAX_CHAIN_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsServerCertMaxChainDepth(Long tlsServerCertMaxChainDepth) { - this.tlsServerCertMaxChainDepth = tlsServerCertMaxChainDepth; - } - - - public DmrCluster tlsServerCertValidateDateEnabled(Boolean tlsServerCertValidateDateEnabled) { - - this.tlsServerCertValidateDateEnabled = tlsServerCertValidateDateEnabled; - return this; - } - - /** - * Enable or disable the validation of the \"Not Before\" and \"Not After\" validity dates in the certificate. When disabled, the certificate is accepted even if the certificate is not valid based on these dates. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - * @return tlsServerCertValidateDateEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_SERVER_CERT_VALIDATE_DATE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTlsServerCertValidateDateEnabled() { - return tlsServerCertValidateDateEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TLS_SERVER_CERT_VALIDATE_DATE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsServerCertValidateDateEnabled(Boolean tlsServerCertValidateDateEnabled) { - this.tlsServerCertValidateDateEnabled = tlsServerCertValidateDateEnabled; - } - - - public DmrCluster tlsServerCertValidateNameEnabled(Boolean tlsServerCertValidateNameEnabled) { - - this.tlsServerCertValidateNameEnabled = tlsServerCertValidateNameEnabled; - return this; - } - - /** - * Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the bridge. If enabled, the name used to connect to the bridge is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.18. - * @return tlsServerCertValidateNameEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_SERVER_CERT_VALIDATE_NAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTlsServerCertValidateNameEnabled() { - return tlsServerCertValidateNameEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TLS_SERVER_CERT_VALIDATE_NAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsServerCertValidateNameEnabled(Boolean tlsServerCertValidateNameEnabled) { - this.tlsServerCertValidateNameEnabled = tlsServerCertValidateNameEnabled; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrCluster dmrCluster = (DmrCluster) o; - return Objects.equals(this.authenticationBasicEnabled, dmrCluster.authenticationBasicEnabled) && - Objects.equals(this.authenticationBasicPassword, dmrCluster.authenticationBasicPassword) && - Objects.equals(this.authenticationBasicType, dmrCluster.authenticationBasicType) && - Objects.equals(this.authenticationClientCertContent, dmrCluster.authenticationClientCertContent) && - Objects.equals(this.authenticationClientCertEnabled, dmrCluster.authenticationClientCertEnabled) && - Objects.equals(this.authenticationClientCertPassword, dmrCluster.authenticationClientCertPassword) && - Objects.equals(this.directOnlyEnabled, dmrCluster.directOnlyEnabled) && - Objects.equals(this.dmrClusterName, dmrCluster.dmrClusterName) && - Objects.equals(this.enabled, dmrCluster.enabled) && - Objects.equals(this.nodeName, dmrCluster.nodeName) && - Objects.equals(this.tlsServerCertEnforceTrustedCommonNameEnabled, dmrCluster.tlsServerCertEnforceTrustedCommonNameEnabled) && - Objects.equals(this.tlsServerCertMaxChainDepth, dmrCluster.tlsServerCertMaxChainDepth) && - Objects.equals(this.tlsServerCertValidateDateEnabled, dmrCluster.tlsServerCertValidateDateEnabled) && - Objects.equals(this.tlsServerCertValidateNameEnabled, dmrCluster.tlsServerCertValidateNameEnabled); - } - - @Override - public int hashCode() { - return Objects.hash(authenticationBasicEnabled, authenticationBasicPassword, authenticationBasicType, authenticationClientCertContent, authenticationClientCertEnabled, authenticationClientCertPassword, directOnlyEnabled, dmrClusterName, enabled, nodeName, tlsServerCertEnforceTrustedCommonNameEnabled, tlsServerCertMaxChainDepth, tlsServerCertValidateDateEnabled, tlsServerCertValidateNameEnabled); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrCluster {\n"); - sb.append(" authenticationBasicEnabled: ").append(toIndentedString(authenticationBasicEnabled)).append("\n"); - sb.append(" authenticationBasicPassword: ").append(toIndentedString(authenticationBasicPassword)).append("\n"); - sb.append(" authenticationBasicType: ").append(toIndentedString(authenticationBasicType)).append("\n"); - sb.append(" authenticationClientCertContent: ").append(toIndentedString(authenticationClientCertContent)).append("\n"); - sb.append(" authenticationClientCertEnabled: ").append(toIndentedString(authenticationClientCertEnabled)).append("\n"); - sb.append(" authenticationClientCertPassword: ").append(toIndentedString(authenticationClientCertPassword)).append("\n"); - sb.append(" directOnlyEnabled: ").append(toIndentedString(directOnlyEnabled)).append("\n"); - sb.append(" dmrClusterName: ").append(toIndentedString(dmrClusterName)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" nodeName: ").append(toIndentedString(nodeName)).append("\n"); - sb.append(" tlsServerCertEnforceTrustedCommonNameEnabled: ").append(toIndentedString(tlsServerCertEnforceTrustedCommonNameEnabled)).append("\n"); - sb.append(" tlsServerCertMaxChainDepth: ").append(toIndentedString(tlsServerCertMaxChainDepth)).append("\n"); - sb.append(" tlsServerCertValidateDateEnabled: ").append(toIndentedString(tlsServerCertValidateDateEnabled)).append("\n"); - sb.append(" tlsServerCertValidateNameEnabled: ").append(toIndentedString(tlsServerCertValidateNameEnabled)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRule.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRule.java deleted file mode 100644 index 613a6a8b5..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRule.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterCertMatchingRule - */ -@JsonPropertyOrder({ - DmrClusterCertMatchingRule.JSON_PROPERTY_DMR_CLUSTER_NAME, - DmrClusterCertMatchingRule.JSON_PROPERTY_ENABLED, - DmrClusterCertMatchingRule.JSON_PROPERTY_RULE_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterCertMatchingRule { - public static final String JSON_PROPERTY_DMR_CLUSTER_NAME = "dmrClusterName"; - private String dmrClusterName; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_RULE_NAME = "ruleName"; - private String ruleName; - - public DmrClusterCertMatchingRule() { - } - - public DmrClusterCertMatchingRule dmrClusterName(String dmrClusterName) { - - this.dmrClusterName = dmrClusterName; - return this; - } - - /** - * The name of the Cluster. - * @return dmrClusterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DMR_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDmrClusterName() { - return dmrClusterName; - } - - - @JsonProperty(JSON_PROPERTY_DMR_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDmrClusterName(String dmrClusterName) { - this.dmrClusterName = dmrClusterName; - } - - - public DmrClusterCertMatchingRule enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable a certificate matching rule. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public DmrClusterCertMatchingRule ruleName(String ruleName) { - - this.ruleName = ruleName; - return this; - } - - /** - * The name of the rule. - * @return ruleName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RULE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRuleName() { - return ruleName; - } - - - @JsonProperty(JSON_PROPERTY_RULE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRuleName(String ruleName) { - this.ruleName = ruleName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterCertMatchingRule dmrClusterCertMatchingRule = (DmrClusterCertMatchingRule) o; - return Objects.equals(this.dmrClusterName, dmrClusterCertMatchingRule.dmrClusterName) && - Objects.equals(this.enabled, dmrClusterCertMatchingRule.enabled) && - Objects.equals(this.ruleName, dmrClusterCertMatchingRule.ruleName); - } - - @Override - public int hashCode() { - return Objects.hash(dmrClusterName, enabled, ruleName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterCertMatchingRule {\n"); - sb.append(" dmrClusterName: ").append(toIndentedString(dmrClusterName)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" ruleName: ").append(toIndentedString(ruleName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilter.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilter.java deleted file mode 100644 index 37d688414..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilter.java +++ /dev/null @@ -1,232 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterCertMatchingRuleAttributeFilter - */ -@JsonPropertyOrder({ - DmrClusterCertMatchingRuleAttributeFilter.JSON_PROPERTY_ATTRIBUTE_NAME, - DmrClusterCertMatchingRuleAttributeFilter.JSON_PROPERTY_ATTRIBUTE_VALUE, - DmrClusterCertMatchingRuleAttributeFilter.JSON_PROPERTY_DMR_CLUSTER_NAME, - DmrClusterCertMatchingRuleAttributeFilter.JSON_PROPERTY_FILTER_NAME, - DmrClusterCertMatchingRuleAttributeFilter.JSON_PROPERTY_RULE_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterCertMatchingRuleAttributeFilter { - public static final String JSON_PROPERTY_ATTRIBUTE_NAME = "attributeName"; - private String attributeName; - - public static final String JSON_PROPERTY_ATTRIBUTE_VALUE = "attributeValue"; - private String attributeValue; - - public static final String JSON_PROPERTY_DMR_CLUSTER_NAME = "dmrClusterName"; - private String dmrClusterName; - - public static final String JSON_PROPERTY_FILTER_NAME = "filterName"; - private String filterName; - - public static final String JSON_PROPERTY_RULE_NAME = "ruleName"; - private String ruleName; - - public DmrClusterCertMatchingRuleAttributeFilter() { - } - - public DmrClusterCertMatchingRuleAttributeFilter attributeName(String attributeName) { - - this.attributeName = attributeName; - return this; - } - - /** - * Link Attribute to be tested. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return attributeName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAttributeName() { - return attributeName; - } - - - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttributeName(String attributeName) { - this.attributeName = attributeName; - } - - - public DmrClusterCertMatchingRuleAttributeFilter attributeValue(String attributeValue) { - - this.attributeValue = attributeValue; - return this; - } - - /** - * Expected attribute value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return attributeValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAttributeValue() { - return attributeValue; - } - - - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttributeValue(String attributeValue) { - this.attributeValue = attributeValue; - } - - - public DmrClusterCertMatchingRuleAttributeFilter dmrClusterName(String dmrClusterName) { - - this.dmrClusterName = dmrClusterName; - return this; - } - - /** - * The name of the Cluster. - * @return dmrClusterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DMR_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDmrClusterName() { - return dmrClusterName; - } - - - @JsonProperty(JSON_PROPERTY_DMR_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDmrClusterName(String dmrClusterName) { - this.dmrClusterName = dmrClusterName; - } - - - public DmrClusterCertMatchingRuleAttributeFilter filterName(String filterName) { - - this.filterName = filterName; - return this; - } - - /** - * The name of the filter. - * @return filterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_FILTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getFilterName() { - return filterName; - } - - - @JsonProperty(JSON_PROPERTY_FILTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFilterName(String filterName) { - this.filterName = filterName; - } - - - public DmrClusterCertMatchingRuleAttributeFilter ruleName(String ruleName) { - - this.ruleName = ruleName; - return this; - } - - /** - * The name of the rule. - * @return ruleName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RULE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRuleName() { - return ruleName; - } - - - @JsonProperty(JSON_PROPERTY_RULE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRuleName(String ruleName) { - this.ruleName = ruleName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterCertMatchingRuleAttributeFilter dmrClusterCertMatchingRuleAttributeFilter = (DmrClusterCertMatchingRuleAttributeFilter) o; - return Objects.equals(this.attributeName, dmrClusterCertMatchingRuleAttributeFilter.attributeName) && - Objects.equals(this.attributeValue, dmrClusterCertMatchingRuleAttributeFilter.attributeValue) && - Objects.equals(this.dmrClusterName, dmrClusterCertMatchingRuleAttributeFilter.dmrClusterName) && - Objects.equals(this.filterName, dmrClusterCertMatchingRuleAttributeFilter.filterName) && - Objects.equals(this.ruleName, dmrClusterCertMatchingRuleAttributeFilter.ruleName); - } - - @Override - public int hashCode() { - return Objects.hash(attributeName, attributeValue, dmrClusterName, filterName, ruleName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterCertMatchingRuleAttributeFilter {\n"); - sb.append(" attributeName: ").append(toIndentedString(attributeName)).append("\n"); - sb.append(" attributeValue: ").append(toIndentedString(attributeValue)).append("\n"); - sb.append(" dmrClusterName: ").append(toIndentedString(dmrClusterName)).append("\n"); - sb.append(" filterName: ").append(toIndentedString(filterName)).append("\n"); - sb.append(" ruleName: ").append(toIndentedString(ruleName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterLinks.java deleted file mode 100644 index 1166a3aa9..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterCertMatchingRuleAttributeFilterLinks - */ -@JsonPropertyOrder({ - DmrClusterCertMatchingRuleAttributeFilterLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterCertMatchingRuleAttributeFilterLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public DmrClusterCertMatchingRuleAttributeFilterLinks() { - } - - public DmrClusterCertMatchingRuleAttributeFilterLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Certificate Matching Rule Attribute Filter object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterCertMatchingRuleAttributeFilterLinks dmrClusterCertMatchingRuleAttributeFilterLinks = (DmrClusterCertMatchingRuleAttributeFilterLinks) o; - return Objects.equals(this.uri, dmrClusterCertMatchingRuleAttributeFilterLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterCertMatchingRuleAttributeFilterLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterResponse.java deleted file mode 100644 index 2137cb333..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFilterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterCertMatchingRuleAttributeFilterResponse - */ -@JsonPropertyOrder({ - DmrClusterCertMatchingRuleAttributeFilterResponse.JSON_PROPERTY_DATA, - DmrClusterCertMatchingRuleAttributeFilterResponse.JSON_PROPERTY_LINKS, - DmrClusterCertMatchingRuleAttributeFilterResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterCertMatchingRuleAttributeFilterResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private DmrClusterCertMatchingRuleAttributeFilter data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private DmrClusterCertMatchingRuleAttributeFilterLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DmrClusterCertMatchingRuleAttributeFilterResponse() { - } - - public DmrClusterCertMatchingRuleAttributeFilterResponse data(DmrClusterCertMatchingRuleAttributeFilter data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DmrClusterCertMatchingRuleAttributeFilter getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(DmrClusterCertMatchingRuleAttributeFilter data) { - this.data = data; - } - - - public DmrClusterCertMatchingRuleAttributeFilterResponse links(DmrClusterCertMatchingRuleAttributeFilterLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DmrClusterCertMatchingRuleAttributeFilterLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(DmrClusterCertMatchingRuleAttributeFilterLinks links) { - this.links = links; - } - - - public DmrClusterCertMatchingRuleAttributeFilterResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterCertMatchingRuleAttributeFilterResponse dmrClusterCertMatchingRuleAttributeFilterResponse = (DmrClusterCertMatchingRuleAttributeFilterResponse) o; - return Objects.equals(this.data, dmrClusterCertMatchingRuleAttributeFilterResponse.data) && - Objects.equals(this.links, dmrClusterCertMatchingRuleAttributeFilterResponse.links) && - Objects.equals(this.meta, dmrClusterCertMatchingRuleAttributeFilterResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterCertMatchingRuleAttributeFilterResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFiltersResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFiltersResponse.java deleted file mode 100644 index 4769c5bf1..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFiltersResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFilterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterCertMatchingRuleAttributeFiltersResponse - */ -@JsonPropertyOrder({ - DmrClusterCertMatchingRuleAttributeFiltersResponse.JSON_PROPERTY_DATA, - DmrClusterCertMatchingRuleAttributeFiltersResponse.JSON_PROPERTY_LINKS, - DmrClusterCertMatchingRuleAttributeFiltersResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterCertMatchingRuleAttributeFiltersResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DmrClusterCertMatchingRuleAttributeFiltersResponse() { - } - - public DmrClusterCertMatchingRuleAttributeFiltersResponse data(List data) { - - this.data = data; - return this; - } - - public DmrClusterCertMatchingRuleAttributeFiltersResponse addDataItem(DmrClusterCertMatchingRuleAttributeFilter dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public DmrClusterCertMatchingRuleAttributeFiltersResponse links(List links) { - - this.links = links; - return this; - } - - public DmrClusterCertMatchingRuleAttributeFiltersResponse addLinksItem(DmrClusterCertMatchingRuleAttributeFilterLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public DmrClusterCertMatchingRuleAttributeFiltersResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterCertMatchingRuleAttributeFiltersResponse dmrClusterCertMatchingRuleAttributeFiltersResponse = (DmrClusterCertMatchingRuleAttributeFiltersResponse) o; - return Objects.equals(this.data, dmrClusterCertMatchingRuleAttributeFiltersResponse.data) && - Objects.equals(this.links, dmrClusterCertMatchingRuleAttributeFiltersResponse.links) && - Objects.equals(this.meta, dmrClusterCertMatchingRuleAttributeFiltersResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterCertMatchingRuleAttributeFiltersResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleCondition.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleCondition.java deleted file mode 100644 index 16d384a6b..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleCondition.java +++ /dev/null @@ -1,289 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterCertMatchingRuleCondition - */ -@JsonPropertyOrder({ - DmrClusterCertMatchingRuleCondition.JSON_PROPERTY_ATTRIBUTE, - DmrClusterCertMatchingRuleCondition.JSON_PROPERTY_DMR_CLUSTER_NAME, - DmrClusterCertMatchingRuleCondition.JSON_PROPERTY_EXPRESSION, - DmrClusterCertMatchingRuleCondition.JSON_PROPERTY_RULE_NAME, - DmrClusterCertMatchingRuleCondition.JSON_PROPERTY_SOURCE -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterCertMatchingRuleCondition { - public static final String JSON_PROPERTY_ATTRIBUTE = "attribute"; - private String attribute; - - public static final String JSON_PROPERTY_DMR_CLUSTER_NAME = "dmrClusterName"; - private String dmrClusterName; - - public static final String JSON_PROPERTY_EXPRESSION = "expression"; - private String expression; - - public static final String JSON_PROPERTY_RULE_NAME = "ruleName"; - private String ruleName; - - /** - * Certificate field to be compared with the Attribute. The allowed values and their meaning are: <pre> \"certificate-thumbprint\" - The attribute is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate. \"common-name\" - The attribute is extracted from the certificate's first instance of the Common Name attribute in the Subject DN. \"common-name-last\" - The attribute is extracted from the certificate's last instance of the Common Name attribute in the Subject DN. \"subject-alternate-name-msupn\" - The attribute is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature. \"uid\" - The attribute is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN. \"uid-last\" - The attribute is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN. \"org-unit\" - The attribute is extracted from the certificate's first instance of the Org Unit attribute in the Subject DN. \"org-unit-last\" - The attribute is extracted from the certificate's last instance of the Org Unit attribute in the Subject DN. \"issuer\" - The attribute is extracted from the certificate's Issuer DN. \"subject\" - The attribute is extracted from the certificate's Subject DN. \"serial-number\" - The attribute is extracted from the certificate's Serial Number. \"dns-name\" - The attribute is extracted from the certificate's Subject Alt Name DNSName. \"ip-address\" - The attribute is extracted from the certificate's Subject Alt Name IPAddress. </pre> - */ - public enum SourceEnum { - CERTIFICATE_THUMBPRINT("certificate-thumbprint"), - - COMMON_NAME("common-name"), - - COMMON_NAME_LAST("common-name-last"), - - SUBJECT_ALTERNATE_NAME_MSUPN("subject-alternate-name-msupn"), - - UID("uid"), - - UID_LAST("uid-last"), - - ORG_UNIT("org-unit"), - - ORG_UNIT_LAST("org-unit-last"), - - ISSUER("issuer"), - - SUBJECT("subject"), - - SERIAL_NUMBER("serial-number"), - - DNS_NAME("dns-name"), - - IP_ADDRESS("ip-address"); - - private String value; - - SourceEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static SourceEnum fromValue(String value) { - for (SourceEnum b : SourceEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_SOURCE = "source"; - private SourceEnum source; - - public DmrClusterCertMatchingRuleCondition() { - } - - public DmrClusterCertMatchingRuleCondition attribute(String attribute) { - - this.attribute = attribute; - return this; - } - - /** - * Link Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The default value is `\"\"`. - * @return attribute - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ATTRIBUTE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAttribute() { - return attribute; - } - - - @JsonProperty(JSON_PROPERTY_ATTRIBUTE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttribute(String attribute) { - this.attribute = attribute; - } - - - public DmrClusterCertMatchingRuleCondition dmrClusterName(String dmrClusterName) { - - this.dmrClusterName = dmrClusterName; - return this; - } - - /** - * The name of the Cluster. - * @return dmrClusterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DMR_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDmrClusterName() { - return dmrClusterName; - } - - - @JsonProperty(JSON_PROPERTY_DMR_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDmrClusterName(String dmrClusterName) { - this.dmrClusterName = dmrClusterName; - } - - - public DmrClusterCertMatchingRuleCondition expression(String expression) { - - this.expression = expression; - return this; - } - - /** - * Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The default value is `\"\"`. - * @return expression - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EXPRESSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getExpression() { - return expression; - } - - - @JsonProperty(JSON_PROPERTY_EXPRESSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setExpression(String expression) { - this.expression = expression; - } - - - public DmrClusterCertMatchingRuleCondition ruleName(String ruleName) { - - this.ruleName = ruleName; - return this; - } - - /** - * The name of the rule. - * @return ruleName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RULE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRuleName() { - return ruleName; - } - - - @JsonProperty(JSON_PROPERTY_RULE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRuleName(String ruleName) { - this.ruleName = ruleName; - } - - - public DmrClusterCertMatchingRuleCondition source(SourceEnum source) { - - this.source = source; - return this; - } - - /** - * Certificate field to be compared with the Attribute. The allowed values and their meaning are: <pre> \"certificate-thumbprint\" - The attribute is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate. \"common-name\" - The attribute is extracted from the certificate's first instance of the Common Name attribute in the Subject DN. \"common-name-last\" - The attribute is extracted from the certificate's last instance of the Common Name attribute in the Subject DN. \"subject-alternate-name-msupn\" - The attribute is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature. \"uid\" - The attribute is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN. \"uid-last\" - The attribute is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN. \"org-unit\" - The attribute is extracted from the certificate's first instance of the Org Unit attribute in the Subject DN. \"org-unit-last\" - The attribute is extracted from the certificate's last instance of the Org Unit attribute in the Subject DN. \"issuer\" - The attribute is extracted from the certificate's Issuer DN. \"subject\" - The attribute is extracted from the certificate's Subject DN. \"serial-number\" - The attribute is extracted from the certificate's Serial Number. \"dns-name\" - The attribute is extracted from the certificate's Subject Alt Name DNSName. \"ip-address\" - The attribute is extracted from the certificate's Subject Alt Name IPAddress. </pre> - * @return source - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SOURCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public SourceEnum getSource() { - return source; - } - - - @JsonProperty(JSON_PROPERTY_SOURCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSource(SourceEnum source) { - this.source = source; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterCertMatchingRuleCondition dmrClusterCertMatchingRuleCondition = (DmrClusterCertMatchingRuleCondition) o; - return Objects.equals(this.attribute, dmrClusterCertMatchingRuleCondition.attribute) && - Objects.equals(this.dmrClusterName, dmrClusterCertMatchingRuleCondition.dmrClusterName) && - Objects.equals(this.expression, dmrClusterCertMatchingRuleCondition.expression) && - Objects.equals(this.ruleName, dmrClusterCertMatchingRuleCondition.ruleName) && - Objects.equals(this.source, dmrClusterCertMatchingRuleCondition.source); - } - - @Override - public int hashCode() { - return Objects.hash(attribute, dmrClusterName, expression, ruleName, source); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterCertMatchingRuleCondition {\n"); - sb.append(" attribute: ").append(toIndentedString(attribute)).append("\n"); - sb.append(" dmrClusterName: ").append(toIndentedString(dmrClusterName)).append("\n"); - sb.append(" expression: ").append(toIndentedString(expression)).append("\n"); - sb.append(" ruleName: ").append(toIndentedString(ruleName)).append("\n"); - sb.append(" source: ").append(toIndentedString(source)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionLinks.java deleted file mode 100644 index a63d084c3..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterCertMatchingRuleConditionLinks - */ -@JsonPropertyOrder({ - DmrClusterCertMatchingRuleConditionLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterCertMatchingRuleConditionLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public DmrClusterCertMatchingRuleConditionLinks() { - } - - public DmrClusterCertMatchingRuleConditionLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Certificate Matching Rule Condition object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterCertMatchingRuleConditionLinks dmrClusterCertMatchingRuleConditionLinks = (DmrClusterCertMatchingRuleConditionLinks) o; - return Objects.equals(this.uri, dmrClusterCertMatchingRuleConditionLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterCertMatchingRuleConditionLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionResponse.java deleted file mode 100644 index 391e40d3d..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleConditionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterCertMatchingRuleConditionResponse - */ -@JsonPropertyOrder({ - DmrClusterCertMatchingRuleConditionResponse.JSON_PROPERTY_DATA, - DmrClusterCertMatchingRuleConditionResponse.JSON_PROPERTY_LINKS, - DmrClusterCertMatchingRuleConditionResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterCertMatchingRuleConditionResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private DmrClusterCertMatchingRuleCondition data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private DmrClusterCertMatchingRuleConditionLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DmrClusterCertMatchingRuleConditionResponse() { - } - - public DmrClusterCertMatchingRuleConditionResponse data(DmrClusterCertMatchingRuleCondition data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DmrClusterCertMatchingRuleCondition getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(DmrClusterCertMatchingRuleCondition data) { - this.data = data; - } - - - public DmrClusterCertMatchingRuleConditionResponse links(DmrClusterCertMatchingRuleConditionLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DmrClusterCertMatchingRuleConditionLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(DmrClusterCertMatchingRuleConditionLinks links) { - this.links = links; - } - - - public DmrClusterCertMatchingRuleConditionResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterCertMatchingRuleConditionResponse dmrClusterCertMatchingRuleConditionResponse = (DmrClusterCertMatchingRuleConditionResponse) o; - return Objects.equals(this.data, dmrClusterCertMatchingRuleConditionResponse.data) && - Objects.equals(this.links, dmrClusterCertMatchingRuleConditionResponse.links) && - Objects.equals(this.meta, dmrClusterCertMatchingRuleConditionResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterCertMatchingRuleConditionResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionsResponse.java deleted file mode 100644 index b2ebedc69..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleConditionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterCertMatchingRuleConditionsResponse - */ -@JsonPropertyOrder({ - DmrClusterCertMatchingRuleConditionsResponse.JSON_PROPERTY_DATA, - DmrClusterCertMatchingRuleConditionsResponse.JSON_PROPERTY_LINKS, - DmrClusterCertMatchingRuleConditionsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterCertMatchingRuleConditionsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DmrClusterCertMatchingRuleConditionsResponse() { - } - - public DmrClusterCertMatchingRuleConditionsResponse data(List data) { - - this.data = data; - return this; - } - - public DmrClusterCertMatchingRuleConditionsResponse addDataItem(DmrClusterCertMatchingRuleCondition dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public DmrClusterCertMatchingRuleConditionsResponse links(List links) { - - this.links = links; - return this; - } - - public DmrClusterCertMatchingRuleConditionsResponse addLinksItem(DmrClusterCertMatchingRuleConditionLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public DmrClusterCertMatchingRuleConditionsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterCertMatchingRuleConditionsResponse dmrClusterCertMatchingRuleConditionsResponse = (DmrClusterCertMatchingRuleConditionsResponse) o; - return Objects.equals(this.data, dmrClusterCertMatchingRuleConditionsResponse.data) && - Objects.equals(this.links, dmrClusterCertMatchingRuleConditionsResponse.links) && - Objects.equals(this.meta, dmrClusterCertMatchingRuleConditionsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterCertMatchingRuleConditionsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleLinks.java deleted file mode 100644 index d0eca8037..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleLinks.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterCertMatchingRuleLinks - */ -@JsonPropertyOrder({ - DmrClusterCertMatchingRuleLinks.JSON_PROPERTY_ATTRIBUTE_FILTERS_URI, - DmrClusterCertMatchingRuleLinks.JSON_PROPERTY_CONDITIONS_URI, - DmrClusterCertMatchingRuleLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterCertMatchingRuleLinks { - public static final String JSON_PROPERTY_ATTRIBUTE_FILTERS_URI = "attributeFiltersUri"; - private String attributeFiltersUri; - - public static final String JSON_PROPERTY_CONDITIONS_URI = "conditionsUri"; - private String conditionsUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public DmrClusterCertMatchingRuleLinks() { - } - - public DmrClusterCertMatchingRuleLinks attributeFiltersUri(String attributeFiltersUri) { - - this.attributeFiltersUri = attributeFiltersUri; - return this; - } - - /** - * The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Attribute Filter objects. - * @return attributeFiltersUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_FILTERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAttributeFiltersUri() { - return attributeFiltersUri; - } - - - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_FILTERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttributeFiltersUri(String attributeFiltersUri) { - this.attributeFiltersUri = attributeFiltersUri; - } - - - public DmrClusterCertMatchingRuleLinks conditionsUri(String conditionsUri) { - - this.conditionsUri = conditionsUri; - return this; - } - - /** - * The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Condition objects. - * @return conditionsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONDITIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getConditionsUri() { - return conditionsUri; - } - - - @JsonProperty(JSON_PROPERTY_CONDITIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConditionsUri(String conditionsUri) { - this.conditionsUri = conditionsUri; - } - - - public DmrClusterCertMatchingRuleLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Certificate Matching Rule object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterCertMatchingRuleLinks dmrClusterCertMatchingRuleLinks = (DmrClusterCertMatchingRuleLinks) o; - return Objects.equals(this.attributeFiltersUri, dmrClusterCertMatchingRuleLinks.attributeFiltersUri) && - Objects.equals(this.conditionsUri, dmrClusterCertMatchingRuleLinks.conditionsUri) && - Objects.equals(this.uri, dmrClusterCertMatchingRuleLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(attributeFiltersUri, conditionsUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterCertMatchingRuleLinks {\n"); - sb.append(" attributeFiltersUri: ").append(toIndentedString(attributeFiltersUri)).append("\n"); - sb.append(" conditionsUri: ").append(toIndentedString(conditionsUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleResponse.java deleted file mode 100644 index 00bf83214..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterCertMatchingRuleResponse - */ -@JsonPropertyOrder({ - DmrClusterCertMatchingRuleResponse.JSON_PROPERTY_DATA, - DmrClusterCertMatchingRuleResponse.JSON_PROPERTY_LINKS, - DmrClusterCertMatchingRuleResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterCertMatchingRuleResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private DmrClusterCertMatchingRule data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private DmrClusterCertMatchingRuleLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DmrClusterCertMatchingRuleResponse() { - } - - public DmrClusterCertMatchingRuleResponse data(DmrClusterCertMatchingRule data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DmrClusterCertMatchingRule getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(DmrClusterCertMatchingRule data) { - this.data = data; - } - - - public DmrClusterCertMatchingRuleResponse links(DmrClusterCertMatchingRuleLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DmrClusterCertMatchingRuleLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(DmrClusterCertMatchingRuleLinks links) { - this.links = links; - } - - - public DmrClusterCertMatchingRuleResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterCertMatchingRuleResponse dmrClusterCertMatchingRuleResponse = (DmrClusterCertMatchingRuleResponse) o; - return Objects.equals(this.data, dmrClusterCertMatchingRuleResponse.data) && - Objects.equals(this.links, dmrClusterCertMatchingRuleResponse.links) && - Objects.equals(this.meta, dmrClusterCertMatchingRuleResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterCertMatchingRuleResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRulesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRulesResponse.java deleted file mode 100644 index cbd303383..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRulesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterCertMatchingRulesResponse - */ -@JsonPropertyOrder({ - DmrClusterCertMatchingRulesResponse.JSON_PROPERTY_DATA, - DmrClusterCertMatchingRulesResponse.JSON_PROPERTY_LINKS, - DmrClusterCertMatchingRulesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterCertMatchingRulesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DmrClusterCertMatchingRulesResponse() { - } - - public DmrClusterCertMatchingRulesResponse data(List data) { - - this.data = data; - return this; - } - - public DmrClusterCertMatchingRulesResponse addDataItem(DmrClusterCertMatchingRule dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public DmrClusterCertMatchingRulesResponse links(List links) { - - this.links = links; - return this; - } - - public DmrClusterCertMatchingRulesResponse addLinksItem(DmrClusterCertMatchingRuleLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public DmrClusterCertMatchingRulesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterCertMatchingRulesResponse dmrClusterCertMatchingRulesResponse = (DmrClusterCertMatchingRulesResponse) o; - return Objects.equals(this.data, dmrClusterCertMatchingRulesResponse.data) && - Objects.equals(this.links, dmrClusterCertMatchingRulesResponse.links) && - Objects.equals(this.meta, dmrClusterCertMatchingRulesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterCertMatchingRulesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLink.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLink.java deleted file mode 100644 index ae1bff675..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLink.java +++ /dev/null @@ -1,1305 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLink - */ -@JsonPropertyOrder({ - DmrClusterLink.JSON_PROPERTY_AUTHENTICATION_BASIC_PASSWORD, - DmrClusterLink.JSON_PROPERTY_AUTHENTICATION_SCHEME, - DmrClusterLink.JSON_PROPERTY_CLIENT_PROFILE_QUEUE_CONTROL1_MAX_DEPTH, - DmrClusterLink.JSON_PROPERTY_CLIENT_PROFILE_QUEUE_CONTROL1_MIN_MSG_BURST, - DmrClusterLink.JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT1_MAX_DEPTH, - DmrClusterLink.JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT1_MIN_MSG_BURST, - DmrClusterLink.JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT2_MAX_DEPTH, - DmrClusterLink.JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT2_MIN_MSG_BURST, - DmrClusterLink.JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT3_MAX_DEPTH, - DmrClusterLink.JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT3_MIN_MSG_BURST, - DmrClusterLink.JSON_PROPERTY_CLIENT_PROFILE_QUEUE_GUARANTEED1_MAX_DEPTH, - DmrClusterLink.JSON_PROPERTY_CLIENT_PROFILE_QUEUE_GUARANTEED1_MIN_MSG_BURST, - DmrClusterLink.JSON_PROPERTY_CLIENT_PROFILE_TCP_CONGESTION_WINDOW_SIZE, - DmrClusterLink.JSON_PROPERTY_CLIENT_PROFILE_TCP_KEEPALIVE_COUNT, - DmrClusterLink.JSON_PROPERTY_CLIENT_PROFILE_TCP_KEEPALIVE_IDLE_TIME, - DmrClusterLink.JSON_PROPERTY_CLIENT_PROFILE_TCP_KEEPALIVE_INTERVAL, - DmrClusterLink.JSON_PROPERTY_CLIENT_PROFILE_TCP_MAX_SEGMENT_SIZE, - DmrClusterLink.JSON_PROPERTY_CLIENT_PROFILE_TCP_MAX_WINDOW_SIZE, - DmrClusterLink.JSON_PROPERTY_DMR_CLUSTER_NAME, - DmrClusterLink.JSON_PROPERTY_EGRESS_FLOW_WINDOW_SIZE, - DmrClusterLink.JSON_PROPERTY_ENABLED, - DmrClusterLink.JSON_PROPERTY_INITIATOR, - DmrClusterLink.JSON_PROPERTY_QUEUE_DEAD_MSG_QUEUE, - DmrClusterLink.JSON_PROPERTY_QUEUE_EVENT_SPOOL_USAGE_THRESHOLD, - DmrClusterLink.JSON_PROPERTY_QUEUE_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW, - DmrClusterLink.JSON_PROPERTY_QUEUE_MAX_MSG_SPOOL_USAGE, - DmrClusterLink.JSON_PROPERTY_QUEUE_MAX_REDELIVERY_COUNT, - DmrClusterLink.JSON_PROPERTY_QUEUE_MAX_TTL, - DmrClusterLink.JSON_PROPERTY_QUEUE_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR, - DmrClusterLink.JSON_PROPERTY_QUEUE_RESPECT_TTL_ENABLED, - DmrClusterLink.JSON_PROPERTY_REMOTE_NODE_NAME, - DmrClusterLink.JSON_PROPERTY_SPAN, - DmrClusterLink.JSON_PROPERTY_TRANSPORT_COMPRESSED_ENABLED, - DmrClusterLink.JSON_PROPERTY_TRANSPORT_TLS_ENABLED -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLink { - public static final String JSON_PROPERTY_AUTHENTICATION_BASIC_PASSWORD = "authenticationBasicPassword"; - private String authenticationBasicPassword; - - /** - * The authentication scheme to be used by the Link which initiates connections to the remote node. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"basic\"`. The allowed values and their meaning are: <pre> \"basic\" - Basic Authentication Scheme (via username and password). \"client-certificate\" - Client Certificate Authentication Scheme (via certificate file or content). </pre> - */ - public enum AuthenticationSchemeEnum { - BASIC("basic"), - - CLIENT_CERTIFICATE("client-certificate"); - - private String value; - - AuthenticationSchemeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AuthenticationSchemeEnum fromValue(String value) { - for (AuthenticationSchemeEnum b : AuthenticationSchemeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_AUTHENTICATION_SCHEME = "authenticationScheme"; - private AuthenticationSchemeEnum authenticationScheme; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_QUEUE_CONTROL1_MAX_DEPTH = "clientProfileQueueControl1MaxDepth"; - private Integer clientProfileQueueControl1MaxDepth; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_QUEUE_CONTROL1_MIN_MSG_BURST = "clientProfileQueueControl1MinMsgBurst"; - private Integer clientProfileQueueControl1MinMsgBurst; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT1_MAX_DEPTH = "clientProfileQueueDirect1MaxDepth"; - private Integer clientProfileQueueDirect1MaxDepth; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT1_MIN_MSG_BURST = "clientProfileQueueDirect1MinMsgBurst"; - private Integer clientProfileQueueDirect1MinMsgBurst; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT2_MAX_DEPTH = "clientProfileQueueDirect2MaxDepth"; - private Integer clientProfileQueueDirect2MaxDepth; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT2_MIN_MSG_BURST = "clientProfileQueueDirect2MinMsgBurst"; - private Integer clientProfileQueueDirect2MinMsgBurst; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT3_MAX_DEPTH = "clientProfileQueueDirect3MaxDepth"; - private Integer clientProfileQueueDirect3MaxDepth; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT3_MIN_MSG_BURST = "clientProfileQueueDirect3MinMsgBurst"; - private Integer clientProfileQueueDirect3MinMsgBurst; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_QUEUE_GUARANTEED1_MAX_DEPTH = "clientProfileQueueGuaranteed1MaxDepth"; - private Integer clientProfileQueueGuaranteed1MaxDepth; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_QUEUE_GUARANTEED1_MIN_MSG_BURST = "clientProfileQueueGuaranteed1MinMsgBurst"; - private Integer clientProfileQueueGuaranteed1MinMsgBurst; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_TCP_CONGESTION_WINDOW_SIZE = "clientProfileTcpCongestionWindowSize"; - private Long clientProfileTcpCongestionWindowSize; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_TCP_KEEPALIVE_COUNT = "clientProfileTcpKeepaliveCount"; - private Long clientProfileTcpKeepaliveCount; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_TCP_KEEPALIVE_IDLE_TIME = "clientProfileTcpKeepaliveIdleTime"; - private Long clientProfileTcpKeepaliveIdleTime; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_TCP_KEEPALIVE_INTERVAL = "clientProfileTcpKeepaliveInterval"; - private Long clientProfileTcpKeepaliveInterval; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_TCP_MAX_SEGMENT_SIZE = "clientProfileTcpMaxSegmentSize"; - private Long clientProfileTcpMaxSegmentSize; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_TCP_MAX_WINDOW_SIZE = "clientProfileTcpMaxWindowSize"; - private Long clientProfileTcpMaxWindowSize; - - public static final String JSON_PROPERTY_DMR_CLUSTER_NAME = "dmrClusterName"; - private String dmrClusterName; - - public static final String JSON_PROPERTY_EGRESS_FLOW_WINDOW_SIZE = "egressFlowWindowSize"; - private Long egressFlowWindowSize; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - /** - * The initiator of the Link's TCP connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"lexical\"`. The allowed values and their meaning are: <pre> \"lexical\" - The \"higher\" node-name initiates. \"local\" - The local node initiates. \"remote\" - The remote node initiates. </pre> - */ - public enum InitiatorEnum { - LEXICAL("lexical"), - - LOCAL("local"), - - REMOTE("remote"); - - private String value; - - InitiatorEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static InitiatorEnum fromValue(String value) { - for (InitiatorEnum b : InitiatorEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_INITIATOR = "initiator"; - private InitiatorEnum initiator; - - public static final String JSON_PROPERTY_QUEUE_DEAD_MSG_QUEUE = "queueDeadMsgQueue"; - private String queueDeadMsgQueue; - - public static final String JSON_PROPERTY_QUEUE_EVENT_SPOOL_USAGE_THRESHOLD = "queueEventSpoolUsageThreshold"; - private EventThreshold queueEventSpoolUsageThreshold; - - public static final String JSON_PROPERTY_QUEUE_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW = "queueMaxDeliveredUnackedMsgsPerFlow"; - private Long queueMaxDeliveredUnackedMsgsPerFlow; - - public static final String JSON_PROPERTY_QUEUE_MAX_MSG_SPOOL_USAGE = "queueMaxMsgSpoolUsage"; - private Long queueMaxMsgSpoolUsage; - - public static final String JSON_PROPERTY_QUEUE_MAX_REDELIVERY_COUNT = "queueMaxRedeliveryCount"; - private Long queueMaxRedeliveryCount; - - public static final String JSON_PROPERTY_QUEUE_MAX_TTL = "queueMaxTtl"; - private Long queueMaxTtl; - - /** - * Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"always\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-queue-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> - */ - public enum QueueRejectMsgToSenderOnDiscardBehaviorEnum { - ALWAYS("always"), - - WHEN_QUEUE_ENABLED("when-queue-enabled"), - - NEVER("never"); - - private String value; - - QueueRejectMsgToSenderOnDiscardBehaviorEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static QueueRejectMsgToSenderOnDiscardBehaviorEnum fromValue(String value) { - for (QueueRejectMsgToSenderOnDiscardBehaviorEnum b : QueueRejectMsgToSenderOnDiscardBehaviorEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_QUEUE_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR = "queueRejectMsgToSenderOnDiscardBehavior"; - private QueueRejectMsgToSenderOnDiscardBehaviorEnum queueRejectMsgToSenderOnDiscardBehavior; - - public static final String JSON_PROPERTY_QUEUE_RESPECT_TTL_ENABLED = "queueRespectTtlEnabled"; - private Boolean queueRespectTtlEnabled; - - public static final String JSON_PROPERTY_REMOTE_NODE_NAME = "remoteNodeName"; - private String remoteNodeName; - - /** - * The span of the Link, either internal or external. Internal Links connect nodes within the same Cluster. External Links connect nodes within different Clusters. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"external\"`. The allowed values and their meaning are: <pre> \"internal\" - Link to same cluster. \"external\" - Link to other cluster. </pre> - */ - public enum SpanEnum { - INTERNAL("internal"), - - EXTERNAL("external"); - - private String value; - - SpanEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static SpanEnum fromValue(String value) { - for (SpanEnum b : SpanEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_SPAN = "span"; - private SpanEnum span; - - public static final String JSON_PROPERTY_TRANSPORT_COMPRESSED_ENABLED = "transportCompressedEnabled"; - private Boolean transportCompressedEnabled; - - public static final String JSON_PROPERTY_TRANSPORT_TLS_ENABLED = "transportTlsEnabled"; - private Boolean transportTlsEnabled; - - public DmrClusterLink() { - } - - public DmrClusterLink authenticationBasicPassword(String authenticationBasicPassword) { - - this.authenticationBasicPassword = authenticationBasicPassword; - return this; - } - - /** - * The password used to authenticate with the remote node when using basic internal authentication. If this per-Link password is not configured, the Cluster's password is used instead. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return authenticationBasicPassword - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_BASIC_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationBasicPassword() { - return authenticationBasicPassword; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_BASIC_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationBasicPassword(String authenticationBasicPassword) { - this.authenticationBasicPassword = authenticationBasicPassword; - } - - - public DmrClusterLink authenticationScheme(AuthenticationSchemeEnum authenticationScheme) { - - this.authenticationScheme = authenticationScheme; - return this; - } - - /** - * The authentication scheme to be used by the Link which initiates connections to the remote node. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"basic\"`. The allowed values and their meaning are: <pre> \"basic\" - Basic Authentication Scheme (via username and password). \"client-certificate\" - Client Certificate Authentication Scheme (via certificate file or content). </pre> - * @return authenticationScheme - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_SCHEME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AuthenticationSchemeEnum getAuthenticationScheme() { - return authenticationScheme; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_SCHEME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationScheme(AuthenticationSchemeEnum authenticationScheme) { - this.authenticationScheme = authenticationScheme; - } - - - public DmrClusterLink clientProfileQueueControl1MaxDepth(Integer clientProfileQueueControl1MaxDepth) { - - this.clientProfileQueueControl1MaxDepth = clientProfileQueueControl1MaxDepth; - return this; - } - - /** - * The maximum depth of the \"Control 1\" (C-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`. - * @return clientProfileQueueControl1MaxDepth - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_CONTROL1_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getClientProfileQueueControl1MaxDepth() { - return clientProfileQueueControl1MaxDepth; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_CONTROL1_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileQueueControl1MaxDepth(Integer clientProfileQueueControl1MaxDepth) { - this.clientProfileQueueControl1MaxDepth = clientProfileQueueControl1MaxDepth; - } - - - public DmrClusterLink clientProfileQueueControl1MinMsgBurst(Integer clientProfileQueueControl1MinMsgBurst) { - - this.clientProfileQueueControl1MinMsgBurst = clientProfileQueueControl1MinMsgBurst; - return this; - } - - /** - * The number of messages that are always allowed entry into the \"Control 1\" (C-1) priority queue, regardless of the `clientProfileQueueControl1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`. - * @return clientProfileQueueControl1MinMsgBurst - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_CONTROL1_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getClientProfileQueueControl1MinMsgBurst() { - return clientProfileQueueControl1MinMsgBurst; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_CONTROL1_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileQueueControl1MinMsgBurst(Integer clientProfileQueueControl1MinMsgBurst) { - this.clientProfileQueueControl1MinMsgBurst = clientProfileQueueControl1MinMsgBurst; - } - - - public DmrClusterLink clientProfileQueueDirect1MaxDepth(Integer clientProfileQueueDirect1MaxDepth) { - - this.clientProfileQueueDirect1MaxDepth = clientProfileQueueDirect1MaxDepth; - return this; - } - - /** - * The maximum depth of the \"Direct 1\" (D-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`. - * @return clientProfileQueueDirect1MaxDepth - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT1_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getClientProfileQueueDirect1MaxDepth() { - return clientProfileQueueDirect1MaxDepth; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT1_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileQueueDirect1MaxDepth(Integer clientProfileQueueDirect1MaxDepth) { - this.clientProfileQueueDirect1MaxDepth = clientProfileQueueDirect1MaxDepth; - } - - - public DmrClusterLink clientProfileQueueDirect1MinMsgBurst(Integer clientProfileQueueDirect1MinMsgBurst) { - - this.clientProfileQueueDirect1MinMsgBurst = clientProfileQueueDirect1MinMsgBurst; - return this; - } - - /** - * The number of messages that are always allowed entry into the \"Direct 1\" (D-1) priority queue, regardless of the `clientProfileQueueDirect1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`. - * @return clientProfileQueueDirect1MinMsgBurst - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT1_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getClientProfileQueueDirect1MinMsgBurst() { - return clientProfileQueueDirect1MinMsgBurst; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT1_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileQueueDirect1MinMsgBurst(Integer clientProfileQueueDirect1MinMsgBurst) { - this.clientProfileQueueDirect1MinMsgBurst = clientProfileQueueDirect1MinMsgBurst; - } - - - public DmrClusterLink clientProfileQueueDirect2MaxDepth(Integer clientProfileQueueDirect2MaxDepth) { - - this.clientProfileQueueDirect2MaxDepth = clientProfileQueueDirect2MaxDepth; - return this; - } - - /** - * The maximum depth of the \"Direct 2\" (D-2) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`. - * @return clientProfileQueueDirect2MaxDepth - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT2_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getClientProfileQueueDirect2MaxDepth() { - return clientProfileQueueDirect2MaxDepth; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT2_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileQueueDirect2MaxDepth(Integer clientProfileQueueDirect2MaxDepth) { - this.clientProfileQueueDirect2MaxDepth = clientProfileQueueDirect2MaxDepth; - } - - - public DmrClusterLink clientProfileQueueDirect2MinMsgBurst(Integer clientProfileQueueDirect2MinMsgBurst) { - - this.clientProfileQueueDirect2MinMsgBurst = clientProfileQueueDirect2MinMsgBurst; - return this; - } - - /** - * The number of messages that are always allowed entry into the \"Direct 2\" (D-2) priority queue, regardless of the `clientProfileQueueDirect2MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`. - * @return clientProfileQueueDirect2MinMsgBurst - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT2_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getClientProfileQueueDirect2MinMsgBurst() { - return clientProfileQueueDirect2MinMsgBurst; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT2_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileQueueDirect2MinMsgBurst(Integer clientProfileQueueDirect2MinMsgBurst) { - this.clientProfileQueueDirect2MinMsgBurst = clientProfileQueueDirect2MinMsgBurst; - } - - - public DmrClusterLink clientProfileQueueDirect3MaxDepth(Integer clientProfileQueueDirect3MaxDepth) { - - this.clientProfileQueueDirect3MaxDepth = clientProfileQueueDirect3MaxDepth; - return this; - } - - /** - * The maximum depth of the \"Direct 3\" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`. - * @return clientProfileQueueDirect3MaxDepth - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT3_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getClientProfileQueueDirect3MaxDepth() { - return clientProfileQueueDirect3MaxDepth; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT3_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileQueueDirect3MaxDepth(Integer clientProfileQueueDirect3MaxDepth) { - this.clientProfileQueueDirect3MaxDepth = clientProfileQueueDirect3MaxDepth; - } - - - public DmrClusterLink clientProfileQueueDirect3MinMsgBurst(Integer clientProfileQueueDirect3MinMsgBurst) { - - this.clientProfileQueueDirect3MinMsgBurst = clientProfileQueueDirect3MinMsgBurst; - return this; - } - - /** - * The number of messages that are always allowed entry into the \"Direct 3\" (D-3) priority queue, regardless of the `clientProfileQueueDirect3MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`. - * @return clientProfileQueueDirect3MinMsgBurst - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT3_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getClientProfileQueueDirect3MinMsgBurst() { - return clientProfileQueueDirect3MinMsgBurst; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_DIRECT3_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileQueueDirect3MinMsgBurst(Integer clientProfileQueueDirect3MinMsgBurst) { - this.clientProfileQueueDirect3MinMsgBurst = clientProfileQueueDirect3MinMsgBurst; - } - - - public DmrClusterLink clientProfileQueueGuaranteed1MaxDepth(Integer clientProfileQueueGuaranteed1MaxDepth) { - - this.clientProfileQueueGuaranteed1MaxDepth = clientProfileQueueGuaranteed1MaxDepth; - return this; - } - - /** - * The maximum depth of the \"Guaranteed 1\" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`. - * @return clientProfileQueueGuaranteed1MaxDepth - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_GUARANTEED1_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getClientProfileQueueGuaranteed1MaxDepth() { - return clientProfileQueueGuaranteed1MaxDepth; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_GUARANTEED1_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileQueueGuaranteed1MaxDepth(Integer clientProfileQueueGuaranteed1MaxDepth) { - this.clientProfileQueueGuaranteed1MaxDepth = clientProfileQueueGuaranteed1MaxDepth; - } - - - public DmrClusterLink clientProfileQueueGuaranteed1MinMsgBurst(Integer clientProfileQueueGuaranteed1MinMsgBurst) { - - this.clientProfileQueueGuaranteed1MinMsgBurst = clientProfileQueueGuaranteed1MinMsgBurst; - return this; - } - - /** - * The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-3) priority queue, regardless of the `clientProfileQueueGuaranteed1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`. - * @return clientProfileQueueGuaranteed1MinMsgBurst - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_GUARANTEED1_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getClientProfileQueueGuaranteed1MinMsgBurst() { - return clientProfileQueueGuaranteed1MinMsgBurst; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_QUEUE_GUARANTEED1_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileQueueGuaranteed1MinMsgBurst(Integer clientProfileQueueGuaranteed1MinMsgBurst) { - this.clientProfileQueueGuaranteed1MinMsgBurst = clientProfileQueueGuaranteed1MinMsgBurst; - } - - - public DmrClusterLink clientProfileTcpCongestionWindowSize(Long clientProfileTcpCongestionWindowSize) { - - this.clientProfileTcpCongestionWindowSize = clientProfileTcpCongestionWindowSize; - return this; - } - - /** - * The TCP initial congestion window size, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `2`. - * @return clientProfileTcpCongestionWindowSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_TCP_CONGESTION_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getClientProfileTcpCongestionWindowSize() { - return clientProfileTcpCongestionWindowSize; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_TCP_CONGESTION_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileTcpCongestionWindowSize(Long clientProfileTcpCongestionWindowSize) { - this.clientProfileTcpCongestionWindowSize = clientProfileTcpCongestionWindowSize; - } - - - public DmrClusterLink clientProfileTcpKeepaliveCount(Long clientProfileTcpKeepaliveCount) { - - this.clientProfileTcpKeepaliveCount = clientProfileTcpKeepaliveCount; - return this; - } - - /** - * The number of TCP keepalive retransmissions to be carried out before declaring that the remote end is not available. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`. - * @return clientProfileTcpKeepaliveCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_TCP_KEEPALIVE_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getClientProfileTcpKeepaliveCount() { - return clientProfileTcpKeepaliveCount; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_TCP_KEEPALIVE_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileTcpKeepaliveCount(Long clientProfileTcpKeepaliveCount) { - this.clientProfileTcpKeepaliveCount = clientProfileTcpKeepaliveCount; - } - - - public DmrClusterLink clientProfileTcpKeepaliveIdleTime(Long clientProfileTcpKeepaliveIdleTime) { - - this.clientProfileTcpKeepaliveIdleTime = clientProfileTcpKeepaliveIdleTime; - return this; - } - - /** - * The amount of time a connection must remain idle before TCP begins sending keepalive probes, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`. - * @return clientProfileTcpKeepaliveIdleTime - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_TCP_KEEPALIVE_IDLE_TIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getClientProfileTcpKeepaliveIdleTime() { - return clientProfileTcpKeepaliveIdleTime; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_TCP_KEEPALIVE_IDLE_TIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileTcpKeepaliveIdleTime(Long clientProfileTcpKeepaliveIdleTime) { - this.clientProfileTcpKeepaliveIdleTime = clientProfileTcpKeepaliveIdleTime; - } - - - public DmrClusterLink clientProfileTcpKeepaliveInterval(Long clientProfileTcpKeepaliveInterval) { - - this.clientProfileTcpKeepaliveInterval = clientProfileTcpKeepaliveInterval; - return this; - } - - /** - * The amount of time between TCP keepalive retransmissions when no acknowledgement is received, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`. - * @return clientProfileTcpKeepaliveInterval - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_TCP_KEEPALIVE_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getClientProfileTcpKeepaliveInterval() { - return clientProfileTcpKeepaliveInterval; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_TCP_KEEPALIVE_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileTcpKeepaliveInterval(Long clientProfileTcpKeepaliveInterval) { - this.clientProfileTcpKeepaliveInterval = clientProfileTcpKeepaliveInterval; - } - - - public DmrClusterLink clientProfileTcpMaxSegmentSize(Long clientProfileTcpMaxSegmentSize) { - - this.clientProfileTcpMaxSegmentSize = clientProfileTcpMaxSegmentSize; - return this; - } - - /** - * The TCP maximum segment size, in bytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1460`. - * @return clientProfileTcpMaxSegmentSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_TCP_MAX_SEGMENT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getClientProfileTcpMaxSegmentSize() { - return clientProfileTcpMaxSegmentSize; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_TCP_MAX_SEGMENT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileTcpMaxSegmentSize(Long clientProfileTcpMaxSegmentSize) { - this.clientProfileTcpMaxSegmentSize = clientProfileTcpMaxSegmentSize; - } - - - public DmrClusterLink clientProfileTcpMaxWindowSize(Long clientProfileTcpMaxWindowSize) { - - this.clientProfileTcpMaxWindowSize = clientProfileTcpMaxWindowSize; - return this; - } - - /** - * The TCP maximum window size, in kilobytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `256`. - * @return clientProfileTcpMaxWindowSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_TCP_MAX_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getClientProfileTcpMaxWindowSize() { - return clientProfileTcpMaxWindowSize; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_TCP_MAX_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileTcpMaxWindowSize(Long clientProfileTcpMaxWindowSize) { - this.clientProfileTcpMaxWindowSize = clientProfileTcpMaxWindowSize; - } - - - public DmrClusterLink dmrClusterName(String dmrClusterName) { - - this.dmrClusterName = dmrClusterName; - return this; - } - - /** - * The name of the Cluster. - * @return dmrClusterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DMR_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDmrClusterName() { - return dmrClusterName; - } - - - @JsonProperty(JSON_PROPERTY_DMR_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDmrClusterName(String dmrClusterName) { - this.dmrClusterName = dmrClusterName; - } - - - public DmrClusterLink egressFlowWindowSize(Long egressFlowWindowSize) { - - this.egressFlowWindowSize = egressFlowWindowSize; - return this; - } - - /** - * The number of outstanding guaranteed messages that can be sent over the Link before acknowledgement is received by the sender. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`. - * @return egressFlowWindowSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EGRESS_FLOW_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getEgressFlowWindowSize() { - return egressFlowWindowSize; - } - - - @JsonProperty(JSON_PROPERTY_EGRESS_FLOW_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEgressFlowWindowSize(Long egressFlowWindowSize) { - this.egressFlowWindowSize = egressFlowWindowSize; - } - - - public DmrClusterLink enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the Link. When disabled, subscription sets of this and the remote node are not kept up-to-date, and messages are not exchanged with the remote node. Published guaranteed messages will be queued up for future delivery based on current subscription sets. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public DmrClusterLink initiator(InitiatorEnum initiator) { - - this.initiator = initiator; - return this; - } - - /** - * The initiator of the Link's TCP connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"lexical\"`. The allowed values and their meaning are: <pre> \"lexical\" - The \"higher\" node-name initiates. \"local\" - The local node initiates. \"remote\" - The remote node initiates. </pre> - * @return initiator - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_INITIATOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public InitiatorEnum getInitiator() { - return initiator; - } - - - @JsonProperty(JSON_PROPERTY_INITIATOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setInitiator(InitiatorEnum initiator) { - this.initiator = initiator; - } - - - public DmrClusterLink queueDeadMsgQueue(String queueDeadMsgQueue) { - - this.queueDeadMsgQueue = queueDeadMsgQueue; - return this; - } - - /** - * The name of the Dead Message Queue (DMQ) used by the Queue for discarded messages. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. - * @return queueDeadMsgQueue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_DEAD_MSG_QUEUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getQueueDeadMsgQueue() { - return queueDeadMsgQueue; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_DEAD_MSG_QUEUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueDeadMsgQueue(String queueDeadMsgQueue) { - this.queueDeadMsgQueue = queueDeadMsgQueue; - } - - - public DmrClusterLink queueEventSpoolUsageThreshold(EventThreshold queueEventSpoolUsageThreshold) { - - this.queueEventSpoolUsageThreshold = queueEventSpoolUsageThreshold; - return this; - } - - /** - * Get queueEventSpoolUsageThreshold - * @return queueEventSpoolUsageThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_EVENT_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getQueueEventSpoolUsageThreshold() { - return queueEventSpoolUsageThreshold; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_EVENT_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueEventSpoolUsageThreshold(EventThreshold queueEventSpoolUsageThreshold) { - this.queueEventSpoolUsageThreshold = queueEventSpoolUsageThreshold; - } - - - public DmrClusterLink queueMaxDeliveredUnackedMsgsPerFlow(Long queueMaxDeliveredUnackedMsgsPerFlow) { - - this.queueMaxDeliveredUnackedMsgsPerFlow = queueMaxDeliveredUnackedMsgsPerFlow; - return this; - } - - /** - * The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1000000`. - * @return queueMaxDeliveredUnackedMsgsPerFlow - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getQueueMaxDeliveredUnackedMsgsPerFlow() { - return queueMaxDeliveredUnackedMsgsPerFlow; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueMaxDeliveredUnackedMsgsPerFlow(Long queueMaxDeliveredUnackedMsgsPerFlow) { - this.queueMaxDeliveredUnackedMsgsPerFlow = queueMaxDeliveredUnackedMsgsPerFlow; - } - - - public DmrClusterLink queueMaxMsgSpoolUsage(Long queueMaxMsgSpoolUsage) { - - this.queueMaxMsgSpoolUsage = queueMaxMsgSpoolUsage; - return this; - } - - /** - * The maximum message spool usage by the Queue (quota), in megabytes (MB). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `800000`. - * @return queueMaxMsgSpoolUsage - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_MSG_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getQueueMaxMsgSpoolUsage() { - return queueMaxMsgSpoolUsage; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_MSG_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueMaxMsgSpoolUsage(Long queueMaxMsgSpoolUsage) { - this.queueMaxMsgSpoolUsage = queueMaxMsgSpoolUsage; - } - - - public DmrClusterLink queueMaxRedeliveryCount(Long queueMaxRedeliveryCount) { - - this.queueMaxRedeliveryCount = queueMaxRedeliveryCount; - return this; - } - - /** - * The maximum number of times the Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. - * @return queueMaxRedeliveryCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_REDELIVERY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getQueueMaxRedeliveryCount() { - return queueMaxRedeliveryCount; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_REDELIVERY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueMaxRedeliveryCount(Long queueMaxRedeliveryCount) { - this.queueMaxRedeliveryCount = queueMaxRedeliveryCount; - } - - - public DmrClusterLink queueMaxTtl(Long queueMaxTtl) { - - this.queueMaxTtl = queueMaxTtl; - return this; - } - - /** - * The maximum time in seconds a message can stay in the Queue when `queueRespectTtlEnabled` is `true`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `queueMaxTtl` configured for the Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. - * @return queueMaxTtl - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_TTL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getQueueMaxTtl() { - return queueMaxTtl; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_TTL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueMaxTtl(Long queueMaxTtl) { - this.queueMaxTtl = queueMaxTtl; - } - - - public DmrClusterLink queueRejectMsgToSenderOnDiscardBehavior(QueueRejectMsgToSenderOnDiscardBehaviorEnum queueRejectMsgToSenderOnDiscardBehavior) { - - this.queueRejectMsgToSenderOnDiscardBehavior = queueRejectMsgToSenderOnDiscardBehavior; - return this; - } - - /** - * Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"always\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-queue-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> - * @return queueRejectMsgToSenderOnDiscardBehavior - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public QueueRejectMsgToSenderOnDiscardBehaviorEnum getQueueRejectMsgToSenderOnDiscardBehavior() { - return queueRejectMsgToSenderOnDiscardBehavior; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueRejectMsgToSenderOnDiscardBehavior(QueueRejectMsgToSenderOnDiscardBehaviorEnum queueRejectMsgToSenderOnDiscardBehavior) { - this.queueRejectMsgToSenderOnDiscardBehavior = queueRejectMsgToSenderOnDiscardBehavior; - } - - - public DmrClusterLink queueRespectTtlEnabled(Boolean queueRespectTtlEnabled) { - - this.queueRespectTtlEnabled = queueRespectTtlEnabled; - return this; - } - - /** - * Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - * @return queueRespectTtlEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_RESPECT_TTL_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getQueueRespectTtlEnabled() { - return queueRespectTtlEnabled; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_RESPECT_TTL_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueRespectTtlEnabled(Boolean queueRespectTtlEnabled) { - this.queueRespectTtlEnabled = queueRespectTtlEnabled; - } - - - public DmrClusterLink remoteNodeName(String remoteNodeName) { - - this.remoteNodeName = remoteNodeName; - return this; - } - - /** - * The name of the node at the remote end of the Link. - * @return remoteNodeName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_NODE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteNodeName() { - return remoteNodeName; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_NODE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteNodeName(String remoteNodeName) { - this.remoteNodeName = remoteNodeName; - } - - - public DmrClusterLink span(SpanEnum span) { - - this.span = span; - return this; - } - - /** - * The span of the Link, either internal or external. Internal Links connect nodes within the same Cluster. External Links connect nodes within different Clusters. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"external\"`. The allowed values and their meaning are: <pre> \"internal\" - Link to same cluster. \"external\" - Link to other cluster. </pre> - * @return span - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SPAN) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public SpanEnum getSpan() { - return span; - } - - - @JsonProperty(JSON_PROPERTY_SPAN) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSpan(SpanEnum span) { - this.span = span; - } - - - public DmrClusterLink transportCompressedEnabled(Boolean transportCompressedEnabled) { - - this.transportCompressedEnabled = transportCompressedEnabled; - return this; - } - - /** - * Enable or disable compression on the Link. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - * @return transportCompressedEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_COMPRESSED_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTransportCompressedEnabled() { - return transportCompressedEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_COMPRESSED_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportCompressedEnabled(Boolean transportCompressedEnabled) { - this.transportCompressedEnabled = transportCompressedEnabled; - } - - - public DmrClusterLink transportTlsEnabled(Boolean transportTlsEnabled) { - - this.transportTlsEnabled = transportTlsEnabled; - return this; - } - - /** - * Enable or disable encryption (TLS) on the Link. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - * @return transportTlsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTransportTlsEnabled() { - return transportTlsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportTlsEnabled(Boolean transportTlsEnabled) { - this.transportTlsEnabled = transportTlsEnabled; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLink dmrClusterLink = (DmrClusterLink) o; - return Objects.equals(this.authenticationBasicPassword, dmrClusterLink.authenticationBasicPassword) && - Objects.equals(this.authenticationScheme, dmrClusterLink.authenticationScheme) && - Objects.equals(this.clientProfileQueueControl1MaxDepth, dmrClusterLink.clientProfileQueueControl1MaxDepth) && - Objects.equals(this.clientProfileQueueControl1MinMsgBurst, dmrClusterLink.clientProfileQueueControl1MinMsgBurst) && - Objects.equals(this.clientProfileQueueDirect1MaxDepth, dmrClusterLink.clientProfileQueueDirect1MaxDepth) && - Objects.equals(this.clientProfileQueueDirect1MinMsgBurst, dmrClusterLink.clientProfileQueueDirect1MinMsgBurst) && - Objects.equals(this.clientProfileQueueDirect2MaxDepth, dmrClusterLink.clientProfileQueueDirect2MaxDepth) && - Objects.equals(this.clientProfileQueueDirect2MinMsgBurst, dmrClusterLink.clientProfileQueueDirect2MinMsgBurst) && - Objects.equals(this.clientProfileQueueDirect3MaxDepth, dmrClusterLink.clientProfileQueueDirect3MaxDepth) && - Objects.equals(this.clientProfileQueueDirect3MinMsgBurst, dmrClusterLink.clientProfileQueueDirect3MinMsgBurst) && - Objects.equals(this.clientProfileQueueGuaranteed1MaxDepth, dmrClusterLink.clientProfileQueueGuaranteed1MaxDepth) && - Objects.equals(this.clientProfileQueueGuaranteed1MinMsgBurst, dmrClusterLink.clientProfileQueueGuaranteed1MinMsgBurst) && - Objects.equals(this.clientProfileTcpCongestionWindowSize, dmrClusterLink.clientProfileTcpCongestionWindowSize) && - Objects.equals(this.clientProfileTcpKeepaliveCount, dmrClusterLink.clientProfileTcpKeepaliveCount) && - Objects.equals(this.clientProfileTcpKeepaliveIdleTime, dmrClusterLink.clientProfileTcpKeepaliveIdleTime) && - Objects.equals(this.clientProfileTcpKeepaliveInterval, dmrClusterLink.clientProfileTcpKeepaliveInterval) && - Objects.equals(this.clientProfileTcpMaxSegmentSize, dmrClusterLink.clientProfileTcpMaxSegmentSize) && - Objects.equals(this.clientProfileTcpMaxWindowSize, dmrClusterLink.clientProfileTcpMaxWindowSize) && - Objects.equals(this.dmrClusterName, dmrClusterLink.dmrClusterName) && - Objects.equals(this.egressFlowWindowSize, dmrClusterLink.egressFlowWindowSize) && - Objects.equals(this.enabled, dmrClusterLink.enabled) && - Objects.equals(this.initiator, dmrClusterLink.initiator) && - Objects.equals(this.queueDeadMsgQueue, dmrClusterLink.queueDeadMsgQueue) && - Objects.equals(this.queueEventSpoolUsageThreshold, dmrClusterLink.queueEventSpoolUsageThreshold) && - Objects.equals(this.queueMaxDeliveredUnackedMsgsPerFlow, dmrClusterLink.queueMaxDeliveredUnackedMsgsPerFlow) && - Objects.equals(this.queueMaxMsgSpoolUsage, dmrClusterLink.queueMaxMsgSpoolUsage) && - Objects.equals(this.queueMaxRedeliveryCount, dmrClusterLink.queueMaxRedeliveryCount) && - Objects.equals(this.queueMaxTtl, dmrClusterLink.queueMaxTtl) && - Objects.equals(this.queueRejectMsgToSenderOnDiscardBehavior, dmrClusterLink.queueRejectMsgToSenderOnDiscardBehavior) && - Objects.equals(this.queueRespectTtlEnabled, dmrClusterLink.queueRespectTtlEnabled) && - Objects.equals(this.remoteNodeName, dmrClusterLink.remoteNodeName) && - Objects.equals(this.span, dmrClusterLink.span) && - Objects.equals(this.transportCompressedEnabled, dmrClusterLink.transportCompressedEnabled) && - Objects.equals(this.transportTlsEnabled, dmrClusterLink.transportTlsEnabled); - } - - @Override - public int hashCode() { - return Objects.hash(authenticationBasicPassword, authenticationScheme, clientProfileQueueControl1MaxDepth, clientProfileQueueControl1MinMsgBurst, clientProfileQueueDirect1MaxDepth, clientProfileQueueDirect1MinMsgBurst, clientProfileQueueDirect2MaxDepth, clientProfileQueueDirect2MinMsgBurst, clientProfileQueueDirect3MaxDepth, clientProfileQueueDirect3MinMsgBurst, clientProfileQueueGuaranteed1MaxDepth, clientProfileQueueGuaranteed1MinMsgBurst, clientProfileTcpCongestionWindowSize, clientProfileTcpKeepaliveCount, clientProfileTcpKeepaliveIdleTime, clientProfileTcpKeepaliveInterval, clientProfileTcpMaxSegmentSize, clientProfileTcpMaxWindowSize, dmrClusterName, egressFlowWindowSize, enabled, initiator, queueDeadMsgQueue, queueEventSpoolUsageThreshold, queueMaxDeliveredUnackedMsgsPerFlow, queueMaxMsgSpoolUsage, queueMaxRedeliveryCount, queueMaxTtl, queueRejectMsgToSenderOnDiscardBehavior, queueRespectTtlEnabled, remoteNodeName, span, transportCompressedEnabled, transportTlsEnabled); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLink {\n"); - sb.append(" authenticationBasicPassword: ").append(toIndentedString(authenticationBasicPassword)).append("\n"); - sb.append(" authenticationScheme: ").append(toIndentedString(authenticationScheme)).append("\n"); - sb.append(" clientProfileQueueControl1MaxDepth: ").append(toIndentedString(clientProfileQueueControl1MaxDepth)).append("\n"); - sb.append(" clientProfileQueueControl1MinMsgBurst: ").append(toIndentedString(clientProfileQueueControl1MinMsgBurst)).append("\n"); - sb.append(" clientProfileQueueDirect1MaxDepth: ").append(toIndentedString(clientProfileQueueDirect1MaxDepth)).append("\n"); - sb.append(" clientProfileQueueDirect1MinMsgBurst: ").append(toIndentedString(clientProfileQueueDirect1MinMsgBurst)).append("\n"); - sb.append(" clientProfileQueueDirect2MaxDepth: ").append(toIndentedString(clientProfileQueueDirect2MaxDepth)).append("\n"); - sb.append(" clientProfileQueueDirect2MinMsgBurst: ").append(toIndentedString(clientProfileQueueDirect2MinMsgBurst)).append("\n"); - sb.append(" clientProfileQueueDirect3MaxDepth: ").append(toIndentedString(clientProfileQueueDirect3MaxDepth)).append("\n"); - sb.append(" clientProfileQueueDirect3MinMsgBurst: ").append(toIndentedString(clientProfileQueueDirect3MinMsgBurst)).append("\n"); - sb.append(" clientProfileQueueGuaranteed1MaxDepth: ").append(toIndentedString(clientProfileQueueGuaranteed1MaxDepth)).append("\n"); - sb.append(" clientProfileQueueGuaranteed1MinMsgBurst: ").append(toIndentedString(clientProfileQueueGuaranteed1MinMsgBurst)).append("\n"); - sb.append(" clientProfileTcpCongestionWindowSize: ").append(toIndentedString(clientProfileTcpCongestionWindowSize)).append("\n"); - sb.append(" clientProfileTcpKeepaliveCount: ").append(toIndentedString(clientProfileTcpKeepaliveCount)).append("\n"); - sb.append(" clientProfileTcpKeepaliveIdleTime: ").append(toIndentedString(clientProfileTcpKeepaliveIdleTime)).append("\n"); - sb.append(" clientProfileTcpKeepaliveInterval: ").append(toIndentedString(clientProfileTcpKeepaliveInterval)).append("\n"); - sb.append(" clientProfileTcpMaxSegmentSize: ").append(toIndentedString(clientProfileTcpMaxSegmentSize)).append("\n"); - sb.append(" clientProfileTcpMaxWindowSize: ").append(toIndentedString(clientProfileTcpMaxWindowSize)).append("\n"); - sb.append(" dmrClusterName: ").append(toIndentedString(dmrClusterName)).append("\n"); - sb.append(" egressFlowWindowSize: ").append(toIndentedString(egressFlowWindowSize)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" initiator: ").append(toIndentedString(initiator)).append("\n"); - sb.append(" queueDeadMsgQueue: ").append(toIndentedString(queueDeadMsgQueue)).append("\n"); - sb.append(" queueEventSpoolUsageThreshold: ").append(toIndentedString(queueEventSpoolUsageThreshold)).append("\n"); - sb.append(" queueMaxDeliveredUnackedMsgsPerFlow: ").append(toIndentedString(queueMaxDeliveredUnackedMsgsPerFlow)).append("\n"); - sb.append(" queueMaxMsgSpoolUsage: ").append(toIndentedString(queueMaxMsgSpoolUsage)).append("\n"); - sb.append(" queueMaxRedeliveryCount: ").append(toIndentedString(queueMaxRedeliveryCount)).append("\n"); - sb.append(" queueMaxTtl: ").append(toIndentedString(queueMaxTtl)).append("\n"); - sb.append(" queueRejectMsgToSenderOnDiscardBehavior: ").append(toIndentedString(queueRejectMsgToSenderOnDiscardBehavior)).append("\n"); - sb.append(" queueRespectTtlEnabled: ").append(toIndentedString(queueRespectTtlEnabled)).append("\n"); - sb.append(" remoteNodeName: ").append(toIndentedString(remoteNodeName)).append("\n"); - sb.append(" span: ").append(toIndentedString(span)).append("\n"); - sb.append(" transportCompressedEnabled: ").append(toIndentedString(transportCompressedEnabled)).append("\n"); - sb.append(" transportTlsEnabled: ").append(toIndentedString(transportTlsEnabled)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttribute.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttribute.java deleted file mode 100644 index d7cc322bb..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttribute.java +++ /dev/null @@ -1,200 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLinkAttribute - */ -@JsonPropertyOrder({ - DmrClusterLinkAttribute.JSON_PROPERTY_ATTRIBUTE_NAME, - DmrClusterLinkAttribute.JSON_PROPERTY_ATTRIBUTE_VALUE, - DmrClusterLinkAttribute.JSON_PROPERTY_DMR_CLUSTER_NAME, - DmrClusterLinkAttribute.JSON_PROPERTY_REMOTE_NODE_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLinkAttribute { - public static final String JSON_PROPERTY_ATTRIBUTE_NAME = "attributeName"; - private String attributeName; - - public static final String JSON_PROPERTY_ATTRIBUTE_VALUE = "attributeValue"; - private String attributeValue; - - public static final String JSON_PROPERTY_DMR_CLUSTER_NAME = "dmrClusterName"; - private String dmrClusterName; - - public static final String JSON_PROPERTY_REMOTE_NODE_NAME = "remoteNodeName"; - private String remoteNodeName; - - public DmrClusterLinkAttribute() { - } - - public DmrClusterLinkAttribute attributeName(String attributeName) { - - this.attributeName = attributeName; - return this; - } - - /** - * The name of the Attribute. - * @return attributeName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAttributeName() { - return attributeName; - } - - - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttributeName(String attributeName) { - this.attributeName = attributeName; - } - - - public DmrClusterLinkAttribute attributeValue(String attributeValue) { - - this.attributeValue = attributeValue; - return this; - } - - /** - * The value of the Attribute. - * @return attributeValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAttributeValue() { - return attributeValue; - } - - - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttributeValue(String attributeValue) { - this.attributeValue = attributeValue; - } - - - public DmrClusterLinkAttribute dmrClusterName(String dmrClusterName) { - - this.dmrClusterName = dmrClusterName; - return this; - } - - /** - * The name of the Cluster. - * @return dmrClusterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DMR_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDmrClusterName() { - return dmrClusterName; - } - - - @JsonProperty(JSON_PROPERTY_DMR_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDmrClusterName(String dmrClusterName) { - this.dmrClusterName = dmrClusterName; - } - - - public DmrClusterLinkAttribute remoteNodeName(String remoteNodeName) { - - this.remoteNodeName = remoteNodeName; - return this; - } - - /** - * The name of the node at the remote end of the Link. - * @return remoteNodeName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_NODE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteNodeName() { - return remoteNodeName; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_NODE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteNodeName(String remoteNodeName) { - this.remoteNodeName = remoteNodeName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLinkAttribute dmrClusterLinkAttribute = (DmrClusterLinkAttribute) o; - return Objects.equals(this.attributeName, dmrClusterLinkAttribute.attributeName) && - Objects.equals(this.attributeValue, dmrClusterLinkAttribute.attributeValue) && - Objects.equals(this.dmrClusterName, dmrClusterLinkAttribute.dmrClusterName) && - Objects.equals(this.remoteNodeName, dmrClusterLinkAttribute.remoteNodeName); - } - - @Override - public int hashCode() { - return Objects.hash(attributeName, attributeValue, dmrClusterName, remoteNodeName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLinkAttribute {\n"); - sb.append(" attributeName: ").append(toIndentedString(attributeName)).append("\n"); - sb.append(" attributeValue: ").append(toIndentedString(attributeValue)).append("\n"); - sb.append(" dmrClusterName: ").append(toIndentedString(dmrClusterName)).append("\n"); - sb.append(" remoteNodeName: ").append(toIndentedString(remoteNodeName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeLinks.java deleted file mode 100644 index ff55383c1..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLinkAttributeLinks - */ -@JsonPropertyOrder({ - DmrClusterLinkAttributeLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLinkAttributeLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public DmrClusterLinkAttributeLinks() { - } - - public DmrClusterLinkAttributeLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Link Attribute object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLinkAttributeLinks dmrClusterLinkAttributeLinks = (DmrClusterLinkAttributeLinks) o; - return Objects.equals(this.uri, dmrClusterLinkAttributeLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLinkAttributeLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeResponse.java deleted file mode 100644 index 537928bbb..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttributeLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLinkAttributeResponse - */ -@JsonPropertyOrder({ - DmrClusterLinkAttributeResponse.JSON_PROPERTY_DATA, - DmrClusterLinkAttributeResponse.JSON_PROPERTY_LINKS, - DmrClusterLinkAttributeResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLinkAttributeResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private DmrClusterLinkAttribute data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private DmrClusterLinkAttributeLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DmrClusterLinkAttributeResponse() { - } - - public DmrClusterLinkAttributeResponse data(DmrClusterLinkAttribute data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DmrClusterLinkAttribute getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(DmrClusterLinkAttribute data) { - this.data = data; - } - - - public DmrClusterLinkAttributeResponse links(DmrClusterLinkAttributeLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DmrClusterLinkAttributeLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(DmrClusterLinkAttributeLinks links) { - this.links = links; - } - - - public DmrClusterLinkAttributeResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLinkAttributeResponse dmrClusterLinkAttributeResponse = (DmrClusterLinkAttributeResponse) o; - return Objects.equals(this.data, dmrClusterLinkAttributeResponse.data) && - Objects.equals(this.links, dmrClusterLinkAttributeResponse.links) && - Objects.equals(this.meta, dmrClusterLinkAttributeResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLinkAttributeResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributesResponse.java deleted file mode 100644 index 94c239bf7..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttributeLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLinkAttributesResponse - */ -@JsonPropertyOrder({ - DmrClusterLinkAttributesResponse.JSON_PROPERTY_DATA, - DmrClusterLinkAttributesResponse.JSON_PROPERTY_LINKS, - DmrClusterLinkAttributesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLinkAttributesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DmrClusterLinkAttributesResponse() { - } - - public DmrClusterLinkAttributesResponse data(List data) { - - this.data = data; - return this; - } - - public DmrClusterLinkAttributesResponse addDataItem(DmrClusterLinkAttribute dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public DmrClusterLinkAttributesResponse links(List links) { - - this.links = links; - return this; - } - - public DmrClusterLinkAttributesResponse addLinksItem(DmrClusterLinkAttributeLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public DmrClusterLinkAttributesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLinkAttributesResponse dmrClusterLinkAttributesResponse = (DmrClusterLinkAttributesResponse) o; - return Objects.equals(this.data, dmrClusterLinkAttributesResponse.data) && - Objects.equals(this.links, dmrClusterLinkAttributesResponse.links) && - Objects.equals(this.meta, dmrClusterLinkAttributesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLinkAttributesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkLinks.java deleted file mode 100644 index 3cd5908a3..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkLinks.java +++ /dev/null @@ -1,200 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLinkLinks - */ -@JsonPropertyOrder({ - DmrClusterLinkLinks.JSON_PROPERTY_ATTRIBUTES_URI, - DmrClusterLinkLinks.JSON_PROPERTY_REMOTE_ADDRESSES_URI, - DmrClusterLinkLinks.JSON_PROPERTY_TLS_TRUSTED_COMMON_NAMES_URI, - DmrClusterLinkLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLinkLinks { - public static final String JSON_PROPERTY_ATTRIBUTES_URI = "attributesUri"; - private String attributesUri; - - public static final String JSON_PROPERTY_REMOTE_ADDRESSES_URI = "remoteAddressesUri"; - private String remoteAddressesUri; - - public static final String JSON_PROPERTY_TLS_TRUSTED_COMMON_NAMES_URI = "tlsTrustedCommonNamesUri"; - private String tlsTrustedCommonNamesUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public DmrClusterLinkLinks() { - } - - public DmrClusterLinkLinks attributesUri(String attributesUri) { - - this.attributesUri = attributesUri; - return this; - } - - /** - * The URI of this Link's collection of Link Attribute objects. Available since 2.28. - * @return attributesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ATTRIBUTES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAttributesUri() { - return attributesUri; - } - - - @JsonProperty(JSON_PROPERTY_ATTRIBUTES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttributesUri(String attributesUri) { - this.attributesUri = attributesUri; - } - - - public DmrClusterLinkLinks remoteAddressesUri(String remoteAddressesUri) { - - this.remoteAddressesUri = remoteAddressesUri; - return this; - } - - /** - * The URI of this Link's collection of Remote Address objects. - * @return remoteAddressesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_ADDRESSES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteAddressesUri() { - return remoteAddressesUri; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_ADDRESSES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteAddressesUri(String remoteAddressesUri) { - this.remoteAddressesUri = remoteAddressesUri; - } - - - public DmrClusterLinkLinks tlsTrustedCommonNamesUri(String tlsTrustedCommonNamesUri) { - - this.tlsTrustedCommonNamesUri = tlsTrustedCommonNamesUri; - return this; - } - - /** - * The URI of this Link's collection of Trusted Common Name objects. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * @return tlsTrustedCommonNamesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_TRUSTED_COMMON_NAMES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTlsTrustedCommonNamesUri() { - return tlsTrustedCommonNamesUri; - } - - - @JsonProperty(JSON_PROPERTY_TLS_TRUSTED_COMMON_NAMES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsTrustedCommonNamesUri(String tlsTrustedCommonNamesUri) { - this.tlsTrustedCommonNamesUri = tlsTrustedCommonNamesUri; - } - - - public DmrClusterLinkLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Link object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLinkLinks dmrClusterLinkLinks = (DmrClusterLinkLinks) o; - return Objects.equals(this.attributesUri, dmrClusterLinkLinks.attributesUri) && - Objects.equals(this.remoteAddressesUri, dmrClusterLinkLinks.remoteAddressesUri) && - Objects.equals(this.tlsTrustedCommonNamesUri, dmrClusterLinkLinks.tlsTrustedCommonNamesUri) && - Objects.equals(this.uri, dmrClusterLinkLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(attributesUri, remoteAddressesUri, tlsTrustedCommonNamesUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLinkLinks {\n"); - sb.append(" attributesUri: ").append(toIndentedString(attributesUri)).append("\n"); - sb.append(" remoteAddressesUri: ").append(toIndentedString(remoteAddressesUri)).append("\n"); - sb.append(" tlsTrustedCommonNamesUri: ").append(toIndentedString(tlsTrustedCommonNamesUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddress.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddress.java deleted file mode 100644 index c0462e07d..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddress.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLinkRemoteAddress - */ -@JsonPropertyOrder({ - DmrClusterLinkRemoteAddress.JSON_PROPERTY_DMR_CLUSTER_NAME, - DmrClusterLinkRemoteAddress.JSON_PROPERTY_REMOTE_ADDRESS, - DmrClusterLinkRemoteAddress.JSON_PROPERTY_REMOTE_NODE_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLinkRemoteAddress { - public static final String JSON_PROPERTY_DMR_CLUSTER_NAME = "dmrClusterName"; - private String dmrClusterName; - - public static final String JSON_PROPERTY_REMOTE_ADDRESS = "remoteAddress"; - private String remoteAddress; - - public static final String JSON_PROPERTY_REMOTE_NODE_NAME = "remoteNodeName"; - private String remoteNodeName; - - public DmrClusterLinkRemoteAddress() { - } - - public DmrClusterLinkRemoteAddress dmrClusterName(String dmrClusterName) { - - this.dmrClusterName = dmrClusterName; - return this; - } - - /** - * The name of the Cluster. - * @return dmrClusterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DMR_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDmrClusterName() { - return dmrClusterName; - } - - - @JsonProperty(JSON_PROPERTY_DMR_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDmrClusterName(String dmrClusterName) { - this.dmrClusterName = dmrClusterName; - } - - - public DmrClusterLinkRemoteAddress remoteAddress(String remoteAddress) { - - this.remoteAddress = remoteAddress; - return this; - } - - /** - * The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). - * @return remoteAddress - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteAddress() { - return remoteAddress; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteAddress(String remoteAddress) { - this.remoteAddress = remoteAddress; - } - - - public DmrClusterLinkRemoteAddress remoteNodeName(String remoteNodeName) { - - this.remoteNodeName = remoteNodeName; - return this; - } - - /** - * The name of the node at the remote end of the Link. - * @return remoteNodeName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_NODE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteNodeName() { - return remoteNodeName; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_NODE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteNodeName(String remoteNodeName) { - this.remoteNodeName = remoteNodeName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLinkRemoteAddress dmrClusterLinkRemoteAddress = (DmrClusterLinkRemoteAddress) o; - return Objects.equals(this.dmrClusterName, dmrClusterLinkRemoteAddress.dmrClusterName) && - Objects.equals(this.remoteAddress, dmrClusterLinkRemoteAddress.remoteAddress) && - Objects.equals(this.remoteNodeName, dmrClusterLinkRemoteAddress.remoteNodeName); - } - - @Override - public int hashCode() { - return Objects.hash(dmrClusterName, remoteAddress, remoteNodeName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLinkRemoteAddress {\n"); - sb.append(" dmrClusterName: ").append(toIndentedString(dmrClusterName)).append("\n"); - sb.append(" remoteAddress: ").append(toIndentedString(remoteAddress)).append("\n"); - sb.append(" remoteNodeName: ").append(toIndentedString(remoteNodeName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressLinks.java deleted file mode 100644 index e42530bce..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLinkRemoteAddressLinks - */ -@JsonPropertyOrder({ - DmrClusterLinkRemoteAddressLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLinkRemoteAddressLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public DmrClusterLinkRemoteAddressLinks() { - } - - public DmrClusterLinkRemoteAddressLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Remote Address object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLinkRemoteAddressLinks dmrClusterLinkRemoteAddressLinks = (DmrClusterLinkRemoteAddressLinks) o; - return Objects.equals(this.uri, dmrClusterLinkRemoteAddressLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLinkRemoteAddressLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressResponse.java deleted file mode 100644 index 1b6caa76d..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddress; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddressLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLinkRemoteAddressResponse - */ -@JsonPropertyOrder({ - DmrClusterLinkRemoteAddressResponse.JSON_PROPERTY_DATA, - DmrClusterLinkRemoteAddressResponse.JSON_PROPERTY_LINKS, - DmrClusterLinkRemoteAddressResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLinkRemoteAddressResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private DmrClusterLinkRemoteAddress data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private DmrClusterLinkRemoteAddressLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DmrClusterLinkRemoteAddressResponse() { - } - - public DmrClusterLinkRemoteAddressResponse data(DmrClusterLinkRemoteAddress data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DmrClusterLinkRemoteAddress getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(DmrClusterLinkRemoteAddress data) { - this.data = data; - } - - - public DmrClusterLinkRemoteAddressResponse links(DmrClusterLinkRemoteAddressLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DmrClusterLinkRemoteAddressLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(DmrClusterLinkRemoteAddressLinks links) { - this.links = links; - } - - - public DmrClusterLinkRemoteAddressResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLinkRemoteAddressResponse dmrClusterLinkRemoteAddressResponse = (DmrClusterLinkRemoteAddressResponse) o; - return Objects.equals(this.data, dmrClusterLinkRemoteAddressResponse.data) && - Objects.equals(this.links, dmrClusterLinkRemoteAddressResponse.links) && - Objects.equals(this.meta, dmrClusterLinkRemoteAddressResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLinkRemoteAddressResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressesResponse.java deleted file mode 100644 index ca2da20e5..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddress; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddressLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLinkRemoteAddressesResponse - */ -@JsonPropertyOrder({ - DmrClusterLinkRemoteAddressesResponse.JSON_PROPERTY_DATA, - DmrClusterLinkRemoteAddressesResponse.JSON_PROPERTY_LINKS, - DmrClusterLinkRemoteAddressesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLinkRemoteAddressesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DmrClusterLinkRemoteAddressesResponse() { - } - - public DmrClusterLinkRemoteAddressesResponse data(List data) { - - this.data = data; - return this; - } - - public DmrClusterLinkRemoteAddressesResponse addDataItem(DmrClusterLinkRemoteAddress dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public DmrClusterLinkRemoteAddressesResponse links(List links) { - - this.links = links; - return this; - } - - public DmrClusterLinkRemoteAddressesResponse addLinksItem(DmrClusterLinkRemoteAddressLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public DmrClusterLinkRemoteAddressesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLinkRemoteAddressesResponse dmrClusterLinkRemoteAddressesResponse = (DmrClusterLinkRemoteAddressesResponse) o; - return Objects.equals(this.data, dmrClusterLinkRemoteAddressesResponse.data) && - Objects.equals(this.links, dmrClusterLinkRemoteAddressesResponse.links) && - Objects.equals(this.meta, dmrClusterLinkRemoteAddressesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLinkRemoteAddressesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkResponse.java deleted file mode 100644 index 7e88a0f83..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLink; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLinkResponse - */ -@JsonPropertyOrder({ - DmrClusterLinkResponse.JSON_PROPERTY_DATA, - DmrClusterLinkResponse.JSON_PROPERTY_LINKS, - DmrClusterLinkResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLinkResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private DmrClusterLink data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private DmrClusterLinkLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DmrClusterLinkResponse() { - } - - public DmrClusterLinkResponse data(DmrClusterLink data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DmrClusterLink getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(DmrClusterLink data) { - this.data = data; - } - - - public DmrClusterLinkResponse links(DmrClusterLinkLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DmrClusterLinkLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(DmrClusterLinkLinks links) { - this.links = links; - } - - - public DmrClusterLinkResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLinkResponse dmrClusterLinkResponse = (DmrClusterLinkResponse) o; - return Objects.equals(this.data, dmrClusterLinkResponse.data) && - Objects.equals(this.links, dmrClusterLinkResponse.links) && - Objects.equals(this.meta, dmrClusterLinkResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLinkResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonName.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonName.java deleted file mode 100644 index 973039a1e..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonName.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLinkTlsTrustedCommonName - */ -@JsonPropertyOrder({ - DmrClusterLinkTlsTrustedCommonName.JSON_PROPERTY_DMR_CLUSTER_NAME, - DmrClusterLinkTlsTrustedCommonName.JSON_PROPERTY_REMOTE_NODE_NAME, - DmrClusterLinkTlsTrustedCommonName.JSON_PROPERTY_TLS_TRUSTED_COMMON_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLinkTlsTrustedCommonName { - public static final String JSON_PROPERTY_DMR_CLUSTER_NAME = "dmrClusterName"; - private String dmrClusterName; - - public static final String JSON_PROPERTY_REMOTE_NODE_NAME = "remoteNodeName"; - private String remoteNodeName; - - public static final String JSON_PROPERTY_TLS_TRUSTED_COMMON_NAME = "tlsTrustedCommonName"; - private String tlsTrustedCommonName; - - public DmrClusterLinkTlsTrustedCommonName() { - } - - public DmrClusterLinkTlsTrustedCommonName dmrClusterName(String dmrClusterName) { - - this.dmrClusterName = dmrClusterName; - return this; - } - - /** - * The name of the Cluster. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * @return dmrClusterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DMR_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDmrClusterName() { - return dmrClusterName; - } - - - @JsonProperty(JSON_PROPERTY_DMR_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDmrClusterName(String dmrClusterName) { - this.dmrClusterName = dmrClusterName; - } - - - public DmrClusterLinkTlsTrustedCommonName remoteNodeName(String remoteNodeName) { - - this.remoteNodeName = remoteNodeName; - return this; - } - - /** - * The name of the node at the remote end of the Link. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * @return remoteNodeName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_NODE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteNodeName() { - return remoteNodeName; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_NODE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteNodeName(String remoteNodeName) { - this.remoteNodeName = remoteNodeName; - } - - - public DmrClusterLinkTlsTrustedCommonName tlsTrustedCommonName(String tlsTrustedCommonName) { - - this.tlsTrustedCommonName = tlsTrustedCommonName; - return this; - } - - /** - * The expected trusted common name of the remote certificate. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * @return tlsTrustedCommonName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_TRUSTED_COMMON_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTlsTrustedCommonName() { - return tlsTrustedCommonName; - } - - - @JsonProperty(JSON_PROPERTY_TLS_TRUSTED_COMMON_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsTrustedCommonName(String tlsTrustedCommonName) { - this.tlsTrustedCommonName = tlsTrustedCommonName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLinkTlsTrustedCommonName dmrClusterLinkTlsTrustedCommonName = (DmrClusterLinkTlsTrustedCommonName) o; - return Objects.equals(this.dmrClusterName, dmrClusterLinkTlsTrustedCommonName.dmrClusterName) && - Objects.equals(this.remoteNodeName, dmrClusterLinkTlsTrustedCommonName.remoteNodeName) && - Objects.equals(this.tlsTrustedCommonName, dmrClusterLinkTlsTrustedCommonName.tlsTrustedCommonName); - } - - @Override - public int hashCode() { - return Objects.hash(dmrClusterName, remoteNodeName, tlsTrustedCommonName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLinkTlsTrustedCommonName {\n"); - sb.append(" dmrClusterName: ").append(toIndentedString(dmrClusterName)).append("\n"); - sb.append(" remoteNodeName: ").append(toIndentedString(remoteNodeName)).append("\n"); - sb.append(" tlsTrustedCommonName: ").append(toIndentedString(tlsTrustedCommonName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameLinks.java deleted file mode 100644 index 7f9b6b209..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLinkTlsTrustedCommonNameLinks - */ -@JsonPropertyOrder({ - DmrClusterLinkTlsTrustedCommonNameLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLinkTlsTrustedCommonNameLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public DmrClusterLinkTlsTrustedCommonNameLinks() { - } - - public DmrClusterLinkTlsTrustedCommonNameLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Trusted Common Name object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLinkTlsTrustedCommonNameLinks dmrClusterLinkTlsTrustedCommonNameLinks = (DmrClusterLinkTlsTrustedCommonNameLinks) o; - return Objects.equals(this.uri, dmrClusterLinkTlsTrustedCommonNameLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLinkTlsTrustedCommonNameLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameResponse.java deleted file mode 100644 index 616b9ba10..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLinkTlsTrustedCommonNameResponse - */ -@JsonPropertyOrder({ - DmrClusterLinkTlsTrustedCommonNameResponse.JSON_PROPERTY_DATA, - DmrClusterLinkTlsTrustedCommonNameResponse.JSON_PROPERTY_LINKS, - DmrClusterLinkTlsTrustedCommonNameResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLinkTlsTrustedCommonNameResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private DmrClusterLinkTlsTrustedCommonName data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private DmrClusterLinkTlsTrustedCommonNameLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DmrClusterLinkTlsTrustedCommonNameResponse() { - } - - public DmrClusterLinkTlsTrustedCommonNameResponse data(DmrClusterLinkTlsTrustedCommonName data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DmrClusterLinkTlsTrustedCommonName getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(DmrClusterLinkTlsTrustedCommonName data) { - this.data = data; - } - - - public DmrClusterLinkTlsTrustedCommonNameResponse links(DmrClusterLinkTlsTrustedCommonNameLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DmrClusterLinkTlsTrustedCommonNameLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(DmrClusterLinkTlsTrustedCommonNameLinks links) { - this.links = links; - } - - - public DmrClusterLinkTlsTrustedCommonNameResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLinkTlsTrustedCommonNameResponse dmrClusterLinkTlsTrustedCommonNameResponse = (DmrClusterLinkTlsTrustedCommonNameResponse) o; - return Objects.equals(this.data, dmrClusterLinkTlsTrustedCommonNameResponse.data) && - Objects.equals(this.links, dmrClusterLinkTlsTrustedCommonNameResponse.links) && - Objects.equals(this.meta, dmrClusterLinkTlsTrustedCommonNameResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLinkTlsTrustedCommonNameResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNamesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNamesResponse.java deleted file mode 100644 index 5e1d4f1ec..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNamesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLinkTlsTrustedCommonNamesResponse - */ -@JsonPropertyOrder({ - DmrClusterLinkTlsTrustedCommonNamesResponse.JSON_PROPERTY_DATA, - DmrClusterLinkTlsTrustedCommonNamesResponse.JSON_PROPERTY_LINKS, - DmrClusterLinkTlsTrustedCommonNamesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLinkTlsTrustedCommonNamesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DmrClusterLinkTlsTrustedCommonNamesResponse() { - } - - public DmrClusterLinkTlsTrustedCommonNamesResponse data(List data) { - - this.data = data; - return this; - } - - public DmrClusterLinkTlsTrustedCommonNamesResponse addDataItem(DmrClusterLinkTlsTrustedCommonName dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public DmrClusterLinkTlsTrustedCommonNamesResponse links(List links) { - - this.links = links; - return this; - } - - public DmrClusterLinkTlsTrustedCommonNamesResponse addLinksItem(DmrClusterLinkTlsTrustedCommonNameLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public DmrClusterLinkTlsTrustedCommonNamesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLinkTlsTrustedCommonNamesResponse dmrClusterLinkTlsTrustedCommonNamesResponse = (DmrClusterLinkTlsTrustedCommonNamesResponse) o; - return Objects.equals(this.data, dmrClusterLinkTlsTrustedCommonNamesResponse.data) && - Objects.equals(this.links, dmrClusterLinkTlsTrustedCommonNamesResponse.links) && - Objects.equals(this.meta, dmrClusterLinkTlsTrustedCommonNamesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLinkTlsTrustedCommonNamesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinks.java deleted file mode 100644 index fe4bbdecb..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinks.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLinks - */ -@JsonPropertyOrder({ - DmrClusterLinks.JSON_PROPERTY_CERT_MATCHING_RULES_URI, - DmrClusterLinks.JSON_PROPERTY_LINKS_URI, - DmrClusterLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLinks { - public static final String JSON_PROPERTY_CERT_MATCHING_RULES_URI = "certMatchingRulesUri"; - private String certMatchingRulesUri; - - public static final String JSON_PROPERTY_LINKS_URI = "linksUri"; - private String linksUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public DmrClusterLinks() { - } - - public DmrClusterLinks certMatchingRulesUri(String certMatchingRulesUri) { - - this.certMatchingRulesUri = certMatchingRulesUri; - return this; - } - - /** - * The URI of this Cluster's collection of Certificate Matching Rule objects. Available since 2.28. - * @return certMatchingRulesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CERT_MATCHING_RULES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCertMatchingRulesUri() { - return certMatchingRulesUri; - } - - - @JsonProperty(JSON_PROPERTY_CERT_MATCHING_RULES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCertMatchingRulesUri(String certMatchingRulesUri) { - this.certMatchingRulesUri = certMatchingRulesUri; - } - - - public DmrClusterLinks linksUri(String linksUri) { - - this.linksUri = linksUri; - return this; - } - - /** - * The URI of this Cluster's collection of Link objects. - * @return linksUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getLinksUri() { - return linksUri; - } - - - @JsonProperty(JSON_PROPERTY_LINKS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinksUri(String linksUri) { - this.linksUri = linksUri; - } - - - public DmrClusterLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Cluster object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLinks dmrClusterLinks = (DmrClusterLinks) o; - return Objects.equals(this.certMatchingRulesUri, dmrClusterLinks.certMatchingRulesUri) && - Objects.equals(this.linksUri, dmrClusterLinks.linksUri) && - Objects.equals(this.uri, dmrClusterLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(certMatchingRulesUri, linksUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLinks {\n"); - sb.append(" certMatchingRulesUri: ").append(toIndentedString(certMatchingRulesUri)).append("\n"); - sb.append(" linksUri: ").append(toIndentedString(linksUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinksResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinksResponse.java deleted file mode 100644 index 643bd1fb9..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinksResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLink; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterLinksResponse - */ -@JsonPropertyOrder({ - DmrClusterLinksResponse.JSON_PROPERTY_DATA, - DmrClusterLinksResponse.JSON_PROPERTY_LINKS, - DmrClusterLinksResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterLinksResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DmrClusterLinksResponse() { - } - - public DmrClusterLinksResponse data(List data) { - - this.data = data; - return this; - } - - public DmrClusterLinksResponse addDataItem(DmrClusterLink dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public DmrClusterLinksResponse links(List links) { - - this.links = links; - return this; - } - - public DmrClusterLinksResponse addLinksItem(DmrClusterLinkLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public DmrClusterLinksResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterLinksResponse dmrClusterLinksResponse = (DmrClusterLinksResponse) o; - return Objects.equals(this.data, dmrClusterLinksResponse.data) && - Objects.equals(this.links, dmrClusterLinksResponse.links) && - Objects.equals(this.meta, dmrClusterLinksResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterLinksResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterResponse.java deleted file mode 100644 index 9ead14816..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClusterResponse - */ -@JsonPropertyOrder({ - DmrClusterResponse.JSON_PROPERTY_DATA, - DmrClusterResponse.JSON_PROPERTY_LINKS, - DmrClusterResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClusterResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private DmrCluster data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private DmrClusterLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DmrClusterResponse() { - } - - public DmrClusterResponse data(DmrCluster data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DmrCluster getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(DmrCluster data) { - this.data = data; - } - - - public DmrClusterResponse links(DmrClusterLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DmrClusterLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(DmrClusterLinks links) { - this.links = links; - } - - - public DmrClusterResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClusterResponse dmrClusterResponse = (DmrClusterResponse) o; - return Objects.equals(this.data, dmrClusterResponse.data) && - Objects.equals(this.links, dmrClusterResponse.links) && - Objects.equals(this.meta, dmrClusterResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClusterResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClustersResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClustersResponse.java deleted file mode 100644 index e5e1041ff..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClustersResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DmrClustersResponse - */ -@JsonPropertyOrder({ - DmrClustersResponse.JSON_PROPERTY_DATA, - DmrClustersResponse.JSON_PROPERTY_LINKS, - DmrClustersResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DmrClustersResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DmrClustersResponse() { - } - - public DmrClustersResponse data(List data) { - - this.data = data; - return this; - } - - public DmrClustersResponse addDataItem(DmrCluster dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public DmrClustersResponse links(List links) { - - this.links = links; - return this; - } - - public DmrClustersResponse addLinksItem(DmrClusterLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public DmrClustersResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DmrClustersResponse dmrClustersResponse = (DmrClustersResponse) o; - return Objects.equals(this.data, dmrClustersResponse.data) && - Objects.equals(this.links, dmrClustersResponse.links) && - Objects.equals(this.meta, dmrClustersResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DmrClustersResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthoritiesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthoritiesResponse.java deleted file mode 100644 index f3228a214..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthoritiesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthorityLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DomainCertAuthoritiesResponse - */ -@JsonPropertyOrder({ - DomainCertAuthoritiesResponse.JSON_PROPERTY_DATA, - DomainCertAuthoritiesResponse.JSON_PROPERTY_LINKS, - DomainCertAuthoritiesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DomainCertAuthoritiesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DomainCertAuthoritiesResponse() { - } - - public DomainCertAuthoritiesResponse data(List data) { - - this.data = data; - return this; - } - - public DomainCertAuthoritiesResponse addDataItem(DomainCertAuthority dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public DomainCertAuthoritiesResponse links(List links) { - - this.links = links; - return this; - } - - public DomainCertAuthoritiesResponse addLinksItem(DomainCertAuthorityLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public DomainCertAuthoritiesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DomainCertAuthoritiesResponse domainCertAuthoritiesResponse = (DomainCertAuthoritiesResponse) o; - return Objects.equals(this.data, domainCertAuthoritiesResponse.data) && - Objects.equals(this.links, domainCertAuthoritiesResponse.links) && - Objects.equals(this.meta, domainCertAuthoritiesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DomainCertAuthoritiesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthority.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthority.java deleted file mode 100644 index 4411240ae..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthority.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DomainCertAuthority - */ -@JsonPropertyOrder({ - DomainCertAuthority.JSON_PROPERTY_CERT_AUTHORITY_NAME, - DomainCertAuthority.JSON_PROPERTY_CERT_CONTENT -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DomainCertAuthority { - public static final String JSON_PROPERTY_CERT_AUTHORITY_NAME = "certAuthorityName"; - private String certAuthorityName; - - public static final String JSON_PROPERTY_CERT_CONTENT = "certContent"; - private String certContent; - - public DomainCertAuthority() { - } - - public DomainCertAuthority certAuthorityName(String certAuthorityName) { - - this.certAuthorityName = certAuthorityName; - return this; - } - - /** - * The name of the Certificate Authority. - * @return certAuthorityName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CERT_AUTHORITY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCertAuthorityName() { - return certAuthorityName; - } - - - @JsonProperty(JSON_PROPERTY_CERT_AUTHORITY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCertAuthorityName(String certAuthorityName) { - this.certAuthorityName = certAuthorityName; - } - - - public DomainCertAuthority certContent(String certContent) { - - this.certContent = certContent; - return this; - } - - /** - * The PEM formatted content for the trusted root certificate of a domain Certificate Authority. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return certContent - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CERT_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCertContent() { - return certContent; - } - - - @JsonProperty(JSON_PROPERTY_CERT_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCertContent(String certContent) { - this.certContent = certContent; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DomainCertAuthority domainCertAuthority = (DomainCertAuthority) o; - return Objects.equals(this.certAuthorityName, domainCertAuthority.certAuthorityName) && - Objects.equals(this.certContent, domainCertAuthority.certContent); - } - - @Override - public int hashCode() { - return Objects.hash(certAuthorityName, certContent); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DomainCertAuthority {\n"); - sb.append(" certAuthorityName: ").append(toIndentedString(certAuthorityName)).append("\n"); - sb.append(" certContent: ").append(toIndentedString(certContent)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityLinks.java deleted file mode 100644 index 9ae77abb1..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DomainCertAuthorityLinks - */ -@JsonPropertyOrder({ - DomainCertAuthorityLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DomainCertAuthorityLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public DomainCertAuthorityLinks() { - } - - public DomainCertAuthorityLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Domain Certificate Authority object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DomainCertAuthorityLinks domainCertAuthorityLinks = (DomainCertAuthorityLinks) o; - return Objects.equals(this.uri, domainCertAuthorityLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DomainCertAuthorityLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityResponse.java deleted file mode 100644 index 9742d888c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthorityLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * DomainCertAuthorityResponse - */ -@JsonPropertyOrder({ - DomainCertAuthorityResponse.JSON_PROPERTY_DATA, - DomainCertAuthorityResponse.JSON_PROPERTY_LINKS, - DomainCertAuthorityResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class DomainCertAuthorityResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private DomainCertAuthority data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private DomainCertAuthorityLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public DomainCertAuthorityResponse() { - } - - public DomainCertAuthorityResponse data(DomainCertAuthority data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DomainCertAuthority getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(DomainCertAuthority data) { - this.data = data; - } - - - public DomainCertAuthorityResponse links(DomainCertAuthorityLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DomainCertAuthorityLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(DomainCertAuthorityLinks links) { - this.links = links; - } - - - public DomainCertAuthorityResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DomainCertAuthorityResponse domainCertAuthorityResponse = (DomainCertAuthorityResponse) o; - return Objects.equals(this.data, domainCertAuthorityResponse.data) && - Objects.equals(this.links, domainCertAuthorityResponse.links) && - Objects.equals(this.meta, domainCertAuthorityResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DomainCertAuthorityResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThreshold.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThreshold.java deleted file mode 100644 index 8db5e5b21..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThreshold.java +++ /dev/null @@ -1,200 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * EventThreshold - */ -@JsonPropertyOrder({ - EventThreshold.JSON_PROPERTY_CLEAR_PERCENT, - EventThreshold.JSON_PROPERTY_CLEAR_VALUE, - EventThreshold.JSON_PROPERTY_SET_PERCENT, - EventThreshold.JSON_PROPERTY_SET_VALUE -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class EventThreshold { - public static final String JSON_PROPERTY_CLEAR_PERCENT = "clearPercent"; - private Long clearPercent; - - public static final String JSON_PROPERTY_CLEAR_VALUE = "clearValue"; - private Long clearValue; - - public static final String JSON_PROPERTY_SET_PERCENT = "setPercent"; - private Long setPercent; - - public static final String JSON_PROPERTY_SET_VALUE = "setValue"; - private Long setValue; - - public EventThreshold() { - } - - public EventThreshold clearPercent(Long clearPercent) { - - this.clearPercent = clearPercent; - return this; - } - - /** - * The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET. - * @return clearPercent - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLEAR_PERCENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getClearPercent() { - return clearPercent; - } - - - @JsonProperty(JSON_PROPERTY_CLEAR_PERCENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClearPercent(Long clearPercent) { - this.clearPercent = clearPercent; - } - - - public EventThreshold clearValue(Long clearValue) { - - this.clearValue = clearValue; - return this; - } - - /** - * The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET. - * @return clearValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLEAR_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getClearValue() { - return clearValue; - } - - - @JsonProperty(JSON_PROPERTY_CLEAR_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClearValue(Long clearValue) { - this.clearValue = clearValue; - } - - - public EventThreshold setPercent(Long setPercent) { - - this.setPercent = setPercent; - return this; - } - - /** - * The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET. - * @return setPercent - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SET_PERCENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getSetPercent() { - return setPercent; - } - - - @JsonProperty(JSON_PROPERTY_SET_PERCENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSetPercent(Long setPercent) { - this.setPercent = setPercent; - } - - - public EventThreshold setValue(Long setValue) { - - this.setValue = setValue; - return this; - } - - /** - * The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET. - * @return setValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SET_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getSetValue() { - return setValue; - } - - - @JsonProperty(JSON_PROPERTY_SET_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSetValue(Long setValue) { - this.setValue = setValue; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - EventThreshold eventThreshold = (EventThreshold) o; - return Objects.equals(this.clearPercent, eventThreshold.clearPercent) && - Objects.equals(this.clearValue, eventThreshold.clearValue) && - Objects.equals(this.setPercent, eventThreshold.setPercent) && - Objects.equals(this.setValue, eventThreshold.setValue); - } - - @Override - public int hashCode() { - return Objects.hash(clearPercent, clearValue, setPercent, setValue); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class EventThreshold {\n"); - sb.append(" clearPercent: ").append(toIndentedString(clearPercent)).append("\n"); - sb.append(" clearValue: ").append(toIndentedString(clearValue)).append("\n"); - sb.append(" setPercent: ").append(toIndentedString(setPercent)).append("\n"); - sb.append(" setValue: ").append(toIndentedString(setValue)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdByPercent.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdByPercent.java deleted file mode 100644 index b788f4851..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdByPercent.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * EventThresholdByPercent - */ -@JsonPropertyOrder({ - EventThresholdByPercent.JSON_PROPERTY_CLEAR_PERCENT, - EventThresholdByPercent.JSON_PROPERTY_SET_PERCENT -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class EventThresholdByPercent { - public static final String JSON_PROPERTY_CLEAR_PERCENT = "clearPercent"; - private Long clearPercent; - - public static final String JSON_PROPERTY_SET_PERCENT = "setPercent"; - private Long setPercent; - - public EventThresholdByPercent() { - } - - public EventThresholdByPercent clearPercent(Long clearPercent) { - - this.clearPercent = clearPercent; - return this; - } - - /** - * The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. - * @return clearPercent - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLEAR_PERCENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getClearPercent() { - return clearPercent; - } - - - @JsonProperty(JSON_PROPERTY_CLEAR_PERCENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClearPercent(Long clearPercent) { - this.clearPercent = clearPercent; - } - - - public EventThresholdByPercent setPercent(Long setPercent) { - - this.setPercent = setPercent; - return this; - } - - /** - * The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. - * @return setPercent - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SET_PERCENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getSetPercent() { - return setPercent; - } - - - @JsonProperty(JSON_PROPERTY_SET_PERCENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSetPercent(Long setPercent) { - this.setPercent = setPercent; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - EventThresholdByPercent eventThresholdByPercent = (EventThresholdByPercent) o; - return Objects.equals(this.clearPercent, eventThresholdByPercent.clearPercent) && - Objects.equals(this.setPercent, eventThresholdByPercent.setPercent); - } - - @Override - public int hashCode() { - return Objects.hash(clearPercent, setPercent); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class EventThresholdByPercent {\n"); - sb.append(" clearPercent: ").append(toIndentedString(clearPercent)).append("\n"); - sb.append(" setPercent: ").append(toIndentedString(setPercent)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdByValue.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdByValue.java deleted file mode 100644 index d7fb98dbc..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdByValue.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * EventThresholdByValue - */ -@JsonPropertyOrder({ - EventThresholdByValue.JSON_PROPERTY_CLEAR_VALUE, - EventThresholdByValue.JSON_PROPERTY_SET_VALUE -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class EventThresholdByValue { - public static final String JSON_PROPERTY_CLEAR_VALUE = "clearValue"; - private Long clearValue; - - public static final String JSON_PROPERTY_SET_VALUE = "setValue"; - private Long setValue; - - public EventThresholdByValue() { - } - - public EventThresholdByValue clearValue(Long clearValue) { - - this.clearValue = clearValue; - return this; - } - - /** - * The clear threshold for the absolute value of this counter or rate. Falling below this value will trigger a corresponding event. - * @return clearValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLEAR_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getClearValue() { - return clearValue; - } - - - @JsonProperty(JSON_PROPERTY_CLEAR_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClearValue(Long clearValue) { - this.clearValue = clearValue; - } - - - public EventThresholdByValue setValue(Long setValue) { - - this.setValue = setValue; - return this; - } - - /** - * The set threshold for the absolute value of this counter or rate. Exceeding this value will trigger a corresponding event. - * @return setValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SET_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getSetValue() { - return setValue; - } - - - @JsonProperty(JSON_PROPERTY_SET_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSetValue(Long setValue) { - this.setValue = setValue; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - EventThresholdByValue eventThresholdByValue = (EventThresholdByValue) o; - return Objects.equals(this.clearValue, eventThresholdByValue.clearValue) && - Objects.equals(this.setValue, eventThresholdByValue.setValue); - } - - @Override - public int hashCode() { - return Objects.hash(clearValue, setValue); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class EventThresholdByValue {\n"); - sb.append(" clearValue: ").append(toIndentedString(clearValue)).append("\n"); - sb.append(" setValue: ").append(toIndentedString(setValue)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpn.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpn.java deleted file mode 100644 index 94b43ab6b..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpn.java +++ /dev/null @@ -1,4466 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThresholdByValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpn - */ -@JsonPropertyOrder({ - MsgVpn.JSON_PROPERTY_ALIAS, - MsgVpn.JSON_PROPERTY_AUTHENTICATION_BASIC_ENABLED, - MsgVpn.JSON_PROPERTY_AUTHENTICATION_BASIC_PROFILE_NAME, - MsgVpn.JSON_PROPERTY_AUTHENTICATION_BASIC_RADIUS_DOMAIN, - MsgVpn.JSON_PROPERTY_AUTHENTICATION_BASIC_TYPE, - MsgVpn.JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_ALLOW_API_PROVIDED_USERNAME_ENABLED, - MsgVpn.JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_CERTIFICATE_MATCHING_RULES_ENABLED, - MsgVpn.JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_ENABLED, - MsgVpn.JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_MAX_CHAIN_DEPTH, - MsgVpn.JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_REVOCATION_CHECK_MODE, - MsgVpn.JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_USERNAME_SOURCE, - MsgVpn.JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_VALIDATE_DATE_ENABLED, - MsgVpn.JSON_PROPERTY_AUTHENTICATION_KERBEROS_ALLOW_API_PROVIDED_USERNAME_ENABLED, - MsgVpn.JSON_PROPERTY_AUTHENTICATION_KERBEROS_ENABLED, - MsgVpn.JSON_PROPERTY_AUTHENTICATION_OAUTH_DEFAULT_PROFILE_NAME, - MsgVpn.JSON_PROPERTY_AUTHENTICATION_OAUTH_DEFAULT_PROVIDER_NAME, - MsgVpn.JSON_PROPERTY_AUTHENTICATION_OAUTH_ENABLED, - MsgVpn.JSON_PROPERTY_AUTHORIZATION_LDAP_GROUP_MEMBERSHIP_ATTRIBUTE_NAME, - MsgVpn.JSON_PROPERTY_AUTHORIZATION_LDAP_TRIM_CLIENT_USERNAME_DOMAIN_ENABLED, - MsgVpn.JSON_PROPERTY_AUTHORIZATION_PROFILE_NAME, - MsgVpn.JSON_PROPERTY_AUTHORIZATION_TYPE, - MsgVpn.JSON_PROPERTY_BRIDGING_TLS_SERVER_CERT_ENFORCE_TRUSTED_COMMON_NAME_ENABLED, - MsgVpn.JSON_PROPERTY_BRIDGING_TLS_SERVER_CERT_MAX_CHAIN_DEPTH, - MsgVpn.JSON_PROPERTY_BRIDGING_TLS_SERVER_CERT_VALIDATE_DATE_ENABLED, - MsgVpn.JSON_PROPERTY_BRIDGING_TLS_SERVER_CERT_VALIDATE_NAME_ENABLED, - MsgVpn.JSON_PROPERTY_DISTRIBUTED_CACHE_MANAGEMENT_ENABLED, - MsgVpn.JSON_PROPERTY_DMR_ENABLED, - MsgVpn.JSON_PROPERTY_ENABLED, - MsgVpn.JSON_PROPERTY_EVENT_CONNECTION_COUNT_THRESHOLD, - MsgVpn.JSON_PROPERTY_EVENT_EGRESS_FLOW_COUNT_THRESHOLD, - MsgVpn.JSON_PROPERTY_EVENT_EGRESS_MSG_RATE_THRESHOLD, - MsgVpn.JSON_PROPERTY_EVENT_ENDPOINT_COUNT_THRESHOLD, - MsgVpn.JSON_PROPERTY_EVENT_INGRESS_FLOW_COUNT_THRESHOLD, - MsgVpn.JSON_PROPERTY_EVENT_INGRESS_MSG_RATE_THRESHOLD, - MsgVpn.JSON_PROPERTY_EVENT_LARGE_MSG_THRESHOLD, - MsgVpn.JSON_PROPERTY_EVENT_LOG_TAG, - MsgVpn.JSON_PROPERTY_EVENT_MSG_SPOOL_USAGE_THRESHOLD, - MsgVpn.JSON_PROPERTY_EVENT_PUBLISH_CLIENT_ENABLED, - MsgVpn.JSON_PROPERTY_EVENT_PUBLISH_MSG_VPN_ENABLED, - MsgVpn.JSON_PROPERTY_EVENT_PUBLISH_SUBSCRIPTION_MODE, - MsgVpn.JSON_PROPERTY_EVENT_PUBLISH_TOPIC_FORMAT_MQTT_ENABLED, - MsgVpn.JSON_PROPERTY_EVENT_PUBLISH_TOPIC_FORMAT_SMF_ENABLED, - MsgVpn.JSON_PROPERTY_EVENT_SERVICE_AMQP_CONNECTION_COUNT_THRESHOLD, - MsgVpn.JSON_PROPERTY_EVENT_SERVICE_MQTT_CONNECTION_COUNT_THRESHOLD, - MsgVpn.JSON_PROPERTY_EVENT_SERVICE_REST_INCOMING_CONNECTION_COUNT_THRESHOLD, - MsgVpn.JSON_PROPERTY_EVENT_SERVICE_SMF_CONNECTION_COUNT_THRESHOLD, - MsgVpn.JSON_PROPERTY_EVENT_SERVICE_WEB_CONNECTION_COUNT_THRESHOLD, - MsgVpn.JSON_PROPERTY_EVENT_SUBSCRIPTION_COUNT_THRESHOLD, - MsgVpn.JSON_PROPERTY_EVENT_TRANSACTED_SESSION_COUNT_THRESHOLD, - MsgVpn.JSON_PROPERTY_EVENT_TRANSACTION_COUNT_THRESHOLD, - MsgVpn.JSON_PROPERTY_EXPORT_SUBSCRIPTIONS_ENABLED, - MsgVpn.JSON_PROPERTY_JNDI_ENABLED, - MsgVpn.JSON_PROPERTY_MAX_CONNECTION_COUNT, - MsgVpn.JSON_PROPERTY_MAX_EGRESS_FLOW_COUNT, - MsgVpn.JSON_PROPERTY_MAX_ENDPOINT_COUNT, - MsgVpn.JSON_PROPERTY_MAX_INGRESS_FLOW_COUNT, - MsgVpn.JSON_PROPERTY_MAX_MSG_SPOOL_USAGE, - MsgVpn.JSON_PROPERTY_MAX_SUBSCRIPTION_COUNT, - MsgVpn.JSON_PROPERTY_MAX_TRANSACTED_SESSION_COUNT, - MsgVpn.JSON_PROPERTY_MAX_TRANSACTION_COUNT, - MsgVpn.JSON_PROPERTY_MQTT_RETAIN_MAX_MEMORY, - MsgVpn.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpn.JSON_PROPERTY_REPLICATION_ACK_PROPAGATION_INTERVAL_MSG_COUNT, - MsgVpn.JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_BASIC_CLIENT_USERNAME, - MsgVpn.JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_BASIC_PASSWORD, - MsgVpn.JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_CLIENT_CERT_CONTENT, - MsgVpn.JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_CLIENT_CERT_PASSWORD, - MsgVpn.JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_SCHEME, - MsgVpn.JSON_PROPERTY_REPLICATION_BRIDGE_COMPRESSED_DATA_ENABLED, - MsgVpn.JSON_PROPERTY_REPLICATION_BRIDGE_EGRESS_FLOW_WINDOW_SIZE, - MsgVpn.JSON_PROPERTY_REPLICATION_BRIDGE_RETRY_DELAY, - MsgVpn.JSON_PROPERTY_REPLICATION_BRIDGE_TLS_ENABLED, - MsgVpn.JSON_PROPERTY_REPLICATION_BRIDGE_UNIDIRECTIONAL_CLIENT_PROFILE_NAME, - MsgVpn.JSON_PROPERTY_REPLICATION_ENABLED, - MsgVpn.JSON_PROPERTY_REPLICATION_ENABLED_QUEUE_BEHAVIOR, - MsgVpn.JSON_PROPERTY_REPLICATION_QUEUE_MAX_MSG_SPOOL_USAGE, - MsgVpn.JSON_PROPERTY_REPLICATION_QUEUE_REJECT_MSG_TO_SENDER_ON_DISCARD_ENABLED, - MsgVpn.JSON_PROPERTY_REPLICATION_REJECT_MSG_WHEN_SYNC_INELIGIBLE_ENABLED, - MsgVpn.JSON_PROPERTY_REPLICATION_ROLE, - MsgVpn.JSON_PROPERTY_REPLICATION_TRANSACTION_MODE, - MsgVpn.JSON_PROPERTY_REST_TLS_SERVER_CERT_ENFORCE_TRUSTED_COMMON_NAME_ENABLED, - MsgVpn.JSON_PROPERTY_REST_TLS_SERVER_CERT_MAX_CHAIN_DEPTH, - MsgVpn.JSON_PROPERTY_REST_TLS_SERVER_CERT_VALIDATE_DATE_ENABLED, - MsgVpn.JSON_PROPERTY_REST_TLS_SERVER_CERT_VALIDATE_NAME_ENABLED, - MsgVpn.JSON_PROPERTY_SEMP_OVER_MSG_BUS_ADMIN_CLIENT_ENABLED, - MsgVpn.JSON_PROPERTY_SEMP_OVER_MSG_BUS_ADMIN_DISTRIBUTED_CACHE_ENABLED, - MsgVpn.JSON_PROPERTY_SEMP_OVER_MSG_BUS_ADMIN_ENABLED, - MsgVpn.JSON_PROPERTY_SEMP_OVER_MSG_BUS_ENABLED, - MsgVpn.JSON_PROPERTY_SEMP_OVER_MSG_BUS_SHOW_ENABLED, - MsgVpn.JSON_PROPERTY_SERVICE_AMQP_MAX_CONNECTION_COUNT, - MsgVpn.JSON_PROPERTY_SERVICE_AMQP_PLAIN_TEXT_ENABLED, - MsgVpn.JSON_PROPERTY_SERVICE_AMQP_PLAIN_TEXT_LISTEN_PORT, - MsgVpn.JSON_PROPERTY_SERVICE_AMQP_TLS_ENABLED, - MsgVpn.JSON_PROPERTY_SERVICE_AMQP_TLS_LISTEN_PORT, - MsgVpn.JSON_PROPERTY_SERVICE_MQTT_AUTHENTICATION_CLIENT_CERT_REQUEST, - MsgVpn.JSON_PROPERTY_SERVICE_MQTT_MAX_CONNECTION_COUNT, - MsgVpn.JSON_PROPERTY_SERVICE_MQTT_PLAIN_TEXT_ENABLED, - MsgVpn.JSON_PROPERTY_SERVICE_MQTT_PLAIN_TEXT_LISTEN_PORT, - MsgVpn.JSON_PROPERTY_SERVICE_MQTT_TLS_ENABLED, - MsgVpn.JSON_PROPERTY_SERVICE_MQTT_TLS_LISTEN_PORT, - MsgVpn.JSON_PROPERTY_SERVICE_MQTT_TLS_WEB_SOCKET_ENABLED, - MsgVpn.JSON_PROPERTY_SERVICE_MQTT_TLS_WEB_SOCKET_LISTEN_PORT, - MsgVpn.JSON_PROPERTY_SERVICE_MQTT_WEB_SOCKET_ENABLED, - MsgVpn.JSON_PROPERTY_SERVICE_MQTT_WEB_SOCKET_LISTEN_PORT, - MsgVpn.JSON_PROPERTY_SERVICE_REST_INCOMING_AUTHENTICATION_CLIENT_CERT_REQUEST, - MsgVpn.JSON_PROPERTY_SERVICE_REST_INCOMING_AUTHORIZATION_HEADER_HANDLING, - MsgVpn.JSON_PROPERTY_SERVICE_REST_INCOMING_MAX_CONNECTION_COUNT, - MsgVpn.JSON_PROPERTY_SERVICE_REST_INCOMING_PLAIN_TEXT_ENABLED, - MsgVpn.JSON_PROPERTY_SERVICE_REST_INCOMING_PLAIN_TEXT_LISTEN_PORT, - MsgVpn.JSON_PROPERTY_SERVICE_REST_INCOMING_TLS_ENABLED, - MsgVpn.JSON_PROPERTY_SERVICE_REST_INCOMING_TLS_LISTEN_PORT, - MsgVpn.JSON_PROPERTY_SERVICE_REST_MODE, - MsgVpn.JSON_PROPERTY_SERVICE_REST_OUTGOING_MAX_CONNECTION_COUNT, - MsgVpn.JSON_PROPERTY_SERVICE_SMF_MAX_CONNECTION_COUNT, - MsgVpn.JSON_PROPERTY_SERVICE_SMF_PLAIN_TEXT_ENABLED, - MsgVpn.JSON_PROPERTY_SERVICE_SMF_TLS_ENABLED, - MsgVpn.JSON_PROPERTY_SERVICE_WEB_AUTHENTICATION_CLIENT_CERT_REQUEST, - MsgVpn.JSON_PROPERTY_SERVICE_WEB_MAX_CONNECTION_COUNT, - MsgVpn.JSON_PROPERTY_SERVICE_WEB_PLAIN_TEXT_ENABLED, - MsgVpn.JSON_PROPERTY_SERVICE_WEB_TLS_ENABLED, - MsgVpn.JSON_PROPERTY_TLS_ALLOW_DOWNGRADE_TO_PLAIN_TEXT_ENABLED -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpn { - public static final String JSON_PROPERTY_ALIAS = "alias"; - private String alias; - - public static final String JSON_PROPERTY_AUTHENTICATION_BASIC_ENABLED = "authenticationBasicEnabled"; - private Boolean authenticationBasicEnabled; - - public static final String JSON_PROPERTY_AUTHENTICATION_BASIC_PROFILE_NAME = "authenticationBasicProfileName"; - private String authenticationBasicProfileName; - - public static final String JSON_PROPERTY_AUTHENTICATION_BASIC_RADIUS_DOMAIN = "authenticationBasicRadiusDomain"; - private String authenticationBasicRadiusDomain; - - /** - * The type of basic authentication to use for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"radius\"`. The allowed values and their meaning are: <pre> \"internal\" - Internal database. Authentication is against Client Usernames. \"ldap\" - LDAP authentication. An LDAP profile name must be provided. \"radius\" - RADIUS authentication. A RADIUS profile name must be provided. \"none\" - No authentication. Anonymous login allowed. </pre> - */ - public enum AuthenticationBasicTypeEnum { - INTERNAL("internal"), - - LDAP("ldap"), - - RADIUS("radius"), - - NONE("none"); - - private String value; - - AuthenticationBasicTypeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AuthenticationBasicTypeEnum fromValue(String value) { - for (AuthenticationBasicTypeEnum b : AuthenticationBasicTypeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_AUTHENTICATION_BASIC_TYPE = "authenticationBasicType"; - private AuthenticationBasicTypeEnum authenticationBasicType; - - public static final String JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_ALLOW_API_PROVIDED_USERNAME_ENABLED = "authenticationClientCertAllowApiProvidedUsernameEnabled"; - private Boolean authenticationClientCertAllowApiProvidedUsernameEnabled; - - public static final String JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_CERTIFICATE_MATCHING_RULES_ENABLED = "authenticationClientCertCertificateMatchingRulesEnabled"; - private Boolean authenticationClientCertCertificateMatchingRulesEnabled; - - public static final String JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_ENABLED = "authenticationClientCertEnabled"; - private Boolean authenticationClientCertEnabled; - - public static final String JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_MAX_CHAIN_DEPTH = "authenticationClientCertMaxChainDepth"; - private Long authenticationClientCertMaxChainDepth; - - /** - * The desired behavior for client certificate revocation checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"allow-valid\"`. The allowed values and their meaning are: <pre> \"allow-all\" - Allow the client to authenticate, the result of client certificate revocation check is ignored. \"allow-unknown\" - Allow the client to authenticate even if the revocation status of his certificate cannot be determined. \"allow-valid\" - Allow the client to authenticate only when the revocation check returned an explicit positive response. </pre> Available since 2.6. - */ - public enum AuthenticationClientCertRevocationCheckModeEnum { - ALL("allow-all"), - - UNKNOWN("allow-unknown"), - - VALID("allow-valid"); - - private String value; - - AuthenticationClientCertRevocationCheckModeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AuthenticationClientCertRevocationCheckModeEnum fromValue(String value) { - for (AuthenticationClientCertRevocationCheckModeEnum b : AuthenticationClientCertRevocationCheckModeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_REVOCATION_CHECK_MODE = "authenticationClientCertRevocationCheckMode"; - private AuthenticationClientCertRevocationCheckModeEnum authenticationClientCertRevocationCheckMode; - - /** - * The field from the client certificate to use as the client username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"common-name\"`. The allowed values and their meaning are: <pre> \"certificate-thumbprint\" - The username is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate. \"common-name\" - The username is extracted from the certificate's first instance of the Common Name attribute in the Subject DN. \"common-name-last\" - The username is extracted from the certificate's last instance of the Common Name attribute in the Subject DN. \"subject-alternate-name-msupn\" - The username is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature. \"uid\" - The username is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN. \"uid-last\" - The username is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN. </pre> Available since 2.6. - */ - public enum AuthenticationClientCertUsernameSourceEnum { - CERTIFICATE_THUMBPRINT("certificate-thumbprint"), - - COMMON_NAME("common-name"), - - COMMON_NAME_LAST("common-name-last"), - - SUBJECT_ALTERNATE_NAME_MSUPN("subject-alternate-name-msupn"), - - UID("uid"), - - UID_LAST("uid-last"); - - private String value; - - AuthenticationClientCertUsernameSourceEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AuthenticationClientCertUsernameSourceEnum fromValue(String value) { - for (AuthenticationClientCertUsernameSourceEnum b : AuthenticationClientCertUsernameSourceEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_USERNAME_SOURCE = "authenticationClientCertUsernameSource"; - private AuthenticationClientCertUsernameSourceEnum authenticationClientCertUsernameSource; - - public static final String JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_VALIDATE_DATE_ENABLED = "authenticationClientCertValidateDateEnabled"; - private Boolean authenticationClientCertValidateDateEnabled; - - public static final String JSON_PROPERTY_AUTHENTICATION_KERBEROS_ALLOW_API_PROVIDED_USERNAME_ENABLED = "authenticationKerberosAllowApiProvidedUsernameEnabled"; - private Boolean authenticationKerberosAllowApiProvidedUsernameEnabled; - - public static final String JSON_PROPERTY_AUTHENTICATION_KERBEROS_ENABLED = "authenticationKerberosEnabled"; - private Boolean authenticationKerberosEnabled; - - public static final String JSON_PROPERTY_AUTHENTICATION_OAUTH_DEFAULT_PROFILE_NAME = "authenticationOauthDefaultProfileName"; - private String authenticationOauthDefaultProfileName; - - public static final String JSON_PROPERTY_AUTHENTICATION_OAUTH_DEFAULT_PROVIDER_NAME = "authenticationOauthDefaultProviderName"; - private String authenticationOauthDefaultProviderName; - - public static final String JSON_PROPERTY_AUTHENTICATION_OAUTH_ENABLED = "authenticationOauthEnabled"; - private Boolean authenticationOauthEnabled; - - public static final String JSON_PROPERTY_AUTHORIZATION_LDAP_GROUP_MEMBERSHIP_ATTRIBUTE_NAME = "authorizationLdapGroupMembershipAttributeName"; - private String authorizationLdapGroupMembershipAttributeName; - - public static final String JSON_PROPERTY_AUTHORIZATION_LDAP_TRIM_CLIENT_USERNAME_DOMAIN_ENABLED = "authorizationLdapTrimClientUsernameDomainEnabled"; - private Boolean authorizationLdapTrimClientUsernameDomainEnabled; - - public static final String JSON_PROPERTY_AUTHORIZATION_PROFILE_NAME = "authorizationProfileName"; - private String authorizationProfileName; - - /** - * The type of authorization to use for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"internal\"`. The allowed values and their meaning are: <pre> \"ldap\" - LDAP authorization. \"internal\" - Internal authorization. </pre> - */ - public enum AuthorizationTypeEnum { - LDAP("ldap"), - - INTERNAL("internal"); - - private String value; - - AuthorizationTypeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AuthorizationTypeEnum fromValue(String value) { - for (AuthorizationTypeEnum b : AuthorizationTypeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_AUTHORIZATION_TYPE = "authorizationType"; - private AuthorizationTypeEnum authorizationType; - - public static final String JSON_PROPERTY_BRIDGING_TLS_SERVER_CERT_ENFORCE_TRUSTED_COMMON_NAME_ENABLED = "bridgingTlsServerCertEnforceTrustedCommonNameEnabled"; - private Boolean bridgingTlsServerCertEnforceTrustedCommonNameEnabled; - - public static final String JSON_PROPERTY_BRIDGING_TLS_SERVER_CERT_MAX_CHAIN_DEPTH = "bridgingTlsServerCertMaxChainDepth"; - private Long bridgingTlsServerCertMaxChainDepth; - - public static final String JSON_PROPERTY_BRIDGING_TLS_SERVER_CERT_VALIDATE_DATE_ENABLED = "bridgingTlsServerCertValidateDateEnabled"; - private Boolean bridgingTlsServerCertValidateDateEnabled; - - public static final String JSON_PROPERTY_BRIDGING_TLS_SERVER_CERT_VALIDATE_NAME_ENABLED = "bridgingTlsServerCertValidateNameEnabled"; - private Boolean bridgingTlsServerCertValidateNameEnabled; - - public static final String JSON_PROPERTY_DISTRIBUTED_CACHE_MANAGEMENT_ENABLED = "distributedCacheManagementEnabled"; - private Boolean distributedCacheManagementEnabled; - - public static final String JSON_PROPERTY_DMR_ENABLED = "dmrEnabled"; - private Boolean dmrEnabled; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_EVENT_CONNECTION_COUNT_THRESHOLD = "eventConnectionCountThreshold"; - private EventThreshold eventConnectionCountThreshold; - - public static final String JSON_PROPERTY_EVENT_EGRESS_FLOW_COUNT_THRESHOLD = "eventEgressFlowCountThreshold"; - private EventThreshold eventEgressFlowCountThreshold; - - public static final String JSON_PROPERTY_EVENT_EGRESS_MSG_RATE_THRESHOLD = "eventEgressMsgRateThreshold"; - private EventThresholdByValue eventEgressMsgRateThreshold; - - public static final String JSON_PROPERTY_EVENT_ENDPOINT_COUNT_THRESHOLD = "eventEndpointCountThreshold"; - private EventThreshold eventEndpointCountThreshold; - - public static final String JSON_PROPERTY_EVENT_INGRESS_FLOW_COUNT_THRESHOLD = "eventIngressFlowCountThreshold"; - private EventThreshold eventIngressFlowCountThreshold; - - public static final String JSON_PROPERTY_EVENT_INGRESS_MSG_RATE_THRESHOLD = "eventIngressMsgRateThreshold"; - private EventThresholdByValue eventIngressMsgRateThreshold; - - public static final String JSON_PROPERTY_EVENT_LARGE_MSG_THRESHOLD = "eventLargeMsgThreshold"; - private Long eventLargeMsgThreshold; - - public static final String JSON_PROPERTY_EVENT_LOG_TAG = "eventLogTag"; - private String eventLogTag; - - public static final String JSON_PROPERTY_EVENT_MSG_SPOOL_USAGE_THRESHOLD = "eventMsgSpoolUsageThreshold"; - private EventThreshold eventMsgSpoolUsageThreshold; - - public static final String JSON_PROPERTY_EVENT_PUBLISH_CLIENT_ENABLED = "eventPublishClientEnabled"; - private Boolean eventPublishClientEnabled; - - public static final String JSON_PROPERTY_EVENT_PUBLISH_MSG_VPN_ENABLED = "eventPublishMsgVpnEnabled"; - private Boolean eventPublishMsgVpnEnabled; - - /** - * Subscription level Event message publishing mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"off\"`. The allowed values and their meaning are: <pre> \"off\" - Disable client level event message publishing. \"on-with-format-v1\" - Enable client level event message publishing with format v1. \"on-with-no-unsubscribe-events-on-disconnect-format-v1\" - As \"on-with-format-v1\", but unsubscribe events are not generated when a client disconnects. Unsubscribe events are still raised when a client explicitly unsubscribes from its subscriptions. \"on-with-format-v2\" - Enable client level event message publishing with format v2. \"on-with-no-unsubscribe-events-on-disconnect-format-v2\" - As \"on-with-format-v2\", but unsubscribe events are not generated when a client disconnects. Unsubscribe events are still raised when a client explicitly unsubscribes from its subscriptions. </pre> - */ - public enum EventPublishSubscriptionModeEnum { - OFF("off"), - - ON_WITH_FORMAT_V1("on-with-format-v1"), - - ON_WITH_NO_UNSUBSCRIBE_EVENTS_ON_DISCONNECT_FORMAT_V1("on-with-no-unsubscribe-events-on-disconnect-format-v1"), - - ON_WITH_FORMAT_V2("on-with-format-v2"), - - ON_WITH_NO_UNSUBSCRIBE_EVENTS_ON_DISCONNECT_FORMAT_V2("on-with-no-unsubscribe-events-on-disconnect-format-v2"); - - private String value; - - EventPublishSubscriptionModeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static EventPublishSubscriptionModeEnum fromValue(String value) { - for (EventPublishSubscriptionModeEnum b : EventPublishSubscriptionModeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_EVENT_PUBLISH_SUBSCRIPTION_MODE = "eventPublishSubscriptionMode"; - private EventPublishSubscriptionModeEnum eventPublishSubscriptionMode; - - public static final String JSON_PROPERTY_EVENT_PUBLISH_TOPIC_FORMAT_MQTT_ENABLED = "eventPublishTopicFormatMqttEnabled"; - private Boolean eventPublishTopicFormatMqttEnabled; - - public static final String JSON_PROPERTY_EVENT_PUBLISH_TOPIC_FORMAT_SMF_ENABLED = "eventPublishTopicFormatSmfEnabled"; - private Boolean eventPublishTopicFormatSmfEnabled; - - public static final String JSON_PROPERTY_EVENT_SERVICE_AMQP_CONNECTION_COUNT_THRESHOLD = "eventServiceAmqpConnectionCountThreshold"; - private EventThreshold eventServiceAmqpConnectionCountThreshold; - - public static final String JSON_PROPERTY_EVENT_SERVICE_MQTT_CONNECTION_COUNT_THRESHOLD = "eventServiceMqttConnectionCountThreshold"; - private EventThreshold eventServiceMqttConnectionCountThreshold; - - public static final String JSON_PROPERTY_EVENT_SERVICE_REST_INCOMING_CONNECTION_COUNT_THRESHOLD = "eventServiceRestIncomingConnectionCountThreshold"; - private EventThreshold eventServiceRestIncomingConnectionCountThreshold; - - public static final String JSON_PROPERTY_EVENT_SERVICE_SMF_CONNECTION_COUNT_THRESHOLD = "eventServiceSmfConnectionCountThreshold"; - private EventThreshold eventServiceSmfConnectionCountThreshold; - - public static final String JSON_PROPERTY_EVENT_SERVICE_WEB_CONNECTION_COUNT_THRESHOLD = "eventServiceWebConnectionCountThreshold"; - private EventThreshold eventServiceWebConnectionCountThreshold; - - public static final String JSON_PROPERTY_EVENT_SUBSCRIPTION_COUNT_THRESHOLD = "eventSubscriptionCountThreshold"; - private EventThreshold eventSubscriptionCountThreshold; - - public static final String JSON_PROPERTY_EVENT_TRANSACTED_SESSION_COUNT_THRESHOLD = "eventTransactedSessionCountThreshold"; - private EventThreshold eventTransactedSessionCountThreshold; - - public static final String JSON_PROPERTY_EVENT_TRANSACTION_COUNT_THRESHOLD = "eventTransactionCountThreshold"; - private EventThreshold eventTransactionCountThreshold; - - public static final String JSON_PROPERTY_EXPORT_SUBSCRIPTIONS_ENABLED = "exportSubscriptionsEnabled"; - private Boolean exportSubscriptionsEnabled; - - public static final String JSON_PROPERTY_JNDI_ENABLED = "jndiEnabled"; - private Boolean jndiEnabled; - - public static final String JSON_PROPERTY_MAX_CONNECTION_COUNT = "maxConnectionCount"; - private Long maxConnectionCount; - - public static final String JSON_PROPERTY_MAX_EGRESS_FLOW_COUNT = "maxEgressFlowCount"; - private Long maxEgressFlowCount; - - public static final String JSON_PROPERTY_MAX_ENDPOINT_COUNT = "maxEndpointCount"; - private Long maxEndpointCount; - - public static final String JSON_PROPERTY_MAX_INGRESS_FLOW_COUNT = "maxIngressFlowCount"; - private Long maxIngressFlowCount; - - public static final String JSON_PROPERTY_MAX_MSG_SPOOL_USAGE = "maxMsgSpoolUsage"; - private Long maxMsgSpoolUsage; - - public static final String JSON_PROPERTY_MAX_SUBSCRIPTION_COUNT = "maxSubscriptionCount"; - private Long maxSubscriptionCount; - - public static final String JSON_PROPERTY_MAX_TRANSACTED_SESSION_COUNT = "maxTransactedSessionCount"; - private Long maxTransactedSessionCount; - - public static final String JSON_PROPERTY_MAX_TRANSACTION_COUNT = "maxTransactionCount"; - private Long maxTransactionCount; - - public static final String JSON_PROPERTY_MQTT_RETAIN_MAX_MEMORY = "mqttRetainMaxMemory"; - private Integer mqttRetainMaxMemory; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_REPLICATION_ACK_PROPAGATION_INTERVAL_MSG_COUNT = "replicationAckPropagationIntervalMsgCount"; - private Long replicationAckPropagationIntervalMsgCount; - - public static final String JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_BASIC_CLIENT_USERNAME = "replicationBridgeAuthenticationBasicClientUsername"; - private String replicationBridgeAuthenticationBasicClientUsername; - - public static final String JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_BASIC_PASSWORD = "replicationBridgeAuthenticationBasicPassword"; - private String replicationBridgeAuthenticationBasicPassword; - - public static final String JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_CLIENT_CERT_CONTENT = "replicationBridgeAuthenticationClientCertContent"; - private String replicationBridgeAuthenticationClientCertContent; - - public static final String JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_CLIENT_CERT_PASSWORD = "replicationBridgeAuthenticationClientCertPassword"; - private String replicationBridgeAuthenticationClientCertPassword; - - /** - * The authentication scheme for the replication Bridge in the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"basic\"`. The allowed values and their meaning are: <pre> \"basic\" - Basic Authentication Scheme (via username and password). \"client-certificate\" - Client Certificate Authentication Scheme (via certificate file or content). </pre> - */ - public enum ReplicationBridgeAuthenticationSchemeEnum { - BASIC("basic"), - - CLIENT_CERTIFICATE("client-certificate"); - - private String value; - - ReplicationBridgeAuthenticationSchemeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static ReplicationBridgeAuthenticationSchemeEnum fromValue(String value) { - for (ReplicationBridgeAuthenticationSchemeEnum b : ReplicationBridgeAuthenticationSchemeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_SCHEME = "replicationBridgeAuthenticationScheme"; - private ReplicationBridgeAuthenticationSchemeEnum replicationBridgeAuthenticationScheme; - - public static final String JSON_PROPERTY_REPLICATION_BRIDGE_COMPRESSED_DATA_ENABLED = "replicationBridgeCompressedDataEnabled"; - private Boolean replicationBridgeCompressedDataEnabled; - - public static final String JSON_PROPERTY_REPLICATION_BRIDGE_EGRESS_FLOW_WINDOW_SIZE = "replicationBridgeEgressFlowWindowSize"; - private Long replicationBridgeEgressFlowWindowSize; - - public static final String JSON_PROPERTY_REPLICATION_BRIDGE_RETRY_DELAY = "replicationBridgeRetryDelay"; - private Long replicationBridgeRetryDelay; - - public static final String JSON_PROPERTY_REPLICATION_BRIDGE_TLS_ENABLED = "replicationBridgeTlsEnabled"; - private Boolean replicationBridgeTlsEnabled; - - public static final String JSON_PROPERTY_REPLICATION_BRIDGE_UNIDIRECTIONAL_CLIENT_PROFILE_NAME = "replicationBridgeUnidirectionalClientProfileName"; - private String replicationBridgeUnidirectionalClientProfileName; - - public static final String JSON_PROPERTY_REPLICATION_ENABLED = "replicationEnabled"; - private Boolean replicationEnabled; - - /** - * The behavior to take when enabling replication for the Message VPN, depending on the existence of the replication Queue. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"fail-on-existing-queue\"`. The allowed values and their meaning are: <pre> \"fail-on-existing-queue\" - The data replication queue must not already exist. \"force-use-existing-queue\" - The data replication queue must already exist. Any data messages on the Queue will be forwarded to interested applications. IMPORTANT: Before using this mode be certain that the messages are not stale or otherwise unsuitable to be forwarded. This mode can only be specified when the existing queue is configured the same as is currently specified under replication configuration otherwise the enabling of replication will fail. \"force-recreate-queue\" - The data replication queue must already exist. Any data messages on the Queue will be discarded. IMPORTANT: Before using this mode be certain that the messages on the existing data replication queue are not needed by interested applications. </pre> - */ - public enum ReplicationEnabledQueueBehaviorEnum { - FAIL_ON_EXISTING_QUEUE("fail-on-existing-queue"), - - FORCE_USE_EXISTING_QUEUE("force-use-existing-queue"), - - FORCE_RECREATE_QUEUE("force-recreate-queue"); - - private String value; - - ReplicationEnabledQueueBehaviorEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static ReplicationEnabledQueueBehaviorEnum fromValue(String value) { - for (ReplicationEnabledQueueBehaviorEnum b : ReplicationEnabledQueueBehaviorEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_REPLICATION_ENABLED_QUEUE_BEHAVIOR = "replicationEnabledQueueBehavior"; - private ReplicationEnabledQueueBehaviorEnum replicationEnabledQueueBehavior; - - public static final String JSON_PROPERTY_REPLICATION_QUEUE_MAX_MSG_SPOOL_USAGE = "replicationQueueMaxMsgSpoolUsage"; - private Long replicationQueueMaxMsgSpoolUsage; - - public static final String JSON_PROPERTY_REPLICATION_QUEUE_REJECT_MSG_TO_SENDER_ON_DISCARD_ENABLED = "replicationQueueRejectMsgToSenderOnDiscardEnabled"; - private Boolean replicationQueueRejectMsgToSenderOnDiscardEnabled; - - public static final String JSON_PROPERTY_REPLICATION_REJECT_MSG_WHEN_SYNC_INELIGIBLE_ENABLED = "replicationRejectMsgWhenSyncIneligibleEnabled"; - private Boolean replicationRejectMsgWhenSyncIneligibleEnabled; - - /** - * The replication role for the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"standby\"`. The allowed values and their meaning are: <pre> \"active\" - Assume the Active role in replication for the Message VPN. \"standby\" - Assume the Standby role in replication for the Message VPN. </pre> - */ - public enum ReplicationRoleEnum { - ACTIVE("active"), - - STANDBY("standby"); - - private String value; - - ReplicationRoleEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static ReplicationRoleEnum fromValue(String value) { - for (ReplicationRoleEnum b : ReplicationRoleEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_REPLICATION_ROLE = "replicationRole"; - private ReplicationRoleEnum replicationRole; - - /** - * The transaction replication mode for all transactions within the Message VPN. Changing this value during operation will not affect existing transactions; it is only used upon starting a transaction. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"async\"`. The allowed values and their meaning are: <pre> \"sync\" - Messages are acknowledged when replicated (spooled remotely). \"async\" - Messages are acknowledged when pending replication (spooled locally). </pre> - */ - public enum ReplicationTransactionModeEnum { - SYNC("sync"), - - ASYNC("async"); - - private String value; - - ReplicationTransactionModeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static ReplicationTransactionModeEnum fromValue(String value) { - for (ReplicationTransactionModeEnum b : ReplicationTransactionModeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_REPLICATION_TRANSACTION_MODE = "replicationTransactionMode"; - private ReplicationTransactionModeEnum replicationTransactionMode; - - public static final String JSON_PROPERTY_REST_TLS_SERVER_CERT_ENFORCE_TRUSTED_COMMON_NAME_ENABLED = "restTlsServerCertEnforceTrustedCommonNameEnabled"; - private Boolean restTlsServerCertEnforceTrustedCommonNameEnabled; - - public static final String JSON_PROPERTY_REST_TLS_SERVER_CERT_MAX_CHAIN_DEPTH = "restTlsServerCertMaxChainDepth"; - private Long restTlsServerCertMaxChainDepth; - - public static final String JSON_PROPERTY_REST_TLS_SERVER_CERT_VALIDATE_DATE_ENABLED = "restTlsServerCertValidateDateEnabled"; - private Boolean restTlsServerCertValidateDateEnabled; - - public static final String JSON_PROPERTY_REST_TLS_SERVER_CERT_VALIDATE_NAME_ENABLED = "restTlsServerCertValidateNameEnabled"; - private Boolean restTlsServerCertValidateNameEnabled; - - public static final String JSON_PROPERTY_SEMP_OVER_MSG_BUS_ADMIN_CLIENT_ENABLED = "sempOverMsgBusAdminClientEnabled"; - private Boolean sempOverMsgBusAdminClientEnabled; - - public static final String JSON_PROPERTY_SEMP_OVER_MSG_BUS_ADMIN_DISTRIBUTED_CACHE_ENABLED = "sempOverMsgBusAdminDistributedCacheEnabled"; - private Boolean sempOverMsgBusAdminDistributedCacheEnabled; - - public static final String JSON_PROPERTY_SEMP_OVER_MSG_BUS_ADMIN_ENABLED = "sempOverMsgBusAdminEnabled"; - private Boolean sempOverMsgBusAdminEnabled; - - public static final String JSON_PROPERTY_SEMP_OVER_MSG_BUS_ENABLED = "sempOverMsgBusEnabled"; - private Boolean sempOverMsgBusEnabled; - - public static final String JSON_PROPERTY_SEMP_OVER_MSG_BUS_SHOW_ENABLED = "sempOverMsgBusShowEnabled"; - private Boolean sempOverMsgBusShowEnabled; - - public static final String JSON_PROPERTY_SERVICE_AMQP_MAX_CONNECTION_COUNT = "serviceAmqpMaxConnectionCount"; - private Long serviceAmqpMaxConnectionCount; - - public static final String JSON_PROPERTY_SERVICE_AMQP_PLAIN_TEXT_ENABLED = "serviceAmqpPlainTextEnabled"; - private Boolean serviceAmqpPlainTextEnabled; - - public static final String JSON_PROPERTY_SERVICE_AMQP_PLAIN_TEXT_LISTEN_PORT = "serviceAmqpPlainTextListenPort"; - private Long serviceAmqpPlainTextListenPort; - - public static final String JSON_PROPERTY_SERVICE_AMQP_TLS_ENABLED = "serviceAmqpTlsEnabled"; - private Boolean serviceAmqpTlsEnabled; - - public static final String JSON_PROPERTY_SERVICE_AMQP_TLS_LISTEN_PORT = "serviceAmqpTlsListenPort"; - private Long serviceAmqpTlsListenPort; - - /** - * Determines when to request a client certificate from an incoming MQTT client connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-enabled-in-message-vpn\"`. The allowed values and their meaning are: <pre> \"always\" - Always ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"never\" - Never ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"when-enabled-in-message-vpn\" - Only ask for a client-certificate if client certificate authentication is enabled under \"message-vpn > authentication > client-certificate > shutdown\". </pre> Available since 2.21. - */ - public enum ServiceMqttAuthenticationClientCertRequestEnum { - ALWAYS("always"), - - NEVER("never"), - - WHEN_ENABLED_IN_MESSAGE_VPN("when-enabled-in-message-vpn"); - - private String value; - - ServiceMqttAuthenticationClientCertRequestEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static ServiceMqttAuthenticationClientCertRequestEnum fromValue(String value) { - for (ServiceMqttAuthenticationClientCertRequestEnum b : ServiceMqttAuthenticationClientCertRequestEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_SERVICE_MQTT_AUTHENTICATION_CLIENT_CERT_REQUEST = "serviceMqttAuthenticationClientCertRequest"; - private ServiceMqttAuthenticationClientCertRequestEnum serviceMqttAuthenticationClientCertRequest; - - public static final String JSON_PROPERTY_SERVICE_MQTT_MAX_CONNECTION_COUNT = "serviceMqttMaxConnectionCount"; - private Long serviceMqttMaxConnectionCount; - - public static final String JSON_PROPERTY_SERVICE_MQTT_PLAIN_TEXT_ENABLED = "serviceMqttPlainTextEnabled"; - private Boolean serviceMqttPlainTextEnabled; - - public static final String JSON_PROPERTY_SERVICE_MQTT_PLAIN_TEXT_LISTEN_PORT = "serviceMqttPlainTextListenPort"; - private Long serviceMqttPlainTextListenPort; - - public static final String JSON_PROPERTY_SERVICE_MQTT_TLS_ENABLED = "serviceMqttTlsEnabled"; - private Boolean serviceMqttTlsEnabled; - - public static final String JSON_PROPERTY_SERVICE_MQTT_TLS_LISTEN_PORT = "serviceMqttTlsListenPort"; - private Long serviceMqttTlsListenPort; - - public static final String JSON_PROPERTY_SERVICE_MQTT_TLS_WEB_SOCKET_ENABLED = "serviceMqttTlsWebSocketEnabled"; - private Boolean serviceMqttTlsWebSocketEnabled; - - public static final String JSON_PROPERTY_SERVICE_MQTT_TLS_WEB_SOCKET_LISTEN_PORT = "serviceMqttTlsWebSocketListenPort"; - private Long serviceMqttTlsWebSocketListenPort; - - public static final String JSON_PROPERTY_SERVICE_MQTT_WEB_SOCKET_ENABLED = "serviceMqttWebSocketEnabled"; - private Boolean serviceMqttWebSocketEnabled; - - public static final String JSON_PROPERTY_SERVICE_MQTT_WEB_SOCKET_LISTEN_PORT = "serviceMqttWebSocketListenPort"; - private Long serviceMqttWebSocketListenPort; - - /** - * Determines when to request a client certificate from an incoming REST Producer connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-enabled-in-message-vpn\"`. The allowed values and their meaning are: <pre> \"always\" - Always ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"never\" - Never ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"when-enabled-in-message-vpn\" - Only ask for a client-certificate if client certificate authentication is enabled under \"message-vpn > authentication > client-certificate > shutdown\". </pre> Available since 2.21. - */ - public enum ServiceRestIncomingAuthenticationClientCertRequestEnum { - ALWAYS("always"), - - NEVER("never"), - - WHEN_ENABLED_IN_MESSAGE_VPN("when-enabled-in-message-vpn"); - - private String value; - - ServiceRestIncomingAuthenticationClientCertRequestEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static ServiceRestIncomingAuthenticationClientCertRequestEnum fromValue(String value) { - for (ServiceRestIncomingAuthenticationClientCertRequestEnum b : ServiceRestIncomingAuthenticationClientCertRequestEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_SERVICE_REST_INCOMING_AUTHENTICATION_CLIENT_CERT_REQUEST = "serviceRestIncomingAuthenticationClientCertRequest"; - private ServiceRestIncomingAuthenticationClientCertRequestEnum serviceRestIncomingAuthenticationClientCertRequest; - - /** - * The handling of Authorization headers for incoming REST connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"drop\"`. The allowed values and their meaning are: <pre> \"drop\" - Do not attach the Authorization header to the message as a user property. This configuration is most secure. \"forward\" - Forward the Authorization header, attaching it to the message as a user property in the same way as other headers. For best security, use the drop setting. \"legacy\" - If the Authorization header was used for authentication to the broker, do not attach it to the message. If the Authorization header was not used for authentication to the broker, attach it to the message as a user property in the same way as other headers. For best security, use the drop setting. </pre> Available since 2.19. - */ - public enum ServiceRestIncomingAuthorizationHeaderHandlingEnum { - DROP("drop"), - - FORWARD("forward"), - - LEGACY("legacy"); - - private String value; - - ServiceRestIncomingAuthorizationHeaderHandlingEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static ServiceRestIncomingAuthorizationHeaderHandlingEnum fromValue(String value) { - for (ServiceRestIncomingAuthorizationHeaderHandlingEnum b : ServiceRestIncomingAuthorizationHeaderHandlingEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_SERVICE_REST_INCOMING_AUTHORIZATION_HEADER_HANDLING = "serviceRestIncomingAuthorizationHeaderHandling"; - private ServiceRestIncomingAuthorizationHeaderHandlingEnum serviceRestIncomingAuthorizationHeaderHandling; - - public static final String JSON_PROPERTY_SERVICE_REST_INCOMING_MAX_CONNECTION_COUNT = "serviceRestIncomingMaxConnectionCount"; - private Long serviceRestIncomingMaxConnectionCount; - - public static final String JSON_PROPERTY_SERVICE_REST_INCOMING_PLAIN_TEXT_ENABLED = "serviceRestIncomingPlainTextEnabled"; - private Boolean serviceRestIncomingPlainTextEnabled; - - public static final String JSON_PROPERTY_SERVICE_REST_INCOMING_PLAIN_TEXT_LISTEN_PORT = "serviceRestIncomingPlainTextListenPort"; - private Long serviceRestIncomingPlainTextListenPort; - - public static final String JSON_PROPERTY_SERVICE_REST_INCOMING_TLS_ENABLED = "serviceRestIncomingTlsEnabled"; - private Boolean serviceRestIncomingTlsEnabled; - - public static final String JSON_PROPERTY_SERVICE_REST_INCOMING_TLS_LISTEN_PORT = "serviceRestIncomingTlsListenPort"; - private Long serviceRestIncomingTlsListenPort; - - /** - * The REST service mode for incoming REST clients that connect to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"messaging\"`. The allowed values and their meaning are: <pre> \"gateway\" - Act as a message gateway through which REST messages are propagated. \"messaging\" - Act as a message broker on which REST messages are queued. </pre> Available since 2.6. - */ - public enum ServiceRestModeEnum { - GATEWAY("gateway"), - - MESSAGING("messaging"); - - private String value; - - ServiceRestModeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static ServiceRestModeEnum fromValue(String value) { - for (ServiceRestModeEnum b : ServiceRestModeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_SERVICE_REST_MODE = "serviceRestMode"; - private ServiceRestModeEnum serviceRestMode; - - public static final String JSON_PROPERTY_SERVICE_REST_OUTGOING_MAX_CONNECTION_COUNT = "serviceRestOutgoingMaxConnectionCount"; - private Long serviceRestOutgoingMaxConnectionCount; - - public static final String JSON_PROPERTY_SERVICE_SMF_MAX_CONNECTION_COUNT = "serviceSmfMaxConnectionCount"; - private Long serviceSmfMaxConnectionCount; - - public static final String JSON_PROPERTY_SERVICE_SMF_PLAIN_TEXT_ENABLED = "serviceSmfPlainTextEnabled"; - private Boolean serviceSmfPlainTextEnabled; - - public static final String JSON_PROPERTY_SERVICE_SMF_TLS_ENABLED = "serviceSmfTlsEnabled"; - private Boolean serviceSmfTlsEnabled; - - /** - * Determines when to request a client certificate from a Web Transport client connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-enabled-in-message-vpn\"`. The allowed values and their meaning are: <pre> \"always\" - Always ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"never\" - Never ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"when-enabled-in-message-vpn\" - Only ask for a client-certificate if client certificate authentication is enabled under \"message-vpn > authentication > client-certificate > shutdown\". </pre> Available since 2.21. - */ - public enum ServiceWebAuthenticationClientCertRequestEnum { - ALWAYS("always"), - - NEVER("never"), - - WHEN_ENABLED_IN_MESSAGE_VPN("when-enabled-in-message-vpn"); - - private String value; - - ServiceWebAuthenticationClientCertRequestEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static ServiceWebAuthenticationClientCertRequestEnum fromValue(String value) { - for (ServiceWebAuthenticationClientCertRequestEnum b : ServiceWebAuthenticationClientCertRequestEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_SERVICE_WEB_AUTHENTICATION_CLIENT_CERT_REQUEST = "serviceWebAuthenticationClientCertRequest"; - private ServiceWebAuthenticationClientCertRequestEnum serviceWebAuthenticationClientCertRequest; - - public static final String JSON_PROPERTY_SERVICE_WEB_MAX_CONNECTION_COUNT = "serviceWebMaxConnectionCount"; - private Long serviceWebMaxConnectionCount; - - public static final String JSON_PROPERTY_SERVICE_WEB_PLAIN_TEXT_ENABLED = "serviceWebPlainTextEnabled"; - private Boolean serviceWebPlainTextEnabled; - - public static final String JSON_PROPERTY_SERVICE_WEB_TLS_ENABLED = "serviceWebTlsEnabled"; - private Boolean serviceWebTlsEnabled; - - public static final String JSON_PROPERTY_TLS_ALLOW_DOWNGRADE_TO_PLAIN_TEXT_ENABLED = "tlsAllowDowngradeToPlainTextEnabled"; - private Boolean tlsAllowDowngradeToPlainTextEnabled; - - public MsgVpn() { - } - - public MsgVpn alias(String alias) { - - this.alias = alias; - return this; - } - - /** - * The name of another Message VPN which this Message VPN is an alias for. When this Message VPN is enabled, the alias has no effect. When this Message VPN is disabled, Clients (but not Bridges and routing Links) logging into this Message VPN are automatically logged in to the other Message VPN, and authentication and authorization take place in the context of the other Message VPN. Aliases may form a non-circular chain, cascading one to the next. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14. - * @return alias - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALIAS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAlias() { - return alias; - } - - - @JsonProperty(JSON_PROPERTY_ALIAS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAlias(String alias) { - this.alias = alias; - } - - - public MsgVpn authenticationBasicEnabled(Boolean authenticationBasicEnabled) { - - this.authenticationBasicEnabled = authenticationBasicEnabled; - return this; - } - - /** - * Enable or disable basic authentication for clients connecting to the Message VPN. Basic authentication is authentication that involves the use of a username and password to prove identity. If a user provides credentials for a different authentication scheme, this setting is not applicable. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return authenticationBasicEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_BASIC_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAuthenticationBasicEnabled() { - return authenticationBasicEnabled; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_BASIC_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationBasicEnabled(Boolean authenticationBasicEnabled) { - this.authenticationBasicEnabled = authenticationBasicEnabled; - } - - - public MsgVpn authenticationBasicProfileName(String authenticationBasicProfileName) { - - this.authenticationBasicProfileName = authenticationBasicProfileName; - return this; - } - - /** - * The name of the RADIUS or LDAP Profile to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`. - * @return authenticationBasicProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_BASIC_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationBasicProfileName() { - return authenticationBasicProfileName; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_BASIC_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationBasicProfileName(String authenticationBasicProfileName) { - this.authenticationBasicProfileName = authenticationBasicProfileName; - } - - - public MsgVpn authenticationBasicRadiusDomain(String authenticationBasicRadiusDomain) { - - this.authenticationBasicRadiusDomain = authenticationBasicRadiusDomain; - return this; - } - - /** - * The RADIUS domain to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return authenticationBasicRadiusDomain - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_BASIC_RADIUS_DOMAIN) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationBasicRadiusDomain() { - return authenticationBasicRadiusDomain; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_BASIC_RADIUS_DOMAIN) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationBasicRadiusDomain(String authenticationBasicRadiusDomain) { - this.authenticationBasicRadiusDomain = authenticationBasicRadiusDomain; - } - - - public MsgVpn authenticationBasicType(AuthenticationBasicTypeEnum authenticationBasicType) { - - this.authenticationBasicType = authenticationBasicType; - return this; - } - - /** - * The type of basic authentication to use for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"radius\"`. The allowed values and their meaning are: <pre> \"internal\" - Internal database. Authentication is against Client Usernames. \"ldap\" - LDAP authentication. An LDAP profile name must be provided. \"radius\" - RADIUS authentication. A RADIUS profile name must be provided. \"none\" - No authentication. Anonymous login allowed. </pre> - * @return authenticationBasicType - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_BASIC_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AuthenticationBasicTypeEnum getAuthenticationBasicType() { - return authenticationBasicType; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_BASIC_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationBasicType(AuthenticationBasicTypeEnum authenticationBasicType) { - this.authenticationBasicType = authenticationBasicType; - } - - - public MsgVpn authenticationClientCertAllowApiProvidedUsernameEnabled(Boolean authenticationClientCertAllowApiProvidedUsernameEnabled) { - - this.authenticationClientCertAllowApiProvidedUsernameEnabled = authenticationClientCertAllowApiProvidedUsernameEnabled; - return this; - } - - /** - * Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the certificate CN (Common Name) is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return authenticationClientCertAllowApiProvidedUsernameEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_ALLOW_API_PROVIDED_USERNAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAuthenticationClientCertAllowApiProvidedUsernameEnabled() { - return authenticationClientCertAllowApiProvidedUsernameEnabled; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_ALLOW_API_PROVIDED_USERNAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationClientCertAllowApiProvidedUsernameEnabled(Boolean authenticationClientCertAllowApiProvidedUsernameEnabled) { - this.authenticationClientCertAllowApiProvidedUsernameEnabled = authenticationClientCertAllowApiProvidedUsernameEnabled; - } - - - public MsgVpn authenticationClientCertCertificateMatchingRulesEnabled(Boolean authenticationClientCertCertificateMatchingRulesEnabled) { - - this.authenticationClientCertCertificateMatchingRulesEnabled = authenticationClientCertCertificateMatchingRulesEnabled; - return this; - } - - /** - * Enable or disable certificate matching rules. When disabled, any valid certificate is accepted. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.27. - * @return authenticationClientCertCertificateMatchingRulesEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_CERTIFICATE_MATCHING_RULES_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAuthenticationClientCertCertificateMatchingRulesEnabled() { - return authenticationClientCertCertificateMatchingRulesEnabled; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_CERTIFICATE_MATCHING_RULES_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationClientCertCertificateMatchingRulesEnabled(Boolean authenticationClientCertCertificateMatchingRulesEnabled) { - this.authenticationClientCertCertificateMatchingRulesEnabled = authenticationClientCertCertificateMatchingRulesEnabled; - } - - - public MsgVpn authenticationClientCertEnabled(Boolean authenticationClientCertEnabled) { - - this.authenticationClientCertEnabled = authenticationClientCertEnabled; - return this; - } - - /** - * Enable or disable client certificate authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return authenticationClientCertEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAuthenticationClientCertEnabled() { - return authenticationClientCertEnabled; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationClientCertEnabled(Boolean authenticationClientCertEnabled) { - this.authenticationClientCertEnabled = authenticationClientCertEnabled; - } - - - public MsgVpn authenticationClientCertMaxChainDepth(Long authenticationClientCertMaxChainDepth) { - - this.authenticationClientCertMaxChainDepth = authenticationClientCertMaxChainDepth; - return this; - } - - /** - * The maximum depth for a client certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. - * @return authenticationClientCertMaxChainDepth - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_MAX_CHAIN_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getAuthenticationClientCertMaxChainDepth() { - return authenticationClientCertMaxChainDepth; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_MAX_CHAIN_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationClientCertMaxChainDepth(Long authenticationClientCertMaxChainDepth) { - this.authenticationClientCertMaxChainDepth = authenticationClientCertMaxChainDepth; - } - - - public MsgVpn authenticationClientCertRevocationCheckMode(AuthenticationClientCertRevocationCheckModeEnum authenticationClientCertRevocationCheckMode) { - - this.authenticationClientCertRevocationCheckMode = authenticationClientCertRevocationCheckMode; - return this; - } - - /** - * The desired behavior for client certificate revocation checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"allow-valid\"`. The allowed values and their meaning are: <pre> \"allow-all\" - Allow the client to authenticate, the result of client certificate revocation check is ignored. \"allow-unknown\" - Allow the client to authenticate even if the revocation status of his certificate cannot be determined. \"allow-valid\" - Allow the client to authenticate only when the revocation check returned an explicit positive response. </pre> Available since 2.6. - * @return authenticationClientCertRevocationCheckMode - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_REVOCATION_CHECK_MODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AuthenticationClientCertRevocationCheckModeEnum getAuthenticationClientCertRevocationCheckMode() { - return authenticationClientCertRevocationCheckMode; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_REVOCATION_CHECK_MODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationClientCertRevocationCheckMode(AuthenticationClientCertRevocationCheckModeEnum authenticationClientCertRevocationCheckMode) { - this.authenticationClientCertRevocationCheckMode = authenticationClientCertRevocationCheckMode; - } - - - public MsgVpn authenticationClientCertUsernameSource(AuthenticationClientCertUsernameSourceEnum authenticationClientCertUsernameSource) { - - this.authenticationClientCertUsernameSource = authenticationClientCertUsernameSource; - return this; - } - - /** - * The field from the client certificate to use as the client username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"common-name\"`. The allowed values and their meaning are: <pre> \"certificate-thumbprint\" - The username is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate. \"common-name\" - The username is extracted from the certificate's first instance of the Common Name attribute in the Subject DN. \"common-name-last\" - The username is extracted from the certificate's last instance of the Common Name attribute in the Subject DN. \"subject-alternate-name-msupn\" - The username is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature. \"uid\" - The username is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN. \"uid-last\" - The username is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN. </pre> Available since 2.6. - * @return authenticationClientCertUsernameSource - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_USERNAME_SOURCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AuthenticationClientCertUsernameSourceEnum getAuthenticationClientCertUsernameSource() { - return authenticationClientCertUsernameSource; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_USERNAME_SOURCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationClientCertUsernameSource(AuthenticationClientCertUsernameSourceEnum authenticationClientCertUsernameSource) { - this.authenticationClientCertUsernameSource = authenticationClientCertUsernameSource; - } - - - public MsgVpn authenticationClientCertValidateDateEnabled(Boolean authenticationClientCertValidateDateEnabled) { - - this.authenticationClientCertValidateDateEnabled = authenticationClientCertValidateDateEnabled; - return this; - } - - /** - * Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the client certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return authenticationClientCertValidateDateEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_VALIDATE_DATE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAuthenticationClientCertValidateDateEnabled() { - return authenticationClientCertValidateDateEnabled; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_VALIDATE_DATE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationClientCertValidateDateEnabled(Boolean authenticationClientCertValidateDateEnabled) { - this.authenticationClientCertValidateDateEnabled = authenticationClientCertValidateDateEnabled; - } - - - public MsgVpn authenticationKerberosAllowApiProvidedUsernameEnabled(Boolean authenticationKerberosAllowApiProvidedUsernameEnabled) { - - this.authenticationKerberosAllowApiProvidedUsernameEnabled = authenticationKerberosAllowApiProvidedUsernameEnabled; - return this; - } - - /** - * Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return authenticationKerberosAllowApiProvidedUsernameEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_KERBEROS_ALLOW_API_PROVIDED_USERNAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAuthenticationKerberosAllowApiProvidedUsernameEnabled() { - return authenticationKerberosAllowApiProvidedUsernameEnabled; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_KERBEROS_ALLOW_API_PROVIDED_USERNAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationKerberosAllowApiProvidedUsernameEnabled(Boolean authenticationKerberosAllowApiProvidedUsernameEnabled) { - this.authenticationKerberosAllowApiProvidedUsernameEnabled = authenticationKerberosAllowApiProvidedUsernameEnabled; - } - - - public MsgVpn authenticationKerberosEnabled(Boolean authenticationKerberosEnabled) { - - this.authenticationKerberosEnabled = authenticationKerberosEnabled; - return this; - } - - /** - * Enable or disable Kerberos authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return authenticationKerberosEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_KERBEROS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAuthenticationKerberosEnabled() { - return authenticationKerberosEnabled; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_KERBEROS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationKerberosEnabled(Boolean authenticationKerberosEnabled) { - this.authenticationKerberosEnabled = authenticationKerberosEnabled; - } - - - public MsgVpn authenticationOauthDefaultProfileName(String authenticationOauthDefaultProfileName) { - - this.authenticationOauthDefaultProfileName = authenticationOauthDefaultProfileName; - return this; - } - - /** - * The name of the profile to use when the client does not supply a profile name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.25. - * @return authenticationOauthDefaultProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_DEFAULT_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationOauthDefaultProfileName() { - return authenticationOauthDefaultProfileName; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_DEFAULT_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationOauthDefaultProfileName(String authenticationOauthDefaultProfileName) { - this.authenticationOauthDefaultProfileName = authenticationOauthDefaultProfileName; - } - - - public MsgVpn authenticationOauthDefaultProviderName(String authenticationOauthDefaultProviderName) { - - this.authenticationOauthDefaultProviderName = authenticationOauthDefaultProviderName; - return this; - } - - /** - * The name of the provider to use when the client does not supply a provider name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthDefaultProviderName and authenticationOauthProviders replaced by authenticationOauthDefaultProfileName and authenticationOauthProfiles. - * @return authenticationOauthDefaultProviderName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_DEFAULT_PROVIDER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationOauthDefaultProviderName() { - return authenticationOauthDefaultProviderName; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_DEFAULT_PROVIDER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationOauthDefaultProviderName(String authenticationOauthDefaultProviderName) { - this.authenticationOauthDefaultProviderName = authenticationOauthDefaultProviderName; - } - - - public MsgVpn authenticationOauthEnabled(Boolean authenticationOauthEnabled) { - - this.authenticationOauthEnabled = authenticationOauthEnabled; - return this; - } - - /** - * Enable or disable OAuth authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13. - * @return authenticationOauthEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAuthenticationOauthEnabled() { - return authenticationOauthEnabled; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationOauthEnabled(Boolean authenticationOauthEnabled) { - this.authenticationOauthEnabled = authenticationOauthEnabled; - } - - - public MsgVpn authorizationLdapGroupMembershipAttributeName(String authorizationLdapGroupMembershipAttributeName) { - - this.authorizationLdapGroupMembershipAttributeName = authorizationLdapGroupMembershipAttributeName; - return this; - } - - /** - * The name of the attribute that is retrieved from the LDAP server as part of the LDAP search when authorizing a client connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"memberOf\"`. - * @return authorizationLdapGroupMembershipAttributeName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_LDAP_GROUP_MEMBERSHIP_ATTRIBUTE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthorizationLdapGroupMembershipAttributeName() { - return authorizationLdapGroupMembershipAttributeName; - } - - - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_LDAP_GROUP_MEMBERSHIP_ATTRIBUTE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthorizationLdapGroupMembershipAttributeName(String authorizationLdapGroupMembershipAttributeName) { - this.authorizationLdapGroupMembershipAttributeName = authorizationLdapGroupMembershipAttributeName; - } - - - public MsgVpn authorizationLdapTrimClientUsernameDomainEnabled(Boolean authorizationLdapTrimClientUsernameDomainEnabled) { - - this.authorizationLdapTrimClientUsernameDomainEnabled = authorizationLdapTrimClientUsernameDomainEnabled; - return this; - } - - /** - * Enable or disable client-username domain trimming for LDAP lookups of client connections. When enabled, the value of $CLIENT_USERNAME (when used for searching) will be truncated at the first occurance of the @ character. For example, if the client-username is in the form of an email address, then the domain portion will be removed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13. - * @return authorizationLdapTrimClientUsernameDomainEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_LDAP_TRIM_CLIENT_USERNAME_DOMAIN_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAuthorizationLdapTrimClientUsernameDomainEnabled() { - return authorizationLdapTrimClientUsernameDomainEnabled; - } - - - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_LDAP_TRIM_CLIENT_USERNAME_DOMAIN_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthorizationLdapTrimClientUsernameDomainEnabled(Boolean authorizationLdapTrimClientUsernameDomainEnabled) { - this.authorizationLdapTrimClientUsernameDomainEnabled = authorizationLdapTrimClientUsernameDomainEnabled; - } - - - public MsgVpn authorizationProfileName(String authorizationProfileName) { - - this.authorizationProfileName = authorizationProfileName; - return this; - } - - /** - * The name of the LDAP Profile to use for client authorization. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return authorizationProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthorizationProfileName() { - return authorizationProfileName; - } - - - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthorizationProfileName(String authorizationProfileName) { - this.authorizationProfileName = authorizationProfileName; - } - - - public MsgVpn authorizationType(AuthorizationTypeEnum authorizationType) { - - this.authorizationType = authorizationType; - return this; - } - - /** - * The type of authorization to use for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"internal\"`. The allowed values and their meaning are: <pre> \"ldap\" - LDAP authorization. \"internal\" - Internal authorization. </pre> - * @return authorizationType - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AuthorizationTypeEnum getAuthorizationType() { - return authorizationType; - } - - - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthorizationType(AuthorizationTypeEnum authorizationType) { - this.authorizationType = authorizationType; - } - - - public MsgVpn bridgingTlsServerCertEnforceTrustedCommonNameEnabled(Boolean bridgingTlsServerCertEnforceTrustedCommonNameEnabled) { - - this.bridgingTlsServerCertEnforceTrustedCommonNameEnabled = bridgingTlsServerCertEnforceTrustedCommonNameEnabled; - return this; - } - - /** - * Enable or disable validation of the Common Name (CN) in the server certificate from the remote broker. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the Bridge. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * @return bridgingTlsServerCertEnforceTrustedCommonNameEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_BRIDGING_TLS_SERVER_CERT_ENFORCE_TRUSTED_COMMON_NAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getBridgingTlsServerCertEnforceTrustedCommonNameEnabled() { - return bridgingTlsServerCertEnforceTrustedCommonNameEnabled; - } - - - @JsonProperty(JSON_PROPERTY_BRIDGING_TLS_SERVER_CERT_ENFORCE_TRUSTED_COMMON_NAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setBridgingTlsServerCertEnforceTrustedCommonNameEnabled(Boolean bridgingTlsServerCertEnforceTrustedCommonNameEnabled) { - this.bridgingTlsServerCertEnforceTrustedCommonNameEnabled = bridgingTlsServerCertEnforceTrustedCommonNameEnabled; - } - - - public MsgVpn bridgingTlsServerCertMaxChainDepth(Long bridgingTlsServerCertMaxChainDepth) { - - this.bridgingTlsServerCertMaxChainDepth = bridgingTlsServerCertMaxChainDepth; - return this; - } - - /** - * The maximum depth for a server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. - * @return bridgingTlsServerCertMaxChainDepth - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_BRIDGING_TLS_SERVER_CERT_MAX_CHAIN_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getBridgingTlsServerCertMaxChainDepth() { - return bridgingTlsServerCertMaxChainDepth; - } - - - @JsonProperty(JSON_PROPERTY_BRIDGING_TLS_SERVER_CERT_MAX_CHAIN_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setBridgingTlsServerCertMaxChainDepth(Long bridgingTlsServerCertMaxChainDepth) { - this.bridgingTlsServerCertMaxChainDepth = bridgingTlsServerCertMaxChainDepth; - } - - - public MsgVpn bridgingTlsServerCertValidateDateEnabled(Boolean bridgingTlsServerCertValidateDateEnabled) { - - this.bridgingTlsServerCertValidateDateEnabled = bridgingTlsServerCertValidateDateEnabled; - return this; - } - - /** - * Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the server certificate. When disabled, a certificate will be accepted even if the certificate is not valid based on these dates. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return bridgingTlsServerCertValidateDateEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_BRIDGING_TLS_SERVER_CERT_VALIDATE_DATE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getBridgingTlsServerCertValidateDateEnabled() { - return bridgingTlsServerCertValidateDateEnabled; - } - - - @JsonProperty(JSON_PROPERTY_BRIDGING_TLS_SERVER_CERT_VALIDATE_DATE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setBridgingTlsServerCertValidateDateEnabled(Boolean bridgingTlsServerCertValidateDateEnabled) { - this.bridgingTlsServerCertValidateDateEnabled = bridgingTlsServerCertValidateDateEnabled; - } - - - public MsgVpn bridgingTlsServerCertValidateNameEnabled(Boolean bridgingTlsServerCertValidateNameEnabled) { - - this.bridgingTlsServerCertValidateNameEnabled = bridgingTlsServerCertValidateNameEnabled; - return this; - } - - /** - * Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the bridge. If enabled, the name used to connect to the bridge is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18. - * @return bridgingTlsServerCertValidateNameEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_BRIDGING_TLS_SERVER_CERT_VALIDATE_NAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getBridgingTlsServerCertValidateNameEnabled() { - return bridgingTlsServerCertValidateNameEnabled; - } - - - @JsonProperty(JSON_PROPERTY_BRIDGING_TLS_SERVER_CERT_VALIDATE_NAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setBridgingTlsServerCertValidateNameEnabled(Boolean bridgingTlsServerCertValidateNameEnabled) { - this.bridgingTlsServerCertValidateNameEnabled = bridgingTlsServerCertValidateNameEnabled; - } - - - public MsgVpn distributedCacheManagementEnabled(Boolean distributedCacheManagementEnabled) { - - this.distributedCacheManagementEnabled = distributedCacheManagementEnabled; - return this; - } - - /** - * Enable or disable managing of cache instances over the message bus. The default value is `true`. Deprecated since 2.28. Distributed cache mangement is now redundancy aware and thus no longer requires administrative intervention for operational state. - * @return distributedCacheManagementEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DISTRIBUTED_CACHE_MANAGEMENT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getDistributedCacheManagementEnabled() { - return distributedCacheManagementEnabled; - } - - - @JsonProperty(JSON_PROPERTY_DISTRIBUTED_CACHE_MANAGEMENT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDistributedCacheManagementEnabled(Boolean distributedCacheManagementEnabled) { - this.distributedCacheManagementEnabled = distributedCacheManagementEnabled; - } - - - public MsgVpn dmrEnabled(Boolean dmrEnabled) { - - this.dmrEnabled = dmrEnabled; - return this; - } - - /** - * Enable or disable Dynamic Message Routing (DMR) for the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.11. - * @return dmrEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DMR_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getDmrEnabled() { - return dmrEnabled; - } - - - @JsonProperty(JSON_PROPERTY_DMR_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDmrEnabled(Boolean dmrEnabled) { - this.dmrEnabled = dmrEnabled; - } - - - public MsgVpn enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public MsgVpn eventConnectionCountThreshold(EventThreshold eventConnectionCountThreshold) { - - this.eventConnectionCountThreshold = eventConnectionCountThreshold; - return this; - } - - /** - * Get eventConnectionCountThreshold - * @return eventConnectionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventConnectionCountThreshold() { - return eventConnectionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventConnectionCountThreshold(EventThreshold eventConnectionCountThreshold) { - this.eventConnectionCountThreshold = eventConnectionCountThreshold; - } - - - public MsgVpn eventEgressFlowCountThreshold(EventThreshold eventEgressFlowCountThreshold) { - - this.eventEgressFlowCountThreshold = eventEgressFlowCountThreshold; - return this; - } - - /** - * Get eventEgressFlowCountThreshold - * @return eventEgressFlowCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_EGRESS_FLOW_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventEgressFlowCountThreshold() { - return eventEgressFlowCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_EGRESS_FLOW_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventEgressFlowCountThreshold(EventThreshold eventEgressFlowCountThreshold) { - this.eventEgressFlowCountThreshold = eventEgressFlowCountThreshold; - } - - - public MsgVpn eventEgressMsgRateThreshold(EventThresholdByValue eventEgressMsgRateThreshold) { - - this.eventEgressMsgRateThreshold = eventEgressMsgRateThreshold; - return this; - } - - /** - * Get eventEgressMsgRateThreshold - * @return eventEgressMsgRateThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_EGRESS_MSG_RATE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThresholdByValue getEventEgressMsgRateThreshold() { - return eventEgressMsgRateThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_EGRESS_MSG_RATE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventEgressMsgRateThreshold(EventThresholdByValue eventEgressMsgRateThreshold) { - this.eventEgressMsgRateThreshold = eventEgressMsgRateThreshold; - } - - - public MsgVpn eventEndpointCountThreshold(EventThreshold eventEndpointCountThreshold) { - - this.eventEndpointCountThreshold = eventEndpointCountThreshold; - return this; - } - - /** - * Get eventEndpointCountThreshold - * @return eventEndpointCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_ENDPOINT_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventEndpointCountThreshold() { - return eventEndpointCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_ENDPOINT_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventEndpointCountThreshold(EventThreshold eventEndpointCountThreshold) { - this.eventEndpointCountThreshold = eventEndpointCountThreshold; - } - - - public MsgVpn eventIngressFlowCountThreshold(EventThreshold eventIngressFlowCountThreshold) { - - this.eventIngressFlowCountThreshold = eventIngressFlowCountThreshold; - return this; - } - - /** - * Get eventIngressFlowCountThreshold - * @return eventIngressFlowCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_INGRESS_FLOW_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventIngressFlowCountThreshold() { - return eventIngressFlowCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_INGRESS_FLOW_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventIngressFlowCountThreshold(EventThreshold eventIngressFlowCountThreshold) { - this.eventIngressFlowCountThreshold = eventIngressFlowCountThreshold; - } - - - public MsgVpn eventIngressMsgRateThreshold(EventThresholdByValue eventIngressMsgRateThreshold) { - - this.eventIngressMsgRateThreshold = eventIngressMsgRateThreshold; - return this; - } - - /** - * Get eventIngressMsgRateThreshold - * @return eventIngressMsgRateThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_INGRESS_MSG_RATE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThresholdByValue getEventIngressMsgRateThreshold() { - return eventIngressMsgRateThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_INGRESS_MSG_RATE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventIngressMsgRateThreshold(EventThresholdByValue eventIngressMsgRateThreshold) { - this.eventIngressMsgRateThreshold = eventIngressMsgRateThreshold; - } - - - public MsgVpn eventLargeMsgThreshold(Long eventLargeMsgThreshold) { - - this.eventLargeMsgThreshold = eventLargeMsgThreshold; - return this; - } - - /** - * The threshold, in kilobytes, after which a message is considered to be large for the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1024`. - * @return eventLargeMsgThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_LARGE_MSG_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getEventLargeMsgThreshold() { - return eventLargeMsgThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_LARGE_MSG_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventLargeMsgThreshold(Long eventLargeMsgThreshold) { - this.eventLargeMsgThreshold = eventLargeMsgThreshold; - } - - - public MsgVpn eventLogTag(String eventLogTag) { - - this.eventLogTag = eventLogTag; - return this; - } - - /** - * A prefix applied to all published Events in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return eventLogTag - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_LOG_TAG) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getEventLogTag() { - return eventLogTag; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_LOG_TAG) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventLogTag(String eventLogTag) { - this.eventLogTag = eventLogTag; - } - - - public MsgVpn eventMsgSpoolUsageThreshold(EventThreshold eventMsgSpoolUsageThreshold) { - - this.eventMsgSpoolUsageThreshold = eventMsgSpoolUsageThreshold; - return this; - } - - /** - * Get eventMsgSpoolUsageThreshold - * @return eventMsgSpoolUsageThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_MSG_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventMsgSpoolUsageThreshold() { - return eventMsgSpoolUsageThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_MSG_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventMsgSpoolUsageThreshold(EventThreshold eventMsgSpoolUsageThreshold) { - this.eventMsgSpoolUsageThreshold = eventMsgSpoolUsageThreshold; - } - - - public MsgVpn eventPublishClientEnabled(Boolean eventPublishClientEnabled) { - - this.eventPublishClientEnabled = eventPublishClientEnabled; - return this; - } - - /** - * Enable or disable Client level Event message publishing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return eventPublishClientEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_PUBLISH_CLIENT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEventPublishClientEnabled() { - return eventPublishClientEnabled; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_PUBLISH_CLIENT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventPublishClientEnabled(Boolean eventPublishClientEnabled) { - this.eventPublishClientEnabled = eventPublishClientEnabled; - } - - - public MsgVpn eventPublishMsgVpnEnabled(Boolean eventPublishMsgVpnEnabled) { - - this.eventPublishMsgVpnEnabled = eventPublishMsgVpnEnabled; - return this; - } - - /** - * Enable or disable Message VPN level Event message publishing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return eventPublishMsgVpnEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_PUBLISH_MSG_VPN_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEventPublishMsgVpnEnabled() { - return eventPublishMsgVpnEnabled; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_PUBLISH_MSG_VPN_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventPublishMsgVpnEnabled(Boolean eventPublishMsgVpnEnabled) { - this.eventPublishMsgVpnEnabled = eventPublishMsgVpnEnabled; - } - - - public MsgVpn eventPublishSubscriptionMode(EventPublishSubscriptionModeEnum eventPublishSubscriptionMode) { - - this.eventPublishSubscriptionMode = eventPublishSubscriptionMode; - return this; - } - - /** - * Subscription level Event message publishing mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"off\"`. The allowed values and their meaning are: <pre> \"off\" - Disable client level event message publishing. \"on-with-format-v1\" - Enable client level event message publishing with format v1. \"on-with-no-unsubscribe-events-on-disconnect-format-v1\" - As \"on-with-format-v1\", but unsubscribe events are not generated when a client disconnects. Unsubscribe events are still raised when a client explicitly unsubscribes from its subscriptions. \"on-with-format-v2\" - Enable client level event message publishing with format v2. \"on-with-no-unsubscribe-events-on-disconnect-format-v2\" - As \"on-with-format-v2\", but unsubscribe events are not generated when a client disconnects. Unsubscribe events are still raised when a client explicitly unsubscribes from its subscriptions. </pre> - * @return eventPublishSubscriptionMode - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_PUBLISH_SUBSCRIPTION_MODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventPublishSubscriptionModeEnum getEventPublishSubscriptionMode() { - return eventPublishSubscriptionMode; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_PUBLISH_SUBSCRIPTION_MODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventPublishSubscriptionMode(EventPublishSubscriptionModeEnum eventPublishSubscriptionMode) { - this.eventPublishSubscriptionMode = eventPublishSubscriptionMode; - } - - - public MsgVpn eventPublishTopicFormatMqttEnabled(Boolean eventPublishTopicFormatMqttEnabled) { - - this.eventPublishTopicFormatMqttEnabled = eventPublishTopicFormatMqttEnabled; - return this; - } - - /** - * Enable or disable Event publish topics in MQTT format. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return eventPublishTopicFormatMqttEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_PUBLISH_TOPIC_FORMAT_MQTT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEventPublishTopicFormatMqttEnabled() { - return eventPublishTopicFormatMqttEnabled; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_PUBLISH_TOPIC_FORMAT_MQTT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventPublishTopicFormatMqttEnabled(Boolean eventPublishTopicFormatMqttEnabled) { - this.eventPublishTopicFormatMqttEnabled = eventPublishTopicFormatMqttEnabled; - } - - - public MsgVpn eventPublishTopicFormatSmfEnabled(Boolean eventPublishTopicFormatSmfEnabled) { - - this.eventPublishTopicFormatSmfEnabled = eventPublishTopicFormatSmfEnabled; - return this; - } - - /** - * Enable or disable Event publish topics in SMF format. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return eventPublishTopicFormatSmfEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_PUBLISH_TOPIC_FORMAT_SMF_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEventPublishTopicFormatSmfEnabled() { - return eventPublishTopicFormatSmfEnabled; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_PUBLISH_TOPIC_FORMAT_SMF_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventPublishTopicFormatSmfEnabled(Boolean eventPublishTopicFormatSmfEnabled) { - this.eventPublishTopicFormatSmfEnabled = eventPublishTopicFormatSmfEnabled; - } - - - public MsgVpn eventServiceAmqpConnectionCountThreshold(EventThreshold eventServiceAmqpConnectionCountThreshold) { - - this.eventServiceAmqpConnectionCountThreshold = eventServiceAmqpConnectionCountThreshold; - return this; - } - - /** - * Get eventServiceAmqpConnectionCountThreshold - * @return eventServiceAmqpConnectionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_SERVICE_AMQP_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventServiceAmqpConnectionCountThreshold() { - return eventServiceAmqpConnectionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_SERVICE_AMQP_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventServiceAmqpConnectionCountThreshold(EventThreshold eventServiceAmqpConnectionCountThreshold) { - this.eventServiceAmqpConnectionCountThreshold = eventServiceAmqpConnectionCountThreshold; - } - - - public MsgVpn eventServiceMqttConnectionCountThreshold(EventThreshold eventServiceMqttConnectionCountThreshold) { - - this.eventServiceMqttConnectionCountThreshold = eventServiceMqttConnectionCountThreshold; - return this; - } - - /** - * Get eventServiceMqttConnectionCountThreshold - * @return eventServiceMqttConnectionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_SERVICE_MQTT_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventServiceMqttConnectionCountThreshold() { - return eventServiceMqttConnectionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_SERVICE_MQTT_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventServiceMqttConnectionCountThreshold(EventThreshold eventServiceMqttConnectionCountThreshold) { - this.eventServiceMqttConnectionCountThreshold = eventServiceMqttConnectionCountThreshold; - } - - - public MsgVpn eventServiceRestIncomingConnectionCountThreshold(EventThreshold eventServiceRestIncomingConnectionCountThreshold) { - - this.eventServiceRestIncomingConnectionCountThreshold = eventServiceRestIncomingConnectionCountThreshold; - return this; - } - - /** - * Get eventServiceRestIncomingConnectionCountThreshold - * @return eventServiceRestIncomingConnectionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_SERVICE_REST_INCOMING_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventServiceRestIncomingConnectionCountThreshold() { - return eventServiceRestIncomingConnectionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_SERVICE_REST_INCOMING_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventServiceRestIncomingConnectionCountThreshold(EventThreshold eventServiceRestIncomingConnectionCountThreshold) { - this.eventServiceRestIncomingConnectionCountThreshold = eventServiceRestIncomingConnectionCountThreshold; - } - - - public MsgVpn eventServiceSmfConnectionCountThreshold(EventThreshold eventServiceSmfConnectionCountThreshold) { - - this.eventServiceSmfConnectionCountThreshold = eventServiceSmfConnectionCountThreshold; - return this; - } - - /** - * Get eventServiceSmfConnectionCountThreshold - * @return eventServiceSmfConnectionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_SERVICE_SMF_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventServiceSmfConnectionCountThreshold() { - return eventServiceSmfConnectionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_SERVICE_SMF_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventServiceSmfConnectionCountThreshold(EventThreshold eventServiceSmfConnectionCountThreshold) { - this.eventServiceSmfConnectionCountThreshold = eventServiceSmfConnectionCountThreshold; - } - - - public MsgVpn eventServiceWebConnectionCountThreshold(EventThreshold eventServiceWebConnectionCountThreshold) { - - this.eventServiceWebConnectionCountThreshold = eventServiceWebConnectionCountThreshold; - return this; - } - - /** - * Get eventServiceWebConnectionCountThreshold - * @return eventServiceWebConnectionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_SERVICE_WEB_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventServiceWebConnectionCountThreshold() { - return eventServiceWebConnectionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_SERVICE_WEB_CONNECTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventServiceWebConnectionCountThreshold(EventThreshold eventServiceWebConnectionCountThreshold) { - this.eventServiceWebConnectionCountThreshold = eventServiceWebConnectionCountThreshold; - } - - - public MsgVpn eventSubscriptionCountThreshold(EventThreshold eventSubscriptionCountThreshold) { - - this.eventSubscriptionCountThreshold = eventSubscriptionCountThreshold; - return this; - } - - /** - * Get eventSubscriptionCountThreshold - * @return eventSubscriptionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_SUBSCRIPTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventSubscriptionCountThreshold() { - return eventSubscriptionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_SUBSCRIPTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventSubscriptionCountThreshold(EventThreshold eventSubscriptionCountThreshold) { - this.eventSubscriptionCountThreshold = eventSubscriptionCountThreshold; - } - - - public MsgVpn eventTransactedSessionCountThreshold(EventThreshold eventTransactedSessionCountThreshold) { - - this.eventTransactedSessionCountThreshold = eventTransactedSessionCountThreshold; - return this; - } - - /** - * Get eventTransactedSessionCountThreshold - * @return eventTransactedSessionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_TRANSACTED_SESSION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventTransactedSessionCountThreshold() { - return eventTransactedSessionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_TRANSACTED_SESSION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventTransactedSessionCountThreshold(EventThreshold eventTransactedSessionCountThreshold) { - this.eventTransactedSessionCountThreshold = eventTransactedSessionCountThreshold; - } - - - public MsgVpn eventTransactionCountThreshold(EventThreshold eventTransactionCountThreshold) { - - this.eventTransactionCountThreshold = eventTransactionCountThreshold; - return this; - } - - /** - * Get eventTransactionCountThreshold - * @return eventTransactionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_TRANSACTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventTransactionCountThreshold() { - return eventTransactionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_TRANSACTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventTransactionCountThreshold(EventThreshold eventTransactionCountThreshold) { - this.eventTransactionCountThreshold = eventTransactionCountThreshold; - } - - - public MsgVpn exportSubscriptionsEnabled(Boolean exportSubscriptionsEnabled) { - - this.exportSubscriptionsEnabled = exportSubscriptionsEnabled; - return this; - } - - /** - * Enable or disable the export of subscriptions in the Message VPN to other routers in the network over Neighbor links. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return exportSubscriptionsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EXPORT_SUBSCRIPTIONS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getExportSubscriptionsEnabled() { - return exportSubscriptionsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_EXPORT_SUBSCRIPTIONS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setExportSubscriptionsEnabled(Boolean exportSubscriptionsEnabled) { - this.exportSubscriptionsEnabled = exportSubscriptionsEnabled; - } - - - public MsgVpn jndiEnabled(Boolean jndiEnabled) { - - this.jndiEnabled = jndiEnabled; - return this; - } - - /** - * Enable or disable JNDI access for clients in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.2. - * @return jndiEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_JNDI_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getJndiEnabled() { - return jndiEnabled; - } - - - @JsonProperty(JSON_PROPERTY_JNDI_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setJndiEnabled(Boolean jndiEnabled) { - this.jndiEnabled = jndiEnabled; - } - - - public MsgVpn maxConnectionCount(Long maxConnectionCount) { - - this.maxConnectionCount = maxConnectionCount; - return this; - } - - /** - * The maximum number of client connections to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. - * @return maxConnectionCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_CONNECTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxConnectionCount() { - return maxConnectionCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_CONNECTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxConnectionCount(Long maxConnectionCount) { - this.maxConnectionCount = maxConnectionCount; - } - - - public MsgVpn maxEgressFlowCount(Long maxEgressFlowCount) { - - this.maxEgressFlowCount = maxEgressFlowCount; - return this; - } - - /** - * The maximum number of transmit flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. - * @return maxEgressFlowCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_EGRESS_FLOW_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxEgressFlowCount() { - return maxEgressFlowCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_EGRESS_FLOW_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxEgressFlowCount(Long maxEgressFlowCount) { - this.maxEgressFlowCount = maxEgressFlowCount; - } - - - public MsgVpn maxEndpointCount(Long maxEndpointCount) { - - this.maxEndpointCount = maxEndpointCount; - return this; - } - - /** - * The maximum number of Queues and Topic Endpoints that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. - * @return maxEndpointCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_ENDPOINT_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxEndpointCount() { - return maxEndpointCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_ENDPOINT_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxEndpointCount(Long maxEndpointCount) { - this.maxEndpointCount = maxEndpointCount; - } - - - public MsgVpn maxIngressFlowCount(Long maxIngressFlowCount) { - - this.maxIngressFlowCount = maxIngressFlowCount; - return this; - } - - /** - * The maximum number of receive flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. - * @return maxIngressFlowCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_INGRESS_FLOW_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxIngressFlowCount() { - return maxIngressFlowCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_INGRESS_FLOW_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxIngressFlowCount(Long maxIngressFlowCount) { - this.maxIngressFlowCount = maxIngressFlowCount; - } - - - public MsgVpn maxMsgSpoolUsage(Long maxMsgSpoolUsage) { - - this.maxMsgSpoolUsage = maxMsgSpoolUsage; - return this; - } - - /** - * The maximum message spool usage by the Message VPN, in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return maxMsgSpoolUsage - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_MSG_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxMsgSpoolUsage() { - return maxMsgSpoolUsage; - } - - - @JsonProperty(JSON_PROPERTY_MAX_MSG_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxMsgSpoolUsage(Long maxMsgSpoolUsage) { - this.maxMsgSpoolUsage = maxMsgSpoolUsage; - } - - - public MsgVpn maxSubscriptionCount(Long maxSubscriptionCount) { - - this.maxSubscriptionCount = maxSubscriptionCount; - return this; - } - - /** - * The maximum number of local client subscriptions that can be added to the Message VPN. This limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. - * @return maxSubscriptionCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_SUBSCRIPTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxSubscriptionCount() { - return maxSubscriptionCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_SUBSCRIPTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxSubscriptionCount(Long maxSubscriptionCount) { - this.maxSubscriptionCount = maxSubscriptionCount; - } - - - public MsgVpn maxTransactedSessionCount(Long maxTransactedSessionCount) { - - this.maxTransactedSessionCount = maxTransactedSessionCount; - return this; - } - - /** - * The maximum number of transacted sessions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. - * @return maxTransactedSessionCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_TRANSACTED_SESSION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxTransactedSessionCount() { - return maxTransactedSessionCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_TRANSACTED_SESSION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxTransactedSessionCount(Long maxTransactedSessionCount) { - this.maxTransactedSessionCount = maxTransactedSessionCount; - } - - - public MsgVpn maxTransactionCount(Long maxTransactionCount) { - - this.maxTransactionCount = maxTransactionCount; - return this; - } - - /** - * The maximum number of transactions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. - * @return maxTransactionCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_TRANSACTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxTransactionCount() { - return maxTransactionCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_TRANSACTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxTransactionCount(Long maxTransactionCount) { - this.maxTransactionCount = maxTransactionCount; - } - - - public MsgVpn mqttRetainMaxMemory(Integer mqttRetainMaxMemory) { - - this.mqttRetainMaxMemory = mqttRetainMaxMemory; - return this; - } - - /** - * The maximum total memory usage of the MQTT Retain feature for this Message VPN, in MB. If the maximum memory is reached, any arriving retain messages that require more memory are discarded. A value of -1 indicates that the memory is bounded only by the global max memory limit. A value of 0 prevents MQTT Retain from becoming operational. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. Available since 2.11. - * @return mqttRetainMaxMemory - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MQTT_RETAIN_MAX_MEMORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getMqttRetainMaxMemory() { - return mqttRetainMaxMemory; - } - - - @JsonProperty(JSON_PROPERTY_MQTT_RETAIN_MAX_MEMORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMqttRetainMaxMemory(Integer mqttRetainMaxMemory) { - this.mqttRetainMaxMemory = mqttRetainMaxMemory; - } - - - public MsgVpn msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpn replicationAckPropagationIntervalMsgCount(Long replicationAckPropagationIntervalMsgCount) { - - this.replicationAckPropagationIntervalMsgCount = replicationAckPropagationIntervalMsgCount; - return this; - } - - /** - * The acknowledgement (ACK) propagation interval for the replication Bridge, in number of replicated messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20`. - * @return replicationAckPropagationIntervalMsgCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_ACK_PROPAGATION_INTERVAL_MSG_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getReplicationAckPropagationIntervalMsgCount() { - return replicationAckPropagationIntervalMsgCount; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_ACK_PROPAGATION_INTERVAL_MSG_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationAckPropagationIntervalMsgCount(Long replicationAckPropagationIntervalMsgCount) { - this.replicationAckPropagationIntervalMsgCount = replicationAckPropagationIntervalMsgCount; - } - - - public MsgVpn replicationBridgeAuthenticationBasicClientUsername(String replicationBridgeAuthenticationBasicClientUsername) { - - this.replicationBridgeAuthenticationBasicClientUsername = replicationBridgeAuthenticationBasicClientUsername; - return this; - } - - /** - * The Client Username the replication Bridge uses to login to the remote Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return replicationBridgeAuthenticationBasicClientUsername - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_BASIC_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getReplicationBridgeAuthenticationBasicClientUsername() { - return replicationBridgeAuthenticationBasicClientUsername; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_BASIC_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationBridgeAuthenticationBasicClientUsername(String replicationBridgeAuthenticationBasicClientUsername) { - this.replicationBridgeAuthenticationBasicClientUsername = replicationBridgeAuthenticationBasicClientUsername; - } - - - public MsgVpn replicationBridgeAuthenticationBasicPassword(String replicationBridgeAuthenticationBasicPassword) { - - this.replicationBridgeAuthenticationBasicPassword = replicationBridgeAuthenticationBasicPassword; - return this; - } - - /** - * The password for the Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return replicationBridgeAuthenticationBasicPassword - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_BASIC_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getReplicationBridgeAuthenticationBasicPassword() { - return replicationBridgeAuthenticationBasicPassword; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_BASIC_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationBridgeAuthenticationBasicPassword(String replicationBridgeAuthenticationBasicPassword) { - this.replicationBridgeAuthenticationBasicPassword = replicationBridgeAuthenticationBasicPassword; - } - - - public MsgVpn replicationBridgeAuthenticationClientCertContent(String replicationBridgeAuthenticationClientCertContent) { - - this.replicationBridgeAuthenticationClientCertContent = replicationBridgeAuthenticationClientCertContent; - return this; - } - - /** - * The PEM formatted content for the client certificate used by this bridge to login to the Remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9. - * @return replicationBridgeAuthenticationClientCertContent - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_CLIENT_CERT_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getReplicationBridgeAuthenticationClientCertContent() { - return replicationBridgeAuthenticationClientCertContent; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_CLIENT_CERT_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationBridgeAuthenticationClientCertContent(String replicationBridgeAuthenticationClientCertContent) { - this.replicationBridgeAuthenticationClientCertContent = replicationBridgeAuthenticationClientCertContent; - } - - - public MsgVpn replicationBridgeAuthenticationClientCertPassword(String replicationBridgeAuthenticationClientCertPassword) { - - this.replicationBridgeAuthenticationClientCertPassword = replicationBridgeAuthenticationClientCertPassword; - return this; - } - - /** - * The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9. - * @return replicationBridgeAuthenticationClientCertPassword - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_CLIENT_CERT_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getReplicationBridgeAuthenticationClientCertPassword() { - return replicationBridgeAuthenticationClientCertPassword; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_CLIENT_CERT_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationBridgeAuthenticationClientCertPassword(String replicationBridgeAuthenticationClientCertPassword) { - this.replicationBridgeAuthenticationClientCertPassword = replicationBridgeAuthenticationClientCertPassword; - } - - - public MsgVpn replicationBridgeAuthenticationScheme(ReplicationBridgeAuthenticationSchemeEnum replicationBridgeAuthenticationScheme) { - - this.replicationBridgeAuthenticationScheme = replicationBridgeAuthenticationScheme; - return this; - } - - /** - * The authentication scheme for the replication Bridge in the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"basic\"`. The allowed values and their meaning are: <pre> \"basic\" - Basic Authentication Scheme (via username and password). \"client-certificate\" - Client Certificate Authentication Scheme (via certificate file or content). </pre> - * @return replicationBridgeAuthenticationScheme - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_SCHEME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ReplicationBridgeAuthenticationSchemeEnum getReplicationBridgeAuthenticationScheme() { - return replicationBridgeAuthenticationScheme; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_AUTHENTICATION_SCHEME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationBridgeAuthenticationScheme(ReplicationBridgeAuthenticationSchemeEnum replicationBridgeAuthenticationScheme) { - this.replicationBridgeAuthenticationScheme = replicationBridgeAuthenticationScheme; - } - - - public MsgVpn replicationBridgeCompressedDataEnabled(Boolean replicationBridgeCompressedDataEnabled) { - - this.replicationBridgeCompressedDataEnabled = replicationBridgeCompressedDataEnabled; - return this; - } - - /** - * Enable or disable use of compression for the replication Bridge. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - * @return replicationBridgeCompressedDataEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_COMPRESSED_DATA_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getReplicationBridgeCompressedDataEnabled() { - return replicationBridgeCompressedDataEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_COMPRESSED_DATA_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationBridgeCompressedDataEnabled(Boolean replicationBridgeCompressedDataEnabled) { - this.replicationBridgeCompressedDataEnabled = replicationBridgeCompressedDataEnabled; - } - - - public MsgVpn replicationBridgeEgressFlowWindowSize(Long replicationBridgeEgressFlowWindowSize) { - - this.replicationBridgeEgressFlowWindowSize = replicationBridgeEgressFlowWindowSize; - return this; - } - - /** - * The size of the window used for guaranteed messages published to the replication Bridge, in messages. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`. - * @return replicationBridgeEgressFlowWindowSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_EGRESS_FLOW_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getReplicationBridgeEgressFlowWindowSize() { - return replicationBridgeEgressFlowWindowSize; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_EGRESS_FLOW_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationBridgeEgressFlowWindowSize(Long replicationBridgeEgressFlowWindowSize) { - this.replicationBridgeEgressFlowWindowSize = replicationBridgeEgressFlowWindowSize; - } - - - public MsgVpn replicationBridgeRetryDelay(Long replicationBridgeRetryDelay) { - - this.replicationBridgeRetryDelay = replicationBridgeRetryDelay; - return this; - } - - /** - * The number of seconds that must pass before retrying the replication Bridge connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`. - * @return replicationBridgeRetryDelay - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_RETRY_DELAY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getReplicationBridgeRetryDelay() { - return replicationBridgeRetryDelay; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_RETRY_DELAY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationBridgeRetryDelay(Long replicationBridgeRetryDelay) { - this.replicationBridgeRetryDelay = replicationBridgeRetryDelay; - } - - - public MsgVpn replicationBridgeTlsEnabled(Boolean replicationBridgeTlsEnabled) { - - this.replicationBridgeTlsEnabled = replicationBridgeTlsEnabled; - return this; - } - - /** - * Enable or disable use of encryption (TLS) for the replication Bridge connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - * @return replicationBridgeTlsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getReplicationBridgeTlsEnabled() { - return replicationBridgeTlsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationBridgeTlsEnabled(Boolean replicationBridgeTlsEnabled) { - this.replicationBridgeTlsEnabled = replicationBridgeTlsEnabled; - } - - - public MsgVpn replicationBridgeUnidirectionalClientProfileName(String replicationBridgeUnidirectionalClientProfileName) { - - this.replicationBridgeUnidirectionalClientProfileName = replicationBridgeUnidirectionalClientProfileName; - return this; - } - - /** - * The Client Profile for the unidirectional replication Bridge in the Message VPN. It is used only for the TCP parameters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#client-profile\"`. - * @return replicationBridgeUnidirectionalClientProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_UNIDIRECTIONAL_CLIENT_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getReplicationBridgeUnidirectionalClientProfileName() { - return replicationBridgeUnidirectionalClientProfileName; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_BRIDGE_UNIDIRECTIONAL_CLIENT_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationBridgeUnidirectionalClientProfileName(String replicationBridgeUnidirectionalClientProfileName) { - this.replicationBridgeUnidirectionalClientProfileName = replicationBridgeUnidirectionalClientProfileName; - } - - - public MsgVpn replicationEnabled(Boolean replicationEnabled) { - - this.replicationEnabled = replicationEnabled; - return this; - } - - /** - * Enable or disable replication for the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - * @return replicationEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getReplicationEnabled() { - return replicationEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationEnabled(Boolean replicationEnabled) { - this.replicationEnabled = replicationEnabled; - } - - - public MsgVpn replicationEnabledQueueBehavior(ReplicationEnabledQueueBehaviorEnum replicationEnabledQueueBehavior) { - - this.replicationEnabledQueueBehavior = replicationEnabledQueueBehavior; - return this; - } - - /** - * The behavior to take when enabling replication for the Message VPN, depending on the existence of the replication Queue. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"fail-on-existing-queue\"`. The allowed values and their meaning are: <pre> \"fail-on-existing-queue\" - The data replication queue must not already exist. \"force-use-existing-queue\" - The data replication queue must already exist. Any data messages on the Queue will be forwarded to interested applications. IMPORTANT: Before using this mode be certain that the messages are not stale or otherwise unsuitable to be forwarded. This mode can only be specified when the existing queue is configured the same as is currently specified under replication configuration otherwise the enabling of replication will fail. \"force-recreate-queue\" - The data replication queue must already exist. Any data messages on the Queue will be discarded. IMPORTANT: Before using this mode be certain that the messages on the existing data replication queue are not needed by interested applications. </pre> - * @return replicationEnabledQueueBehavior - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_ENABLED_QUEUE_BEHAVIOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ReplicationEnabledQueueBehaviorEnum getReplicationEnabledQueueBehavior() { - return replicationEnabledQueueBehavior; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_ENABLED_QUEUE_BEHAVIOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationEnabledQueueBehavior(ReplicationEnabledQueueBehaviorEnum replicationEnabledQueueBehavior) { - this.replicationEnabledQueueBehavior = replicationEnabledQueueBehavior; - } - - - public MsgVpn replicationQueueMaxMsgSpoolUsage(Long replicationQueueMaxMsgSpoolUsage) { - - this.replicationQueueMaxMsgSpoolUsage = replicationQueueMaxMsgSpoolUsage; - return this; - } - - /** - * The maximum message spool usage by the replication Bridge local Queue (quota), in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `60000`. - * @return replicationQueueMaxMsgSpoolUsage - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_QUEUE_MAX_MSG_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getReplicationQueueMaxMsgSpoolUsage() { - return replicationQueueMaxMsgSpoolUsage; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_QUEUE_MAX_MSG_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationQueueMaxMsgSpoolUsage(Long replicationQueueMaxMsgSpoolUsage) { - this.replicationQueueMaxMsgSpoolUsage = replicationQueueMaxMsgSpoolUsage; - } - - - public MsgVpn replicationQueueRejectMsgToSenderOnDiscardEnabled(Boolean replicationQueueRejectMsgToSenderOnDiscardEnabled) { - - this.replicationQueueRejectMsgToSenderOnDiscardEnabled = replicationQueueRejectMsgToSenderOnDiscardEnabled; - return this; - } - - /** - * Enable or disable whether messages discarded on the replication Bridge local Queue are rejected back to the sender. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return replicationQueueRejectMsgToSenderOnDiscardEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_QUEUE_REJECT_MSG_TO_SENDER_ON_DISCARD_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getReplicationQueueRejectMsgToSenderOnDiscardEnabled() { - return replicationQueueRejectMsgToSenderOnDiscardEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_QUEUE_REJECT_MSG_TO_SENDER_ON_DISCARD_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationQueueRejectMsgToSenderOnDiscardEnabled(Boolean replicationQueueRejectMsgToSenderOnDiscardEnabled) { - this.replicationQueueRejectMsgToSenderOnDiscardEnabled = replicationQueueRejectMsgToSenderOnDiscardEnabled; - } - - - public MsgVpn replicationRejectMsgWhenSyncIneligibleEnabled(Boolean replicationRejectMsgWhenSyncIneligibleEnabled) { - - this.replicationRejectMsgWhenSyncIneligibleEnabled = replicationRejectMsgWhenSyncIneligibleEnabled; - return this; - } - - /** - * Enable or disable whether guaranteed messages published to synchronously replicated Topics are rejected back to the sender when synchronous replication becomes ineligible. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return replicationRejectMsgWhenSyncIneligibleEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_REJECT_MSG_WHEN_SYNC_INELIGIBLE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getReplicationRejectMsgWhenSyncIneligibleEnabled() { - return replicationRejectMsgWhenSyncIneligibleEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_REJECT_MSG_WHEN_SYNC_INELIGIBLE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationRejectMsgWhenSyncIneligibleEnabled(Boolean replicationRejectMsgWhenSyncIneligibleEnabled) { - this.replicationRejectMsgWhenSyncIneligibleEnabled = replicationRejectMsgWhenSyncIneligibleEnabled; - } - - - public MsgVpn replicationRole(ReplicationRoleEnum replicationRole) { - - this.replicationRole = replicationRole; - return this; - } - - /** - * The replication role for the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"standby\"`. The allowed values and their meaning are: <pre> \"active\" - Assume the Active role in replication for the Message VPN. \"standby\" - Assume the Standby role in replication for the Message VPN. </pre> - * @return replicationRole - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_ROLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ReplicationRoleEnum getReplicationRole() { - return replicationRole; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_ROLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationRole(ReplicationRoleEnum replicationRole) { - this.replicationRole = replicationRole; - } - - - public MsgVpn replicationTransactionMode(ReplicationTransactionModeEnum replicationTransactionMode) { - - this.replicationTransactionMode = replicationTransactionMode; - return this; - } - - /** - * The transaction replication mode for all transactions within the Message VPN. Changing this value during operation will not affect existing transactions; it is only used upon starting a transaction. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"async\"`. The allowed values and their meaning are: <pre> \"sync\" - Messages are acknowledged when replicated (spooled remotely). \"async\" - Messages are acknowledged when pending replication (spooled locally). </pre> - * @return replicationTransactionMode - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_TRANSACTION_MODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ReplicationTransactionModeEnum getReplicationTransactionMode() { - return replicationTransactionMode; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_TRANSACTION_MODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationTransactionMode(ReplicationTransactionModeEnum replicationTransactionMode) { - this.replicationTransactionMode = replicationTransactionMode; - } - - - public MsgVpn restTlsServerCertEnforceTrustedCommonNameEnabled(Boolean restTlsServerCertEnforceTrustedCommonNameEnabled) { - - this.restTlsServerCertEnforceTrustedCommonNameEnabled = restTlsServerCertEnforceTrustedCommonNameEnabled; - return this; - } - - /** - * Enable or disable validation of the Common Name (CN) in the server certificate from the remote REST Consumer. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the REST Consumer. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation. - * @return restTlsServerCertEnforceTrustedCommonNameEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REST_TLS_SERVER_CERT_ENFORCE_TRUSTED_COMMON_NAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRestTlsServerCertEnforceTrustedCommonNameEnabled() { - return restTlsServerCertEnforceTrustedCommonNameEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REST_TLS_SERVER_CERT_ENFORCE_TRUSTED_COMMON_NAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRestTlsServerCertEnforceTrustedCommonNameEnabled(Boolean restTlsServerCertEnforceTrustedCommonNameEnabled) { - this.restTlsServerCertEnforceTrustedCommonNameEnabled = restTlsServerCertEnforceTrustedCommonNameEnabled; - } - - - public MsgVpn restTlsServerCertMaxChainDepth(Long restTlsServerCertMaxChainDepth) { - - this.restTlsServerCertMaxChainDepth = restTlsServerCertMaxChainDepth; - return this; - } - - /** - * The maximum depth for a REST Consumer server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. - * @return restTlsServerCertMaxChainDepth - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REST_TLS_SERVER_CERT_MAX_CHAIN_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getRestTlsServerCertMaxChainDepth() { - return restTlsServerCertMaxChainDepth; - } - - - @JsonProperty(JSON_PROPERTY_REST_TLS_SERVER_CERT_MAX_CHAIN_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRestTlsServerCertMaxChainDepth(Long restTlsServerCertMaxChainDepth) { - this.restTlsServerCertMaxChainDepth = restTlsServerCertMaxChainDepth; - } - - - public MsgVpn restTlsServerCertValidateDateEnabled(Boolean restTlsServerCertValidateDateEnabled) { - - this.restTlsServerCertValidateDateEnabled = restTlsServerCertValidateDateEnabled; - return this; - } - - /** - * Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the REST Consumer server certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return restTlsServerCertValidateDateEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REST_TLS_SERVER_CERT_VALIDATE_DATE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRestTlsServerCertValidateDateEnabled() { - return restTlsServerCertValidateDateEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REST_TLS_SERVER_CERT_VALIDATE_DATE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRestTlsServerCertValidateDateEnabled(Boolean restTlsServerCertValidateDateEnabled) { - this.restTlsServerCertValidateDateEnabled = restTlsServerCertValidateDateEnabled; - } - - - public MsgVpn restTlsServerCertValidateNameEnabled(Boolean restTlsServerCertValidateNameEnabled) { - - this.restTlsServerCertValidateNameEnabled = restTlsServerCertValidateNameEnabled; - return this; - } - - /** - * Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the remote REST Consumer. If enabled, the name used to connect to the remote REST Consumer is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.17. - * @return restTlsServerCertValidateNameEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REST_TLS_SERVER_CERT_VALIDATE_NAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRestTlsServerCertValidateNameEnabled() { - return restTlsServerCertValidateNameEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REST_TLS_SERVER_CERT_VALIDATE_NAME_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRestTlsServerCertValidateNameEnabled(Boolean restTlsServerCertValidateNameEnabled) { - this.restTlsServerCertValidateNameEnabled = restTlsServerCertValidateNameEnabled; - } - - - public MsgVpn sempOverMsgBusAdminClientEnabled(Boolean sempOverMsgBusAdminClientEnabled) { - - this.sempOverMsgBusAdminClientEnabled = sempOverMsgBusAdminClientEnabled; - return this; - } - - /** - * Enable or disable \"admin client\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return sempOverMsgBusAdminClientEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SEMP_OVER_MSG_BUS_ADMIN_CLIENT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getSempOverMsgBusAdminClientEnabled() { - return sempOverMsgBusAdminClientEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SEMP_OVER_MSG_BUS_ADMIN_CLIENT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSempOverMsgBusAdminClientEnabled(Boolean sempOverMsgBusAdminClientEnabled) { - this.sempOverMsgBusAdminClientEnabled = sempOverMsgBusAdminClientEnabled; - } - - - public MsgVpn sempOverMsgBusAdminDistributedCacheEnabled(Boolean sempOverMsgBusAdminDistributedCacheEnabled) { - - this.sempOverMsgBusAdminDistributedCacheEnabled = sempOverMsgBusAdminDistributedCacheEnabled; - return this; - } - - /** - * Enable or disable \"admin distributed-cache\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return sempOverMsgBusAdminDistributedCacheEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SEMP_OVER_MSG_BUS_ADMIN_DISTRIBUTED_CACHE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getSempOverMsgBusAdminDistributedCacheEnabled() { - return sempOverMsgBusAdminDistributedCacheEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SEMP_OVER_MSG_BUS_ADMIN_DISTRIBUTED_CACHE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSempOverMsgBusAdminDistributedCacheEnabled(Boolean sempOverMsgBusAdminDistributedCacheEnabled) { - this.sempOverMsgBusAdminDistributedCacheEnabled = sempOverMsgBusAdminDistributedCacheEnabled; - } - - - public MsgVpn sempOverMsgBusAdminEnabled(Boolean sempOverMsgBusAdminEnabled) { - - this.sempOverMsgBusAdminEnabled = sempOverMsgBusAdminEnabled; - return this; - } - - /** - * Enable or disable \"admin\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return sempOverMsgBusAdminEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SEMP_OVER_MSG_BUS_ADMIN_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getSempOverMsgBusAdminEnabled() { - return sempOverMsgBusAdminEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SEMP_OVER_MSG_BUS_ADMIN_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSempOverMsgBusAdminEnabled(Boolean sempOverMsgBusAdminEnabled) { - this.sempOverMsgBusAdminEnabled = sempOverMsgBusAdminEnabled; - } - - - public MsgVpn sempOverMsgBusEnabled(Boolean sempOverMsgBusEnabled) { - - this.sempOverMsgBusEnabled = sempOverMsgBusEnabled; - return this; - } - - /** - * Enable or disable SEMP over the message bus for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return sempOverMsgBusEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SEMP_OVER_MSG_BUS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getSempOverMsgBusEnabled() { - return sempOverMsgBusEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SEMP_OVER_MSG_BUS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSempOverMsgBusEnabled(Boolean sempOverMsgBusEnabled) { - this.sempOverMsgBusEnabled = sempOverMsgBusEnabled; - } - - - public MsgVpn sempOverMsgBusShowEnabled(Boolean sempOverMsgBusShowEnabled) { - - this.sempOverMsgBusShowEnabled = sempOverMsgBusShowEnabled; - return this; - } - - /** - * Enable or disable \"show\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return sempOverMsgBusShowEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SEMP_OVER_MSG_BUS_SHOW_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getSempOverMsgBusShowEnabled() { - return sempOverMsgBusShowEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SEMP_OVER_MSG_BUS_SHOW_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSempOverMsgBusShowEnabled(Boolean sempOverMsgBusShowEnabled) { - this.sempOverMsgBusShowEnabled = sempOverMsgBusShowEnabled; - } - - - public MsgVpn serviceAmqpMaxConnectionCount(Long serviceAmqpMaxConnectionCount) { - - this.serviceAmqpMaxConnectionCount = serviceAmqpMaxConnectionCount; - return this; - } - - /** - * The maximum number of AMQP client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.7. - * @return serviceAmqpMaxConnectionCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_AMQP_MAX_CONNECTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceAmqpMaxConnectionCount() { - return serviceAmqpMaxConnectionCount; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_AMQP_MAX_CONNECTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceAmqpMaxConnectionCount(Long serviceAmqpMaxConnectionCount) { - this.serviceAmqpMaxConnectionCount = serviceAmqpMaxConnectionCount; - } - - - public MsgVpn serviceAmqpPlainTextEnabled(Boolean serviceAmqpPlainTextEnabled) { - - this.serviceAmqpPlainTextEnabled = serviceAmqpPlainTextEnabled; - return this; - } - - /** - * Enable or disable the plain-text AMQP service in the Message VPN. Disabling causes clients connected to the corresponding listen-port to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.7. - * @return serviceAmqpPlainTextEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_AMQP_PLAIN_TEXT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceAmqpPlainTextEnabled() { - return serviceAmqpPlainTextEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_AMQP_PLAIN_TEXT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceAmqpPlainTextEnabled(Boolean serviceAmqpPlainTextEnabled) { - this.serviceAmqpPlainTextEnabled = serviceAmqpPlainTextEnabled; - } - - - public MsgVpn serviceAmqpPlainTextListenPort(Long serviceAmqpPlainTextListenPort) { - - this.serviceAmqpPlainTextListenPort = serviceAmqpPlainTextListenPort; - return this; - } - - /** - * The port number for plain-text AMQP clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.7. - * @return serviceAmqpPlainTextListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_AMQP_PLAIN_TEXT_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceAmqpPlainTextListenPort() { - return serviceAmqpPlainTextListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_AMQP_PLAIN_TEXT_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceAmqpPlainTextListenPort(Long serviceAmqpPlainTextListenPort) { - this.serviceAmqpPlainTextListenPort = serviceAmqpPlainTextListenPort; - } - - - public MsgVpn serviceAmqpTlsEnabled(Boolean serviceAmqpTlsEnabled) { - - this.serviceAmqpTlsEnabled = serviceAmqpTlsEnabled; - return this; - } - - /** - * Enable or disable the use of encryption (TLS) for the AMQP service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.7. - * @return serviceAmqpTlsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_AMQP_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceAmqpTlsEnabled() { - return serviceAmqpTlsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_AMQP_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceAmqpTlsEnabled(Boolean serviceAmqpTlsEnabled) { - this.serviceAmqpTlsEnabled = serviceAmqpTlsEnabled; - } - - - public MsgVpn serviceAmqpTlsListenPort(Long serviceAmqpTlsListenPort) { - - this.serviceAmqpTlsListenPort = serviceAmqpTlsListenPort; - return this; - } - - /** - * The port number for AMQP clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.7. - * @return serviceAmqpTlsListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_AMQP_TLS_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceAmqpTlsListenPort() { - return serviceAmqpTlsListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_AMQP_TLS_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceAmqpTlsListenPort(Long serviceAmqpTlsListenPort) { - this.serviceAmqpTlsListenPort = serviceAmqpTlsListenPort; - } - - - public MsgVpn serviceMqttAuthenticationClientCertRequest(ServiceMqttAuthenticationClientCertRequestEnum serviceMqttAuthenticationClientCertRequest) { - - this.serviceMqttAuthenticationClientCertRequest = serviceMqttAuthenticationClientCertRequest; - return this; - } - - /** - * Determines when to request a client certificate from an incoming MQTT client connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-enabled-in-message-vpn\"`. The allowed values and their meaning are: <pre> \"always\" - Always ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"never\" - Never ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"when-enabled-in-message-vpn\" - Only ask for a client-certificate if client certificate authentication is enabled under \"message-vpn > authentication > client-certificate > shutdown\". </pre> Available since 2.21. - * @return serviceMqttAuthenticationClientCertRequest - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_AUTHENTICATION_CLIENT_CERT_REQUEST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ServiceMqttAuthenticationClientCertRequestEnum getServiceMqttAuthenticationClientCertRequest() { - return serviceMqttAuthenticationClientCertRequest; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_AUTHENTICATION_CLIENT_CERT_REQUEST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceMqttAuthenticationClientCertRequest(ServiceMqttAuthenticationClientCertRequestEnum serviceMqttAuthenticationClientCertRequest) { - this.serviceMqttAuthenticationClientCertRequest = serviceMqttAuthenticationClientCertRequest; - } - - - public MsgVpn serviceMqttMaxConnectionCount(Long serviceMqttMaxConnectionCount) { - - this.serviceMqttMaxConnectionCount = serviceMqttMaxConnectionCount; - return this; - } - - /** - * The maximum number of MQTT client connections that can be simultaneously connected to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.1. - * @return serviceMqttMaxConnectionCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_MAX_CONNECTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceMqttMaxConnectionCount() { - return serviceMqttMaxConnectionCount; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_MAX_CONNECTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceMqttMaxConnectionCount(Long serviceMqttMaxConnectionCount) { - this.serviceMqttMaxConnectionCount = serviceMqttMaxConnectionCount; - } - - - public MsgVpn serviceMqttPlainTextEnabled(Boolean serviceMqttPlainTextEnabled) { - - this.serviceMqttPlainTextEnabled = serviceMqttPlainTextEnabled; - return this; - } - - /** - * Enable or disable the plain-text MQTT service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1. - * @return serviceMqttPlainTextEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_PLAIN_TEXT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceMqttPlainTextEnabled() { - return serviceMqttPlainTextEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_PLAIN_TEXT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceMqttPlainTextEnabled(Boolean serviceMqttPlainTextEnabled) { - this.serviceMqttPlainTextEnabled = serviceMqttPlainTextEnabled; - } - - - public MsgVpn serviceMqttPlainTextListenPort(Long serviceMqttPlainTextListenPort) { - - this.serviceMqttPlainTextListenPort = serviceMqttPlainTextListenPort; - return this; - } - - /** - * The port number for plain-text MQTT clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1. - * @return serviceMqttPlainTextListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_PLAIN_TEXT_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceMqttPlainTextListenPort() { - return serviceMqttPlainTextListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_PLAIN_TEXT_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceMqttPlainTextListenPort(Long serviceMqttPlainTextListenPort) { - this.serviceMqttPlainTextListenPort = serviceMqttPlainTextListenPort; - } - - - public MsgVpn serviceMqttTlsEnabled(Boolean serviceMqttTlsEnabled) { - - this.serviceMqttTlsEnabled = serviceMqttTlsEnabled; - return this; - } - - /** - * Enable or disable the use of encryption (TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1. - * @return serviceMqttTlsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceMqttTlsEnabled() { - return serviceMqttTlsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceMqttTlsEnabled(Boolean serviceMqttTlsEnabled) { - this.serviceMqttTlsEnabled = serviceMqttTlsEnabled; - } - - - public MsgVpn serviceMqttTlsListenPort(Long serviceMqttTlsListenPort) { - - this.serviceMqttTlsListenPort = serviceMqttTlsListenPort; - return this; - } - - /** - * The port number for MQTT clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1. - * @return serviceMqttTlsListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_TLS_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceMqttTlsListenPort() { - return serviceMqttTlsListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_TLS_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceMqttTlsListenPort(Long serviceMqttTlsListenPort) { - this.serviceMqttTlsListenPort = serviceMqttTlsListenPort; - } - - - public MsgVpn serviceMqttTlsWebSocketEnabled(Boolean serviceMqttTlsWebSocketEnabled) { - - this.serviceMqttTlsWebSocketEnabled = serviceMqttTlsWebSocketEnabled; - return this; - } - - /** - * Enable or disable the use of encrypted WebSocket (WebSocket over TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected by encrypted WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1. - * @return serviceMqttTlsWebSocketEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_TLS_WEB_SOCKET_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceMqttTlsWebSocketEnabled() { - return serviceMqttTlsWebSocketEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_TLS_WEB_SOCKET_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceMqttTlsWebSocketEnabled(Boolean serviceMqttTlsWebSocketEnabled) { - this.serviceMqttTlsWebSocketEnabled = serviceMqttTlsWebSocketEnabled; - } - - - public MsgVpn serviceMqttTlsWebSocketListenPort(Long serviceMqttTlsWebSocketListenPort) { - - this.serviceMqttTlsWebSocketListenPort = serviceMqttTlsWebSocketListenPort; - return this; - } - - /** - * The port number for MQTT clients that connect to the Message VPN using WebSocket over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1. - * @return serviceMqttTlsWebSocketListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_TLS_WEB_SOCKET_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceMqttTlsWebSocketListenPort() { - return serviceMqttTlsWebSocketListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_TLS_WEB_SOCKET_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceMqttTlsWebSocketListenPort(Long serviceMqttTlsWebSocketListenPort) { - this.serviceMqttTlsWebSocketListenPort = serviceMqttTlsWebSocketListenPort; - } - - - public MsgVpn serviceMqttWebSocketEnabled(Boolean serviceMqttWebSocketEnabled) { - - this.serviceMqttWebSocketEnabled = serviceMqttWebSocketEnabled; - return this; - } - - /** - * Enable or disable the use of WebSocket for the MQTT service in the Message VPN. Disabling causes clients currently connected by WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1. - * @return serviceMqttWebSocketEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_WEB_SOCKET_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceMqttWebSocketEnabled() { - return serviceMqttWebSocketEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_WEB_SOCKET_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceMqttWebSocketEnabled(Boolean serviceMqttWebSocketEnabled) { - this.serviceMqttWebSocketEnabled = serviceMqttWebSocketEnabled; - } - - - public MsgVpn serviceMqttWebSocketListenPort(Long serviceMqttWebSocketListenPort) { - - this.serviceMqttWebSocketListenPort = serviceMqttWebSocketListenPort; - return this; - } - - /** - * The port number for plain-text MQTT clients that connect to the Message VPN using WebSocket. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1. - * @return serviceMqttWebSocketListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_WEB_SOCKET_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceMqttWebSocketListenPort() { - return serviceMqttWebSocketListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_MQTT_WEB_SOCKET_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceMqttWebSocketListenPort(Long serviceMqttWebSocketListenPort) { - this.serviceMqttWebSocketListenPort = serviceMqttWebSocketListenPort; - } - - - public MsgVpn serviceRestIncomingAuthenticationClientCertRequest(ServiceRestIncomingAuthenticationClientCertRequestEnum serviceRestIncomingAuthenticationClientCertRequest) { - - this.serviceRestIncomingAuthenticationClientCertRequest = serviceRestIncomingAuthenticationClientCertRequest; - return this; - } - - /** - * Determines when to request a client certificate from an incoming REST Producer connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-enabled-in-message-vpn\"`. The allowed values and their meaning are: <pre> \"always\" - Always ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"never\" - Never ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"when-enabled-in-message-vpn\" - Only ask for a client-certificate if client certificate authentication is enabled under \"message-vpn > authentication > client-certificate > shutdown\". </pre> Available since 2.21. - * @return serviceRestIncomingAuthenticationClientCertRequest - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_REST_INCOMING_AUTHENTICATION_CLIENT_CERT_REQUEST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ServiceRestIncomingAuthenticationClientCertRequestEnum getServiceRestIncomingAuthenticationClientCertRequest() { - return serviceRestIncomingAuthenticationClientCertRequest; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_REST_INCOMING_AUTHENTICATION_CLIENT_CERT_REQUEST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceRestIncomingAuthenticationClientCertRequest(ServiceRestIncomingAuthenticationClientCertRequestEnum serviceRestIncomingAuthenticationClientCertRequest) { - this.serviceRestIncomingAuthenticationClientCertRequest = serviceRestIncomingAuthenticationClientCertRequest; - } - - - public MsgVpn serviceRestIncomingAuthorizationHeaderHandling(ServiceRestIncomingAuthorizationHeaderHandlingEnum serviceRestIncomingAuthorizationHeaderHandling) { - - this.serviceRestIncomingAuthorizationHeaderHandling = serviceRestIncomingAuthorizationHeaderHandling; - return this; - } - - /** - * The handling of Authorization headers for incoming REST connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"drop\"`. The allowed values and their meaning are: <pre> \"drop\" - Do not attach the Authorization header to the message as a user property. This configuration is most secure. \"forward\" - Forward the Authorization header, attaching it to the message as a user property in the same way as other headers. For best security, use the drop setting. \"legacy\" - If the Authorization header was used for authentication to the broker, do not attach it to the message. If the Authorization header was not used for authentication to the broker, attach it to the message as a user property in the same way as other headers. For best security, use the drop setting. </pre> Available since 2.19. - * @return serviceRestIncomingAuthorizationHeaderHandling - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_REST_INCOMING_AUTHORIZATION_HEADER_HANDLING) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ServiceRestIncomingAuthorizationHeaderHandlingEnum getServiceRestIncomingAuthorizationHeaderHandling() { - return serviceRestIncomingAuthorizationHeaderHandling; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_REST_INCOMING_AUTHORIZATION_HEADER_HANDLING) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceRestIncomingAuthorizationHeaderHandling(ServiceRestIncomingAuthorizationHeaderHandlingEnum serviceRestIncomingAuthorizationHeaderHandling) { - this.serviceRestIncomingAuthorizationHeaderHandling = serviceRestIncomingAuthorizationHeaderHandling; - } - - - public MsgVpn serviceRestIncomingMaxConnectionCount(Long serviceRestIncomingMaxConnectionCount) { - - this.serviceRestIncomingMaxConnectionCount = serviceRestIncomingMaxConnectionCount; - return this; - } - - /** - * The maximum number of REST incoming client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. - * @return serviceRestIncomingMaxConnectionCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_REST_INCOMING_MAX_CONNECTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceRestIncomingMaxConnectionCount() { - return serviceRestIncomingMaxConnectionCount; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_REST_INCOMING_MAX_CONNECTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceRestIncomingMaxConnectionCount(Long serviceRestIncomingMaxConnectionCount) { - this.serviceRestIncomingMaxConnectionCount = serviceRestIncomingMaxConnectionCount; - } - - - public MsgVpn serviceRestIncomingPlainTextEnabled(Boolean serviceRestIncomingPlainTextEnabled) { - - this.serviceRestIncomingPlainTextEnabled = serviceRestIncomingPlainTextEnabled; - return this; - } - - /** - * Enable or disable the plain-text REST service for incoming clients in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return serviceRestIncomingPlainTextEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_REST_INCOMING_PLAIN_TEXT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceRestIncomingPlainTextEnabled() { - return serviceRestIncomingPlainTextEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_REST_INCOMING_PLAIN_TEXT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceRestIncomingPlainTextEnabled(Boolean serviceRestIncomingPlainTextEnabled) { - this.serviceRestIncomingPlainTextEnabled = serviceRestIncomingPlainTextEnabled; - } - - - public MsgVpn serviceRestIncomingPlainTextListenPort(Long serviceRestIncomingPlainTextListenPort) { - - this.serviceRestIncomingPlainTextListenPort = serviceRestIncomingPlainTextListenPort; - return this; - } - - /** - * The port number for incoming plain-text REST clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return serviceRestIncomingPlainTextListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_REST_INCOMING_PLAIN_TEXT_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceRestIncomingPlainTextListenPort() { - return serviceRestIncomingPlainTextListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_REST_INCOMING_PLAIN_TEXT_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceRestIncomingPlainTextListenPort(Long serviceRestIncomingPlainTextListenPort) { - this.serviceRestIncomingPlainTextListenPort = serviceRestIncomingPlainTextListenPort; - } - - - public MsgVpn serviceRestIncomingTlsEnabled(Boolean serviceRestIncomingTlsEnabled) { - - this.serviceRestIncomingTlsEnabled = serviceRestIncomingTlsEnabled; - return this; - } - - /** - * Enable or disable the use of encryption (TLS) for the REST service for incoming clients in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return serviceRestIncomingTlsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_REST_INCOMING_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceRestIncomingTlsEnabled() { - return serviceRestIncomingTlsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_REST_INCOMING_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceRestIncomingTlsEnabled(Boolean serviceRestIncomingTlsEnabled) { - this.serviceRestIncomingTlsEnabled = serviceRestIncomingTlsEnabled; - } - - - public MsgVpn serviceRestIncomingTlsListenPort(Long serviceRestIncomingTlsListenPort) { - - this.serviceRestIncomingTlsListenPort = serviceRestIncomingTlsListenPort; - return this; - } - - /** - * The port number for incoming REST clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return serviceRestIncomingTlsListenPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_REST_INCOMING_TLS_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceRestIncomingTlsListenPort() { - return serviceRestIncomingTlsListenPort; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_REST_INCOMING_TLS_LISTEN_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceRestIncomingTlsListenPort(Long serviceRestIncomingTlsListenPort) { - this.serviceRestIncomingTlsListenPort = serviceRestIncomingTlsListenPort; - } - - - public MsgVpn serviceRestMode(ServiceRestModeEnum serviceRestMode) { - - this.serviceRestMode = serviceRestMode; - return this; - } - - /** - * The REST service mode for incoming REST clients that connect to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"messaging\"`. The allowed values and their meaning are: <pre> \"gateway\" - Act as a message gateway through which REST messages are propagated. \"messaging\" - Act as a message broker on which REST messages are queued. </pre> Available since 2.6. - * @return serviceRestMode - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_REST_MODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ServiceRestModeEnum getServiceRestMode() { - return serviceRestMode; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_REST_MODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceRestMode(ServiceRestModeEnum serviceRestMode) { - this.serviceRestMode = serviceRestMode; - } - - - public MsgVpn serviceRestOutgoingMaxConnectionCount(Long serviceRestOutgoingMaxConnectionCount) { - - this.serviceRestOutgoingMaxConnectionCount = serviceRestOutgoingMaxConnectionCount; - return this; - } - - /** - * The maximum number of REST Consumer (outgoing) client connections that can be simultaneously connected to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. - * @return serviceRestOutgoingMaxConnectionCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_REST_OUTGOING_MAX_CONNECTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceRestOutgoingMaxConnectionCount() { - return serviceRestOutgoingMaxConnectionCount; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_REST_OUTGOING_MAX_CONNECTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceRestOutgoingMaxConnectionCount(Long serviceRestOutgoingMaxConnectionCount) { - this.serviceRestOutgoingMaxConnectionCount = serviceRestOutgoingMaxConnectionCount; - } - - - public MsgVpn serviceSmfMaxConnectionCount(Long serviceSmfMaxConnectionCount) { - - this.serviceSmfMaxConnectionCount = serviceSmfMaxConnectionCount; - return this; - } - - /** - * The maximum number of SMF client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. - * @return serviceSmfMaxConnectionCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_MAX_CONNECTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceSmfMaxConnectionCount() { - return serviceSmfMaxConnectionCount; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_MAX_CONNECTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSmfMaxConnectionCount(Long serviceSmfMaxConnectionCount) { - this.serviceSmfMaxConnectionCount = serviceSmfMaxConnectionCount; - } - - - public MsgVpn serviceSmfPlainTextEnabled(Boolean serviceSmfPlainTextEnabled) { - - this.serviceSmfPlainTextEnabled = serviceSmfPlainTextEnabled; - return this; - } - - /** - * Enable or disable the plain-text SMF service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return serviceSmfPlainTextEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_PLAIN_TEXT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceSmfPlainTextEnabled() { - return serviceSmfPlainTextEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_PLAIN_TEXT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSmfPlainTextEnabled(Boolean serviceSmfPlainTextEnabled) { - this.serviceSmfPlainTextEnabled = serviceSmfPlainTextEnabled; - } - - - public MsgVpn serviceSmfTlsEnabled(Boolean serviceSmfTlsEnabled) { - - this.serviceSmfTlsEnabled = serviceSmfTlsEnabled; - return this; - } - - /** - * Enable or disable the use of encryption (TLS) for the SMF service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return serviceSmfTlsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceSmfTlsEnabled() { - return serviceSmfTlsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSmfTlsEnabled(Boolean serviceSmfTlsEnabled) { - this.serviceSmfTlsEnabled = serviceSmfTlsEnabled; - } - - - public MsgVpn serviceWebAuthenticationClientCertRequest(ServiceWebAuthenticationClientCertRequestEnum serviceWebAuthenticationClientCertRequest) { - - this.serviceWebAuthenticationClientCertRequest = serviceWebAuthenticationClientCertRequest; - return this; - } - - /** - * Determines when to request a client certificate from a Web Transport client connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-enabled-in-message-vpn\"`. The allowed values and their meaning are: <pre> \"always\" - Always ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"never\" - Never ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration. \"when-enabled-in-message-vpn\" - Only ask for a client-certificate if client certificate authentication is enabled under \"message-vpn > authentication > client-certificate > shutdown\". </pre> Available since 2.21. - * @return serviceWebAuthenticationClientCertRequest - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_AUTHENTICATION_CLIENT_CERT_REQUEST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ServiceWebAuthenticationClientCertRequestEnum getServiceWebAuthenticationClientCertRequest() { - return serviceWebAuthenticationClientCertRequest; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_AUTHENTICATION_CLIENT_CERT_REQUEST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceWebAuthenticationClientCertRequest(ServiceWebAuthenticationClientCertRequestEnum serviceWebAuthenticationClientCertRequest) { - this.serviceWebAuthenticationClientCertRequest = serviceWebAuthenticationClientCertRequest; - } - - - public MsgVpn serviceWebMaxConnectionCount(Long serviceWebMaxConnectionCount) { - - this.serviceWebMaxConnectionCount = serviceWebMaxConnectionCount; - return this; - } - - /** - * The maximum number of Web Transport client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. - * @return serviceWebMaxConnectionCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_MAX_CONNECTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceWebMaxConnectionCount() { - return serviceWebMaxConnectionCount; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_MAX_CONNECTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceWebMaxConnectionCount(Long serviceWebMaxConnectionCount) { - this.serviceWebMaxConnectionCount = serviceWebMaxConnectionCount; - } - - - public MsgVpn serviceWebPlainTextEnabled(Boolean serviceWebPlainTextEnabled) { - - this.serviceWebPlainTextEnabled = serviceWebPlainTextEnabled; - return this; - } - - /** - * Enable or disable the plain-text Web Transport service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return serviceWebPlainTextEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_PLAIN_TEXT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceWebPlainTextEnabled() { - return serviceWebPlainTextEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_PLAIN_TEXT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceWebPlainTextEnabled(Boolean serviceWebPlainTextEnabled) { - this.serviceWebPlainTextEnabled = serviceWebPlainTextEnabled; - } - - - public MsgVpn serviceWebTlsEnabled(Boolean serviceWebTlsEnabled) { - - this.serviceWebTlsEnabled = serviceWebTlsEnabled; - return this; - } - - /** - * Enable or disable the use of TLS for the Web Transport service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return serviceWebTlsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceWebTlsEnabled() { - return serviceWebTlsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceWebTlsEnabled(Boolean serviceWebTlsEnabled) { - this.serviceWebTlsEnabled = serviceWebTlsEnabled; - } - - - public MsgVpn tlsAllowDowngradeToPlainTextEnabled(Boolean tlsAllowDowngradeToPlainTextEnabled) { - - this.tlsAllowDowngradeToPlainTextEnabled = tlsAllowDowngradeToPlainTextEnabled; - return this; - } - - /** - * Enable or disable the allowing of TLS SMF clients to downgrade their connections to plain-text connections. Changing this will not affect existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return tlsAllowDowngradeToPlainTextEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_ALLOW_DOWNGRADE_TO_PLAIN_TEXT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTlsAllowDowngradeToPlainTextEnabled() { - return tlsAllowDowngradeToPlainTextEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TLS_ALLOW_DOWNGRADE_TO_PLAIN_TEXT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsAllowDowngradeToPlainTextEnabled(Boolean tlsAllowDowngradeToPlainTextEnabled) { - this.tlsAllowDowngradeToPlainTextEnabled = tlsAllowDowngradeToPlainTextEnabled; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpn msgVpn = (MsgVpn) o; - return Objects.equals(this.alias, msgVpn.alias) && - Objects.equals(this.authenticationBasicEnabled, msgVpn.authenticationBasicEnabled) && - Objects.equals(this.authenticationBasicProfileName, msgVpn.authenticationBasicProfileName) && - Objects.equals(this.authenticationBasicRadiusDomain, msgVpn.authenticationBasicRadiusDomain) && - Objects.equals(this.authenticationBasicType, msgVpn.authenticationBasicType) && - Objects.equals(this.authenticationClientCertAllowApiProvidedUsernameEnabled, msgVpn.authenticationClientCertAllowApiProvidedUsernameEnabled) && - Objects.equals(this.authenticationClientCertCertificateMatchingRulesEnabled, msgVpn.authenticationClientCertCertificateMatchingRulesEnabled) && - Objects.equals(this.authenticationClientCertEnabled, msgVpn.authenticationClientCertEnabled) && - Objects.equals(this.authenticationClientCertMaxChainDepth, msgVpn.authenticationClientCertMaxChainDepth) && - Objects.equals(this.authenticationClientCertRevocationCheckMode, msgVpn.authenticationClientCertRevocationCheckMode) && - Objects.equals(this.authenticationClientCertUsernameSource, msgVpn.authenticationClientCertUsernameSource) && - Objects.equals(this.authenticationClientCertValidateDateEnabled, msgVpn.authenticationClientCertValidateDateEnabled) && - Objects.equals(this.authenticationKerberosAllowApiProvidedUsernameEnabled, msgVpn.authenticationKerberosAllowApiProvidedUsernameEnabled) && - Objects.equals(this.authenticationKerberosEnabled, msgVpn.authenticationKerberosEnabled) && - Objects.equals(this.authenticationOauthDefaultProfileName, msgVpn.authenticationOauthDefaultProfileName) && - Objects.equals(this.authenticationOauthDefaultProviderName, msgVpn.authenticationOauthDefaultProviderName) && - Objects.equals(this.authenticationOauthEnabled, msgVpn.authenticationOauthEnabled) && - Objects.equals(this.authorizationLdapGroupMembershipAttributeName, msgVpn.authorizationLdapGroupMembershipAttributeName) && - Objects.equals(this.authorizationLdapTrimClientUsernameDomainEnabled, msgVpn.authorizationLdapTrimClientUsernameDomainEnabled) && - Objects.equals(this.authorizationProfileName, msgVpn.authorizationProfileName) && - Objects.equals(this.authorizationType, msgVpn.authorizationType) && - Objects.equals(this.bridgingTlsServerCertEnforceTrustedCommonNameEnabled, msgVpn.bridgingTlsServerCertEnforceTrustedCommonNameEnabled) && - Objects.equals(this.bridgingTlsServerCertMaxChainDepth, msgVpn.bridgingTlsServerCertMaxChainDepth) && - Objects.equals(this.bridgingTlsServerCertValidateDateEnabled, msgVpn.bridgingTlsServerCertValidateDateEnabled) && - Objects.equals(this.bridgingTlsServerCertValidateNameEnabled, msgVpn.bridgingTlsServerCertValidateNameEnabled) && - Objects.equals(this.distributedCacheManagementEnabled, msgVpn.distributedCacheManagementEnabled) && - Objects.equals(this.dmrEnabled, msgVpn.dmrEnabled) && - Objects.equals(this.enabled, msgVpn.enabled) && - Objects.equals(this.eventConnectionCountThreshold, msgVpn.eventConnectionCountThreshold) && - Objects.equals(this.eventEgressFlowCountThreshold, msgVpn.eventEgressFlowCountThreshold) && - Objects.equals(this.eventEgressMsgRateThreshold, msgVpn.eventEgressMsgRateThreshold) && - Objects.equals(this.eventEndpointCountThreshold, msgVpn.eventEndpointCountThreshold) && - Objects.equals(this.eventIngressFlowCountThreshold, msgVpn.eventIngressFlowCountThreshold) && - Objects.equals(this.eventIngressMsgRateThreshold, msgVpn.eventIngressMsgRateThreshold) && - Objects.equals(this.eventLargeMsgThreshold, msgVpn.eventLargeMsgThreshold) && - Objects.equals(this.eventLogTag, msgVpn.eventLogTag) && - Objects.equals(this.eventMsgSpoolUsageThreshold, msgVpn.eventMsgSpoolUsageThreshold) && - Objects.equals(this.eventPublishClientEnabled, msgVpn.eventPublishClientEnabled) && - Objects.equals(this.eventPublishMsgVpnEnabled, msgVpn.eventPublishMsgVpnEnabled) && - Objects.equals(this.eventPublishSubscriptionMode, msgVpn.eventPublishSubscriptionMode) && - Objects.equals(this.eventPublishTopicFormatMqttEnabled, msgVpn.eventPublishTopicFormatMqttEnabled) && - Objects.equals(this.eventPublishTopicFormatSmfEnabled, msgVpn.eventPublishTopicFormatSmfEnabled) && - Objects.equals(this.eventServiceAmqpConnectionCountThreshold, msgVpn.eventServiceAmqpConnectionCountThreshold) && - Objects.equals(this.eventServiceMqttConnectionCountThreshold, msgVpn.eventServiceMqttConnectionCountThreshold) && - Objects.equals(this.eventServiceRestIncomingConnectionCountThreshold, msgVpn.eventServiceRestIncomingConnectionCountThreshold) && - Objects.equals(this.eventServiceSmfConnectionCountThreshold, msgVpn.eventServiceSmfConnectionCountThreshold) && - Objects.equals(this.eventServiceWebConnectionCountThreshold, msgVpn.eventServiceWebConnectionCountThreshold) && - Objects.equals(this.eventSubscriptionCountThreshold, msgVpn.eventSubscriptionCountThreshold) && - Objects.equals(this.eventTransactedSessionCountThreshold, msgVpn.eventTransactedSessionCountThreshold) && - Objects.equals(this.eventTransactionCountThreshold, msgVpn.eventTransactionCountThreshold) && - Objects.equals(this.exportSubscriptionsEnabled, msgVpn.exportSubscriptionsEnabled) && - Objects.equals(this.jndiEnabled, msgVpn.jndiEnabled) && - Objects.equals(this.maxConnectionCount, msgVpn.maxConnectionCount) && - Objects.equals(this.maxEgressFlowCount, msgVpn.maxEgressFlowCount) && - Objects.equals(this.maxEndpointCount, msgVpn.maxEndpointCount) && - Objects.equals(this.maxIngressFlowCount, msgVpn.maxIngressFlowCount) && - Objects.equals(this.maxMsgSpoolUsage, msgVpn.maxMsgSpoolUsage) && - Objects.equals(this.maxSubscriptionCount, msgVpn.maxSubscriptionCount) && - Objects.equals(this.maxTransactedSessionCount, msgVpn.maxTransactedSessionCount) && - Objects.equals(this.maxTransactionCount, msgVpn.maxTransactionCount) && - Objects.equals(this.mqttRetainMaxMemory, msgVpn.mqttRetainMaxMemory) && - Objects.equals(this.msgVpnName, msgVpn.msgVpnName) && - Objects.equals(this.replicationAckPropagationIntervalMsgCount, msgVpn.replicationAckPropagationIntervalMsgCount) && - Objects.equals(this.replicationBridgeAuthenticationBasicClientUsername, msgVpn.replicationBridgeAuthenticationBasicClientUsername) && - Objects.equals(this.replicationBridgeAuthenticationBasicPassword, msgVpn.replicationBridgeAuthenticationBasicPassword) && - Objects.equals(this.replicationBridgeAuthenticationClientCertContent, msgVpn.replicationBridgeAuthenticationClientCertContent) && - Objects.equals(this.replicationBridgeAuthenticationClientCertPassword, msgVpn.replicationBridgeAuthenticationClientCertPassword) && - Objects.equals(this.replicationBridgeAuthenticationScheme, msgVpn.replicationBridgeAuthenticationScheme) && - Objects.equals(this.replicationBridgeCompressedDataEnabled, msgVpn.replicationBridgeCompressedDataEnabled) && - Objects.equals(this.replicationBridgeEgressFlowWindowSize, msgVpn.replicationBridgeEgressFlowWindowSize) && - Objects.equals(this.replicationBridgeRetryDelay, msgVpn.replicationBridgeRetryDelay) && - Objects.equals(this.replicationBridgeTlsEnabled, msgVpn.replicationBridgeTlsEnabled) && - Objects.equals(this.replicationBridgeUnidirectionalClientProfileName, msgVpn.replicationBridgeUnidirectionalClientProfileName) && - Objects.equals(this.replicationEnabled, msgVpn.replicationEnabled) && - Objects.equals(this.replicationEnabledQueueBehavior, msgVpn.replicationEnabledQueueBehavior) && - Objects.equals(this.replicationQueueMaxMsgSpoolUsage, msgVpn.replicationQueueMaxMsgSpoolUsage) && - Objects.equals(this.replicationQueueRejectMsgToSenderOnDiscardEnabled, msgVpn.replicationQueueRejectMsgToSenderOnDiscardEnabled) && - Objects.equals(this.replicationRejectMsgWhenSyncIneligibleEnabled, msgVpn.replicationRejectMsgWhenSyncIneligibleEnabled) && - Objects.equals(this.replicationRole, msgVpn.replicationRole) && - Objects.equals(this.replicationTransactionMode, msgVpn.replicationTransactionMode) && - Objects.equals(this.restTlsServerCertEnforceTrustedCommonNameEnabled, msgVpn.restTlsServerCertEnforceTrustedCommonNameEnabled) && - Objects.equals(this.restTlsServerCertMaxChainDepth, msgVpn.restTlsServerCertMaxChainDepth) && - Objects.equals(this.restTlsServerCertValidateDateEnabled, msgVpn.restTlsServerCertValidateDateEnabled) && - Objects.equals(this.restTlsServerCertValidateNameEnabled, msgVpn.restTlsServerCertValidateNameEnabled) && - Objects.equals(this.sempOverMsgBusAdminClientEnabled, msgVpn.sempOverMsgBusAdminClientEnabled) && - Objects.equals(this.sempOverMsgBusAdminDistributedCacheEnabled, msgVpn.sempOverMsgBusAdminDistributedCacheEnabled) && - Objects.equals(this.sempOverMsgBusAdminEnabled, msgVpn.sempOverMsgBusAdminEnabled) && - Objects.equals(this.sempOverMsgBusEnabled, msgVpn.sempOverMsgBusEnabled) && - Objects.equals(this.sempOverMsgBusShowEnabled, msgVpn.sempOverMsgBusShowEnabled) && - Objects.equals(this.serviceAmqpMaxConnectionCount, msgVpn.serviceAmqpMaxConnectionCount) && - Objects.equals(this.serviceAmqpPlainTextEnabled, msgVpn.serviceAmqpPlainTextEnabled) && - Objects.equals(this.serviceAmqpPlainTextListenPort, msgVpn.serviceAmqpPlainTextListenPort) && - Objects.equals(this.serviceAmqpTlsEnabled, msgVpn.serviceAmqpTlsEnabled) && - Objects.equals(this.serviceAmqpTlsListenPort, msgVpn.serviceAmqpTlsListenPort) && - Objects.equals(this.serviceMqttAuthenticationClientCertRequest, msgVpn.serviceMqttAuthenticationClientCertRequest) && - Objects.equals(this.serviceMqttMaxConnectionCount, msgVpn.serviceMqttMaxConnectionCount) && - Objects.equals(this.serviceMqttPlainTextEnabled, msgVpn.serviceMqttPlainTextEnabled) && - Objects.equals(this.serviceMqttPlainTextListenPort, msgVpn.serviceMqttPlainTextListenPort) && - Objects.equals(this.serviceMqttTlsEnabled, msgVpn.serviceMqttTlsEnabled) && - Objects.equals(this.serviceMqttTlsListenPort, msgVpn.serviceMqttTlsListenPort) && - Objects.equals(this.serviceMqttTlsWebSocketEnabled, msgVpn.serviceMqttTlsWebSocketEnabled) && - Objects.equals(this.serviceMqttTlsWebSocketListenPort, msgVpn.serviceMqttTlsWebSocketListenPort) && - Objects.equals(this.serviceMqttWebSocketEnabled, msgVpn.serviceMqttWebSocketEnabled) && - Objects.equals(this.serviceMqttWebSocketListenPort, msgVpn.serviceMqttWebSocketListenPort) && - Objects.equals(this.serviceRestIncomingAuthenticationClientCertRequest, msgVpn.serviceRestIncomingAuthenticationClientCertRequest) && - Objects.equals(this.serviceRestIncomingAuthorizationHeaderHandling, msgVpn.serviceRestIncomingAuthorizationHeaderHandling) && - Objects.equals(this.serviceRestIncomingMaxConnectionCount, msgVpn.serviceRestIncomingMaxConnectionCount) && - Objects.equals(this.serviceRestIncomingPlainTextEnabled, msgVpn.serviceRestIncomingPlainTextEnabled) && - Objects.equals(this.serviceRestIncomingPlainTextListenPort, msgVpn.serviceRestIncomingPlainTextListenPort) && - Objects.equals(this.serviceRestIncomingTlsEnabled, msgVpn.serviceRestIncomingTlsEnabled) && - Objects.equals(this.serviceRestIncomingTlsListenPort, msgVpn.serviceRestIncomingTlsListenPort) && - Objects.equals(this.serviceRestMode, msgVpn.serviceRestMode) && - Objects.equals(this.serviceRestOutgoingMaxConnectionCount, msgVpn.serviceRestOutgoingMaxConnectionCount) && - Objects.equals(this.serviceSmfMaxConnectionCount, msgVpn.serviceSmfMaxConnectionCount) && - Objects.equals(this.serviceSmfPlainTextEnabled, msgVpn.serviceSmfPlainTextEnabled) && - Objects.equals(this.serviceSmfTlsEnabled, msgVpn.serviceSmfTlsEnabled) && - Objects.equals(this.serviceWebAuthenticationClientCertRequest, msgVpn.serviceWebAuthenticationClientCertRequest) && - Objects.equals(this.serviceWebMaxConnectionCount, msgVpn.serviceWebMaxConnectionCount) && - Objects.equals(this.serviceWebPlainTextEnabled, msgVpn.serviceWebPlainTextEnabled) && - Objects.equals(this.serviceWebTlsEnabled, msgVpn.serviceWebTlsEnabled) && - Objects.equals(this.tlsAllowDowngradeToPlainTextEnabled, msgVpn.tlsAllowDowngradeToPlainTextEnabled); - } - - @Override - public int hashCode() { - return Objects.hash(alias, authenticationBasicEnabled, authenticationBasicProfileName, authenticationBasicRadiusDomain, authenticationBasicType, authenticationClientCertAllowApiProvidedUsernameEnabled, authenticationClientCertCertificateMatchingRulesEnabled, authenticationClientCertEnabled, authenticationClientCertMaxChainDepth, authenticationClientCertRevocationCheckMode, authenticationClientCertUsernameSource, authenticationClientCertValidateDateEnabled, authenticationKerberosAllowApiProvidedUsernameEnabled, authenticationKerberosEnabled, authenticationOauthDefaultProfileName, authenticationOauthDefaultProviderName, authenticationOauthEnabled, authorizationLdapGroupMembershipAttributeName, authorizationLdapTrimClientUsernameDomainEnabled, authorizationProfileName, authorizationType, bridgingTlsServerCertEnforceTrustedCommonNameEnabled, bridgingTlsServerCertMaxChainDepth, bridgingTlsServerCertValidateDateEnabled, bridgingTlsServerCertValidateNameEnabled, distributedCacheManagementEnabled, dmrEnabled, enabled, eventConnectionCountThreshold, eventEgressFlowCountThreshold, eventEgressMsgRateThreshold, eventEndpointCountThreshold, eventIngressFlowCountThreshold, eventIngressMsgRateThreshold, eventLargeMsgThreshold, eventLogTag, eventMsgSpoolUsageThreshold, eventPublishClientEnabled, eventPublishMsgVpnEnabled, eventPublishSubscriptionMode, eventPublishTopicFormatMqttEnabled, eventPublishTopicFormatSmfEnabled, eventServiceAmqpConnectionCountThreshold, eventServiceMqttConnectionCountThreshold, eventServiceRestIncomingConnectionCountThreshold, eventServiceSmfConnectionCountThreshold, eventServiceWebConnectionCountThreshold, eventSubscriptionCountThreshold, eventTransactedSessionCountThreshold, eventTransactionCountThreshold, exportSubscriptionsEnabled, jndiEnabled, maxConnectionCount, maxEgressFlowCount, maxEndpointCount, maxIngressFlowCount, maxMsgSpoolUsage, maxSubscriptionCount, maxTransactedSessionCount, maxTransactionCount, mqttRetainMaxMemory, msgVpnName, replicationAckPropagationIntervalMsgCount, replicationBridgeAuthenticationBasicClientUsername, replicationBridgeAuthenticationBasicPassword, replicationBridgeAuthenticationClientCertContent, replicationBridgeAuthenticationClientCertPassword, replicationBridgeAuthenticationScheme, replicationBridgeCompressedDataEnabled, replicationBridgeEgressFlowWindowSize, replicationBridgeRetryDelay, replicationBridgeTlsEnabled, replicationBridgeUnidirectionalClientProfileName, replicationEnabled, replicationEnabledQueueBehavior, replicationQueueMaxMsgSpoolUsage, replicationQueueRejectMsgToSenderOnDiscardEnabled, replicationRejectMsgWhenSyncIneligibleEnabled, replicationRole, replicationTransactionMode, restTlsServerCertEnforceTrustedCommonNameEnabled, restTlsServerCertMaxChainDepth, restTlsServerCertValidateDateEnabled, restTlsServerCertValidateNameEnabled, sempOverMsgBusAdminClientEnabled, sempOverMsgBusAdminDistributedCacheEnabled, sempOverMsgBusAdminEnabled, sempOverMsgBusEnabled, sempOverMsgBusShowEnabled, serviceAmqpMaxConnectionCount, serviceAmqpPlainTextEnabled, serviceAmqpPlainTextListenPort, serviceAmqpTlsEnabled, serviceAmqpTlsListenPort, serviceMqttAuthenticationClientCertRequest, serviceMqttMaxConnectionCount, serviceMqttPlainTextEnabled, serviceMqttPlainTextListenPort, serviceMqttTlsEnabled, serviceMqttTlsListenPort, serviceMqttTlsWebSocketEnabled, serviceMqttTlsWebSocketListenPort, serviceMqttWebSocketEnabled, serviceMqttWebSocketListenPort, serviceRestIncomingAuthenticationClientCertRequest, serviceRestIncomingAuthorizationHeaderHandling, serviceRestIncomingMaxConnectionCount, serviceRestIncomingPlainTextEnabled, serviceRestIncomingPlainTextListenPort, serviceRestIncomingTlsEnabled, serviceRestIncomingTlsListenPort, serviceRestMode, serviceRestOutgoingMaxConnectionCount, serviceSmfMaxConnectionCount, serviceSmfPlainTextEnabled, serviceSmfTlsEnabled, serviceWebAuthenticationClientCertRequest, serviceWebMaxConnectionCount, serviceWebPlainTextEnabled, serviceWebTlsEnabled, tlsAllowDowngradeToPlainTextEnabled); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpn {\n"); - sb.append(" alias: ").append(toIndentedString(alias)).append("\n"); - sb.append(" authenticationBasicEnabled: ").append(toIndentedString(authenticationBasicEnabled)).append("\n"); - sb.append(" authenticationBasicProfileName: ").append(toIndentedString(authenticationBasicProfileName)).append("\n"); - sb.append(" authenticationBasicRadiusDomain: ").append(toIndentedString(authenticationBasicRadiusDomain)).append("\n"); - sb.append(" authenticationBasicType: ").append(toIndentedString(authenticationBasicType)).append("\n"); - sb.append(" authenticationClientCertAllowApiProvidedUsernameEnabled: ").append(toIndentedString(authenticationClientCertAllowApiProvidedUsernameEnabled)).append("\n"); - sb.append(" authenticationClientCertCertificateMatchingRulesEnabled: ").append(toIndentedString(authenticationClientCertCertificateMatchingRulesEnabled)).append("\n"); - sb.append(" authenticationClientCertEnabled: ").append(toIndentedString(authenticationClientCertEnabled)).append("\n"); - sb.append(" authenticationClientCertMaxChainDepth: ").append(toIndentedString(authenticationClientCertMaxChainDepth)).append("\n"); - sb.append(" authenticationClientCertRevocationCheckMode: ").append(toIndentedString(authenticationClientCertRevocationCheckMode)).append("\n"); - sb.append(" authenticationClientCertUsernameSource: ").append(toIndentedString(authenticationClientCertUsernameSource)).append("\n"); - sb.append(" authenticationClientCertValidateDateEnabled: ").append(toIndentedString(authenticationClientCertValidateDateEnabled)).append("\n"); - sb.append(" authenticationKerberosAllowApiProvidedUsernameEnabled: ").append(toIndentedString(authenticationKerberosAllowApiProvidedUsernameEnabled)).append("\n"); - sb.append(" authenticationKerberosEnabled: ").append(toIndentedString(authenticationKerberosEnabled)).append("\n"); - sb.append(" authenticationOauthDefaultProfileName: ").append(toIndentedString(authenticationOauthDefaultProfileName)).append("\n"); - sb.append(" authenticationOauthDefaultProviderName: ").append(toIndentedString(authenticationOauthDefaultProviderName)).append("\n"); - sb.append(" authenticationOauthEnabled: ").append(toIndentedString(authenticationOauthEnabled)).append("\n"); - sb.append(" authorizationLdapGroupMembershipAttributeName: ").append(toIndentedString(authorizationLdapGroupMembershipAttributeName)).append("\n"); - sb.append(" authorizationLdapTrimClientUsernameDomainEnabled: ").append(toIndentedString(authorizationLdapTrimClientUsernameDomainEnabled)).append("\n"); - sb.append(" authorizationProfileName: ").append(toIndentedString(authorizationProfileName)).append("\n"); - sb.append(" authorizationType: ").append(toIndentedString(authorizationType)).append("\n"); - sb.append(" bridgingTlsServerCertEnforceTrustedCommonNameEnabled: ").append(toIndentedString(bridgingTlsServerCertEnforceTrustedCommonNameEnabled)).append("\n"); - sb.append(" bridgingTlsServerCertMaxChainDepth: ").append(toIndentedString(bridgingTlsServerCertMaxChainDepth)).append("\n"); - sb.append(" bridgingTlsServerCertValidateDateEnabled: ").append(toIndentedString(bridgingTlsServerCertValidateDateEnabled)).append("\n"); - sb.append(" bridgingTlsServerCertValidateNameEnabled: ").append(toIndentedString(bridgingTlsServerCertValidateNameEnabled)).append("\n"); - sb.append(" distributedCacheManagementEnabled: ").append(toIndentedString(distributedCacheManagementEnabled)).append("\n"); - sb.append(" dmrEnabled: ").append(toIndentedString(dmrEnabled)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" eventConnectionCountThreshold: ").append(toIndentedString(eventConnectionCountThreshold)).append("\n"); - sb.append(" eventEgressFlowCountThreshold: ").append(toIndentedString(eventEgressFlowCountThreshold)).append("\n"); - sb.append(" eventEgressMsgRateThreshold: ").append(toIndentedString(eventEgressMsgRateThreshold)).append("\n"); - sb.append(" eventEndpointCountThreshold: ").append(toIndentedString(eventEndpointCountThreshold)).append("\n"); - sb.append(" eventIngressFlowCountThreshold: ").append(toIndentedString(eventIngressFlowCountThreshold)).append("\n"); - sb.append(" eventIngressMsgRateThreshold: ").append(toIndentedString(eventIngressMsgRateThreshold)).append("\n"); - sb.append(" eventLargeMsgThreshold: ").append(toIndentedString(eventLargeMsgThreshold)).append("\n"); - sb.append(" eventLogTag: ").append(toIndentedString(eventLogTag)).append("\n"); - sb.append(" eventMsgSpoolUsageThreshold: ").append(toIndentedString(eventMsgSpoolUsageThreshold)).append("\n"); - sb.append(" eventPublishClientEnabled: ").append(toIndentedString(eventPublishClientEnabled)).append("\n"); - sb.append(" eventPublishMsgVpnEnabled: ").append(toIndentedString(eventPublishMsgVpnEnabled)).append("\n"); - sb.append(" eventPublishSubscriptionMode: ").append(toIndentedString(eventPublishSubscriptionMode)).append("\n"); - sb.append(" eventPublishTopicFormatMqttEnabled: ").append(toIndentedString(eventPublishTopicFormatMqttEnabled)).append("\n"); - sb.append(" eventPublishTopicFormatSmfEnabled: ").append(toIndentedString(eventPublishTopicFormatSmfEnabled)).append("\n"); - sb.append(" eventServiceAmqpConnectionCountThreshold: ").append(toIndentedString(eventServiceAmqpConnectionCountThreshold)).append("\n"); - sb.append(" eventServiceMqttConnectionCountThreshold: ").append(toIndentedString(eventServiceMqttConnectionCountThreshold)).append("\n"); - sb.append(" eventServiceRestIncomingConnectionCountThreshold: ").append(toIndentedString(eventServiceRestIncomingConnectionCountThreshold)).append("\n"); - sb.append(" eventServiceSmfConnectionCountThreshold: ").append(toIndentedString(eventServiceSmfConnectionCountThreshold)).append("\n"); - sb.append(" eventServiceWebConnectionCountThreshold: ").append(toIndentedString(eventServiceWebConnectionCountThreshold)).append("\n"); - sb.append(" eventSubscriptionCountThreshold: ").append(toIndentedString(eventSubscriptionCountThreshold)).append("\n"); - sb.append(" eventTransactedSessionCountThreshold: ").append(toIndentedString(eventTransactedSessionCountThreshold)).append("\n"); - sb.append(" eventTransactionCountThreshold: ").append(toIndentedString(eventTransactionCountThreshold)).append("\n"); - sb.append(" exportSubscriptionsEnabled: ").append(toIndentedString(exportSubscriptionsEnabled)).append("\n"); - sb.append(" jndiEnabled: ").append(toIndentedString(jndiEnabled)).append("\n"); - sb.append(" maxConnectionCount: ").append(toIndentedString(maxConnectionCount)).append("\n"); - sb.append(" maxEgressFlowCount: ").append(toIndentedString(maxEgressFlowCount)).append("\n"); - sb.append(" maxEndpointCount: ").append(toIndentedString(maxEndpointCount)).append("\n"); - sb.append(" maxIngressFlowCount: ").append(toIndentedString(maxIngressFlowCount)).append("\n"); - sb.append(" maxMsgSpoolUsage: ").append(toIndentedString(maxMsgSpoolUsage)).append("\n"); - sb.append(" maxSubscriptionCount: ").append(toIndentedString(maxSubscriptionCount)).append("\n"); - sb.append(" maxTransactedSessionCount: ").append(toIndentedString(maxTransactedSessionCount)).append("\n"); - sb.append(" maxTransactionCount: ").append(toIndentedString(maxTransactionCount)).append("\n"); - sb.append(" mqttRetainMaxMemory: ").append(toIndentedString(mqttRetainMaxMemory)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" replicationAckPropagationIntervalMsgCount: ").append(toIndentedString(replicationAckPropagationIntervalMsgCount)).append("\n"); - sb.append(" replicationBridgeAuthenticationBasicClientUsername: ").append(toIndentedString(replicationBridgeAuthenticationBasicClientUsername)).append("\n"); - sb.append(" replicationBridgeAuthenticationBasicPassword: ").append(toIndentedString(replicationBridgeAuthenticationBasicPassword)).append("\n"); - sb.append(" replicationBridgeAuthenticationClientCertContent: ").append(toIndentedString(replicationBridgeAuthenticationClientCertContent)).append("\n"); - sb.append(" replicationBridgeAuthenticationClientCertPassword: ").append(toIndentedString(replicationBridgeAuthenticationClientCertPassword)).append("\n"); - sb.append(" replicationBridgeAuthenticationScheme: ").append(toIndentedString(replicationBridgeAuthenticationScheme)).append("\n"); - sb.append(" replicationBridgeCompressedDataEnabled: ").append(toIndentedString(replicationBridgeCompressedDataEnabled)).append("\n"); - sb.append(" replicationBridgeEgressFlowWindowSize: ").append(toIndentedString(replicationBridgeEgressFlowWindowSize)).append("\n"); - sb.append(" replicationBridgeRetryDelay: ").append(toIndentedString(replicationBridgeRetryDelay)).append("\n"); - sb.append(" replicationBridgeTlsEnabled: ").append(toIndentedString(replicationBridgeTlsEnabled)).append("\n"); - sb.append(" replicationBridgeUnidirectionalClientProfileName: ").append(toIndentedString(replicationBridgeUnidirectionalClientProfileName)).append("\n"); - sb.append(" replicationEnabled: ").append(toIndentedString(replicationEnabled)).append("\n"); - sb.append(" replicationEnabledQueueBehavior: ").append(toIndentedString(replicationEnabledQueueBehavior)).append("\n"); - sb.append(" replicationQueueMaxMsgSpoolUsage: ").append(toIndentedString(replicationQueueMaxMsgSpoolUsage)).append("\n"); - sb.append(" replicationQueueRejectMsgToSenderOnDiscardEnabled: ").append(toIndentedString(replicationQueueRejectMsgToSenderOnDiscardEnabled)).append("\n"); - sb.append(" replicationRejectMsgWhenSyncIneligibleEnabled: ").append(toIndentedString(replicationRejectMsgWhenSyncIneligibleEnabled)).append("\n"); - sb.append(" replicationRole: ").append(toIndentedString(replicationRole)).append("\n"); - sb.append(" replicationTransactionMode: ").append(toIndentedString(replicationTransactionMode)).append("\n"); - sb.append(" restTlsServerCertEnforceTrustedCommonNameEnabled: ").append(toIndentedString(restTlsServerCertEnforceTrustedCommonNameEnabled)).append("\n"); - sb.append(" restTlsServerCertMaxChainDepth: ").append(toIndentedString(restTlsServerCertMaxChainDepth)).append("\n"); - sb.append(" restTlsServerCertValidateDateEnabled: ").append(toIndentedString(restTlsServerCertValidateDateEnabled)).append("\n"); - sb.append(" restTlsServerCertValidateNameEnabled: ").append(toIndentedString(restTlsServerCertValidateNameEnabled)).append("\n"); - sb.append(" sempOverMsgBusAdminClientEnabled: ").append(toIndentedString(sempOverMsgBusAdminClientEnabled)).append("\n"); - sb.append(" sempOverMsgBusAdminDistributedCacheEnabled: ").append(toIndentedString(sempOverMsgBusAdminDistributedCacheEnabled)).append("\n"); - sb.append(" sempOverMsgBusAdminEnabled: ").append(toIndentedString(sempOverMsgBusAdminEnabled)).append("\n"); - sb.append(" sempOverMsgBusEnabled: ").append(toIndentedString(sempOverMsgBusEnabled)).append("\n"); - sb.append(" sempOverMsgBusShowEnabled: ").append(toIndentedString(sempOverMsgBusShowEnabled)).append("\n"); - sb.append(" serviceAmqpMaxConnectionCount: ").append(toIndentedString(serviceAmqpMaxConnectionCount)).append("\n"); - sb.append(" serviceAmqpPlainTextEnabled: ").append(toIndentedString(serviceAmqpPlainTextEnabled)).append("\n"); - sb.append(" serviceAmqpPlainTextListenPort: ").append(toIndentedString(serviceAmqpPlainTextListenPort)).append("\n"); - sb.append(" serviceAmqpTlsEnabled: ").append(toIndentedString(serviceAmqpTlsEnabled)).append("\n"); - sb.append(" serviceAmqpTlsListenPort: ").append(toIndentedString(serviceAmqpTlsListenPort)).append("\n"); - sb.append(" serviceMqttAuthenticationClientCertRequest: ").append(toIndentedString(serviceMqttAuthenticationClientCertRequest)).append("\n"); - sb.append(" serviceMqttMaxConnectionCount: ").append(toIndentedString(serviceMqttMaxConnectionCount)).append("\n"); - sb.append(" serviceMqttPlainTextEnabled: ").append(toIndentedString(serviceMqttPlainTextEnabled)).append("\n"); - sb.append(" serviceMqttPlainTextListenPort: ").append(toIndentedString(serviceMqttPlainTextListenPort)).append("\n"); - sb.append(" serviceMqttTlsEnabled: ").append(toIndentedString(serviceMqttTlsEnabled)).append("\n"); - sb.append(" serviceMqttTlsListenPort: ").append(toIndentedString(serviceMqttTlsListenPort)).append("\n"); - sb.append(" serviceMqttTlsWebSocketEnabled: ").append(toIndentedString(serviceMqttTlsWebSocketEnabled)).append("\n"); - sb.append(" serviceMqttTlsWebSocketListenPort: ").append(toIndentedString(serviceMqttTlsWebSocketListenPort)).append("\n"); - sb.append(" serviceMqttWebSocketEnabled: ").append(toIndentedString(serviceMqttWebSocketEnabled)).append("\n"); - sb.append(" serviceMqttWebSocketListenPort: ").append(toIndentedString(serviceMqttWebSocketListenPort)).append("\n"); - sb.append(" serviceRestIncomingAuthenticationClientCertRequest: ").append(toIndentedString(serviceRestIncomingAuthenticationClientCertRequest)).append("\n"); - sb.append(" serviceRestIncomingAuthorizationHeaderHandling: ").append(toIndentedString(serviceRestIncomingAuthorizationHeaderHandling)).append("\n"); - sb.append(" serviceRestIncomingMaxConnectionCount: ").append(toIndentedString(serviceRestIncomingMaxConnectionCount)).append("\n"); - sb.append(" serviceRestIncomingPlainTextEnabled: ").append(toIndentedString(serviceRestIncomingPlainTextEnabled)).append("\n"); - sb.append(" serviceRestIncomingPlainTextListenPort: ").append(toIndentedString(serviceRestIncomingPlainTextListenPort)).append("\n"); - sb.append(" serviceRestIncomingTlsEnabled: ").append(toIndentedString(serviceRestIncomingTlsEnabled)).append("\n"); - sb.append(" serviceRestIncomingTlsListenPort: ").append(toIndentedString(serviceRestIncomingTlsListenPort)).append("\n"); - sb.append(" serviceRestMode: ").append(toIndentedString(serviceRestMode)).append("\n"); - sb.append(" serviceRestOutgoingMaxConnectionCount: ").append(toIndentedString(serviceRestOutgoingMaxConnectionCount)).append("\n"); - sb.append(" serviceSmfMaxConnectionCount: ").append(toIndentedString(serviceSmfMaxConnectionCount)).append("\n"); - sb.append(" serviceSmfPlainTextEnabled: ").append(toIndentedString(serviceSmfPlainTextEnabled)).append("\n"); - sb.append(" serviceSmfTlsEnabled: ").append(toIndentedString(serviceSmfTlsEnabled)).append("\n"); - sb.append(" serviceWebAuthenticationClientCertRequest: ").append(toIndentedString(serviceWebAuthenticationClientCertRequest)).append("\n"); - sb.append(" serviceWebMaxConnectionCount: ").append(toIndentedString(serviceWebMaxConnectionCount)).append("\n"); - sb.append(" serviceWebPlainTextEnabled: ").append(toIndentedString(serviceWebPlainTextEnabled)).append("\n"); - sb.append(" serviceWebTlsEnabled: ").append(toIndentedString(serviceWebTlsEnabled)).append("\n"); - sb.append(" tlsAllowDowngradeToPlainTextEnabled: ").append(toIndentedString(tlsAllowDowngradeToPlainTextEnabled)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfile.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfile.java deleted file mode 100644 index 2c14b5493..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfile.java +++ /dev/null @@ -1,404 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfile - */ -@JsonPropertyOrder({ - MsgVpnAclProfile.JSON_PROPERTY_ACL_PROFILE_NAME, - MsgVpnAclProfile.JSON_PROPERTY_CLIENT_CONNECT_DEFAULT_ACTION, - MsgVpnAclProfile.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnAclProfile.JSON_PROPERTY_PUBLISH_TOPIC_DEFAULT_ACTION, - MsgVpnAclProfile.JSON_PROPERTY_SUBSCRIBE_SHARE_NAME_DEFAULT_ACTION, - MsgVpnAclProfile.JSON_PROPERTY_SUBSCRIBE_TOPIC_DEFAULT_ACTION -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfile { - public static final String JSON_PROPERTY_ACL_PROFILE_NAME = "aclProfileName"; - private String aclProfileName; - - /** - * The default action to take when a client using the ACL Profile connects to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"disallow\"`. The allowed values and their meaning are: <pre> \"allow\" - Allow client connection unless an exception is found for it. \"disallow\" - Disallow client connection unless an exception is found for it. </pre> - */ - public enum ClientConnectDefaultActionEnum { - ALLOW("allow"), - - DISALLOW("disallow"); - - private String value; - - ClientConnectDefaultActionEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static ClientConnectDefaultActionEnum fromValue(String value) { - for (ClientConnectDefaultActionEnum b : ClientConnectDefaultActionEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_CLIENT_CONNECT_DEFAULT_ACTION = "clientConnectDefaultAction"; - private ClientConnectDefaultActionEnum clientConnectDefaultAction; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - /** - * The default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"disallow\"`. The allowed values and their meaning are: <pre> \"allow\" - Allow topic unless an exception is found for it. \"disallow\" - Disallow topic unless an exception is found for it. </pre> - */ - public enum PublishTopicDefaultActionEnum { - ALLOW("allow"), - - DISALLOW("disallow"); - - private String value; - - PublishTopicDefaultActionEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static PublishTopicDefaultActionEnum fromValue(String value) { - for (PublishTopicDefaultActionEnum b : PublishTopicDefaultActionEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_PUBLISH_TOPIC_DEFAULT_ACTION = "publishTopicDefaultAction"; - private PublishTopicDefaultActionEnum publishTopicDefaultAction; - - /** - * The default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"allow\"`. The allowed values and their meaning are: <pre> \"allow\" - Allow topic unless an exception is found for it. \"disallow\" - Disallow topic unless an exception is found for it. </pre> Available since 2.14. - */ - public enum SubscribeShareNameDefaultActionEnum { - ALLOW("allow"), - - DISALLOW("disallow"); - - private String value; - - SubscribeShareNameDefaultActionEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static SubscribeShareNameDefaultActionEnum fromValue(String value) { - for (SubscribeShareNameDefaultActionEnum b : SubscribeShareNameDefaultActionEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_SUBSCRIBE_SHARE_NAME_DEFAULT_ACTION = "subscribeShareNameDefaultAction"; - private SubscribeShareNameDefaultActionEnum subscribeShareNameDefaultAction; - - /** - * The default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"disallow\"`. The allowed values and their meaning are: <pre> \"allow\" - Allow topic unless an exception is found for it. \"disallow\" - Disallow topic unless an exception is found for it. </pre> - */ - public enum SubscribeTopicDefaultActionEnum { - ALLOW("allow"), - - DISALLOW("disallow"); - - private String value; - - SubscribeTopicDefaultActionEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static SubscribeTopicDefaultActionEnum fromValue(String value) { - for (SubscribeTopicDefaultActionEnum b : SubscribeTopicDefaultActionEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_SUBSCRIBE_TOPIC_DEFAULT_ACTION = "subscribeTopicDefaultAction"; - private SubscribeTopicDefaultActionEnum subscribeTopicDefaultAction; - - public MsgVpnAclProfile() { - } - - public MsgVpnAclProfile aclProfileName(String aclProfileName) { - - this.aclProfileName = aclProfileName; - return this; - } - - /** - * The name of the ACL Profile. - * @return aclProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAclProfileName() { - return aclProfileName; - } - - - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAclProfileName(String aclProfileName) { - this.aclProfileName = aclProfileName; - } - - - public MsgVpnAclProfile clientConnectDefaultAction(ClientConnectDefaultActionEnum clientConnectDefaultAction) { - - this.clientConnectDefaultAction = clientConnectDefaultAction; - return this; - } - - /** - * The default action to take when a client using the ACL Profile connects to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"disallow\"`. The allowed values and their meaning are: <pre> \"allow\" - Allow client connection unless an exception is found for it. \"disallow\" - Disallow client connection unless an exception is found for it. </pre> - * @return clientConnectDefaultAction - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_CONNECT_DEFAULT_ACTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ClientConnectDefaultActionEnum getClientConnectDefaultAction() { - return clientConnectDefaultAction; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_CONNECT_DEFAULT_ACTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientConnectDefaultAction(ClientConnectDefaultActionEnum clientConnectDefaultAction) { - this.clientConnectDefaultAction = clientConnectDefaultAction; - } - - - public MsgVpnAclProfile msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnAclProfile publishTopicDefaultAction(PublishTopicDefaultActionEnum publishTopicDefaultAction) { - - this.publishTopicDefaultAction = publishTopicDefaultAction; - return this; - } - - /** - * The default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"disallow\"`. The allowed values and their meaning are: <pre> \"allow\" - Allow topic unless an exception is found for it. \"disallow\" - Disallow topic unless an exception is found for it. </pre> - * @return publishTopicDefaultAction - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PUBLISH_TOPIC_DEFAULT_ACTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PublishTopicDefaultActionEnum getPublishTopicDefaultAction() { - return publishTopicDefaultAction; - } - - - @JsonProperty(JSON_PROPERTY_PUBLISH_TOPIC_DEFAULT_ACTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPublishTopicDefaultAction(PublishTopicDefaultActionEnum publishTopicDefaultAction) { - this.publishTopicDefaultAction = publishTopicDefaultAction; - } - - - public MsgVpnAclProfile subscribeShareNameDefaultAction(SubscribeShareNameDefaultActionEnum subscribeShareNameDefaultAction) { - - this.subscribeShareNameDefaultAction = subscribeShareNameDefaultAction; - return this; - } - - /** - * The default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"allow\"`. The allowed values and their meaning are: <pre> \"allow\" - Allow topic unless an exception is found for it. \"disallow\" - Disallow topic unless an exception is found for it. </pre> Available since 2.14. - * @return subscribeShareNameDefaultAction - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_SHARE_NAME_DEFAULT_ACTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public SubscribeShareNameDefaultActionEnum getSubscribeShareNameDefaultAction() { - return subscribeShareNameDefaultAction; - } - - - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_SHARE_NAME_DEFAULT_ACTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubscribeShareNameDefaultAction(SubscribeShareNameDefaultActionEnum subscribeShareNameDefaultAction) { - this.subscribeShareNameDefaultAction = subscribeShareNameDefaultAction; - } - - - public MsgVpnAclProfile subscribeTopicDefaultAction(SubscribeTopicDefaultActionEnum subscribeTopicDefaultAction) { - - this.subscribeTopicDefaultAction = subscribeTopicDefaultAction; - return this; - } - - /** - * The default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"disallow\"`. The allowed values and their meaning are: <pre> \"allow\" - Allow topic unless an exception is found for it. \"disallow\" - Disallow topic unless an exception is found for it. </pre> - * @return subscribeTopicDefaultAction - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_TOPIC_DEFAULT_ACTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public SubscribeTopicDefaultActionEnum getSubscribeTopicDefaultAction() { - return subscribeTopicDefaultAction; - } - - - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_TOPIC_DEFAULT_ACTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubscribeTopicDefaultAction(SubscribeTopicDefaultActionEnum subscribeTopicDefaultAction) { - this.subscribeTopicDefaultAction = subscribeTopicDefaultAction; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfile msgVpnAclProfile = (MsgVpnAclProfile) o; - return Objects.equals(this.aclProfileName, msgVpnAclProfile.aclProfileName) && - Objects.equals(this.clientConnectDefaultAction, msgVpnAclProfile.clientConnectDefaultAction) && - Objects.equals(this.msgVpnName, msgVpnAclProfile.msgVpnName) && - Objects.equals(this.publishTopicDefaultAction, msgVpnAclProfile.publishTopicDefaultAction) && - Objects.equals(this.subscribeShareNameDefaultAction, msgVpnAclProfile.subscribeShareNameDefaultAction) && - Objects.equals(this.subscribeTopicDefaultAction, msgVpnAclProfile.subscribeTopicDefaultAction); - } - - @Override - public int hashCode() { - return Objects.hash(aclProfileName, clientConnectDefaultAction, msgVpnName, publishTopicDefaultAction, subscribeShareNameDefaultAction, subscribeTopicDefaultAction); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfile {\n"); - sb.append(" aclProfileName: ").append(toIndentedString(aclProfileName)).append("\n"); - sb.append(" clientConnectDefaultAction: ").append(toIndentedString(clientConnectDefaultAction)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" publishTopicDefaultAction: ").append(toIndentedString(publishTopicDefaultAction)).append("\n"); - sb.append(" subscribeShareNameDefaultAction: ").append(toIndentedString(subscribeShareNameDefaultAction)).append("\n"); - sb.append(" subscribeTopicDefaultAction: ").append(toIndentedString(subscribeTopicDefaultAction)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectException.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectException.java deleted file mode 100644 index 3f812f0de..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectException.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileClientConnectException - */ -@JsonPropertyOrder({ - MsgVpnAclProfileClientConnectException.JSON_PROPERTY_ACL_PROFILE_NAME, - MsgVpnAclProfileClientConnectException.JSON_PROPERTY_CLIENT_CONNECT_EXCEPTION_ADDRESS, - MsgVpnAclProfileClientConnectException.JSON_PROPERTY_MSG_VPN_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileClientConnectException { - public static final String JSON_PROPERTY_ACL_PROFILE_NAME = "aclProfileName"; - private String aclProfileName; - - public static final String JSON_PROPERTY_CLIENT_CONNECT_EXCEPTION_ADDRESS = "clientConnectExceptionAddress"; - private String clientConnectExceptionAddress; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public MsgVpnAclProfileClientConnectException() { - } - - public MsgVpnAclProfileClientConnectException aclProfileName(String aclProfileName) { - - this.aclProfileName = aclProfileName; - return this; - } - - /** - * The name of the ACL Profile. - * @return aclProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAclProfileName() { - return aclProfileName; - } - - - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAclProfileName(String aclProfileName) { - this.aclProfileName = aclProfileName; - } - - - public MsgVpnAclProfileClientConnectException clientConnectExceptionAddress(String clientConnectExceptionAddress) { - - this.clientConnectExceptionAddress = clientConnectExceptionAddress; - return this; - } - - /** - * The IP address/netmask of the client connect exception in CIDR form. - * @return clientConnectExceptionAddress - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_CONNECT_EXCEPTION_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientConnectExceptionAddress() { - return clientConnectExceptionAddress; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_CONNECT_EXCEPTION_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientConnectExceptionAddress(String clientConnectExceptionAddress) { - this.clientConnectExceptionAddress = clientConnectExceptionAddress; - } - - - public MsgVpnAclProfileClientConnectException msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileClientConnectException msgVpnAclProfileClientConnectException = (MsgVpnAclProfileClientConnectException) o; - return Objects.equals(this.aclProfileName, msgVpnAclProfileClientConnectException.aclProfileName) && - Objects.equals(this.clientConnectExceptionAddress, msgVpnAclProfileClientConnectException.clientConnectExceptionAddress) && - Objects.equals(this.msgVpnName, msgVpnAclProfileClientConnectException.msgVpnName); - } - - @Override - public int hashCode() { - return Objects.hash(aclProfileName, clientConnectExceptionAddress, msgVpnName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileClientConnectException {\n"); - sb.append(" aclProfileName: ").append(toIndentedString(aclProfileName)).append("\n"); - sb.append(" clientConnectExceptionAddress: ").append(toIndentedString(clientConnectExceptionAddress)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionLinks.java deleted file mode 100644 index 1652761f1..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileClientConnectExceptionLinks - */ -@JsonPropertyOrder({ - MsgVpnAclProfileClientConnectExceptionLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileClientConnectExceptionLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnAclProfileClientConnectExceptionLinks() { - } - - public MsgVpnAclProfileClientConnectExceptionLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Client Connect Exception object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileClientConnectExceptionLinks msgVpnAclProfileClientConnectExceptionLinks = (MsgVpnAclProfileClientConnectExceptionLinks) o; - return Objects.equals(this.uri, msgVpnAclProfileClientConnectExceptionLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileClientConnectExceptionLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionResponse.java deleted file mode 100644 index a4a31211a..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileClientConnectExceptionResponse - */ -@JsonPropertyOrder({ - MsgVpnAclProfileClientConnectExceptionResponse.JSON_PROPERTY_DATA, - MsgVpnAclProfileClientConnectExceptionResponse.JSON_PROPERTY_LINKS, - MsgVpnAclProfileClientConnectExceptionResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileClientConnectExceptionResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnAclProfileClientConnectException data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnAclProfileClientConnectExceptionLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAclProfileClientConnectExceptionResponse() { - } - - public MsgVpnAclProfileClientConnectExceptionResponse data(MsgVpnAclProfileClientConnectException data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAclProfileClientConnectException getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnAclProfileClientConnectException data) { - this.data = data; - } - - - public MsgVpnAclProfileClientConnectExceptionResponse links(MsgVpnAclProfileClientConnectExceptionLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAclProfileClientConnectExceptionLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnAclProfileClientConnectExceptionLinks links) { - this.links = links; - } - - - public MsgVpnAclProfileClientConnectExceptionResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileClientConnectExceptionResponse msgVpnAclProfileClientConnectExceptionResponse = (MsgVpnAclProfileClientConnectExceptionResponse) o; - return Objects.equals(this.data, msgVpnAclProfileClientConnectExceptionResponse.data) && - Objects.equals(this.links, msgVpnAclProfileClientConnectExceptionResponse.links) && - Objects.equals(this.meta, msgVpnAclProfileClientConnectExceptionResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileClientConnectExceptionResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionsResponse.java deleted file mode 100644 index de481457d..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileClientConnectExceptionsResponse - */ -@JsonPropertyOrder({ - MsgVpnAclProfileClientConnectExceptionsResponse.JSON_PROPERTY_DATA, - MsgVpnAclProfileClientConnectExceptionsResponse.JSON_PROPERTY_LINKS, - MsgVpnAclProfileClientConnectExceptionsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileClientConnectExceptionsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAclProfileClientConnectExceptionsResponse() { - } - - public MsgVpnAclProfileClientConnectExceptionsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnAclProfileClientConnectExceptionsResponse addDataItem(MsgVpnAclProfileClientConnectException dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnAclProfileClientConnectExceptionsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnAclProfileClientConnectExceptionsResponse addLinksItem(MsgVpnAclProfileClientConnectExceptionLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnAclProfileClientConnectExceptionsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileClientConnectExceptionsResponse msgVpnAclProfileClientConnectExceptionsResponse = (MsgVpnAclProfileClientConnectExceptionsResponse) o; - return Objects.equals(this.data, msgVpnAclProfileClientConnectExceptionsResponse.data) && - Objects.equals(this.links, msgVpnAclProfileClientConnectExceptionsResponse.links) && - Objects.equals(this.meta, msgVpnAclProfileClientConnectExceptionsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileClientConnectExceptionsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileLinks.java deleted file mode 100644 index ba6da6416..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileLinks.java +++ /dev/null @@ -1,296 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileLinks - */ -@JsonPropertyOrder({ - MsgVpnAclProfileLinks.JSON_PROPERTY_CLIENT_CONNECT_EXCEPTIONS_URI, - MsgVpnAclProfileLinks.JSON_PROPERTY_PUBLISH_EXCEPTIONS_URI, - MsgVpnAclProfileLinks.JSON_PROPERTY_PUBLISH_TOPIC_EXCEPTIONS_URI, - MsgVpnAclProfileLinks.JSON_PROPERTY_SUBSCRIBE_EXCEPTIONS_URI, - MsgVpnAclProfileLinks.JSON_PROPERTY_SUBSCRIBE_SHARE_NAME_EXCEPTIONS_URI, - MsgVpnAclProfileLinks.JSON_PROPERTY_SUBSCRIBE_TOPIC_EXCEPTIONS_URI, - MsgVpnAclProfileLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileLinks { - public static final String JSON_PROPERTY_CLIENT_CONNECT_EXCEPTIONS_URI = "clientConnectExceptionsUri"; - private String clientConnectExceptionsUri; - - public static final String JSON_PROPERTY_PUBLISH_EXCEPTIONS_URI = "publishExceptionsUri"; - private String publishExceptionsUri; - - public static final String JSON_PROPERTY_PUBLISH_TOPIC_EXCEPTIONS_URI = "publishTopicExceptionsUri"; - private String publishTopicExceptionsUri; - - public static final String JSON_PROPERTY_SUBSCRIBE_EXCEPTIONS_URI = "subscribeExceptionsUri"; - private String subscribeExceptionsUri; - - public static final String JSON_PROPERTY_SUBSCRIBE_SHARE_NAME_EXCEPTIONS_URI = "subscribeShareNameExceptionsUri"; - private String subscribeShareNameExceptionsUri; - - public static final String JSON_PROPERTY_SUBSCRIBE_TOPIC_EXCEPTIONS_URI = "subscribeTopicExceptionsUri"; - private String subscribeTopicExceptionsUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnAclProfileLinks() { - } - - public MsgVpnAclProfileLinks clientConnectExceptionsUri(String clientConnectExceptionsUri) { - - this.clientConnectExceptionsUri = clientConnectExceptionsUri; - return this; - } - - /** - * The URI of this ACL Profile's collection of Client Connect Exception objects. - * @return clientConnectExceptionsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_CONNECT_EXCEPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientConnectExceptionsUri() { - return clientConnectExceptionsUri; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_CONNECT_EXCEPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientConnectExceptionsUri(String clientConnectExceptionsUri) { - this.clientConnectExceptionsUri = clientConnectExceptionsUri; - } - - - public MsgVpnAclProfileLinks publishExceptionsUri(String publishExceptionsUri) { - - this.publishExceptionsUri = publishExceptionsUri; - return this; - } - - /** - * The URI of this ACL Profile's collection of Publish Topic Exception objects. Deprecated since 2.14. Replaced by publishTopicExceptions. - * @return publishExceptionsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PUBLISH_EXCEPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getPublishExceptionsUri() { - return publishExceptionsUri; - } - - - @JsonProperty(JSON_PROPERTY_PUBLISH_EXCEPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPublishExceptionsUri(String publishExceptionsUri) { - this.publishExceptionsUri = publishExceptionsUri; - } - - - public MsgVpnAclProfileLinks publishTopicExceptionsUri(String publishTopicExceptionsUri) { - - this.publishTopicExceptionsUri = publishTopicExceptionsUri; - return this; - } - - /** - * The URI of this ACL Profile's collection of Publish Topic Exception objects. Available since 2.14. - * @return publishTopicExceptionsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PUBLISH_TOPIC_EXCEPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getPublishTopicExceptionsUri() { - return publishTopicExceptionsUri; - } - - - @JsonProperty(JSON_PROPERTY_PUBLISH_TOPIC_EXCEPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPublishTopicExceptionsUri(String publishTopicExceptionsUri) { - this.publishTopicExceptionsUri = publishTopicExceptionsUri; - } - - - public MsgVpnAclProfileLinks subscribeExceptionsUri(String subscribeExceptionsUri) { - - this.subscribeExceptionsUri = subscribeExceptionsUri; - return this; - } - - /** - * The URI of this ACL Profile's collection of Subscribe Topic Exception objects. Deprecated since 2.14. Replaced by subscribeTopicExceptions. - * @return subscribeExceptionsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_EXCEPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSubscribeExceptionsUri() { - return subscribeExceptionsUri; - } - - - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_EXCEPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubscribeExceptionsUri(String subscribeExceptionsUri) { - this.subscribeExceptionsUri = subscribeExceptionsUri; - } - - - public MsgVpnAclProfileLinks subscribeShareNameExceptionsUri(String subscribeShareNameExceptionsUri) { - - this.subscribeShareNameExceptionsUri = subscribeShareNameExceptionsUri; - return this; - } - - /** - * The URI of this ACL Profile's collection of Subscribe Share Name Exception objects. Available since 2.14. - * @return subscribeShareNameExceptionsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_SHARE_NAME_EXCEPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSubscribeShareNameExceptionsUri() { - return subscribeShareNameExceptionsUri; - } - - - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_SHARE_NAME_EXCEPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubscribeShareNameExceptionsUri(String subscribeShareNameExceptionsUri) { - this.subscribeShareNameExceptionsUri = subscribeShareNameExceptionsUri; - } - - - public MsgVpnAclProfileLinks subscribeTopicExceptionsUri(String subscribeTopicExceptionsUri) { - - this.subscribeTopicExceptionsUri = subscribeTopicExceptionsUri; - return this; - } - - /** - * The URI of this ACL Profile's collection of Subscribe Topic Exception objects. Available since 2.14. - * @return subscribeTopicExceptionsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_TOPIC_EXCEPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSubscribeTopicExceptionsUri() { - return subscribeTopicExceptionsUri; - } - - - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_TOPIC_EXCEPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubscribeTopicExceptionsUri(String subscribeTopicExceptionsUri) { - this.subscribeTopicExceptionsUri = subscribeTopicExceptionsUri; - } - - - public MsgVpnAclProfileLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this ACL Profile object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileLinks msgVpnAclProfileLinks = (MsgVpnAclProfileLinks) o; - return Objects.equals(this.clientConnectExceptionsUri, msgVpnAclProfileLinks.clientConnectExceptionsUri) && - Objects.equals(this.publishExceptionsUri, msgVpnAclProfileLinks.publishExceptionsUri) && - Objects.equals(this.publishTopicExceptionsUri, msgVpnAclProfileLinks.publishTopicExceptionsUri) && - Objects.equals(this.subscribeExceptionsUri, msgVpnAclProfileLinks.subscribeExceptionsUri) && - Objects.equals(this.subscribeShareNameExceptionsUri, msgVpnAclProfileLinks.subscribeShareNameExceptionsUri) && - Objects.equals(this.subscribeTopicExceptionsUri, msgVpnAclProfileLinks.subscribeTopicExceptionsUri) && - Objects.equals(this.uri, msgVpnAclProfileLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(clientConnectExceptionsUri, publishExceptionsUri, publishTopicExceptionsUri, subscribeExceptionsUri, subscribeShareNameExceptionsUri, subscribeTopicExceptionsUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileLinks {\n"); - sb.append(" clientConnectExceptionsUri: ").append(toIndentedString(clientConnectExceptionsUri)).append("\n"); - sb.append(" publishExceptionsUri: ").append(toIndentedString(publishExceptionsUri)).append("\n"); - sb.append(" publishTopicExceptionsUri: ").append(toIndentedString(publishTopicExceptionsUri)).append("\n"); - sb.append(" subscribeExceptionsUri: ").append(toIndentedString(subscribeExceptionsUri)).append("\n"); - sb.append(" subscribeShareNameExceptionsUri: ").append(toIndentedString(subscribeShareNameExceptionsUri)).append("\n"); - sb.append(" subscribeTopicExceptionsUri: ").append(toIndentedString(subscribeTopicExceptionsUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishException.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishException.java deleted file mode 100644 index 708a636cd..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishException.java +++ /dev/null @@ -1,235 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfilePublishException - */ -@JsonPropertyOrder({ - MsgVpnAclProfilePublishException.JSON_PROPERTY_ACL_PROFILE_NAME, - MsgVpnAclProfilePublishException.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnAclProfilePublishException.JSON_PROPERTY_PUBLISH_EXCEPTION_TOPIC, - MsgVpnAclProfilePublishException.JSON_PROPERTY_TOPIC_SYNTAX -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfilePublishException { - public static final String JSON_PROPERTY_ACL_PROFILE_NAME = "aclProfileName"; - private String aclProfileName; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_PUBLISH_EXCEPTION_TOPIC = "publishExceptionTopic"; - private String publishExceptionTopic; - - /** - * The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are: <pre> \"smf\" - Topic uses SMF syntax. \"mqtt\" - Topic uses MQTT syntax. </pre> Deprecated since 2.14. Replaced by publishTopicExceptions. - */ - public enum TopicSyntaxEnum { - SMF("smf"), - - MQTT("mqtt"); - - private String value; - - TopicSyntaxEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static TopicSyntaxEnum fromValue(String value) { - for (TopicSyntaxEnum b : TopicSyntaxEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_TOPIC_SYNTAX = "topicSyntax"; - private TopicSyntaxEnum topicSyntax; - - public MsgVpnAclProfilePublishException() { - } - - public MsgVpnAclProfilePublishException aclProfileName(String aclProfileName) { - - this.aclProfileName = aclProfileName; - return this; - } - - /** - * The name of the ACL Profile. Deprecated since 2.14. Replaced by publishTopicExceptions. - * @return aclProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAclProfileName() { - return aclProfileName; - } - - - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAclProfileName(String aclProfileName) { - this.aclProfileName = aclProfileName; - } - - - public MsgVpnAclProfilePublishException msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. Deprecated since 2.14. Replaced by publishTopicExceptions. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnAclProfilePublishException publishExceptionTopic(String publishExceptionTopic) { - - this.publishExceptionTopic = publishExceptionTopic; - return this; - } - - /** - * The topic for the exception to the default action taken. May include wildcard characters. Deprecated since 2.14. Replaced by publishTopicExceptions. - * @return publishExceptionTopic - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PUBLISH_EXCEPTION_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getPublishExceptionTopic() { - return publishExceptionTopic; - } - - - @JsonProperty(JSON_PROPERTY_PUBLISH_EXCEPTION_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPublishExceptionTopic(String publishExceptionTopic) { - this.publishExceptionTopic = publishExceptionTopic; - } - - - public MsgVpnAclProfilePublishException topicSyntax(TopicSyntaxEnum topicSyntax) { - - this.topicSyntax = topicSyntax; - return this; - } - - /** - * The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are: <pre> \"smf\" - Topic uses SMF syntax. \"mqtt\" - Topic uses MQTT syntax. </pre> Deprecated since 2.14. Replaced by publishTopicExceptions. - * @return topicSyntax - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOPIC_SYNTAX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public TopicSyntaxEnum getTopicSyntax() { - return topicSyntax; - } - - - @JsonProperty(JSON_PROPERTY_TOPIC_SYNTAX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTopicSyntax(TopicSyntaxEnum topicSyntax) { - this.topicSyntax = topicSyntax; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfilePublishException msgVpnAclProfilePublishException = (MsgVpnAclProfilePublishException) o; - return Objects.equals(this.aclProfileName, msgVpnAclProfilePublishException.aclProfileName) && - Objects.equals(this.msgVpnName, msgVpnAclProfilePublishException.msgVpnName) && - Objects.equals(this.publishExceptionTopic, msgVpnAclProfilePublishException.publishExceptionTopic) && - Objects.equals(this.topicSyntax, msgVpnAclProfilePublishException.topicSyntax); - } - - @Override - public int hashCode() { - return Objects.hash(aclProfileName, msgVpnName, publishExceptionTopic, topicSyntax); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfilePublishException {\n"); - sb.append(" aclProfileName: ").append(toIndentedString(aclProfileName)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" publishExceptionTopic: ").append(toIndentedString(publishExceptionTopic)).append("\n"); - sb.append(" topicSyntax: ").append(toIndentedString(topicSyntax)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionLinks.java deleted file mode 100644 index 97b4d11c3..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfilePublishExceptionLinks - */ -@JsonPropertyOrder({ - MsgVpnAclProfilePublishExceptionLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfilePublishExceptionLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnAclProfilePublishExceptionLinks() { - } - - public MsgVpnAclProfilePublishExceptionLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Publish Topic Exception object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfilePublishExceptionLinks msgVpnAclProfilePublishExceptionLinks = (MsgVpnAclProfilePublishExceptionLinks) o; - return Objects.equals(this.uri, msgVpnAclProfilePublishExceptionLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfilePublishExceptionLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionResponse.java deleted file mode 100644 index cd7887c5c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfilePublishExceptionResponse - */ -@JsonPropertyOrder({ - MsgVpnAclProfilePublishExceptionResponse.JSON_PROPERTY_DATA, - MsgVpnAclProfilePublishExceptionResponse.JSON_PROPERTY_LINKS, - MsgVpnAclProfilePublishExceptionResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfilePublishExceptionResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnAclProfilePublishException data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnAclProfilePublishExceptionLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAclProfilePublishExceptionResponse() { - } - - public MsgVpnAclProfilePublishExceptionResponse data(MsgVpnAclProfilePublishException data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAclProfilePublishException getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnAclProfilePublishException data) { - this.data = data; - } - - - public MsgVpnAclProfilePublishExceptionResponse links(MsgVpnAclProfilePublishExceptionLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAclProfilePublishExceptionLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnAclProfilePublishExceptionLinks links) { - this.links = links; - } - - - public MsgVpnAclProfilePublishExceptionResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfilePublishExceptionResponse msgVpnAclProfilePublishExceptionResponse = (MsgVpnAclProfilePublishExceptionResponse) o; - return Objects.equals(this.data, msgVpnAclProfilePublishExceptionResponse.data) && - Objects.equals(this.links, msgVpnAclProfilePublishExceptionResponse.links) && - Objects.equals(this.meta, msgVpnAclProfilePublishExceptionResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfilePublishExceptionResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionsResponse.java deleted file mode 100644 index 13b0e7188..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfilePublishExceptionsResponse - */ -@JsonPropertyOrder({ - MsgVpnAclProfilePublishExceptionsResponse.JSON_PROPERTY_DATA, - MsgVpnAclProfilePublishExceptionsResponse.JSON_PROPERTY_LINKS, - MsgVpnAclProfilePublishExceptionsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfilePublishExceptionsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAclProfilePublishExceptionsResponse() { - } - - public MsgVpnAclProfilePublishExceptionsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnAclProfilePublishExceptionsResponse addDataItem(MsgVpnAclProfilePublishException dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnAclProfilePublishExceptionsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnAclProfilePublishExceptionsResponse addLinksItem(MsgVpnAclProfilePublishExceptionLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnAclProfilePublishExceptionsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfilePublishExceptionsResponse msgVpnAclProfilePublishExceptionsResponse = (MsgVpnAclProfilePublishExceptionsResponse) o; - return Objects.equals(this.data, msgVpnAclProfilePublishExceptionsResponse.data) && - Objects.equals(this.links, msgVpnAclProfilePublishExceptionsResponse.links) && - Objects.equals(this.meta, msgVpnAclProfilePublishExceptionsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfilePublishExceptionsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicException.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicException.java deleted file mode 100644 index 12a5bf61d..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicException.java +++ /dev/null @@ -1,235 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfilePublishTopicException - */ -@JsonPropertyOrder({ - MsgVpnAclProfilePublishTopicException.JSON_PROPERTY_ACL_PROFILE_NAME, - MsgVpnAclProfilePublishTopicException.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnAclProfilePublishTopicException.JSON_PROPERTY_PUBLISH_TOPIC_EXCEPTION, - MsgVpnAclProfilePublishTopicException.JSON_PROPERTY_PUBLISH_TOPIC_EXCEPTION_SYNTAX -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfilePublishTopicException { - public static final String JSON_PROPERTY_ACL_PROFILE_NAME = "aclProfileName"; - private String aclProfileName; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_PUBLISH_TOPIC_EXCEPTION = "publishTopicException"; - private String publishTopicException; - - /** - * The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are: <pre> \"smf\" - Topic uses SMF syntax. \"mqtt\" - Topic uses MQTT syntax. </pre> - */ - public enum PublishTopicExceptionSyntaxEnum { - SMF("smf"), - - MQTT("mqtt"); - - private String value; - - PublishTopicExceptionSyntaxEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static PublishTopicExceptionSyntaxEnum fromValue(String value) { - for (PublishTopicExceptionSyntaxEnum b : PublishTopicExceptionSyntaxEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_PUBLISH_TOPIC_EXCEPTION_SYNTAX = "publishTopicExceptionSyntax"; - private PublishTopicExceptionSyntaxEnum publishTopicExceptionSyntax; - - public MsgVpnAclProfilePublishTopicException() { - } - - public MsgVpnAclProfilePublishTopicException aclProfileName(String aclProfileName) { - - this.aclProfileName = aclProfileName; - return this; - } - - /** - * The name of the ACL Profile. - * @return aclProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAclProfileName() { - return aclProfileName; - } - - - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAclProfileName(String aclProfileName) { - this.aclProfileName = aclProfileName; - } - - - public MsgVpnAclProfilePublishTopicException msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnAclProfilePublishTopicException publishTopicException(String publishTopicException) { - - this.publishTopicException = publishTopicException; - return this; - } - - /** - * The topic for the exception to the default action taken. May include wildcard characters. - * @return publishTopicException - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PUBLISH_TOPIC_EXCEPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getPublishTopicException() { - return publishTopicException; - } - - - @JsonProperty(JSON_PROPERTY_PUBLISH_TOPIC_EXCEPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPublishTopicException(String publishTopicException) { - this.publishTopicException = publishTopicException; - } - - - public MsgVpnAclProfilePublishTopicException publishTopicExceptionSyntax(PublishTopicExceptionSyntaxEnum publishTopicExceptionSyntax) { - - this.publishTopicExceptionSyntax = publishTopicExceptionSyntax; - return this; - } - - /** - * The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are: <pre> \"smf\" - Topic uses SMF syntax. \"mqtt\" - Topic uses MQTT syntax. </pre> - * @return publishTopicExceptionSyntax - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PUBLISH_TOPIC_EXCEPTION_SYNTAX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PublishTopicExceptionSyntaxEnum getPublishTopicExceptionSyntax() { - return publishTopicExceptionSyntax; - } - - - @JsonProperty(JSON_PROPERTY_PUBLISH_TOPIC_EXCEPTION_SYNTAX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPublishTopicExceptionSyntax(PublishTopicExceptionSyntaxEnum publishTopicExceptionSyntax) { - this.publishTopicExceptionSyntax = publishTopicExceptionSyntax; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfilePublishTopicException msgVpnAclProfilePublishTopicException = (MsgVpnAclProfilePublishTopicException) o; - return Objects.equals(this.aclProfileName, msgVpnAclProfilePublishTopicException.aclProfileName) && - Objects.equals(this.msgVpnName, msgVpnAclProfilePublishTopicException.msgVpnName) && - Objects.equals(this.publishTopicException, msgVpnAclProfilePublishTopicException.publishTopicException) && - Objects.equals(this.publishTopicExceptionSyntax, msgVpnAclProfilePublishTopicException.publishTopicExceptionSyntax); - } - - @Override - public int hashCode() { - return Objects.hash(aclProfileName, msgVpnName, publishTopicException, publishTopicExceptionSyntax); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfilePublishTopicException {\n"); - sb.append(" aclProfileName: ").append(toIndentedString(aclProfileName)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" publishTopicException: ").append(toIndentedString(publishTopicException)).append("\n"); - sb.append(" publishTopicExceptionSyntax: ").append(toIndentedString(publishTopicExceptionSyntax)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionLinks.java deleted file mode 100644 index 9132286cc..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfilePublishTopicExceptionLinks - */ -@JsonPropertyOrder({ - MsgVpnAclProfilePublishTopicExceptionLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfilePublishTopicExceptionLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnAclProfilePublishTopicExceptionLinks() { - } - - public MsgVpnAclProfilePublishTopicExceptionLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Publish Topic Exception object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfilePublishTopicExceptionLinks msgVpnAclProfilePublishTopicExceptionLinks = (MsgVpnAclProfilePublishTopicExceptionLinks) o; - return Objects.equals(this.uri, msgVpnAclProfilePublishTopicExceptionLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfilePublishTopicExceptionLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionResponse.java deleted file mode 100644 index f3dc0b051..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfilePublishTopicExceptionResponse - */ -@JsonPropertyOrder({ - MsgVpnAclProfilePublishTopicExceptionResponse.JSON_PROPERTY_DATA, - MsgVpnAclProfilePublishTopicExceptionResponse.JSON_PROPERTY_LINKS, - MsgVpnAclProfilePublishTopicExceptionResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfilePublishTopicExceptionResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnAclProfilePublishTopicException data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnAclProfilePublishTopicExceptionLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAclProfilePublishTopicExceptionResponse() { - } - - public MsgVpnAclProfilePublishTopicExceptionResponse data(MsgVpnAclProfilePublishTopicException data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAclProfilePublishTopicException getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnAclProfilePublishTopicException data) { - this.data = data; - } - - - public MsgVpnAclProfilePublishTopicExceptionResponse links(MsgVpnAclProfilePublishTopicExceptionLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAclProfilePublishTopicExceptionLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnAclProfilePublishTopicExceptionLinks links) { - this.links = links; - } - - - public MsgVpnAclProfilePublishTopicExceptionResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfilePublishTopicExceptionResponse msgVpnAclProfilePublishTopicExceptionResponse = (MsgVpnAclProfilePublishTopicExceptionResponse) o; - return Objects.equals(this.data, msgVpnAclProfilePublishTopicExceptionResponse.data) && - Objects.equals(this.links, msgVpnAclProfilePublishTopicExceptionResponse.links) && - Objects.equals(this.meta, msgVpnAclProfilePublishTopicExceptionResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfilePublishTopicExceptionResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionsResponse.java deleted file mode 100644 index 893d071d5..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfilePublishTopicExceptionsResponse - */ -@JsonPropertyOrder({ - MsgVpnAclProfilePublishTopicExceptionsResponse.JSON_PROPERTY_DATA, - MsgVpnAclProfilePublishTopicExceptionsResponse.JSON_PROPERTY_LINKS, - MsgVpnAclProfilePublishTopicExceptionsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfilePublishTopicExceptionsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAclProfilePublishTopicExceptionsResponse() { - } - - public MsgVpnAclProfilePublishTopicExceptionsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnAclProfilePublishTopicExceptionsResponse addDataItem(MsgVpnAclProfilePublishTopicException dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnAclProfilePublishTopicExceptionsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnAclProfilePublishTopicExceptionsResponse addLinksItem(MsgVpnAclProfilePublishTopicExceptionLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnAclProfilePublishTopicExceptionsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfilePublishTopicExceptionsResponse msgVpnAclProfilePublishTopicExceptionsResponse = (MsgVpnAclProfilePublishTopicExceptionsResponse) o; - return Objects.equals(this.data, msgVpnAclProfilePublishTopicExceptionsResponse.data) && - Objects.equals(this.links, msgVpnAclProfilePublishTopicExceptionsResponse.links) && - Objects.equals(this.meta, msgVpnAclProfilePublishTopicExceptionsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfilePublishTopicExceptionsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileResponse.java deleted file mode 100644 index ec9974fcd..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileResponse - */ -@JsonPropertyOrder({ - MsgVpnAclProfileResponse.JSON_PROPERTY_DATA, - MsgVpnAclProfileResponse.JSON_PROPERTY_LINKS, - MsgVpnAclProfileResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnAclProfile data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnAclProfileLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAclProfileResponse() { - } - - public MsgVpnAclProfileResponse data(MsgVpnAclProfile data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAclProfile getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnAclProfile data) { - this.data = data; - } - - - public MsgVpnAclProfileResponse links(MsgVpnAclProfileLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAclProfileLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnAclProfileLinks links) { - this.links = links; - } - - - public MsgVpnAclProfileResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileResponse msgVpnAclProfileResponse = (MsgVpnAclProfileResponse) o; - return Objects.equals(this.data, msgVpnAclProfileResponse.data) && - Objects.equals(this.links, msgVpnAclProfileResponse.links) && - Objects.equals(this.meta, msgVpnAclProfileResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeException.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeException.java deleted file mode 100644 index fe7b903e9..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeException.java +++ /dev/null @@ -1,235 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileSubscribeException - */ -@JsonPropertyOrder({ - MsgVpnAclProfileSubscribeException.JSON_PROPERTY_ACL_PROFILE_NAME, - MsgVpnAclProfileSubscribeException.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnAclProfileSubscribeException.JSON_PROPERTY_SUBSCRIBE_EXCEPTION_TOPIC, - MsgVpnAclProfileSubscribeException.JSON_PROPERTY_TOPIC_SYNTAX -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileSubscribeException { - public static final String JSON_PROPERTY_ACL_PROFILE_NAME = "aclProfileName"; - private String aclProfileName; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_SUBSCRIBE_EXCEPTION_TOPIC = "subscribeExceptionTopic"; - private String subscribeExceptionTopic; - - /** - * The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are: <pre> \"smf\" - Topic uses SMF syntax. \"mqtt\" - Topic uses MQTT syntax. </pre> Deprecated since 2.14. Replaced by subscribeTopicExceptions. - */ - public enum TopicSyntaxEnum { - SMF("smf"), - - MQTT("mqtt"); - - private String value; - - TopicSyntaxEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static TopicSyntaxEnum fromValue(String value) { - for (TopicSyntaxEnum b : TopicSyntaxEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_TOPIC_SYNTAX = "topicSyntax"; - private TopicSyntaxEnum topicSyntax; - - public MsgVpnAclProfileSubscribeException() { - } - - public MsgVpnAclProfileSubscribeException aclProfileName(String aclProfileName) { - - this.aclProfileName = aclProfileName; - return this; - } - - /** - * The name of the ACL Profile. Deprecated since 2.14. Replaced by subscribeTopicExceptions. - * @return aclProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAclProfileName() { - return aclProfileName; - } - - - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAclProfileName(String aclProfileName) { - this.aclProfileName = aclProfileName; - } - - - public MsgVpnAclProfileSubscribeException msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. Deprecated since 2.14. Replaced by subscribeTopicExceptions. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnAclProfileSubscribeException subscribeExceptionTopic(String subscribeExceptionTopic) { - - this.subscribeExceptionTopic = subscribeExceptionTopic; - return this; - } - - /** - * The topic for the exception to the default action taken. May include wildcard characters. Deprecated since 2.14. Replaced by subscribeTopicExceptions. - * @return subscribeExceptionTopic - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_EXCEPTION_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSubscribeExceptionTopic() { - return subscribeExceptionTopic; - } - - - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_EXCEPTION_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubscribeExceptionTopic(String subscribeExceptionTopic) { - this.subscribeExceptionTopic = subscribeExceptionTopic; - } - - - public MsgVpnAclProfileSubscribeException topicSyntax(TopicSyntaxEnum topicSyntax) { - - this.topicSyntax = topicSyntax; - return this; - } - - /** - * The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are: <pre> \"smf\" - Topic uses SMF syntax. \"mqtt\" - Topic uses MQTT syntax. </pre> Deprecated since 2.14. Replaced by subscribeTopicExceptions. - * @return topicSyntax - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOPIC_SYNTAX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public TopicSyntaxEnum getTopicSyntax() { - return topicSyntax; - } - - - @JsonProperty(JSON_PROPERTY_TOPIC_SYNTAX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTopicSyntax(TopicSyntaxEnum topicSyntax) { - this.topicSyntax = topicSyntax; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileSubscribeException msgVpnAclProfileSubscribeException = (MsgVpnAclProfileSubscribeException) o; - return Objects.equals(this.aclProfileName, msgVpnAclProfileSubscribeException.aclProfileName) && - Objects.equals(this.msgVpnName, msgVpnAclProfileSubscribeException.msgVpnName) && - Objects.equals(this.subscribeExceptionTopic, msgVpnAclProfileSubscribeException.subscribeExceptionTopic) && - Objects.equals(this.topicSyntax, msgVpnAclProfileSubscribeException.topicSyntax); - } - - @Override - public int hashCode() { - return Objects.hash(aclProfileName, msgVpnName, subscribeExceptionTopic, topicSyntax); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileSubscribeException {\n"); - sb.append(" aclProfileName: ").append(toIndentedString(aclProfileName)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" subscribeExceptionTopic: ").append(toIndentedString(subscribeExceptionTopic)).append("\n"); - sb.append(" topicSyntax: ").append(toIndentedString(topicSyntax)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionLinks.java deleted file mode 100644 index a96f9f53c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileSubscribeExceptionLinks - */ -@JsonPropertyOrder({ - MsgVpnAclProfileSubscribeExceptionLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileSubscribeExceptionLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnAclProfileSubscribeExceptionLinks() { - } - - public MsgVpnAclProfileSubscribeExceptionLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Subscribe Topic Exception object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileSubscribeExceptionLinks msgVpnAclProfileSubscribeExceptionLinks = (MsgVpnAclProfileSubscribeExceptionLinks) o; - return Objects.equals(this.uri, msgVpnAclProfileSubscribeExceptionLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileSubscribeExceptionLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionResponse.java deleted file mode 100644 index 2f44c5392..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileSubscribeExceptionResponse - */ -@JsonPropertyOrder({ - MsgVpnAclProfileSubscribeExceptionResponse.JSON_PROPERTY_DATA, - MsgVpnAclProfileSubscribeExceptionResponse.JSON_PROPERTY_LINKS, - MsgVpnAclProfileSubscribeExceptionResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileSubscribeExceptionResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnAclProfileSubscribeException data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnAclProfileSubscribeExceptionLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAclProfileSubscribeExceptionResponse() { - } - - public MsgVpnAclProfileSubscribeExceptionResponse data(MsgVpnAclProfileSubscribeException data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAclProfileSubscribeException getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnAclProfileSubscribeException data) { - this.data = data; - } - - - public MsgVpnAclProfileSubscribeExceptionResponse links(MsgVpnAclProfileSubscribeExceptionLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAclProfileSubscribeExceptionLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnAclProfileSubscribeExceptionLinks links) { - this.links = links; - } - - - public MsgVpnAclProfileSubscribeExceptionResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileSubscribeExceptionResponse msgVpnAclProfileSubscribeExceptionResponse = (MsgVpnAclProfileSubscribeExceptionResponse) o; - return Objects.equals(this.data, msgVpnAclProfileSubscribeExceptionResponse.data) && - Objects.equals(this.links, msgVpnAclProfileSubscribeExceptionResponse.links) && - Objects.equals(this.meta, msgVpnAclProfileSubscribeExceptionResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileSubscribeExceptionResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionsResponse.java deleted file mode 100644 index 18c58b3f6..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileSubscribeExceptionsResponse - */ -@JsonPropertyOrder({ - MsgVpnAclProfileSubscribeExceptionsResponse.JSON_PROPERTY_DATA, - MsgVpnAclProfileSubscribeExceptionsResponse.JSON_PROPERTY_LINKS, - MsgVpnAclProfileSubscribeExceptionsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileSubscribeExceptionsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAclProfileSubscribeExceptionsResponse() { - } - - public MsgVpnAclProfileSubscribeExceptionsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnAclProfileSubscribeExceptionsResponse addDataItem(MsgVpnAclProfileSubscribeException dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnAclProfileSubscribeExceptionsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnAclProfileSubscribeExceptionsResponse addLinksItem(MsgVpnAclProfileSubscribeExceptionLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnAclProfileSubscribeExceptionsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileSubscribeExceptionsResponse msgVpnAclProfileSubscribeExceptionsResponse = (MsgVpnAclProfileSubscribeExceptionsResponse) o; - return Objects.equals(this.data, msgVpnAclProfileSubscribeExceptionsResponse.data) && - Objects.equals(this.links, msgVpnAclProfileSubscribeExceptionsResponse.links) && - Objects.equals(this.meta, msgVpnAclProfileSubscribeExceptionsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileSubscribeExceptionsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameException.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameException.java deleted file mode 100644 index 8990a1ecf..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameException.java +++ /dev/null @@ -1,235 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileSubscribeShareNameException - */ -@JsonPropertyOrder({ - MsgVpnAclProfileSubscribeShareNameException.JSON_PROPERTY_ACL_PROFILE_NAME, - MsgVpnAclProfileSubscribeShareNameException.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnAclProfileSubscribeShareNameException.JSON_PROPERTY_SUBSCRIBE_SHARE_NAME_EXCEPTION, - MsgVpnAclProfileSubscribeShareNameException.JSON_PROPERTY_SUBSCRIBE_SHARE_NAME_EXCEPTION_SYNTAX -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileSubscribeShareNameException { - public static final String JSON_PROPERTY_ACL_PROFILE_NAME = "aclProfileName"; - private String aclProfileName; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_SUBSCRIBE_SHARE_NAME_EXCEPTION = "subscribeShareNameException"; - private String subscribeShareNameException; - - /** - * The syntax of the subscribe share name for the exception to the default action taken. The allowed values and their meaning are: <pre> \"smf\" - Topic uses SMF syntax. \"mqtt\" - Topic uses MQTT syntax. </pre> - */ - public enum SubscribeShareNameExceptionSyntaxEnum { - SMF("smf"), - - MQTT("mqtt"); - - private String value; - - SubscribeShareNameExceptionSyntaxEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static SubscribeShareNameExceptionSyntaxEnum fromValue(String value) { - for (SubscribeShareNameExceptionSyntaxEnum b : SubscribeShareNameExceptionSyntaxEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_SUBSCRIBE_SHARE_NAME_EXCEPTION_SYNTAX = "subscribeShareNameExceptionSyntax"; - private SubscribeShareNameExceptionSyntaxEnum subscribeShareNameExceptionSyntax; - - public MsgVpnAclProfileSubscribeShareNameException() { - } - - public MsgVpnAclProfileSubscribeShareNameException aclProfileName(String aclProfileName) { - - this.aclProfileName = aclProfileName; - return this; - } - - /** - * The name of the ACL Profile. - * @return aclProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAclProfileName() { - return aclProfileName; - } - - - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAclProfileName(String aclProfileName) { - this.aclProfileName = aclProfileName; - } - - - public MsgVpnAclProfileSubscribeShareNameException msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnAclProfileSubscribeShareNameException subscribeShareNameException(String subscribeShareNameException) { - - this.subscribeShareNameException = subscribeShareNameException; - return this; - } - - /** - * The subscribe share name exception to the default action taken. May include wildcard characters. - * @return subscribeShareNameException - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_SHARE_NAME_EXCEPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSubscribeShareNameException() { - return subscribeShareNameException; - } - - - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_SHARE_NAME_EXCEPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubscribeShareNameException(String subscribeShareNameException) { - this.subscribeShareNameException = subscribeShareNameException; - } - - - public MsgVpnAclProfileSubscribeShareNameException subscribeShareNameExceptionSyntax(SubscribeShareNameExceptionSyntaxEnum subscribeShareNameExceptionSyntax) { - - this.subscribeShareNameExceptionSyntax = subscribeShareNameExceptionSyntax; - return this; - } - - /** - * The syntax of the subscribe share name for the exception to the default action taken. The allowed values and their meaning are: <pre> \"smf\" - Topic uses SMF syntax. \"mqtt\" - Topic uses MQTT syntax. </pre> - * @return subscribeShareNameExceptionSyntax - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_SHARE_NAME_EXCEPTION_SYNTAX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public SubscribeShareNameExceptionSyntaxEnum getSubscribeShareNameExceptionSyntax() { - return subscribeShareNameExceptionSyntax; - } - - - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_SHARE_NAME_EXCEPTION_SYNTAX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubscribeShareNameExceptionSyntax(SubscribeShareNameExceptionSyntaxEnum subscribeShareNameExceptionSyntax) { - this.subscribeShareNameExceptionSyntax = subscribeShareNameExceptionSyntax; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileSubscribeShareNameException msgVpnAclProfileSubscribeShareNameException = (MsgVpnAclProfileSubscribeShareNameException) o; - return Objects.equals(this.aclProfileName, msgVpnAclProfileSubscribeShareNameException.aclProfileName) && - Objects.equals(this.msgVpnName, msgVpnAclProfileSubscribeShareNameException.msgVpnName) && - Objects.equals(this.subscribeShareNameException, msgVpnAclProfileSubscribeShareNameException.subscribeShareNameException) && - Objects.equals(this.subscribeShareNameExceptionSyntax, msgVpnAclProfileSubscribeShareNameException.subscribeShareNameExceptionSyntax); - } - - @Override - public int hashCode() { - return Objects.hash(aclProfileName, msgVpnName, subscribeShareNameException, subscribeShareNameExceptionSyntax); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileSubscribeShareNameException {\n"); - sb.append(" aclProfileName: ").append(toIndentedString(aclProfileName)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" subscribeShareNameException: ").append(toIndentedString(subscribeShareNameException)).append("\n"); - sb.append(" subscribeShareNameExceptionSyntax: ").append(toIndentedString(subscribeShareNameExceptionSyntax)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionLinks.java deleted file mode 100644 index 498f92489..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileSubscribeShareNameExceptionLinks - */ -@JsonPropertyOrder({ - MsgVpnAclProfileSubscribeShareNameExceptionLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileSubscribeShareNameExceptionLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnAclProfileSubscribeShareNameExceptionLinks() { - } - - public MsgVpnAclProfileSubscribeShareNameExceptionLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Subscribe Share Name Exception object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileSubscribeShareNameExceptionLinks msgVpnAclProfileSubscribeShareNameExceptionLinks = (MsgVpnAclProfileSubscribeShareNameExceptionLinks) o; - return Objects.equals(this.uri, msgVpnAclProfileSubscribeShareNameExceptionLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileSubscribeShareNameExceptionLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionResponse.java deleted file mode 100644 index 0a9f7fd3a..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileSubscribeShareNameExceptionResponse - */ -@JsonPropertyOrder({ - MsgVpnAclProfileSubscribeShareNameExceptionResponse.JSON_PROPERTY_DATA, - MsgVpnAclProfileSubscribeShareNameExceptionResponse.JSON_PROPERTY_LINKS, - MsgVpnAclProfileSubscribeShareNameExceptionResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileSubscribeShareNameExceptionResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnAclProfileSubscribeShareNameException data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnAclProfileSubscribeShareNameExceptionLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAclProfileSubscribeShareNameExceptionResponse() { - } - - public MsgVpnAclProfileSubscribeShareNameExceptionResponse data(MsgVpnAclProfileSubscribeShareNameException data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAclProfileSubscribeShareNameException getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnAclProfileSubscribeShareNameException data) { - this.data = data; - } - - - public MsgVpnAclProfileSubscribeShareNameExceptionResponse links(MsgVpnAclProfileSubscribeShareNameExceptionLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAclProfileSubscribeShareNameExceptionLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnAclProfileSubscribeShareNameExceptionLinks links) { - this.links = links; - } - - - public MsgVpnAclProfileSubscribeShareNameExceptionResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileSubscribeShareNameExceptionResponse msgVpnAclProfileSubscribeShareNameExceptionResponse = (MsgVpnAclProfileSubscribeShareNameExceptionResponse) o; - return Objects.equals(this.data, msgVpnAclProfileSubscribeShareNameExceptionResponse.data) && - Objects.equals(this.links, msgVpnAclProfileSubscribeShareNameExceptionResponse.links) && - Objects.equals(this.meta, msgVpnAclProfileSubscribeShareNameExceptionResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileSubscribeShareNameExceptionResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionsResponse.java deleted file mode 100644 index ecadcf190..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileSubscribeShareNameExceptionsResponse - */ -@JsonPropertyOrder({ - MsgVpnAclProfileSubscribeShareNameExceptionsResponse.JSON_PROPERTY_DATA, - MsgVpnAclProfileSubscribeShareNameExceptionsResponse.JSON_PROPERTY_LINKS, - MsgVpnAclProfileSubscribeShareNameExceptionsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileSubscribeShareNameExceptionsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAclProfileSubscribeShareNameExceptionsResponse() { - } - - public MsgVpnAclProfileSubscribeShareNameExceptionsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnAclProfileSubscribeShareNameExceptionsResponse addDataItem(MsgVpnAclProfileSubscribeShareNameException dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnAclProfileSubscribeShareNameExceptionsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnAclProfileSubscribeShareNameExceptionsResponse addLinksItem(MsgVpnAclProfileSubscribeShareNameExceptionLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnAclProfileSubscribeShareNameExceptionsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileSubscribeShareNameExceptionsResponse msgVpnAclProfileSubscribeShareNameExceptionsResponse = (MsgVpnAclProfileSubscribeShareNameExceptionsResponse) o; - return Objects.equals(this.data, msgVpnAclProfileSubscribeShareNameExceptionsResponse.data) && - Objects.equals(this.links, msgVpnAclProfileSubscribeShareNameExceptionsResponse.links) && - Objects.equals(this.meta, msgVpnAclProfileSubscribeShareNameExceptionsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileSubscribeShareNameExceptionsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicException.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicException.java deleted file mode 100644 index c25511da0..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicException.java +++ /dev/null @@ -1,235 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileSubscribeTopicException - */ -@JsonPropertyOrder({ - MsgVpnAclProfileSubscribeTopicException.JSON_PROPERTY_ACL_PROFILE_NAME, - MsgVpnAclProfileSubscribeTopicException.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnAclProfileSubscribeTopicException.JSON_PROPERTY_SUBSCRIBE_TOPIC_EXCEPTION, - MsgVpnAclProfileSubscribeTopicException.JSON_PROPERTY_SUBSCRIBE_TOPIC_EXCEPTION_SYNTAX -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileSubscribeTopicException { - public static final String JSON_PROPERTY_ACL_PROFILE_NAME = "aclProfileName"; - private String aclProfileName; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_SUBSCRIBE_TOPIC_EXCEPTION = "subscribeTopicException"; - private String subscribeTopicException; - - /** - * The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are: <pre> \"smf\" - Topic uses SMF syntax. \"mqtt\" - Topic uses MQTT syntax. </pre> - */ - public enum SubscribeTopicExceptionSyntaxEnum { - SMF("smf"), - - MQTT("mqtt"); - - private String value; - - SubscribeTopicExceptionSyntaxEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static SubscribeTopicExceptionSyntaxEnum fromValue(String value) { - for (SubscribeTopicExceptionSyntaxEnum b : SubscribeTopicExceptionSyntaxEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_SUBSCRIBE_TOPIC_EXCEPTION_SYNTAX = "subscribeTopicExceptionSyntax"; - private SubscribeTopicExceptionSyntaxEnum subscribeTopicExceptionSyntax; - - public MsgVpnAclProfileSubscribeTopicException() { - } - - public MsgVpnAclProfileSubscribeTopicException aclProfileName(String aclProfileName) { - - this.aclProfileName = aclProfileName; - return this; - } - - /** - * The name of the ACL Profile. - * @return aclProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAclProfileName() { - return aclProfileName; - } - - - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAclProfileName(String aclProfileName) { - this.aclProfileName = aclProfileName; - } - - - public MsgVpnAclProfileSubscribeTopicException msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnAclProfileSubscribeTopicException subscribeTopicException(String subscribeTopicException) { - - this.subscribeTopicException = subscribeTopicException; - return this; - } - - /** - * The topic for the exception to the default action taken. May include wildcard characters. - * @return subscribeTopicException - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_TOPIC_EXCEPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSubscribeTopicException() { - return subscribeTopicException; - } - - - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_TOPIC_EXCEPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubscribeTopicException(String subscribeTopicException) { - this.subscribeTopicException = subscribeTopicException; - } - - - public MsgVpnAclProfileSubscribeTopicException subscribeTopicExceptionSyntax(SubscribeTopicExceptionSyntaxEnum subscribeTopicExceptionSyntax) { - - this.subscribeTopicExceptionSyntax = subscribeTopicExceptionSyntax; - return this; - } - - /** - * The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are: <pre> \"smf\" - Topic uses SMF syntax. \"mqtt\" - Topic uses MQTT syntax. </pre> - * @return subscribeTopicExceptionSyntax - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_TOPIC_EXCEPTION_SYNTAX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public SubscribeTopicExceptionSyntaxEnum getSubscribeTopicExceptionSyntax() { - return subscribeTopicExceptionSyntax; - } - - - @JsonProperty(JSON_PROPERTY_SUBSCRIBE_TOPIC_EXCEPTION_SYNTAX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubscribeTopicExceptionSyntax(SubscribeTopicExceptionSyntaxEnum subscribeTopicExceptionSyntax) { - this.subscribeTopicExceptionSyntax = subscribeTopicExceptionSyntax; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileSubscribeTopicException msgVpnAclProfileSubscribeTopicException = (MsgVpnAclProfileSubscribeTopicException) o; - return Objects.equals(this.aclProfileName, msgVpnAclProfileSubscribeTopicException.aclProfileName) && - Objects.equals(this.msgVpnName, msgVpnAclProfileSubscribeTopicException.msgVpnName) && - Objects.equals(this.subscribeTopicException, msgVpnAclProfileSubscribeTopicException.subscribeTopicException) && - Objects.equals(this.subscribeTopicExceptionSyntax, msgVpnAclProfileSubscribeTopicException.subscribeTopicExceptionSyntax); - } - - @Override - public int hashCode() { - return Objects.hash(aclProfileName, msgVpnName, subscribeTopicException, subscribeTopicExceptionSyntax); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileSubscribeTopicException {\n"); - sb.append(" aclProfileName: ").append(toIndentedString(aclProfileName)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" subscribeTopicException: ").append(toIndentedString(subscribeTopicException)).append("\n"); - sb.append(" subscribeTopicExceptionSyntax: ").append(toIndentedString(subscribeTopicExceptionSyntax)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionLinks.java deleted file mode 100644 index 18d44b229..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileSubscribeTopicExceptionLinks - */ -@JsonPropertyOrder({ - MsgVpnAclProfileSubscribeTopicExceptionLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileSubscribeTopicExceptionLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnAclProfileSubscribeTopicExceptionLinks() { - } - - public MsgVpnAclProfileSubscribeTopicExceptionLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Subscribe Topic Exception object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileSubscribeTopicExceptionLinks msgVpnAclProfileSubscribeTopicExceptionLinks = (MsgVpnAclProfileSubscribeTopicExceptionLinks) o; - return Objects.equals(this.uri, msgVpnAclProfileSubscribeTopicExceptionLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileSubscribeTopicExceptionLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionResponse.java deleted file mode 100644 index 774f7abbf..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileSubscribeTopicExceptionResponse - */ -@JsonPropertyOrder({ - MsgVpnAclProfileSubscribeTopicExceptionResponse.JSON_PROPERTY_DATA, - MsgVpnAclProfileSubscribeTopicExceptionResponse.JSON_PROPERTY_LINKS, - MsgVpnAclProfileSubscribeTopicExceptionResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileSubscribeTopicExceptionResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnAclProfileSubscribeTopicException data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnAclProfileSubscribeTopicExceptionLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAclProfileSubscribeTopicExceptionResponse() { - } - - public MsgVpnAclProfileSubscribeTopicExceptionResponse data(MsgVpnAclProfileSubscribeTopicException data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAclProfileSubscribeTopicException getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnAclProfileSubscribeTopicException data) { - this.data = data; - } - - - public MsgVpnAclProfileSubscribeTopicExceptionResponse links(MsgVpnAclProfileSubscribeTopicExceptionLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAclProfileSubscribeTopicExceptionLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnAclProfileSubscribeTopicExceptionLinks links) { - this.links = links; - } - - - public MsgVpnAclProfileSubscribeTopicExceptionResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileSubscribeTopicExceptionResponse msgVpnAclProfileSubscribeTopicExceptionResponse = (MsgVpnAclProfileSubscribeTopicExceptionResponse) o; - return Objects.equals(this.data, msgVpnAclProfileSubscribeTopicExceptionResponse.data) && - Objects.equals(this.links, msgVpnAclProfileSubscribeTopicExceptionResponse.links) && - Objects.equals(this.meta, msgVpnAclProfileSubscribeTopicExceptionResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileSubscribeTopicExceptionResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionsResponse.java deleted file mode 100644 index 5ec28f94c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfileSubscribeTopicExceptionsResponse - */ -@JsonPropertyOrder({ - MsgVpnAclProfileSubscribeTopicExceptionsResponse.JSON_PROPERTY_DATA, - MsgVpnAclProfileSubscribeTopicExceptionsResponse.JSON_PROPERTY_LINKS, - MsgVpnAclProfileSubscribeTopicExceptionsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfileSubscribeTopicExceptionsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAclProfileSubscribeTopicExceptionsResponse() { - } - - public MsgVpnAclProfileSubscribeTopicExceptionsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnAclProfileSubscribeTopicExceptionsResponse addDataItem(MsgVpnAclProfileSubscribeTopicException dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnAclProfileSubscribeTopicExceptionsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnAclProfileSubscribeTopicExceptionsResponse addLinksItem(MsgVpnAclProfileSubscribeTopicExceptionLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnAclProfileSubscribeTopicExceptionsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfileSubscribeTopicExceptionsResponse msgVpnAclProfileSubscribeTopicExceptionsResponse = (MsgVpnAclProfileSubscribeTopicExceptionsResponse) o; - return Objects.equals(this.data, msgVpnAclProfileSubscribeTopicExceptionsResponse.data) && - Objects.equals(this.links, msgVpnAclProfileSubscribeTopicExceptionsResponse.links) && - Objects.equals(this.meta, msgVpnAclProfileSubscribeTopicExceptionsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfileSubscribeTopicExceptionsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilesResponse.java deleted file mode 100644 index be0120c63..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAclProfilesResponse - */ -@JsonPropertyOrder({ - MsgVpnAclProfilesResponse.JSON_PROPERTY_DATA, - MsgVpnAclProfilesResponse.JSON_PROPERTY_LINKS, - MsgVpnAclProfilesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAclProfilesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAclProfilesResponse() { - } - - public MsgVpnAclProfilesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnAclProfilesResponse addDataItem(MsgVpnAclProfile dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnAclProfilesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnAclProfilesResponse addLinksItem(MsgVpnAclProfileLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnAclProfilesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAclProfilesResponse msgVpnAclProfilesResponse = (MsgVpnAclProfilesResponse) o; - return Objects.equals(this.data, msgVpnAclProfilesResponse.data) && - Objects.equals(this.links, msgVpnAclProfilesResponse.links) && - Objects.equals(this.meta, msgVpnAclProfilesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAclProfilesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfile.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfile.java deleted file mode 100644 index 23e4ea573..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfile.java +++ /dev/null @@ -1,1067 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthenticationOauthProfile - */ -@JsonPropertyOrder({ - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_AUTHORIZATION_GROUPS_CLAIM_NAME, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_CLIENT_ID, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_CLIENT_REQUIRED_TYPE, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_CLIENT_SECRET, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_CLIENT_VALIDATE_TYPE_ENABLED, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_DISCONNECT_ON_TOKEN_EXPIRATION_ENABLED, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_ENABLED, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_ENDPOINT_DISCOVERY, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_ENDPOINT_DISCOVERY_REFRESH_INTERVAL, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_ENDPOINT_INTROSPECTION, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_ENDPOINT_INTROSPECTION_TIMEOUT, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_ENDPOINT_JWKS, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_ENDPOINT_JWKS_REFRESH_INTERVAL, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_ENDPOINT_USERINFO, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_ENDPOINT_USERINFO_TIMEOUT, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_ISSUER, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_MQTT_USERNAME_VALIDATE_ENABLED, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_OAUTH_PROFILE_NAME, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_OAUTH_ROLE, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_RESOURCE_SERVER_PARSE_ACCESS_TOKEN_ENABLED, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_AUDIENCE, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_ISSUER, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_SCOPE, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_TYPE, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_AUDIENCE_ENABLED, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_ISSUER_ENABLED, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_SCOPE_ENABLED, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_TYPE_ENABLED, - MsgVpnAuthenticationOauthProfile.JSON_PROPERTY_USERNAME_CLAIM_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthenticationOauthProfile { - public static final String JSON_PROPERTY_AUTHORIZATION_GROUPS_CLAIM_NAME = "authorizationGroupsClaimName"; - private String authorizationGroupsClaimName; - - public static final String JSON_PROPERTY_CLIENT_ID = "clientId"; - private String clientId; - - public static final String JSON_PROPERTY_CLIENT_REQUIRED_TYPE = "clientRequiredType"; - private String clientRequiredType; - - public static final String JSON_PROPERTY_CLIENT_SECRET = "clientSecret"; - private String clientSecret; - - public static final String JSON_PROPERTY_CLIENT_VALIDATE_TYPE_ENABLED = "clientValidateTypeEnabled"; - private Boolean clientValidateTypeEnabled; - - public static final String JSON_PROPERTY_DISCONNECT_ON_TOKEN_EXPIRATION_ENABLED = "disconnectOnTokenExpirationEnabled"; - private Boolean disconnectOnTokenExpirationEnabled; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_ENDPOINT_DISCOVERY = "endpointDiscovery"; - private String endpointDiscovery; - - public static final String JSON_PROPERTY_ENDPOINT_DISCOVERY_REFRESH_INTERVAL = "endpointDiscoveryRefreshInterval"; - private Integer endpointDiscoveryRefreshInterval; - - public static final String JSON_PROPERTY_ENDPOINT_INTROSPECTION = "endpointIntrospection"; - private String endpointIntrospection; - - public static final String JSON_PROPERTY_ENDPOINT_INTROSPECTION_TIMEOUT = "endpointIntrospectionTimeout"; - private Integer endpointIntrospectionTimeout; - - public static final String JSON_PROPERTY_ENDPOINT_JWKS = "endpointJwks"; - private String endpointJwks; - - public static final String JSON_PROPERTY_ENDPOINT_JWKS_REFRESH_INTERVAL = "endpointJwksRefreshInterval"; - private Integer endpointJwksRefreshInterval; - - public static final String JSON_PROPERTY_ENDPOINT_USERINFO = "endpointUserinfo"; - private String endpointUserinfo; - - public static final String JSON_PROPERTY_ENDPOINT_USERINFO_TIMEOUT = "endpointUserinfoTimeout"; - private Integer endpointUserinfoTimeout; - - public static final String JSON_PROPERTY_ISSUER = "issuer"; - private String issuer; - - public static final String JSON_PROPERTY_MQTT_USERNAME_VALIDATE_ENABLED = "mqttUsernameValidateEnabled"; - private Boolean mqttUsernameValidateEnabled; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_OAUTH_PROFILE_NAME = "oauthProfileName"; - private String oauthProfileName; - - /** - * The OAuth role of the broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"client\"`. The allowed values and their meaning are: <pre> \"client\" - The broker is in the OAuth client role. \"resource-server\" - The broker is in the OAuth resource server role. </pre> - */ - public enum OauthRoleEnum { - CLIENT("client"), - - RESOURCE_SERVER("resource-server"); - - private String value; - - OauthRoleEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static OauthRoleEnum fromValue(String value) { - for (OauthRoleEnum b : OauthRoleEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_OAUTH_ROLE = "oauthRole"; - private OauthRoleEnum oauthRole; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_PARSE_ACCESS_TOKEN_ENABLED = "resourceServerParseAccessTokenEnabled"; - private Boolean resourceServerParseAccessTokenEnabled; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_AUDIENCE = "resourceServerRequiredAudience"; - private String resourceServerRequiredAudience; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_ISSUER = "resourceServerRequiredIssuer"; - private String resourceServerRequiredIssuer; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_SCOPE = "resourceServerRequiredScope"; - private String resourceServerRequiredScope; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_TYPE = "resourceServerRequiredType"; - private String resourceServerRequiredType; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_AUDIENCE_ENABLED = "resourceServerValidateAudienceEnabled"; - private Boolean resourceServerValidateAudienceEnabled; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_ISSUER_ENABLED = "resourceServerValidateIssuerEnabled"; - private Boolean resourceServerValidateIssuerEnabled; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_SCOPE_ENABLED = "resourceServerValidateScopeEnabled"; - private Boolean resourceServerValidateScopeEnabled; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_TYPE_ENABLED = "resourceServerValidateTypeEnabled"; - private Boolean resourceServerValidateTypeEnabled; - - public static final String JSON_PROPERTY_USERNAME_CLAIM_NAME = "usernameClaimName"; - private String usernameClaimName; - - public MsgVpnAuthenticationOauthProfile() { - } - - public MsgVpnAuthenticationOauthProfile authorizationGroupsClaimName(String authorizationGroupsClaimName) { - - this.authorizationGroupsClaimName = authorizationGroupsClaimName; - return this; - } - - /** - * The name of the groups claim. If non-empty, the specified claim will be used to determine groups for authorization. If empty, the authorizationType attribute of the Message VPN will be used to determine authorization. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"groups\"`. - * @return authorizationGroupsClaimName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_GROUPS_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthorizationGroupsClaimName() { - return authorizationGroupsClaimName; - } - - - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_GROUPS_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthorizationGroupsClaimName(String authorizationGroupsClaimName) { - this.authorizationGroupsClaimName = authorizationGroupsClaimName; - } - - - public MsgVpnAuthenticationOauthProfile clientId(String clientId) { - - this.clientId = clientId; - return this; - } - - /** - * The OAuth client id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return clientId - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientId() { - return clientId; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientId(String clientId) { - this.clientId = clientId; - } - - - public MsgVpnAuthenticationOauthProfile clientRequiredType(String clientRequiredType) { - - this.clientRequiredType = clientRequiredType; - return this; - } - - /** - * The required value for the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"JWT\"`. - * @return clientRequiredType - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_REQUIRED_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientRequiredType() { - return clientRequiredType; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_REQUIRED_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientRequiredType(String clientRequiredType) { - this.clientRequiredType = clientRequiredType; - } - - - public MsgVpnAuthenticationOauthProfile clientSecret(String clientSecret) { - - this.clientSecret = clientSecret; - return this; - } - - /** - * The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return clientSecret - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientSecret() { - return clientSecret; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientSecret(String clientSecret) { - this.clientSecret = clientSecret; - } - - - public MsgVpnAuthenticationOauthProfile clientValidateTypeEnabled(Boolean clientValidateTypeEnabled) { - - this.clientValidateTypeEnabled = clientValidateTypeEnabled; - return this; - } - - /** - * Enable or disable verification of the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return clientValidateTypeEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_VALIDATE_TYPE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getClientValidateTypeEnabled() { - return clientValidateTypeEnabled; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_VALIDATE_TYPE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientValidateTypeEnabled(Boolean clientValidateTypeEnabled) { - this.clientValidateTypeEnabled = clientValidateTypeEnabled; - } - - - public MsgVpnAuthenticationOauthProfile disconnectOnTokenExpirationEnabled(Boolean disconnectOnTokenExpirationEnabled) { - - this.disconnectOnTokenExpirationEnabled = disconnectOnTokenExpirationEnabled; - return this; - } - - /** - * Enable or disable the disconnection of clients when their tokens expire. Changing this value does not affect existing clients, only new client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return disconnectOnTokenExpirationEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DISCONNECT_ON_TOKEN_EXPIRATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getDisconnectOnTokenExpirationEnabled() { - return disconnectOnTokenExpirationEnabled; - } - - - @JsonProperty(JSON_PROPERTY_DISCONNECT_ON_TOKEN_EXPIRATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDisconnectOnTokenExpirationEnabled(Boolean disconnectOnTokenExpirationEnabled) { - this.disconnectOnTokenExpirationEnabled = disconnectOnTokenExpirationEnabled; - } - - - public MsgVpnAuthenticationOauthProfile enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the OAuth profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public MsgVpnAuthenticationOauthProfile endpointDiscovery(String endpointDiscovery) { - - this.endpointDiscovery = endpointDiscovery; - return this; - } - - /** - * The OpenID Connect discovery endpoint or OAuth Authorization Server Metadata endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return endpointDiscovery - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_DISCOVERY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getEndpointDiscovery() { - return endpointDiscovery; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_DISCOVERY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointDiscovery(String endpointDiscovery) { - this.endpointDiscovery = endpointDiscovery; - } - - - public MsgVpnAuthenticationOauthProfile endpointDiscoveryRefreshInterval(Integer endpointDiscoveryRefreshInterval) { - - this.endpointDiscoveryRefreshInterval = endpointDiscoveryRefreshInterval; - return this; - } - - /** - * The number of seconds between discovery endpoint requests. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `86400`. - * @return endpointDiscoveryRefreshInterval - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_DISCOVERY_REFRESH_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getEndpointDiscoveryRefreshInterval() { - return endpointDiscoveryRefreshInterval; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_DISCOVERY_REFRESH_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointDiscoveryRefreshInterval(Integer endpointDiscoveryRefreshInterval) { - this.endpointDiscoveryRefreshInterval = endpointDiscoveryRefreshInterval; - } - - - public MsgVpnAuthenticationOauthProfile endpointIntrospection(String endpointIntrospection) { - - this.endpointIntrospection = endpointIntrospection; - return this; - } - - /** - * The OAuth introspection endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return endpointIntrospection - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_INTROSPECTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getEndpointIntrospection() { - return endpointIntrospection; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_INTROSPECTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointIntrospection(String endpointIntrospection) { - this.endpointIntrospection = endpointIntrospection; - } - - - public MsgVpnAuthenticationOauthProfile endpointIntrospectionTimeout(Integer endpointIntrospectionTimeout) { - - this.endpointIntrospectionTimeout = endpointIntrospectionTimeout; - return this; - } - - /** - * The maximum time in seconds a token introspection request is allowed to take. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. - * @return endpointIntrospectionTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_INTROSPECTION_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getEndpointIntrospectionTimeout() { - return endpointIntrospectionTimeout; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_INTROSPECTION_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointIntrospectionTimeout(Integer endpointIntrospectionTimeout) { - this.endpointIntrospectionTimeout = endpointIntrospectionTimeout; - } - - - public MsgVpnAuthenticationOauthProfile endpointJwks(String endpointJwks) { - - this.endpointJwks = endpointJwks; - return this; - } - - /** - * The OAuth JWKS endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return endpointJwks - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_JWKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getEndpointJwks() { - return endpointJwks; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_JWKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointJwks(String endpointJwks) { - this.endpointJwks = endpointJwks; - } - - - public MsgVpnAuthenticationOauthProfile endpointJwksRefreshInterval(Integer endpointJwksRefreshInterval) { - - this.endpointJwksRefreshInterval = endpointJwksRefreshInterval; - return this; - } - - /** - * The number of seconds between JWKS endpoint requests. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `86400`. - * @return endpointJwksRefreshInterval - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_JWKS_REFRESH_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getEndpointJwksRefreshInterval() { - return endpointJwksRefreshInterval; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_JWKS_REFRESH_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointJwksRefreshInterval(Integer endpointJwksRefreshInterval) { - this.endpointJwksRefreshInterval = endpointJwksRefreshInterval; - } - - - public MsgVpnAuthenticationOauthProfile endpointUserinfo(String endpointUserinfo) { - - this.endpointUserinfo = endpointUserinfo; - return this; - } - - /** - * The OpenID Connect Userinfo endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return endpointUserinfo - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_USERINFO) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getEndpointUserinfo() { - return endpointUserinfo; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_USERINFO) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointUserinfo(String endpointUserinfo) { - this.endpointUserinfo = endpointUserinfo; - } - - - public MsgVpnAuthenticationOauthProfile endpointUserinfoTimeout(Integer endpointUserinfoTimeout) { - - this.endpointUserinfoTimeout = endpointUserinfoTimeout; - return this; - } - - /** - * The maximum time in seconds a userinfo request is allowed to take. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. - * @return endpointUserinfoTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_USERINFO_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getEndpointUserinfoTimeout() { - return endpointUserinfoTimeout; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_USERINFO_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointUserinfoTimeout(Integer endpointUserinfoTimeout) { - this.endpointUserinfoTimeout = endpointUserinfoTimeout; - } - - - public MsgVpnAuthenticationOauthProfile issuer(String issuer) { - - this.issuer = issuer; - return this; - } - - /** - * The Issuer Identifier for the OAuth provider. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return issuer - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ISSUER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getIssuer() { - return issuer; - } - - - @JsonProperty(JSON_PROPERTY_ISSUER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIssuer(String issuer) { - this.issuer = issuer; - } - - - public MsgVpnAuthenticationOauthProfile mqttUsernameValidateEnabled(Boolean mqttUsernameValidateEnabled) { - - this.mqttUsernameValidateEnabled = mqttUsernameValidateEnabled; - return this; - } - - /** - * Enable or disable whether the API provided MQTT client username will be validated against the username calculated from the token(s). When enabled, connection attempts by MQTT clients are rejected if they differ. Note that this value only applies to MQTT clients; SMF client usernames will not be validated. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return mqttUsernameValidateEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MQTT_USERNAME_VALIDATE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getMqttUsernameValidateEnabled() { - return mqttUsernameValidateEnabled; - } - - - @JsonProperty(JSON_PROPERTY_MQTT_USERNAME_VALIDATE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMqttUsernameValidateEnabled(Boolean mqttUsernameValidateEnabled) { - this.mqttUsernameValidateEnabled = mqttUsernameValidateEnabled; - } - - - public MsgVpnAuthenticationOauthProfile msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnAuthenticationOauthProfile oauthProfileName(String oauthProfileName) { - - this.oauthProfileName = oauthProfileName; - return this; - } - - /** - * The name of the OAuth profile. - * @return oauthProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthProfileName() { - return oauthProfileName; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthProfileName(String oauthProfileName) { - this.oauthProfileName = oauthProfileName; - } - - - public MsgVpnAuthenticationOauthProfile oauthRole(OauthRoleEnum oauthRole) { - - this.oauthRole = oauthRole; - return this; - } - - /** - * The OAuth role of the broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"client\"`. The allowed values and their meaning are: <pre> \"client\" - The broker is in the OAuth client role. \"resource-server\" - The broker is in the OAuth resource server role. </pre> - * @return oauthRole - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_ROLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthRoleEnum getOauthRole() { - return oauthRole; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_ROLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthRole(OauthRoleEnum oauthRole) { - this.oauthRole = oauthRole; - } - - - public MsgVpnAuthenticationOauthProfile resourceServerParseAccessTokenEnabled(Boolean resourceServerParseAccessTokenEnabled) { - - this.resourceServerParseAccessTokenEnabled = resourceServerParseAccessTokenEnabled; - return this; - } - - /** - * Enable or disable parsing of the access token as a JWT. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return resourceServerParseAccessTokenEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_PARSE_ACCESS_TOKEN_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getResourceServerParseAccessTokenEnabled() { - return resourceServerParseAccessTokenEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_PARSE_ACCESS_TOKEN_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerParseAccessTokenEnabled(Boolean resourceServerParseAccessTokenEnabled) { - this.resourceServerParseAccessTokenEnabled = resourceServerParseAccessTokenEnabled; - } - - - public MsgVpnAuthenticationOauthProfile resourceServerRequiredAudience(String resourceServerRequiredAudience) { - - this.resourceServerRequiredAudience = resourceServerRequiredAudience; - return this; - } - - /** - * The required audience value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return resourceServerRequiredAudience - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_AUDIENCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getResourceServerRequiredAudience() { - return resourceServerRequiredAudience; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_AUDIENCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerRequiredAudience(String resourceServerRequiredAudience) { - this.resourceServerRequiredAudience = resourceServerRequiredAudience; - } - - - public MsgVpnAuthenticationOauthProfile resourceServerRequiredIssuer(String resourceServerRequiredIssuer) { - - this.resourceServerRequiredIssuer = resourceServerRequiredIssuer; - return this; - } - - /** - * The required issuer value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return resourceServerRequiredIssuer - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_ISSUER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getResourceServerRequiredIssuer() { - return resourceServerRequiredIssuer; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_ISSUER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerRequiredIssuer(String resourceServerRequiredIssuer) { - this.resourceServerRequiredIssuer = resourceServerRequiredIssuer; - } - - - public MsgVpnAuthenticationOauthProfile resourceServerRequiredScope(String resourceServerRequiredScope) { - - this.resourceServerRequiredScope = resourceServerRequiredScope; - return this; - } - - /** - * A space-separated list of scopes that must be present in the scope claim. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return resourceServerRequiredScope - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_SCOPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getResourceServerRequiredScope() { - return resourceServerRequiredScope; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_SCOPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerRequiredScope(String resourceServerRequiredScope) { - this.resourceServerRequiredScope = resourceServerRequiredScope; - } - - - public MsgVpnAuthenticationOauthProfile resourceServerRequiredType(String resourceServerRequiredType) { - - this.resourceServerRequiredType = resourceServerRequiredType; - return this; - } - - /** - * The required TYP value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"at+jwt\"`. - * @return resourceServerRequiredType - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getResourceServerRequiredType() { - return resourceServerRequiredType; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerRequiredType(String resourceServerRequiredType) { - this.resourceServerRequiredType = resourceServerRequiredType; - } - - - public MsgVpnAuthenticationOauthProfile resourceServerValidateAudienceEnabled(Boolean resourceServerValidateAudienceEnabled) { - - this.resourceServerValidateAudienceEnabled = resourceServerValidateAudienceEnabled; - return this; - } - - /** - * Enable or disable verification of the audience claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return resourceServerValidateAudienceEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_AUDIENCE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getResourceServerValidateAudienceEnabled() { - return resourceServerValidateAudienceEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_AUDIENCE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerValidateAudienceEnabled(Boolean resourceServerValidateAudienceEnabled) { - this.resourceServerValidateAudienceEnabled = resourceServerValidateAudienceEnabled; - } - - - public MsgVpnAuthenticationOauthProfile resourceServerValidateIssuerEnabled(Boolean resourceServerValidateIssuerEnabled) { - - this.resourceServerValidateIssuerEnabled = resourceServerValidateIssuerEnabled; - return this; - } - - /** - * Enable or disable verification of the issuer claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return resourceServerValidateIssuerEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_ISSUER_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getResourceServerValidateIssuerEnabled() { - return resourceServerValidateIssuerEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_ISSUER_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerValidateIssuerEnabled(Boolean resourceServerValidateIssuerEnabled) { - this.resourceServerValidateIssuerEnabled = resourceServerValidateIssuerEnabled; - } - - - public MsgVpnAuthenticationOauthProfile resourceServerValidateScopeEnabled(Boolean resourceServerValidateScopeEnabled) { - - this.resourceServerValidateScopeEnabled = resourceServerValidateScopeEnabled; - return this; - } - - /** - * Enable or disable verification of the scope claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return resourceServerValidateScopeEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_SCOPE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getResourceServerValidateScopeEnabled() { - return resourceServerValidateScopeEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_SCOPE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerValidateScopeEnabled(Boolean resourceServerValidateScopeEnabled) { - this.resourceServerValidateScopeEnabled = resourceServerValidateScopeEnabled; - } - - - public MsgVpnAuthenticationOauthProfile resourceServerValidateTypeEnabled(Boolean resourceServerValidateTypeEnabled) { - - this.resourceServerValidateTypeEnabled = resourceServerValidateTypeEnabled; - return this; - } - - /** - * Enable or disable verification of the TYP field in the access token header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return resourceServerValidateTypeEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_TYPE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getResourceServerValidateTypeEnabled() { - return resourceServerValidateTypeEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_TYPE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerValidateTypeEnabled(Boolean resourceServerValidateTypeEnabled) { - this.resourceServerValidateTypeEnabled = resourceServerValidateTypeEnabled; - } - - - public MsgVpnAuthenticationOauthProfile usernameClaimName(String usernameClaimName) { - - this.usernameClaimName = usernameClaimName; - return this; - } - - /** - * The name of the username claim. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sub\"`. - * @return usernameClaimName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_USERNAME_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUsernameClaimName() { - return usernameClaimName; - } - - - @JsonProperty(JSON_PROPERTY_USERNAME_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUsernameClaimName(String usernameClaimName) { - this.usernameClaimName = usernameClaimName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthenticationOauthProfile msgVpnAuthenticationOauthProfile = (MsgVpnAuthenticationOauthProfile) o; - return Objects.equals(this.authorizationGroupsClaimName, msgVpnAuthenticationOauthProfile.authorizationGroupsClaimName) && - Objects.equals(this.clientId, msgVpnAuthenticationOauthProfile.clientId) && - Objects.equals(this.clientRequiredType, msgVpnAuthenticationOauthProfile.clientRequiredType) && - Objects.equals(this.clientSecret, msgVpnAuthenticationOauthProfile.clientSecret) && - Objects.equals(this.clientValidateTypeEnabled, msgVpnAuthenticationOauthProfile.clientValidateTypeEnabled) && - Objects.equals(this.disconnectOnTokenExpirationEnabled, msgVpnAuthenticationOauthProfile.disconnectOnTokenExpirationEnabled) && - Objects.equals(this.enabled, msgVpnAuthenticationOauthProfile.enabled) && - Objects.equals(this.endpointDiscovery, msgVpnAuthenticationOauthProfile.endpointDiscovery) && - Objects.equals(this.endpointDiscoveryRefreshInterval, msgVpnAuthenticationOauthProfile.endpointDiscoveryRefreshInterval) && - Objects.equals(this.endpointIntrospection, msgVpnAuthenticationOauthProfile.endpointIntrospection) && - Objects.equals(this.endpointIntrospectionTimeout, msgVpnAuthenticationOauthProfile.endpointIntrospectionTimeout) && - Objects.equals(this.endpointJwks, msgVpnAuthenticationOauthProfile.endpointJwks) && - Objects.equals(this.endpointJwksRefreshInterval, msgVpnAuthenticationOauthProfile.endpointJwksRefreshInterval) && - Objects.equals(this.endpointUserinfo, msgVpnAuthenticationOauthProfile.endpointUserinfo) && - Objects.equals(this.endpointUserinfoTimeout, msgVpnAuthenticationOauthProfile.endpointUserinfoTimeout) && - Objects.equals(this.issuer, msgVpnAuthenticationOauthProfile.issuer) && - Objects.equals(this.mqttUsernameValidateEnabled, msgVpnAuthenticationOauthProfile.mqttUsernameValidateEnabled) && - Objects.equals(this.msgVpnName, msgVpnAuthenticationOauthProfile.msgVpnName) && - Objects.equals(this.oauthProfileName, msgVpnAuthenticationOauthProfile.oauthProfileName) && - Objects.equals(this.oauthRole, msgVpnAuthenticationOauthProfile.oauthRole) && - Objects.equals(this.resourceServerParseAccessTokenEnabled, msgVpnAuthenticationOauthProfile.resourceServerParseAccessTokenEnabled) && - Objects.equals(this.resourceServerRequiredAudience, msgVpnAuthenticationOauthProfile.resourceServerRequiredAudience) && - Objects.equals(this.resourceServerRequiredIssuer, msgVpnAuthenticationOauthProfile.resourceServerRequiredIssuer) && - Objects.equals(this.resourceServerRequiredScope, msgVpnAuthenticationOauthProfile.resourceServerRequiredScope) && - Objects.equals(this.resourceServerRequiredType, msgVpnAuthenticationOauthProfile.resourceServerRequiredType) && - Objects.equals(this.resourceServerValidateAudienceEnabled, msgVpnAuthenticationOauthProfile.resourceServerValidateAudienceEnabled) && - Objects.equals(this.resourceServerValidateIssuerEnabled, msgVpnAuthenticationOauthProfile.resourceServerValidateIssuerEnabled) && - Objects.equals(this.resourceServerValidateScopeEnabled, msgVpnAuthenticationOauthProfile.resourceServerValidateScopeEnabled) && - Objects.equals(this.resourceServerValidateTypeEnabled, msgVpnAuthenticationOauthProfile.resourceServerValidateTypeEnabled) && - Objects.equals(this.usernameClaimName, msgVpnAuthenticationOauthProfile.usernameClaimName); - } - - @Override - public int hashCode() { - return Objects.hash(authorizationGroupsClaimName, clientId, clientRequiredType, clientSecret, clientValidateTypeEnabled, disconnectOnTokenExpirationEnabled, enabled, endpointDiscovery, endpointDiscoveryRefreshInterval, endpointIntrospection, endpointIntrospectionTimeout, endpointJwks, endpointJwksRefreshInterval, endpointUserinfo, endpointUserinfoTimeout, issuer, mqttUsernameValidateEnabled, msgVpnName, oauthProfileName, oauthRole, resourceServerParseAccessTokenEnabled, resourceServerRequiredAudience, resourceServerRequiredIssuer, resourceServerRequiredScope, resourceServerRequiredType, resourceServerValidateAudienceEnabled, resourceServerValidateIssuerEnabled, resourceServerValidateScopeEnabled, resourceServerValidateTypeEnabled, usernameClaimName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthenticationOauthProfile {\n"); - sb.append(" authorizationGroupsClaimName: ").append(toIndentedString(authorizationGroupsClaimName)).append("\n"); - sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); - sb.append(" clientRequiredType: ").append(toIndentedString(clientRequiredType)).append("\n"); - sb.append(" clientSecret: ").append(toIndentedString(clientSecret)).append("\n"); - sb.append(" clientValidateTypeEnabled: ").append(toIndentedString(clientValidateTypeEnabled)).append("\n"); - sb.append(" disconnectOnTokenExpirationEnabled: ").append(toIndentedString(disconnectOnTokenExpirationEnabled)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" endpointDiscovery: ").append(toIndentedString(endpointDiscovery)).append("\n"); - sb.append(" endpointDiscoveryRefreshInterval: ").append(toIndentedString(endpointDiscoveryRefreshInterval)).append("\n"); - sb.append(" endpointIntrospection: ").append(toIndentedString(endpointIntrospection)).append("\n"); - sb.append(" endpointIntrospectionTimeout: ").append(toIndentedString(endpointIntrospectionTimeout)).append("\n"); - sb.append(" endpointJwks: ").append(toIndentedString(endpointJwks)).append("\n"); - sb.append(" endpointJwksRefreshInterval: ").append(toIndentedString(endpointJwksRefreshInterval)).append("\n"); - sb.append(" endpointUserinfo: ").append(toIndentedString(endpointUserinfo)).append("\n"); - sb.append(" endpointUserinfoTimeout: ").append(toIndentedString(endpointUserinfoTimeout)).append("\n"); - sb.append(" issuer: ").append(toIndentedString(issuer)).append("\n"); - sb.append(" mqttUsernameValidateEnabled: ").append(toIndentedString(mqttUsernameValidateEnabled)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" oauthProfileName: ").append(toIndentedString(oauthProfileName)).append("\n"); - sb.append(" oauthRole: ").append(toIndentedString(oauthRole)).append("\n"); - sb.append(" resourceServerParseAccessTokenEnabled: ").append(toIndentedString(resourceServerParseAccessTokenEnabled)).append("\n"); - sb.append(" resourceServerRequiredAudience: ").append(toIndentedString(resourceServerRequiredAudience)).append("\n"); - sb.append(" resourceServerRequiredIssuer: ").append(toIndentedString(resourceServerRequiredIssuer)).append("\n"); - sb.append(" resourceServerRequiredScope: ").append(toIndentedString(resourceServerRequiredScope)).append("\n"); - sb.append(" resourceServerRequiredType: ").append(toIndentedString(resourceServerRequiredType)).append("\n"); - sb.append(" resourceServerValidateAudienceEnabled: ").append(toIndentedString(resourceServerValidateAudienceEnabled)).append("\n"); - sb.append(" resourceServerValidateIssuerEnabled: ").append(toIndentedString(resourceServerValidateIssuerEnabled)).append("\n"); - sb.append(" resourceServerValidateScopeEnabled: ").append(toIndentedString(resourceServerValidateScopeEnabled)).append("\n"); - sb.append(" resourceServerValidateTypeEnabled: ").append(toIndentedString(resourceServerValidateTypeEnabled)).append("\n"); - sb.append(" usernameClaimName: ").append(toIndentedString(usernameClaimName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaim.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaim.java deleted file mode 100644 index 0399dad4c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaim.java +++ /dev/null @@ -1,200 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthenticationOauthProfileClientRequiredClaim - */ -@JsonPropertyOrder({ - MsgVpnAuthenticationOauthProfileClientRequiredClaim.JSON_PROPERTY_CLIENT_REQUIRED_CLAIM_NAME, - MsgVpnAuthenticationOauthProfileClientRequiredClaim.JSON_PROPERTY_CLIENT_REQUIRED_CLAIM_VALUE, - MsgVpnAuthenticationOauthProfileClientRequiredClaim.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnAuthenticationOauthProfileClientRequiredClaim.JSON_PROPERTY_OAUTH_PROFILE_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthenticationOauthProfileClientRequiredClaim { - public static final String JSON_PROPERTY_CLIENT_REQUIRED_CLAIM_NAME = "clientRequiredClaimName"; - private String clientRequiredClaimName; - - public static final String JSON_PROPERTY_CLIENT_REQUIRED_CLAIM_VALUE = "clientRequiredClaimValue"; - private String clientRequiredClaimValue; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_OAUTH_PROFILE_NAME = "oauthProfileName"; - private String oauthProfileName; - - public MsgVpnAuthenticationOauthProfileClientRequiredClaim() { - } - - public MsgVpnAuthenticationOauthProfileClientRequiredClaim clientRequiredClaimName(String clientRequiredClaimName) { - - this.clientRequiredClaimName = clientRequiredClaimName; - return this; - } - - /** - * The name of the ID token claim to verify. - * @return clientRequiredClaimName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_REQUIRED_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientRequiredClaimName() { - return clientRequiredClaimName; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_REQUIRED_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientRequiredClaimName(String clientRequiredClaimName) { - this.clientRequiredClaimName = clientRequiredClaimName; - } - - - public MsgVpnAuthenticationOauthProfileClientRequiredClaim clientRequiredClaimValue(String clientRequiredClaimValue) { - - this.clientRequiredClaimValue = clientRequiredClaimValue; - return this; - } - - /** - * The required claim value. - * @return clientRequiredClaimValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_REQUIRED_CLAIM_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientRequiredClaimValue() { - return clientRequiredClaimValue; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_REQUIRED_CLAIM_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientRequiredClaimValue(String clientRequiredClaimValue) { - this.clientRequiredClaimValue = clientRequiredClaimValue; - } - - - public MsgVpnAuthenticationOauthProfileClientRequiredClaim msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnAuthenticationOauthProfileClientRequiredClaim oauthProfileName(String oauthProfileName) { - - this.oauthProfileName = oauthProfileName; - return this; - } - - /** - * The name of the OAuth profile. - * @return oauthProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthProfileName() { - return oauthProfileName; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthProfileName(String oauthProfileName) { - this.oauthProfileName = oauthProfileName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthenticationOauthProfileClientRequiredClaim msgVpnAuthenticationOauthProfileClientRequiredClaim = (MsgVpnAuthenticationOauthProfileClientRequiredClaim) o; - return Objects.equals(this.clientRequiredClaimName, msgVpnAuthenticationOauthProfileClientRequiredClaim.clientRequiredClaimName) && - Objects.equals(this.clientRequiredClaimValue, msgVpnAuthenticationOauthProfileClientRequiredClaim.clientRequiredClaimValue) && - Objects.equals(this.msgVpnName, msgVpnAuthenticationOauthProfileClientRequiredClaim.msgVpnName) && - Objects.equals(this.oauthProfileName, msgVpnAuthenticationOauthProfileClientRequiredClaim.oauthProfileName); - } - - @Override - public int hashCode() { - return Objects.hash(clientRequiredClaimName, clientRequiredClaimValue, msgVpnName, oauthProfileName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthenticationOauthProfileClientRequiredClaim {\n"); - sb.append(" clientRequiredClaimName: ").append(toIndentedString(clientRequiredClaimName)).append("\n"); - sb.append(" clientRequiredClaimValue: ").append(toIndentedString(clientRequiredClaimValue)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" oauthProfileName: ").append(toIndentedString(oauthProfileName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks.java deleted file mode 100644 index 97aaefdf5..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks - */ -@JsonPropertyOrder({ - MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks() { - } - - public MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Required Claim object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks msgVpnAuthenticationOauthProfileClientRequiredClaimLinks = (MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks) o; - return Objects.equals(this.uri, msgVpnAuthenticationOauthProfileClientRequiredClaimLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.java deleted file mode 100644 index 238c7fa7f..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse - */ -@JsonPropertyOrder({ - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.JSON_PROPERTY_DATA, - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.JSON_PROPERTY_LINKS, - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnAuthenticationOauthProfileClientRequiredClaim data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse() { - } - - public MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse data(MsgVpnAuthenticationOauthProfileClientRequiredClaim data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAuthenticationOauthProfileClientRequiredClaim getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnAuthenticationOauthProfileClientRequiredClaim data) { - this.data = data; - } - - - public MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse links(MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks links) { - this.links = links; - } - - - public MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse msgVpnAuthenticationOauthProfileClientRequiredClaimResponse = (MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse) o; - return Objects.equals(this.data, msgVpnAuthenticationOauthProfileClientRequiredClaimResponse.data) && - Objects.equals(this.links, msgVpnAuthenticationOauthProfileClientRequiredClaimResponse.links) && - Objects.equals(this.meta, msgVpnAuthenticationOauthProfileClientRequiredClaimResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.java deleted file mode 100644 index 0a65627cd..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse - */ -@JsonPropertyOrder({ - MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.JSON_PROPERTY_DATA, - MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.JSON_PROPERTY_LINKS, - MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse() { - } - - public MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse addDataItem(MsgVpnAuthenticationOauthProfileClientRequiredClaim dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse addLinksItem(MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse msgVpnAuthenticationOauthProfileClientRequiredClaimsResponse = (MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse) o; - return Objects.equals(this.data, msgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.data) && - Objects.equals(this.links, msgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.links) && - Objects.equals(this.meta, msgVpnAuthenticationOauthProfileClientRequiredClaimsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileLinks.java deleted file mode 100644 index 040817842..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileLinks.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthenticationOauthProfileLinks - */ -@JsonPropertyOrder({ - MsgVpnAuthenticationOauthProfileLinks.JSON_PROPERTY_CLIENT_REQUIRED_CLAIMS_URI, - MsgVpnAuthenticationOauthProfileLinks.JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIMS_URI, - MsgVpnAuthenticationOauthProfileLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthenticationOauthProfileLinks { - public static final String JSON_PROPERTY_CLIENT_REQUIRED_CLAIMS_URI = "clientRequiredClaimsUri"; - private String clientRequiredClaimsUri; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIMS_URI = "resourceServerRequiredClaimsUri"; - private String resourceServerRequiredClaimsUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnAuthenticationOauthProfileLinks() { - } - - public MsgVpnAuthenticationOauthProfileLinks clientRequiredClaimsUri(String clientRequiredClaimsUri) { - - this.clientRequiredClaimsUri = clientRequiredClaimsUri; - return this; - } - - /** - * The URI of this OAuth Profile's collection of Required Claim objects. - * @return clientRequiredClaimsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_REQUIRED_CLAIMS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientRequiredClaimsUri() { - return clientRequiredClaimsUri; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_REQUIRED_CLAIMS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientRequiredClaimsUri(String clientRequiredClaimsUri) { - this.clientRequiredClaimsUri = clientRequiredClaimsUri; - } - - - public MsgVpnAuthenticationOauthProfileLinks resourceServerRequiredClaimsUri(String resourceServerRequiredClaimsUri) { - - this.resourceServerRequiredClaimsUri = resourceServerRequiredClaimsUri; - return this; - } - - /** - * The URI of this OAuth Profile's collection of Required Claim objects. - * @return resourceServerRequiredClaimsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIMS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getResourceServerRequiredClaimsUri() { - return resourceServerRequiredClaimsUri; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIMS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerRequiredClaimsUri(String resourceServerRequiredClaimsUri) { - this.resourceServerRequiredClaimsUri = resourceServerRequiredClaimsUri; - } - - - public MsgVpnAuthenticationOauthProfileLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this OAuth Profile object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthenticationOauthProfileLinks msgVpnAuthenticationOauthProfileLinks = (MsgVpnAuthenticationOauthProfileLinks) o; - return Objects.equals(this.clientRequiredClaimsUri, msgVpnAuthenticationOauthProfileLinks.clientRequiredClaimsUri) && - Objects.equals(this.resourceServerRequiredClaimsUri, msgVpnAuthenticationOauthProfileLinks.resourceServerRequiredClaimsUri) && - Objects.equals(this.uri, msgVpnAuthenticationOauthProfileLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(clientRequiredClaimsUri, resourceServerRequiredClaimsUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthenticationOauthProfileLinks {\n"); - sb.append(" clientRequiredClaimsUri: ").append(toIndentedString(clientRequiredClaimsUri)).append("\n"); - sb.append(" resourceServerRequiredClaimsUri: ").append(toIndentedString(resourceServerRequiredClaimsUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.java deleted file mode 100644 index 30f4e184f..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.java +++ /dev/null @@ -1,200 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - */ -@JsonPropertyOrder({ - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.JSON_PROPERTY_OAUTH_PROFILE_NAME, - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIM_NAME, - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIM_VALUE -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim { - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_OAUTH_PROFILE_NAME = "oauthProfileName"; - private String oauthProfileName; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIM_NAME = "resourceServerRequiredClaimName"; - private String resourceServerRequiredClaimName; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIM_VALUE = "resourceServerRequiredClaimValue"; - private String resourceServerRequiredClaimValue; - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim() { - } - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim oauthProfileName(String oauthProfileName) { - - this.oauthProfileName = oauthProfileName; - return this; - } - - /** - * The name of the OAuth profile. - * @return oauthProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthProfileName() { - return oauthProfileName; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthProfileName(String oauthProfileName) { - this.oauthProfileName = oauthProfileName; - } - - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim resourceServerRequiredClaimName(String resourceServerRequiredClaimName) { - - this.resourceServerRequiredClaimName = resourceServerRequiredClaimName; - return this; - } - - /** - * The name of the access token claim to verify. - * @return resourceServerRequiredClaimName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getResourceServerRequiredClaimName() { - return resourceServerRequiredClaimName; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerRequiredClaimName(String resourceServerRequiredClaimName) { - this.resourceServerRequiredClaimName = resourceServerRequiredClaimName; - } - - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim resourceServerRequiredClaimValue(String resourceServerRequiredClaimValue) { - - this.resourceServerRequiredClaimValue = resourceServerRequiredClaimValue; - return this; - } - - /** - * The required claim value. - * @return resourceServerRequiredClaimValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIM_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getResourceServerRequiredClaimValue() { - return resourceServerRequiredClaimValue; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIM_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerRequiredClaimValue(String resourceServerRequiredClaimValue) { - this.resourceServerRequiredClaimValue = resourceServerRequiredClaimValue; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim msgVpnAuthenticationOauthProfileResourceServerRequiredClaim = (MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim) o; - return Objects.equals(this.msgVpnName, msgVpnAuthenticationOauthProfileResourceServerRequiredClaim.msgVpnName) && - Objects.equals(this.oauthProfileName, msgVpnAuthenticationOauthProfileResourceServerRequiredClaim.oauthProfileName) && - Objects.equals(this.resourceServerRequiredClaimName, msgVpnAuthenticationOauthProfileResourceServerRequiredClaim.resourceServerRequiredClaimName) && - Objects.equals(this.resourceServerRequiredClaimValue, msgVpnAuthenticationOauthProfileResourceServerRequiredClaim.resourceServerRequiredClaimValue); - } - - @Override - public int hashCode() { - return Objects.hash(msgVpnName, oauthProfileName, resourceServerRequiredClaimName, resourceServerRequiredClaimValue); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim {\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" oauthProfileName: ").append(toIndentedString(oauthProfileName)).append("\n"); - sb.append(" resourceServerRequiredClaimName: ").append(toIndentedString(resourceServerRequiredClaimName)).append("\n"); - sb.append(" resourceServerRequiredClaimValue: ").append(toIndentedString(resourceServerRequiredClaimValue)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks.java deleted file mode 100644 index ad34b0070..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks - */ -@JsonPropertyOrder({ - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks() { - } - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Required Claim object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks msgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks = (MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks) o; - return Objects.equals(this.uri, msgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.java deleted file mode 100644 index 39cfb0049..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse - */ -@JsonPropertyOrder({ - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.JSON_PROPERTY_DATA, - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.JSON_PROPERTY_LINKS, - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse() { - } - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse data(MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim data) { - this.data = data; - } - - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse links(MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks links) { - this.links = links; - } - - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse msgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse = (MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse) o; - return Objects.equals(this.data, msgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.data) && - Objects.equals(this.links, msgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.links) && - Objects.equals(this.meta, msgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.java deleted file mode 100644 index 84fdebb97..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse - */ -@JsonPropertyOrder({ - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.JSON_PROPERTY_DATA, - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.JSON_PROPERTY_LINKS, - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse() { - } - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse addDataItem(MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse addLinksItem(MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse msgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse = (MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse) o; - return Objects.equals(this.data, msgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.data) && - Objects.equals(this.links, msgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.links) && - Objects.equals(this.meta, msgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResponse.java deleted file mode 100644 index e1091066c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthenticationOauthProfileResponse - */ -@JsonPropertyOrder({ - MsgVpnAuthenticationOauthProfileResponse.JSON_PROPERTY_DATA, - MsgVpnAuthenticationOauthProfileResponse.JSON_PROPERTY_LINKS, - MsgVpnAuthenticationOauthProfileResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthenticationOauthProfileResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnAuthenticationOauthProfile data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnAuthenticationOauthProfileLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAuthenticationOauthProfileResponse() { - } - - public MsgVpnAuthenticationOauthProfileResponse data(MsgVpnAuthenticationOauthProfile data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAuthenticationOauthProfile getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnAuthenticationOauthProfile data) { - this.data = data; - } - - - public MsgVpnAuthenticationOauthProfileResponse links(MsgVpnAuthenticationOauthProfileLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAuthenticationOauthProfileLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnAuthenticationOauthProfileLinks links) { - this.links = links; - } - - - public MsgVpnAuthenticationOauthProfileResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthenticationOauthProfileResponse msgVpnAuthenticationOauthProfileResponse = (MsgVpnAuthenticationOauthProfileResponse) o; - return Objects.equals(this.data, msgVpnAuthenticationOauthProfileResponse.data) && - Objects.equals(this.links, msgVpnAuthenticationOauthProfileResponse.links) && - Objects.equals(this.meta, msgVpnAuthenticationOauthProfileResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthenticationOauthProfileResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfilesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfilesResponse.java deleted file mode 100644 index 92cf72fcc..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfilesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthenticationOauthProfilesResponse - */ -@JsonPropertyOrder({ - MsgVpnAuthenticationOauthProfilesResponse.JSON_PROPERTY_DATA, - MsgVpnAuthenticationOauthProfilesResponse.JSON_PROPERTY_LINKS, - MsgVpnAuthenticationOauthProfilesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthenticationOauthProfilesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAuthenticationOauthProfilesResponse() { - } - - public MsgVpnAuthenticationOauthProfilesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnAuthenticationOauthProfilesResponse addDataItem(MsgVpnAuthenticationOauthProfile dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnAuthenticationOauthProfilesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnAuthenticationOauthProfilesResponse addLinksItem(MsgVpnAuthenticationOauthProfileLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnAuthenticationOauthProfilesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthenticationOauthProfilesResponse msgVpnAuthenticationOauthProfilesResponse = (MsgVpnAuthenticationOauthProfilesResponse) o; - return Objects.equals(this.data, msgVpnAuthenticationOauthProfilesResponse.data) && - Objects.equals(this.links, msgVpnAuthenticationOauthProfilesResponse.links) && - Objects.equals(this.meta, msgVpnAuthenticationOauthProfilesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthenticationOauthProfilesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProvider.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProvider.java deleted file mode 100644 index 5bcfc19f1..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProvider.java +++ /dev/null @@ -1,887 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthenticationOauthProvider - */ -@JsonPropertyOrder({ - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_AUDIENCE_CLAIM_NAME, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_AUDIENCE_CLAIM_SOURCE, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_AUDIENCE_CLAIM_VALUE, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_AUDIENCE_VALIDATION_ENABLED, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_AUTHORIZATION_GROUP_CLAIM_NAME, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_AUTHORIZATION_GROUP_CLAIM_SOURCE, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_AUTHORIZATION_GROUP_ENABLED, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_DISCONNECT_ON_TOKEN_EXPIRATION_ENABLED, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_ENABLED, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_JWKS_REFRESH_INTERVAL, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_JWKS_URI, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_OAUTH_PROVIDER_NAME, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_TOKEN_IGNORE_TIME_LIMITS_ENABLED, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_TOKEN_INTROSPECTION_PARAMETER_NAME, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_TOKEN_INTROSPECTION_PASSWORD, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_TOKEN_INTROSPECTION_TIMEOUT, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_TOKEN_INTROSPECTION_URI, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_TOKEN_INTROSPECTION_USERNAME, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_USERNAME_CLAIM_NAME, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_USERNAME_CLAIM_SOURCE, - MsgVpnAuthenticationOauthProvider.JSON_PROPERTY_USERNAME_VALIDATE_ENABLED -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthenticationOauthProvider { - public static final String JSON_PROPERTY_AUDIENCE_CLAIM_NAME = "audienceClaimName"; - private String audienceClaimName; - - /** - * The audience claim source, indicating where to search for the audience value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"id-token\"`. The allowed values and their meaning are: <pre> \"access-token\" - The OAuth v2 access_token. \"id-token\" - The OpenID Connect id_token. \"introspection\" - The result of introspecting the OAuth v2 access_token. </pre> Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - */ - public enum AudienceClaimSourceEnum { - ACCESS_TOKEN("access-token"), - - ID_TOKEN("id-token"), - - INTROSPECTION("introspection"); - - private String value; - - AudienceClaimSourceEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AudienceClaimSourceEnum fromValue(String value) { - for (AudienceClaimSourceEnum b : AudienceClaimSourceEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_AUDIENCE_CLAIM_SOURCE = "audienceClaimSource"; - private AudienceClaimSourceEnum audienceClaimSource; - - public static final String JSON_PROPERTY_AUDIENCE_CLAIM_VALUE = "audienceClaimValue"; - private String audienceClaimValue; - - public static final String JSON_PROPERTY_AUDIENCE_VALIDATION_ENABLED = "audienceValidationEnabled"; - private Boolean audienceValidationEnabled; - - public static final String JSON_PROPERTY_AUTHORIZATION_GROUP_CLAIM_NAME = "authorizationGroupClaimName"; - private String authorizationGroupClaimName; - - /** - * The authorization group claim source, indicating where to search for the authorization group name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"id-token\"`. The allowed values and their meaning are: <pre> \"access-token\" - The OAuth v2 access_token. \"id-token\" - The OpenID Connect id_token. \"introspection\" - The result of introspecting the OAuth v2 access_token. </pre> Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - */ - public enum AuthorizationGroupClaimSourceEnum { - ACCESS_TOKEN("access-token"), - - ID_TOKEN("id-token"), - - INTROSPECTION("introspection"); - - private String value; - - AuthorizationGroupClaimSourceEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AuthorizationGroupClaimSourceEnum fromValue(String value) { - for (AuthorizationGroupClaimSourceEnum b : AuthorizationGroupClaimSourceEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_AUTHORIZATION_GROUP_CLAIM_SOURCE = "authorizationGroupClaimSource"; - private AuthorizationGroupClaimSourceEnum authorizationGroupClaimSource; - - public static final String JSON_PROPERTY_AUTHORIZATION_GROUP_ENABLED = "authorizationGroupEnabled"; - private Boolean authorizationGroupEnabled; - - public static final String JSON_PROPERTY_DISCONNECT_ON_TOKEN_EXPIRATION_ENABLED = "disconnectOnTokenExpirationEnabled"; - private Boolean disconnectOnTokenExpirationEnabled; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_JWKS_REFRESH_INTERVAL = "jwksRefreshInterval"; - private Integer jwksRefreshInterval; - - public static final String JSON_PROPERTY_JWKS_URI = "jwksUri"; - private String jwksUri; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_OAUTH_PROVIDER_NAME = "oauthProviderName"; - private String oauthProviderName; - - public static final String JSON_PROPERTY_TOKEN_IGNORE_TIME_LIMITS_ENABLED = "tokenIgnoreTimeLimitsEnabled"; - private Boolean tokenIgnoreTimeLimitsEnabled; - - public static final String JSON_PROPERTY_TOKEN_INTROSPECTION_PARAMETER_NAME = "tokenIntrospectionParameterName"; - private String tokenIntrospectionParameterName; - - public static final String JSON_PROPERTY_TOKEN_INTROSPECTION_PASSWORD = "tokenIntrospectionPassword"; - private String tokenIntrospectionPassword; - - public static final String JSON_PROPERTY_TOKEN_INTROSPECTION_TIMEOUT = "tokenIntrospectionTimeout"; - private Integer tokenIntrospectionTimeout; - - public static final String JSON_PROPERTY_TOKEN_INTROSPECTION_URI = "tokenIntrospectionUri"; - private String tokenIntrospectionUri; - - public static final String JSON_PROPERTY_TOKEN_INTROSPECTION_USERNAME = "tokenIntrospectionUsername"; - private String tokenIntrospectionUsername; - - public static final String JSON_PROPERTY_USERNAME_CLAIM_NAME = "usernameClaimName"; - private String usernameClaimName; - - /** - * The username claim source, indicating where to search for the username value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"id-token\"`. The allowed values and their meaning are: <pre> \"access-token\" - The OAuth v2 access_token. \"id-token\" - The OpenID Connect id_token. \"introspection\" - The result of introspecting the OAuth v2 access_token. </pre> Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - */ - public enum UsernameClaimSourceEnum { - ACCESS_TOKEN("access-token"), - - ID_TOKEN("id-token"), - - INTROSPECTION("introspection"); - - private String value; - - UsernameClaimSourceEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static UsernameClaimSourceEnum fromValue(String value) { - for (UsernameClaimSourceEnum b : UsernameClaimSourceEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_USERNAME_CLAIM_SOURCE = "usernameClaimSource"; - private UsernameClaimSourceEnum usernameClaimSource; - - public static final String JSON_PROPERTY_USERNAME_VALIDATE_ENABLED = "usernameValidateEnabled"; - private Boolean usernameValidateEnabled; - - public MsgVpnAuthenticationOauthProvider() { - } - - public MsgVpnAuthenticationOauthProvider audienceClaimName(String audienceClaimName) { - - this.audienceClaimName = audienceClaimName; - return this; - } - - /** - * The audience claim name, indicating which part of the object to use for determining the audience. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"aud\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return audienceClaimName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUDIENCE_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAudienceClaimName() { - return audienceClaimName; - } - - - @JsonProperty(JSON_PROPERTY_AUDIENCE_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAudienceClaimName(String audienceClaimName) { - this.audienceClaimName = audienceClaimName; - } - - - public MsgVpnAuthenticationOauthProvider audienceClaimSource(AudienceClaimSourceEnum audienceClaimSource) { - - this.audienceClaimSource = audienceClaimSource; - return this; - } - - /** - * The audience claim source, indicating where to search for the audience value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"id-token\"`. The allowed values and their meaning are: <pre> \"access-token\" - The OAuth v2 access_token. \"id-token\" - The OpenID Connect id_token. \"introspection\" - The result of introspecting the OAuth v2 access_token. </pre> Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return audienceClaimSource - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUDIENCE_CLAIM_SOURCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AudienceClaimSourceEnum getAudienceClaimSource() { - return audienceClaimSource; - } - - - @JsonProperty(JSON_PROPERTY_AUDIENCE_CLAIM_SOURCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAudienceClaimSource(AudienceClaimSourceEnum audienceClaimSource) { - this.audienceClaimSource = audienceClaimSource; - } - - - public MsgVpnAuthenticationOauthProvider audienceClaimValue(String audienceClaimValue) { - - this.audienceClaimValue = audienceClaimValue; - return this; - } - - /** - * The required audience value for a token to be considered valid. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return audienceClaimValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUDIENCE_CLAIM_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAudienceClaimValue() { - return audienceClaimValue; - } - - - @JsonProperty(JSON_PROPERTY_AUDIENCE_CLAIM_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAudienceClaimValue(String audienceClaimValue) { - this.audienceClaimValue = audienceClaimValue; - } - - - public MsgVpnAuthenticationOauthProvider audienceValidationEnabled(Boolean audienceValidationEnabled) { - - this.audienceValidationEnabled = audienceValidationEnabled; - return this; - } - - /** - * Enable or disable audience validation. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return audienceValidationEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUDIENCE_VALIDATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAudienceValidationEnabled() { - return audienceValidationEnabled; - } - - - @JsonProperty(JSON_PROPERTY_AUDIENCE_VALIDATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAudienceValidationEnabled(Boolean audienceValidationEnabled) { - this.audienceValidationEnabled = audienceValidationEnabled; - } - - - public MsgVpnAuthenticationOauthProvider authorizationGroupClaimName(String authorizationGroupClaimName) { - - this.authorizationGroupClaimName = authorizationGroupClaimName; - return this; - } - - /** - * The authorization group claim name, indicating which part of the object to use for determining the authorization group. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"scope\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return authorizationGroupClaimName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_GROUP_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthorizationGroupClaimName() { - return authorizationGroupClaimName; - } - - - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_GROUP_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthorizationGroupClaimName(String authorizationGroupClaimName) { - this.authorizationGroupClaimName = authorizationGroupClaimName; - } - - - public MsgVpnAuthenticationOauthProvider authorizationGroupClaimSource(AuthorizationGroupClaimSourceEnum authorizationGroupClaimSource) { - - this.authorizationGroupClaimSource = authorizationGroupClaimSource; - return this; - } - - /** - * The authorization group claim source, indicating where to search for the authorization group name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"id-token\"`. The allowed values and their meaning are: <pre> \"access-token\" - The OAuth v2 access_token. \"id-token\" - The OpenID Connect id_token. \"introspection\" - The result of introspecting the OAuth v2 access_token. </pre> Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return authorizationGroupClaimSource - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_GROUP_CLAIM_SOURCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AuthorizationGroupClaimSourceEnum getAuthorizationGroupClaimSource() { - return authorizationGroupClaimSource; - } - - - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_GROUP_CLAIM_SOURCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthorizationGroupClaimSource(AuthorizationGroupClaimSourceEnum authorizationGroupClaimSource) { - this.authorizationGroupClaimSource = authorizationGroupClaimSource; - } - - - public MsgVpnAuthenticationOauthProvider authorizationGroupEnabled(Boolean authorizationGroupEnabled) { - - this.authorizationGroupEnabled = authorizationGroupEnabled; - return this; - } - - /** - * Enable or disable OAuth based authorization. When enabled, the configured authorization type for OAuth clients is overridden. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return authorizationGroupEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_GROUP_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAuthorizationGroupEnabled() { - return authorizationGroupEnabled; - } - - - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_GROUP_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthorizationGroupEnabled(Boolean authorizationGroupEnabled) { - this.authorizationGroupEnabled = authorizationGroupEnabled; - } - - - public MsgVpnAuthenticationOauthProvider disconnectOnTokenExpirationEnabled(Boolean disconnectOnTokenExpirationEnabled) { - - this.disconnectOnTokenExpirationEnabled = disconnectOnTokenExpirationEnabled; - return this; - } - - /** - * Enable or disable the disconnection of clients when their tokens expire. Changing this value does not affect existing clients, only new client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return disconnectOnTokenExpirationEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DISCONNECT_ON_TOKEN_EXPIRATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getDisconnectOnTokenExpirationEnabled() { - return disconnectOnTokenExpirationEnabled; - } - - - @JsonProperty(JSON_PROPERTY_DISCONNECT_ON_TOKEN_EXPIRATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDisconnectOnTokenExpirationEnabled(Boolean disconnectOnTokenExpirationEnabled) { - this.disconnectOnTokenExpirationEnabled = disconnectOnTokenExpirationEnabled; - } - - - public MsgVpnAuthenticationOauthProvider enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable OAuth Provider client authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public MsgVpnAuthenticationOauthProvider jwksRefreshInterval(Integer jwksRefreshInterval) { - - this.jwksRefreshInterval = jwksRefreshInterval; - return this; - } - - /** - * The number of seconds between forced JWKS public key refreshing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `86400`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return jwksRefreshInterval - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_JWKS_REFRESH_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getJwksRefreshInterval() { - return jwksRefreshInterval; - } - - - @JsonProperty(JSON_PROPERTY_JWKS_REFRESH_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setJwksRefreshInterval(Integer jwksRefreshInterval) { - this.jwksRefreshInterval = jwksRefreshInterval; - } - - - public MsgVpnAuthenticationOauthProvider jwksUri(String jwksUri) { - - this.jwksUri = jwksUri; - return this; - } - - /** - * The URI where the OAuth provider publishes its JWKS public keys. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return jwksUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_JWKS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getJwksUri() { - return jwksUri; - } - - - @JsonProperty(JSON_PROPERTY_JWKS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setJwksUri(String jwksUri) { - this.jwksUri = jwksUri; - } - - - public MsgVpnAuthenticationOauthProvider msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. Deprecated since 2.25. Replaced by authenticationOauthProfiles. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnAuthenticationOauthProvider oauthProviderName(String oauthProviderName) { - - this.oauthProviderName = oauthProviderName; - return this; - } - - /** - * The name of the OAuth Provider. Deprecated since 2.25. Replaced by authenticationOauthProfiles. - * @return oauthProviderName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_PROVIDER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthProviderName() { - return oauthProviderName; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_PROVIDER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthProviderName(String oauthProviderName) { - this.oauthProviderName = oauthProviderName; - } - - - public MsgVpnAuthenticationOauthProvider tokenIgnoreTimeLimitsEnabled(Boolean tokenIgnoreTimeLimitsEnabled) { - - this.tokenIgnoreTimeLimitsEnabled = tokenIgnoreTimeLimitsEnabled; - return this; - } - - /** - * Enable or disable whether to ignore time limits and accept tokens that are not yet valid or are no longer valid. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return tokenIgnoreTimeLimitsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOKEN_IGNORE_TIME_LIMITS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTokenIgnoreTimeLimitsEnabled() { - return tokenIgnoreTimeLimitsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TOKEN_IGNORE_TIME_LIMITS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTokenIgnoreTimeLimitsEnabled(Boolean tokenIgnoreTimeLimitsEnabled) { - this.tokenIgnoreTimeLimitsEnabled = tokenIgnoreTimeLimitsEnabled; - } - - - public MsgVpnAuthenticationOauthProvider tokenIntrospectionParameterName(String tokenIntrospectionParameterName) { - - this.tokenIntrospectionParameterName = tokenIntrospectionParameterName; - return this; - } - - /** - * The parameter name used to identify the token during access token introspection. A standards compliant OAuth introspection server expects \"token\". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"token\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return tokenIntrospectionParameterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOKEN_INTROSPECTION_PARAMETER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTokenIntrospectionParameterName() { - return tokenIntrospectionParameterName; - } - - - @JsonProperty(JSON_PROPERTY_TOKEN_INTROSPECTION_PARAMETER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTokenIntrospectionParameterName(String tokenIntrospectionParameterName) { - this.tokenIntrospectionParameterName = tokenIntrospectionParameterName; - } - - - public MsgVpnAuthenticationOauthProvider tokenIntrospectionPassword(String tokenIntrospectionPassword) { - - this.tokenIntrospectionPassword = tokenIntrospectionPassword; - return this; - } - - /** - * The password to use when logging into the token introspection URI. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return tokenIntrospectionPassword - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOKEN_INTROSPECTION_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTokenIntrospectionPassword() { - return tokenIntrospectionPassword; - } - - - @JsonProperty(JSON_PROPERTY_TOKEN_INTROSPECTION_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTokenIntrospectionPassword(String tokenIntrospectionPassword) { - this.tokenIntrospectionPassword = tokenIntrospectionPassword; - } - - - public MsgVpnAuthenticationOauthProvider tokenIntrospectionTimeout(Integer tokenIntrospectionTimeout) { - - this.tokenIntrospectionTimeout = tokenIntrospectionTimeout; - return this; - } - - /** - * The maximum time in seconds a token introspection is allowed to take. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return tokenIntrospectionTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOKEN_INTROSPECTION_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getTokenIntrospectionTimeout() { - return tokenIntrospectionTimeout; - } - - - @JsonProperty(JSON_PROPERTY_TOKEN_INTROSPECTION_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTokenIntrospectionTimeout(Integer tokenIntrospectionTimeout) { - this.tokenIntrospectionTimeout = tokenIntrospectionTimeout; - } - - - public MsgVpnAuthenticationOauthProvider tokenIntrospectionUri(String tokenIntrospectionUri) { - - this.tokenIntrospectionUri = tokenIntrospectionUri; - return this; - } - - /** - * The token introspection URI of the OAuth authentication server. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return tokenIntrospectionUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOKEN_INTROSPECTION_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTokenIntrospectionUri() { - return tokenIntrospectionUri; - } - - - @JsonProperty(JSON_PROPERTY_TOKEN_INTROSPECTION_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTokenIntrospectionUri(String tokenIntrospectionUri) { - this.tokenIntrospectionUri = tokenIntrospectionUri; - } - - - public MsgVpnAuthenticationOauthProvider tokenIntrospectionUsername(String tokenIntrospectionUsername) { - - this.tokenIntrospectionUsername = tokenIntrospectionUsername; - return this; - } - - /** - * The username to use when logging into the token introspection URI. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return tokenIntrospectionUsername - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOKEN_INTROSPECTION_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTokenIntrospectionUsername() { - return tokenIntrospectionUsername; - } - - - @JsonProperty(JSON_PROPERTY_TOKEN_INTROSPECTION_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTokenIntrospectionUsername(String tokenIntrospectionUsername) { - this.tokenIntrospectionUsername = tokenIntrospectionUsername; - } - - - public MsgVpnAuthenticationOauthProvider usernameClaimName(String usernameClaimName) { - - this.usernameClaimName = usernameClaimName; - return this; - } - - /** - * The username claim name, indicating which part of the object to use for determining the username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sub\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return usernameClaimName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_USERNAME_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUsernameClaimName() { - return usernameClaimName; - } - - - @JsonProperty(JSON_PROPERTY_USERNAME_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUsernameClaimName(String usernameClaimName) { - this.usernameClaimName = usernameClaimName; - } - - - public MsgVpnAuthenticationOauthProvider usernameClaimSource(UsernameClaimSourceEnum usernameClaimSource) { - - this.usernameClaimSource = usernameClaimSource; - return this; - } - - /** - * The username claim source, indicating where to search for the username value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"id-token\"`. The allowed values and their meaning are: <pre> \"access-token\" - The OAuth v2 access_token. \"id-token\" - The OpenID Connect id_token. \"introspection\" - The result of introspecting the OAuth v2 access_token. </pre> Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return usernameClaimSource - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_USERNAME_CLAIM_SOURCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public UsernameClaimSourceEnum getUsernameClaimSource() { - return usernameClaimSource; - } - - - @JsonProperty(JSON_PROPERTY_USERNAME_CLAIM_SOURCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUsernameClaimSource(UsernameClaimSourceEnum usernameClaimSource) { - this.usernameClaimSource = usernameClaimSource; - } - - - public MsgVpnAuthenticationOauthProvider usernameValidateEnabled(Boolean usernameValidateEnabled) { - - this.usernameValidateEnabled = usernameValidateEnabled; - return this; - } - - /** - * Enable or disable whether the API provided username will be validated against the username calculated from the token(s); the connection attempt is rejected if they differ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles. - * @return usernameValidateEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_USERNAME_VALIDATE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getUsernameValidateEnabled() { - return usernameValidateEnabled; - } - - - @JsonProperty(JSON_PROPERTY_USERNAME_VALIDATE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUsernameValidateEnabled(Boolean usernameValidateEnabled) { - this.usernameValidateEnabled = usernameValidateEnabled; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthenticationOauthProvider msgVpnAuthenticationOauthProvider = (MsgVpnAuthenticationOauthProvider) o; - return Objects.equals(this.audienceClaimName, msgVpnAuthenticationOauthProvider.audienceClaimName) && - Objects.equals(this.audienceClaimSource, msgVpnAuthenticationOauthProvider.audienceClaimSource) && - Objects.equals(this.audienceClaimValue, msgVpnAuthenticationOauthProvider.audienceClaimValue) && - Objects.equals(this.audienceValidationEnabled, msgVpnAuthenticationOauthProvider.audienceValidationEnabled) && - Objects.equals(this.authorizationGroupClaimName, msgVpnAuthenticationOauthProvider.authorizationGroupClaimName) && - Objects.equals(this.authorizationGroupClaimSource, msgVpnAuthenticationOauthProvider.authorizationGroupClaimSource) && - Objects.equals(this.authorizationGroupEnabled, msgVpnAuthenticationOauthProvider.authorizationGroupEnabled) && - Objects.equals(this.disconnectOnTokenExpirationEnabled, msgVpnAuthenticationOauthProvider.disconnectOnTokenExpirationEnabled) && - Objects.equals(this.enabled, msgVpnAuthenticationOauthProvider.enabled) && - Objects.equals(this.jwksRefreshInterval, msgVpnAuthenticationOauthProvider.jwksRefreshInterval) && - Objects.equals(this.jwksUri, msgVpnAuthenticationOauthProvider.jwksUri) && - Objects.equals(this.msgVpnName, msgVpnAuthenticationOauthProvider.msgVpnName) && - Objects.equals(this.oauthProviderName, msgVpnAuthenticationOauthProvider.oauthProviderName) && - Objects.equals(this.tokenIgnoreTimeLimitsEnabled, msgVpnAuthenticationOauthProvider.tokenIgnoreTimeLimitsEnabled) && - Objects.equals(this.tokenIntrospectionParameterName, msgVpnAuthenticationOauthProvider.tokenIntrospectionParameterName) && - Objects.equals(this.tokenIntrospectionPassword, msgVpnAuthenticationOauthProvider.tokenIntrospectionPassword) && - Objects.equals(this.tokenIntrospectionTimeout, msgVpnAuthenticationOauthProvider.tokenIntrospectionTimeout) && - Objects.equals(this.tokenIntrospectionUri, msgVpnAuthenticationOauthProvider.tokenIntrospectionUri) && - Objects.equals(this.tokenIntrospectionUsername, msgVpnAuthenticationOauthProvider.tokenIntrospectionUsername) && - Objects.equals(this.usernameClaimName, msgVpnAuthenticationOauthProvider.usernameClaimName) && - Objects.equals(this.usernameClaimSource, msgVpnAuthenticationOauthProvider.usernameClaimSource) && - Objects.equals(this.usernameValidateEnabled, msgVpnAuthenticationOauthProvider.usernameValidateEnabled); - } - - @Override - public int hashCode() { - return Objects.hash(audienceClaimName, audienceClaimSource, audienceClaimValue, audienceValidationEnabled, authorizationGroupClaimName, authorizationGroupClaimSource, authorizationGroupEnabled, disconnectOnTokenExpirationEnabled, enabled, jwksRefreshInterval, jwksUri, msgVpnName, oauthProviderName, tokenIgnoreTimeLimitsEnabled, tokenIntrospectionParameterName, tokenIntrospectionPassword, tokenIntrospectionTimeout, tokenIntrospectionUri, tokenIntrospectionUsername, usernameClaimName, usernameClaimSource, usernameValidateEnabled); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthenticationOauthProvider {\n"); - sb.append(" audienceClaimName: ").append(toIndentedString(audienceClaimName)).append("\n"); - sb.append(" audienceClaimSource: ").append(toIndentedString(audienceClaimSource)).append("\n"); - sb.append(" audienceClaimValue: ").append(toIndentedString(audienceClaimValue)).append("\n"); - sb.append(" audienceValidationEnabled: ").append(toIndentedString(audienceValidationEnabled)).append("\n"); - sb.append(" authorizationGroupClaimName: ").append(toIndentedString(authorizationGroupClaimName)).append("\n"); - sb.append(" authorizationGroupClaimSource: ").append(toIndentedString(authorizationGroupClaimSource)).append("\n"); - sb.append(" authorizationGroupEnabled: ").append(toIndentedString(authorizationGroupEnabled)).append("\n"); - sb.append(" disconnectOnTokenExpirationEnabled: ").append(toIndentedString(disconnectOnTokenExpirationEnabled)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" jwksRefreshInterval: ").append(toIndentedString(jwksRefreshInterval)).append("\n"); - sb.append(" jwksUri: ").append(toIndentedString(jwksUri)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" oauthProviderName: ").append(toIndentedString(oauthProviderName)).append("\n"); - sb.append(" tokenIgnoreTimeLimitsEnabled: ").append(toIndentedString(tokenIgnoreTimeLimitsEnabled)).append("\n"); - sb.append(" tokenIntrospectionParameterName: ").append(toIndentedString(tokenIntrospectionParameterName)).append("\n"); - sb.append(" tokenIntrospectionPassword: ").append(toIndentedString(tokenIntrospectionPassword)).append("\n"); - sb.append(" tokenIntrospectionTimeout: ").append(toIndentedString(tokenIntrospectionTimeout)).append("\n"); - sb.append(" tokenIntrospectionUri: ").append(toIndentedString(tokenIntrospectionUri)).append("\n"); - sb.append(" tokenIntrospectionUsername: ").append(toIndentedString(tokenIntrospectionUsername)).append("\n"); - sb.append(" usernameClaimName: ").append(toIndentedString(usernameClaimName)).append("\n"); - sb.append(" usernameClaimSource: ").append(toIndentedString(usernameClaimSource)).append("\n"); - sb.append(" usernameValidateEnabled: ").append(toIndentedString(usernameValidateEnabled)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderLinks.java deleted file mode 100644 index 10a597965..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthenticationOauthProviderLinks - */ -@JsonPropertyOrder({ - MsgVpnAuthenticationOauthProviderLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthenticationOauthProviderLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnAuthenticationOauthProviderLinks() { - } - - public MsgVpnAuthenticationOauthProviderLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this OAuth Provider object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthenticationOauthProviderLinks msgVpnAuthenticationOauthProviderLinks = (MsgVpnAuthenticationOauthProviderLinks) o; - return Objects.equals(this.uri, msgVpnAuthenticationOauthProviderLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthenticationOauthProviderLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderResponse.java deleted file mode 100644 index bf19ad2ff..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProvider; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProviderLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthenticationOauthProviderResponse - */ -@JsonPropertyOrder({ - MsgVpnAuthenticationOauthProviderResponse.JSON_PROPERTY_DATA, - MsgVpnAuthenticationOauthProviderResponse.JSON_PROPERTY_LINKS, - MsgVpnAuthenticationOauthProviderResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthenticationOauthProviderResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnAuthenticationOauthProvider data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnAuthenticationOauthProviderLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAuthenticationOauthProviderResponse() { - } - - public MsgVpnAuthenticationOauthProviderResponse data(MsgVpnAuthenticationOauthProvider data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAuthenticationOauthProvider getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnAuthenticationOauthProvider data) { - this.data = data; - } - - - public MsgVpnAuthenticationOauthProviderResponse links(MsgVpnAuthenticationOauthProviderLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAuthenticationOauthProviderLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnAuthenticationOauthProviderLinks links) { - this.links = links; - } - - - public MsgVpnAuthenticationOauthProviderResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthenticationOauthProviderResponse msgVpnAuthenticationOauthProviderResponse = (MsgVpnAuthenticationOauthProviderResponse) o; - return Objects.equals(this.data, msgVpnAuthenticationOauthProviderResponse.data) && - Objects.equals(this.links, msgVpnAuthenticationOauthProviderResponse.links) && - Objects.equals(this.meta, msgVpnAuthenticationOauthProviderResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthenticationOauthProviderResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProvidersResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProvidersResponse.java deleted file mode 100644 index e427d930c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProvidersResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProvider; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProviderLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthenticationOauthProvidersResponse - */ -@JsonPropertyOrder({ - MsgVpnAuthenticationOauthProvidersResponse.JSON_PROPERTY_DATA, - MsgVpnAuthenticationOauthProvidersResponse.JSON_PROPERTY_LINKS, - MsgVpnAuthenticationOauthProvidersResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthenticationOauthProvidersResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAuthenticationOauthProvidersResponse() { - } - - public MsgVpnAuthenticationOauthProvidersResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnAuthenticationOauthProvidersResponse addDataItem(MsgVpnAuthenticationOauthProvider dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnAuthenticationOauthProvidersResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnAuthenticationOauthProvidersResponse addLinksItem(MsgVpnAuthenticationOauthProviderLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnAuthenticationOauthProvidersResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthenticationOauthProvidersResponse msgVpnAuthenticationOauthProvidersResponse = (MsgVpnAuthenticationOauthProvidersResponse) o; - return Objects.equals(this.data, msgVpnAuthenticationOauthProvidersResponse.data) && - Objects.equals(this.links, msgVpnAuthenticationOauthProvidersResponse.links) && - Objects.equals(this.meta, msgVpnAuthenticationOauthProvidersResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthenticationOauthProvidersResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroup.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroup.java deleted file mode 100644 index 69af66950..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroup.java +++ /dev/null @@ -1,296 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthorizationGroup - */ -@JsonPropertyOrder({ - MsgVpnAuthorizationGroup.JSON_PROPERTY_ACL_PROFILE_NAME, - MsgVpnAuthorizationGroup.JSON_PROPERTY_AUTHORIZATION_GROUP_NAME, - MsgVpnAuthorizationGroup.JSON_PROPERTY_CLIENT_PROFILE_NAME, - MsgVpnAuthorizationGroup.JSON_PROPERTY_ENABLED, - MsgVpnAuthorizationGroup.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnAuthorizationGroup.JSON_PROPERTY_ORDER_AFTER_AUTHORIZATION_GROUP_NAME, - MsgVpnAuthorizationGroup.JSON_PROPERTY_ORDER_BEFORE_AUTHORIZATION_GROUP_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthorizationGroup { - public static final String JSON_PROPERTY_ACL_PROFILE_NAME = "aclProfileName"; - private String aclProfileName; - - public static final String JSON_PROPERTY_AUTHORIZATION_GROUP_NAME = "authorizationGroupName"; - private String authorizationGroupName; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_NAME = "clientProfileName"; - private String clientProfileName; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_ORDER_AFTER_AUTHORIZATION_GROUP_NAME = "orderAfterAuthorizationGroupName"; - private String orderAfterAuthorizationGroupName; - - public static final String JSON_PROPERTY_ORDER_BEFORE_AUTHORIZATION_GROUP_NAME = "orderBeforeAuthorizationGroupName"; - private String orderBeforeAuthorizationGroupName; - - public MsgVpnAuthorizationGroup() { - } - - public MsgVpnAuthorizationGroup aclProfileName(String aclProfileName) { - - this.aclProfileName = aclProfileName; - return this; - } - - /** - * The ACL Profile of the Authorization Group. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`. - * @return aclProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAclProfileName() { - return aclProfileName; - } - - - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAclProfileName(String aclProfileName) { - this.aclProfileName = aclProfileName; - } - - - public MsgVpnAuthorizationGroup authorizationGroupName(String authorizationGroupName) { - - this.authorizationGroupName = authorizationGroupName; - return this; - } - - /** - * The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'. - * @return authorizationGroupName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_GROUP_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthorizationGroupName() { - return authorizationGroupName; - } - - - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_GROUP_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthorizationGroupName(String authorizationGroupName) { - this.authorizationGroupName = authorizationGroupName; - } - - - public MsgVpnAuthorizationGroup clientProfileName(String clientProfileName) { - - this.clientProfileName = clientProfileName; - return this; - } - - /** - * The Client Profile of the Authorization Group. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`. - * @return clientProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientProfileName() { - return clientProfileName; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileName(String clientProfileName) { - this.clientProfileName = clientProfileName; - } - - - public MsgVpnAuthorizationGroup enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the Authorization Group in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public MsgVpnAuthorizationGroup msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnAuthorizationGroup orderAfterAuthorizationGroupName(String orderAfterAuthorizationGroupName) { - - this.orderAfterAuthorizationGroupName = orderAfterAuthorizationGroupName; - return this; - } - - /** - * Lower the priority to be less than this group. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable. - * @return orderAfterAuthorizationGroupName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ORDER_AFTER_AUTHORIZATION_GROUP_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOrderAfterAuthorizationGroupName() { - return orderAfterAuthorizationGroupName; - } - - - @JsonProperty(JSON_PROPERTY_ORDER_AFTER_AUTHORIZATION_GROUP_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOrderAfterAuthorizationGroupName(String orderAfterAuthorizationGroupName) { - this.orderAfterAuthorizationGroupName = orderAfterAuthorizationGroupName; - } - - - public MsgVpnAuthorizationGroup orderBeforeAuthorizationGroupName(String orderBeforeAuthorizationGroupName) { - - this.orderBeforeAuthorizationGroupName = orderBeforeAuthorizationGroupName; - return this; - } - - /** - * Raise the priority to be greater than this group. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable. - * @return orderBeforeAuthorizationGroupName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ORDER_BEFORE_AUTHORIZATION_GROUP_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOrderBeforeAuthorizationGroupName() { - return orderBeforeAuthorizationGroupName; - } - - - @JsonProperty(JSON_PROPERTY_ORDER_BEFORE_AUTHORIZATION_GROUP_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOrderBeforeAuthorizationGroupName(String orderBeforeAuthorizationGroupName) { - this.orderBeforeAuthorizationGroupName = orderBeforeAuthorizationGroupName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthorizationGroup msgVpnAuthorizationGroup = (MsgVpnAuthorizationGroup) o; - return Objects.equals(this.aclProfileName, msgVpnAuthorizationGroup.aclProfileName) && - Objects.equals(this.authorizationGroupName, msgVpnAuthorizationGroup.authorizationGroupName) && - Objects.equals(this.clientProfileName, msgVpnAuthorizationGroup.clientProfileName) && - Objects.equals(this.enabled, msgVpnAuthorizationGroup.enabled) && - Objects.equals(this.msgVpnName, msgVpnAuthorizationGroup.msgVpnName) && - Objects.equals(this.orderAfterAuthorizationGroupName, msgVpnAuthorizationGroup.orderAfterAuthorizationGroupName) && - Objects.equals(this.orderBeforeAuthorizationGroupName, msgVpnAuthorizationGroup.orderBeforeAuthorizationGroupName); - } - - @Override - public int hashCode() { - return Objects.hash(aclProfileName, authorizationGroupName, clientProfileName, enabled, msgVpnName, orderAfterAuthorizationGroupName, orderBeforeAuthorizationGroupName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthorizationGroup {\n"); - sb.append(" aclProfileName: ").append(toIndentedString(aclProfileName)).append("\n"); - sb.append(" authorizationGroupName: ").append(toIndentedString(authorizationGroupName)).append("\n"); - sb.append(" clientProfileName: ").append(toIndentedString(clientProfileName)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" orderAfterAuthorizationGroupName: ").append(toIndentedString(orderAfterAuthorizationGroupName)).append("\n"); - sb.append(" orderBeforeAuthorizationGroupName: ").append(toIndentedString(orderBeforeAuthorizationGroupName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupLinks.java deleted file mode 100644 index c60bac1a5..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthorizationGroupLinks - */ -@JsonPropertyOrder({ - MsgVpnAuthorizationGroupLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthorizationGroupLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnAuthorizationGroupLinks() { - } - - public MsgVpnAuthorizationGroupLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Authorization Group object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthorizationGroupLinks msgVpnAuthorizationGroupLinks = (MsgVpnAuthorizationGroupLinks) o; - return Objects.equals(this.uri, msgVpnAuthorizationGroupLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthorizationGroupLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupResponse.java deleted file mode 100644 index 3e09a6b54..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroupLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthorizationGroupResponse - */ -@JsonPropertyOrder({ - MsgVpnAuthorizationGroupResponse.JSON_PROPERTY_DATA, - MsgVpnAuthorizationGroupResponse.JSON_PROPERTY_LINKS, - MsgVpnAuthorizationGroupResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthorizationGroupResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnAuthorizationGroup data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnAuthorizationGroupLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAuthorizationGroupResponse() { - } - - public MsgVpnAuthorizationGroupResponse data(MsgVpnAuthorizationGroup data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAuthorizationGroup getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnAuthorizationGroup data) { - this.data = data; - } - - - public MsgVpnAuthorizationGroupResponse links(MsgVpnAuthorizationGroupLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAuthorizationGroupLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnAuthorizationGroupLinks links) { - this.links = links; - } - - - public MsgVpnAuthorizationGroupResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthorizationGroupResponse msgVpnAuthorizationGroupResponse = (MsgVpnAuthorizationGroupResponse) o; - return Objects.equals(this.data, msgVpnAuthorizationGroupResponse.data) && - Objects.equals(this.links, msgVpnAuthorizationGroupResponse.links) && - Objects.equals(this.meta, msgVpnAuthorizationGroupResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthorizationGroupResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupsResponse.java deleted file mode 100644 index 70942ed27..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroupLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnAuthorizationGroupsResponse - */ -@JsonPropertyOrder({ - MsgVpnAuthorizationGroupsResponse.JSON_PROPERTY_DATA, - MsgVpnAuthorizationGroupsResponse.JSON_PROPERTY_LINKS, - MsgVpnAuthorizationGroupsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnAuthorizationGroupsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnAuthorizationGroupsResponse() { - } - - public MsgVpnAuthorizationGroupsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnAuthorizationGroupsResponse addDataItem(MsgVpnAuthorizationGroup dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnAuthorizationGroupsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnAuthorizationGroupsResponse addLinksItem(MsgVpnAuthorizationGroupLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnAuthorizationGroupsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnAuthorizationGroupsResponse msgVpnAuthorizationGroupsResponse = (MsgVpnAuthorizationGroupsResponse) o; - return Objects.equals(this.data, msgVpnAuthorizationGroupsResponse.data) && - Objects.equals(this.links, msgVpnAuthorizationGroupsResponse.links) && - Objects.equals(this.meta, msgVpnAuthorizationGroupsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnAuthorizationGroupsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridge.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridge.java deleted file mode 100644 index bab54803a..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridge.java +++ /dev/null @@ -1,633 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnBridge - */ -@JsonPropertyOrder({ - MsgVpnBridge.JSON_PROPERTY_BRIDGE_NAME, - MsgVpnBridge.JSON_PROPERTY_BRIDGE_VIRTUAL_ROUTER, - MsgVpnBridge.JSON_PROPERTY_ENABLED, - MsgVpnBridge.JSON_PROPERTY_MAX_TTL, - MsgVpnBridge.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnBridge.JSON_PROPERTY_REMOTE_AUTHENTICATION_BASIC_CLIENT_USERNAME, - MsgVpnBridge.JSON_PROPERTY_REMOTE_AUTHENTICATION_BASIC_PASSWORD, - MsgVpnBridge.JSON_PROPERTY_REMOTE_AUTHENTICATION_CLIENT_CERT_CONTENT, - MsgVpnBridge.JSON_PROPERTY_REMOTE_AUTHENTICATION_CLIENT_CERT_PASSWORD, - MsgVpnBridge.JSON_PROPERTY_REMOTE_AUTHENTICATION_SCHEME, - MsgVpnBridge.JSON_PROPERTY_REMOTE_CONNECTION_RETRY_COUNT, - MsgVpnBridge.JSON_PROPERTY_REMOTE_CONNECTION_RETRY_DELAY, - MsgVpnBridge.JSON_PROPERTY_REMOTE_DELIVER_TO_ONE_PRIORITY, - MsgVpnBridge.JSON_PROPERTY_TLS_CIPHER_SUITE_LIST -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnBridge { - public static final String JSON_PROPERTY_BRIDGE_NAME = "bridgeName"; - private String bridgeName; - - /** - * The virtual router of the Bridge. The allowed values and their meaning are: <pre> \"primary\" - The Bridge is used for the primary virtual router. \"backup\" - The Bridge is used for the backup virtual router. \"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> - */ - public enum BridgeVirtualRouterEnum { - PRIMARY("primary"), - - BACKUP("backup"), - - AUTO("auto"); - - private String value; - - BridgeVirtualRouterEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static BridgeVirtualRouterEnum fromValue(String value) { - for (BridgeVirtualRouterEnum b : BridgeVirtualRouterEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_BRIDGE_VIRTUAL_ROUTER = "bridgeVirtualRouter"; - private BridgeVirtualRouterEnum bridgeVirtualRouter; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_MAX_TTL = "maxTtl"; - private Long maxTtl; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_REMOTE_AUTHENTICATION_BASIC_CLIENT_USERNAME = "remoteAuthenticationBasicClientUsername"; - private String remoteAuthenticationBasicClientUsername; - - public static final String JSON_PROPERTY_REMOTE_AUTHENTICATION_BASIC_PASSWORD = "remoteAuthenticationBasicPassword"; - private String remoteAuthenticationBasicPassword; - - public static final String JSON_PROPERTY_REMOTE_AUTHENTICATION_CLIENT_CERT_CONTENT = "remoteAuthenticationClientCertContent"; - private String remoteAuthenticationClientCertContent; - - public static final String JSON_PROPERTY_REMOTE_AUTHENTICATION_CLIENT_CERT_PASSWORD = "remoteAuthenticationClientCertPassword"; - private String remoteAuthenticationClientCertPassword; - - /** - * The authentication scheme for the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"basic\"`. The allowed values and their meaning are: <pre> \"basic\" - Basic Authentication Scheme (via username and password). \"client-certificate\" - Client Certificate Authentication Scheme (via certificate file or content). </pre> - */ - public enum RemoteAuthenticationSchemeEnum { - BASIC("basic"), - - CLIENT_CERTIFICATE("client-certificate"); - - private String value; - - RemoteAuthenticationSchemeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static RemoteAuthenticationSchemeEnum fromValue(String value) { - for (RemoteAuthenticationSchemeEnum b : RemoteAuthenticationSchemeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_REMOTE_AUTHENTICATION_SCHEME = "remoteAuthenticationScheme"; - private RemoteAuthenticationSchemeEnum remoteAuthenticationScheme; - - public static final String JSON_PROPERTY_REMOTE_CONNECTION_RETRY_COUNT = "remoteConnectionRetryCount"; - private Long remoteConnectionRetryCount; - - public static final String JSON_PROPERTY_REMOTE_CONNECTION_RETRY_DELAY = "remoteConnectionRetryDelay"; - private Long remoteConnectionRetryDelay; - - /** - * The priority for deliver-to-one (DTO) messages transmitted from the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"p1\"`. The allowed values and their meaning are: <pre> \"p1\" - The 1st or highest priority. \"p2\" - The 2nd highest priority. \"p3\" - The 3rd highest priority. \"p4\" - The 4th highest priority. \"da\" - Ignore priority and deliver always. </pre> - */ - public enum RemoteDeliverToOnePriorityEnum { - P1("p1"), - - P2("p2"), - - P3("p3"), - - P4("p4"), - - DA("da"); - - private String value; - - RemoteDeliverToOnePriorityEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static RemoteDeliverToOnePriorityEnum fromValue(String value) { - for (RemoteDeliverToOnePriorityEnum b : RemoteDeliverToOnePriorityEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_REMOTE_DELIVER_TO_ONE_PRIORITY = "remoteDeliverToOnePriority"; - private RemoteDeliverToOnePriorityEnum remoteDeliverToOnePriority; - - public static final String JSON_PROPERTY_TLS_CIPHER_SUITE_LIST = "tlsCipherSuiteList"; - private String tlsCipherSuiteList; - - public MsgVpnBridge() { - } - - public MsgVpnBridge bridgeName(String bridgeName) { - - this.bridgeName = bridgeName; - return this; - } - - /** - * The name of the Bridge. - * @return bridgeName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_BRIDGE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getBridgeName() { - return bridgeName; - } - - - @JsonProperty(JSON_PROPERTY_BRIDGE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setBridgeName(String bridgeName) { - this.bridgeName = bridgeName; - } - - - public MsgVpnBridge bridgeVirtualRouter(BridgeVirtualRouterEnum bridgeVirtualRouter) { - - this.bridgeVirtualRouter = bridgeVirtualRouter; - return this; - } - - /** - * The virtual router of the Bridge. The allowed values and their meaning are: <pre> \"primary\" - The Bridge is used for the primary virtual router. \"backup\" - The Bridge is used for the backup virtual router. \"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> - * @return bridgeVirtualRouter - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_BRIDGE_VIRTUAL_ROUTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public BridgeVirtualRouterEnum getBridgeVirtualRouter() { - return bridgeVirtualRouter; - } - - - @JsonProperty(JSON_PROPERTY_BRIDGE_VIRTUAL_ROUTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setBridgeVirtualRouter(BridgeVirtualRouterEnum bridgeVirtualRouter) { - this.bridgeVirtualRouter = bridgeVirtualRouter; - } - - - public MsgVpnBridge enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the Bridge. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public MsgVpnBridge maxTtl(Long maxTtl) { - - this.maxTtl = maxTtl; - return this; - } - - /** - * The maximum time-to-live (TTL) in hops. Messages are discarded if their TTL exceeds this value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `8`. - * @return maxTtl - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_TTL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxTtl() { - return maxTtl; - } - - - @JsonProperty(JSON_PROPERTY_MAX_TTL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxTtl(Long maxTtl) { - this.maxTtl = maxTtl; - } - - - public MsgVpnBridge msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnBridge remoteAuthenticationBasicClientUsername(String remoteAuthenticationBasicClientUsername) { - - this.remoteAuthenticationBasicClientUsername = remoteAuthenticationBasicClientUsername; - return this; - } - - /** - * The Client Username the Bridge uses to login to the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return remoteAuthenticationBasicClientUsername - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_AUTHENTICATION_BASIC_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteAuthenticationBasicClientUsername() { - return remoteAuthenticationBasicClientUsername; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_AUTHENTICATION_BASIC_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteAuthenticationBasicClientUsername(String remoteAuthenticationBasicClientUsername) { - this.remoteAuthenticationBasicClientUsername = remoteAuthenticationBasicClientUsername; - } - - - public MsgVpnBridge remoteAuthenticationBasicPassword(String remoteAuthenticationBasicPassword) { - - this.remoteAuthenticationBasicPassword = remoteAuthenticationBasicPassword; - return this; - } - - /** - * The password for the Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return remoteAuthenticationBasicPassword - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_AUTHENTICATION_BASIC_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteAuthenticationBasicPassword() { - return remoteAuthenticationBasicPassword; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_AUTHENTICATION_BASIC_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteAuthenticationBasicPassword(String remoteAuthenticationBasicPassword) { - this.remoteAuthenticationBasicPassword = remoteAuthenticationBasicPassword; - } - - - public MsgVpnBridge remoteAuthenticationClientCertContent(String remoteAuthenticationClientCertContent) { - - this.remoteAuthenticationClientCertContent = remoteAuthenticationClientCertContent; - return this; - } - - /** - * The PEM formatted content for the client certificate used by the Bridge to login to the remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9. - * @return remoteAuthenticationClientCertContent - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_AUTHENTICATION_CLIENT_CERT_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteAuthenticationClientCertContent() { - return remoteAuthenticationClientCertContent; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_AUTHENTICATION_CLIENT_CERT_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteAuthenticationClientCertContent(String remoteAuthenticationClientCertContent) { - this.remoteAuthenticationClientCertContent = remoteAuthenticationClientCertContent; - } - - - public MsgVpnBridge remoteAuthenticationClientCertPassword(String remoteAuthenticationClientCertPassword) { - - this.remoteAuthenticationClientCertPassword = remoteAuthenticationClientCertPassword; - return this; - } - - /** - * The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9. - * @return remoteAuthenticationClientCertPassword - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_AUTHENTICATION_CLIENT_CERT_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteAuthenticationClientCertPassword() { - return remoteAuthenticationClientCertPassword; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_AUTHENTICATION_CLIENT_CERT_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteAuthenticationClientCertPassword(String remoteAuthenticationClientCertPassword) { - this.remoteAuthenticationClientCertPassword = remoteAuthenticationClientCertPassword; - } - - - public MsgVpnBridge remoteAuthenticationScheme(RemoteAuthenticationSchemeEnum remoteAuthenticationScheme) { - - this.remoteAuthenticationScheme = remoteAuthenticationScheme; - return this; - } - - /** - * The authentication scheme for the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"basic\"`. The allowed values and their meaning are: <pre> \"basic\" - Basic Authentication Scheme (via username and password). \"client-certificate\" - Client Certificate Authentication Scheme (via certificate file or content). </pre> - * @return remoteAuthenticationScheme - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_AUTHENTICATION_SCHEME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public RemoteAuthenticationSchemeEnum getRemoteAuthenticationScheme() { - return remoteAuthenticationScheme; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_AUTHENTICATION_SCHEME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteAuthenticationScheme(RemoteAuthenticationSchemeEnum remoteAuthenticationScheme) { - this.remoteAuthenticationScheme = remoteAuthenticationScheme; - } - - - public MsgVpnBridge remoteConnectionRetryCount(Long remoteConnectionRetryCount) { - - this.remoteConnectionRetryCount = remoteConnectionRetryCount; - return this; - } - - /** - * The maximum number of retry attempts to establish a connection to the remote Message VPN. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return remoteConnectionRetryCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_CONNECTION_RETRY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getRemoteConnectionRetryCount() { - return remoteConnectionRetryCount; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_CONNECTION_RETRY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteConnectionRetryCount(Long remoteConnectionRetryCount) { - this.remoteConnectionRetryCount = remoteConnectionRetryCount; - } - - - public MsgVpnBridge remoteConnectionRetryDelay(Long remoteConnectionRetryDelay) { - - this.remoteConnectionRetryDelay = remoteConnectionRetryDelay; - return this; - } - - /** - * The number of seconds the broker waits for the bridge connection to be established before attempting a new connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. - * @return remoteConnectionRetryDelay - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_CONNECTION_RETRY_DELAY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getRemoteConnectionRetryDelay() { - return remoteConnectionRetryDelay; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_CONNECTION_RETRY_DELAY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteConnectionRetryDelay(Long remoteConnectionRetryDelay) { - this.remoteConnectionRetryDelay = remoteConnectionRetryDelay; - } - - - public MsgVpnBridge remoteDeliverToOnePriority(RemoteDeliverToOnePriorityEnum remoteDeliverToOnePriority) { - - this.remoteDeliverToOnePriority = remoteDeliverToOnePriority; - return this; - } - - /** - * The priority for deliver-to-one (DTO) messages transmitted from the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"p1\"`. The allowed values and their meaning are: <pre> \"p1\" - The 1st or highest priority. \"p2\" - The 2nd highest priority. \"p3\" - The 3rd highest priority. \"p4\" - The 4th highest priority. \"da\" - Ignore priority and deliver always. </pre> - * @return remoteDeliverToOnePriority - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_DELIVER_TO_ONE_PRIORITY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public RemoteDeliverToOnePriorityEnum getRemoteDeliverToOnePriority() { - return remoteDeliverToOnePriority; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_DELIVER_TO_ONE_PRIORITY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteDeliverToOnePriority(RemoteDeliverToOnePriorityEnum remoteDeliverToOnePriority) { - this.remoteDeliverToOnePriority = remoteDeliverToOnePriority; - } - - - public MsgVpnBridge tlsCipherSuiteList(String tlsCipherSuiteList) { - - this.tlsCipherSuiteList = tlsCipherSuiteList; - return this; - } - - /** - * The colon-separated list of cipher suites supported for TLS connections to the remote Message VPN. The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`. - * @return tlsCipherSuiteList - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_CIPHER_SUITE_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTlsCipherSuiteList() { - return tlsCipherSuiteList; - } - - - @JsonProperty(JSON_PROPERTY_TLS_CIPHER_SUITE_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsCipherSuiteList(String tlsCipherSuiteList) { - this.tlsCipherSuiteList = tlsCipherSuiteList; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnBridge msgVpnBridge = (MsgVpnBridge) o; - return Objects.equals(this.bridgeName, msgVpnBridge.bridgeName) && - Objects.equals(this.bridgeVirtualRouter, msgVpnBridge.bridgeVirtualRouter) && - Objects.equals(this.enabled, msgVpnBridge.enabled) && - Objects.equals(this.maxTtl, msgVpnBridge.maxTtl) && - Objects.equals(this.msgVpnName, msgVpnBridge.msgVpnName) && - Objects.equals(this.remoteAuthenticationBasicClientUsername, msgVpnBridge.remoteAuthenticationBasicClientUsername) && - Objects.equals(this.remoteAuthenticationBasicPassword, msgVpnBridge.remoteAuthenticationBasicPassword) && - Objects.equals(this.remoteAuthenticationClientCertContent, msgVpnBridge.remoteAuthenticationClientCertContent) && - Objects.equals(this.remoteAuthenticationClientCertPassword, msgVpnBridge.remoteAuthenticationClientCertPassword) && - Objects.equals(this.remoteAuthenticationScheme, msgVpnBridge.remoteAuthenticationScheme) && - Objects.equals(this.remoteConnectionRetryCount, msgVpnBridge.remoteConnectionRetryCount) && - Objects.equals(this.remoteConnectionRetryDelay, msgVpnBridge.remoteConnectionRetryDelay) && - Objects.equals(this.remoteDeliverToOnePriority, msgVpnBridge.remoteDeliverToOnePriority) && - Objects.equals(this.tlsCipherSuiteList, msgVpnBridge.tlsCipherSuiteList); - } - - @Override - public int hashCode() { - return Objects.hash(bridgeName, bridgeVirtualRouter, enabled, maxTtl, msgVpnName, remoteAuthenticationBasicClientUsername, remoteAuthenticationBasicPassword, remoteAuthenticationClientCertContent, remoteAuthenticationClientCertPassword, remoteAuthenticationScheme, remoteConnectionRetryCount, remoteConnectionRetryDelay, remoteDeliverToOnePriority, tlsCipherSuiteList); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnBridge {\n"); - sb.append(" bridgeName: ").append(toIndentedString(bridgeName)).append("\n"); - sb.append(" bridgeVirtualRouter: ").append(toIndentedString(bridgeVirtualRouter)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" maxTtl: ").append(toIndentedString(maxTtl)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" remoteAuthenticationBasicClientUsername: ").append(toIndentedString(remoteAuthenticationBasicClientUsername)).append("\n"); - sb.append(" remoteAuthenticationBasicPassword: ").append(toIndentedString(remoteAuthenticationBasicPassword)).append("\n"); - sb.append(" remoteAuthenticationClientCertContent: ").append(toIndentedString(remoteAuthenticationClientCertContent)).append("\n"); - sb.append(" remoteAuthenticationClientCertPassword: ").append(toIndentedString(remoteAuthenticationClientCertPassword)).append("\n"); - sb.append(" remoteAuthenticationScheme: ").append(toIndentedString(remoteAuthenticationScheme)).append("\n"); - sb.append(" remoteConnectionRetryCount: ").append(toIndentedString(remoteConnectionRetryCount)).append("\n"); - sb.append(" remoteConnectionRetryDelay: ").append(toIndentedString(remoteConnectionRetryDelay)).append("\n"); - sb.append(" remoteDeliverToOnePriority: ").append(toIndentedString(remoteDeliverToOnePriority)).append("\n"); - sb.append(" tlsCipherSuiteList: ").append(toIndentedString(tlsCipherSuiteList)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeLinks.java deleted file mode 100644 index 9e8ad3974..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeLinks.java +++ /dev/null @@ -1,200 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnBridgeLinks - */ -@JsonPropertyOrder({ - MsgVpnBridgeLinks.JSON_PROPERTY_REMOTE_MSG_VPNS_URI, - MsgVpnBridgeLinks.JSON_PROPERTY_REMOTE_SUBSCRIPTIONS_URI, - MsgVpnBridgeLinks.JSON_PROPERTY_TLS_TRUSTED_COMMON_NAMES_URI, - MsgVpnBridgeLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnBridgeLinks { - public static final String JSON_PROPERTY_REMOTE_MSG_VPNS_URI = "remoteMsgVpnsUri"; - private String remoteMsgVpnsUri; - - public static final String JSON_PROPERTY_REMOTE_SUBSCRIPTIONS_URI = "remoteSubscriptionsUri"; - private String remoteSubscriptionsUri; - - public static final String JSON_PROPERTY_TLS_TRUSTED_COMMON_NAMES_URI = "tlsTrustedCommonNamesUri"; - private String tlsTrustedCommonNamesUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnBridgeLinks() { - } - - public MsgVpnBridgeLinks remoteMsgVpnsUri(String remoteMsgVpnsUri) { - - this.remoteMsgVpnsUri = remoteMsgVpnsUri; - return this; - } - - /** - * The URI of this Bridge's collection of Remote Message VPN objects. - * @return remoteMsgVpnsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_MSG_VPNS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteMsgVpnsUri() { - return remoteMsgVpnsUri; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_MSG_VPNS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteMsgVpnsUri(String remoteMsgVpnsUri) { - this.remoteMsgVpnsUri = remoteMsgVpnsUri; - } - - - public MsgVpnBridgeLinks remoteSubscriptionsUri(String remoteSubscriptionsUri) { - - this.remoteSubscriptionsUri = remoteSubscriptionsUri; - return this; - } - - /** - * The URI of this Bridge's collection of Remote Subscription objects. - * @return remoteSubscriptionsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_SUBSCRIPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteSubscriptionsUri() { - return remoteSubscriptionsUri; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_SUBSCRIPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteSubscriptionsUri(String remoteSubscriptionsUri) { - this.remoteSubscriptionsUri = remoteSubscriptionsUri; - } - - - public MsgVpnBridgeLinks tlsTrustedCommonNamesUri(String tlsTrustedCommonNamesUri) { - - this.tlsTrustedCommonNamesUri = tlsTrustedCommonNamesUri; - return this; - } - - /** - * The URI of this Bridge's collection of Trusted Common Name objects. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * @return tlsTrustedCommonNamesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_TRUSTED_COMMON_NAMES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTlsTrustedCommonNamesUri() { - return tlsTrustedCommonNamesUri; - } - - - @JsonProperty(JSON_PROPERTY_TLS_TRUSTED_COMMON_NAMES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsTrustedCommonNamesUri(String tlsTrustedCommonNamesUri) { - this.tlsTrustedCommonNamesUri = tlsTrustedCommonNamesUri; - } - - - public MsgVpnBridgeLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Bridge object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnBridgeLinks msgVpnBridgeLinks = (MsgVpnBridgeLinks) o; - return Objects.equals(this.remoteMsgVpnsUri, msgVpnBridgeLinks.remoteMsgVpnsUri) && - Objects.equals(this.remoteSubscriptionsUri, msgVpnBridgeLinks.remoteSubscriptionsUri) && - Objects.equals(this.tlsTrustedCommonNamesUri, msgVpnBridgeLinks.tlsTrustedCommonNamesUri) && - Objects.equals(this.uri, msgVpnBridgeLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(remoteMsgVpnsUri, remoteSubscriptionsUri, tlsTrustedCommonNamesUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnBridgeLinks {\n"); - sb.append(" remoteMsgVpnsUri: ").append(toIndentedString(remoteMsgVpnsUri)).append("\n"); - sb.append(" remoteSubscriptionsUri: ").append(toIndentedString(remoteSubscriptionsUri)).append("\n"); - sb.append(" tlsTrustedCommonNamesUri: ").append(toIndentedString(tlsTrustedCommonNamesUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpn.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpn.java deleted file mode 100644 index 90307234d..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpn.java +++ /dev/null @@ -1,589 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnBridgeRemoteMsgVpn - */ -@JsonPropertyOrder({ - MsgVpnBridgeRemoteMsgVpn.JSON_PROPERTY_BRIDGE_NAME, - MsgVpnBridgeRemoteMsgVpn.JSON_PROPERTY_BRIDGE_VIRTUAL_ROUTER, - MsgVpnBridgeRemoteMsgVpn.JSON_PROPERTY_CLIENT_USERNAME, - MsgVpnBridgeRemoteMsgVpn.JSON_PROPERTY_COMPRESSED_DATA_ENABLED, - MsgVpnBridgeRemoteMsgVpn.JSON_PROPERTY_CONNECT_ORDER, - MsgVpnBridgeRemoteMsgVpn.JSON_PROPERTY_EGRESS_FLOW_WINDOW_SIZE, - MsgVpnBridgeRemoteMsgVpn.JSON_PROPERTY_ENABLED, - MsgVpnBridgeRemoteMsgVpn.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnBridgeRemoteMsgVpn.JSON_PROPERTY_PASSWORD, - MsgVpnBridgeRemoteMsgVpn.JSON_PROPERTY_QUEUE_BINDING, - MsgVpnBridgeRemoteMsgVpn.JSON_PROPERTY_REMOTE_MSG_VPN_INTERFACE, - MsgVpnBridgeRemoteMsgVpn.JSON_PROPERTY_REMOTE_MSG_VPN_LOCATION, - MsgVpnBridgeRemoteMsgVpn.JSON_PROPERTY_REMOTE_MSG_VPN_NAME, - MsgVpnBridgeRemoteMsgVpn.JSON_PROPERTY_TLS_ENABLED, - MsgVpnBridgeRemoteMsgVpn.JSON_PROPERTY_UNIDIRECTIONAL_CLIENT_PROFILE -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnBridgeRemoteMsgVpn { - public static final String JSON_PROPERTY_BRIDGE_NAME = "bridgeName"; - private String bridgeName; - - /** - * The virtual router of the Bridge. The allowed values and their meaning are: <pre> \"primary\" - The Bridge is used for the primary virtual router. \"backup\" - The Bridge is used for the backup virtual router. \"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> - */ - public enum BridgeVirtualRouterEnum { - PRIMARY("primary"), - - BACKUP("backup"), - - AUTO("auto"); - - private String value; - - BridgeVirtualRouterEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static BridgeVirtualRouterEnum fromValue(String value) { - for (BridgeVirtualRouterEnum b : BridgeVirtualRouterEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_BRIDGE_VIRTUAL_ROUTER = "bridgeVirtualRouter"; - private BridgeVirtualRouterEnum bridgeVirtualRouter; - - public static final String JSON_PROPERTY_CLIENT_USERNAME = "clientUsername"; - private String clientUsername; - - public static final String JSON_PROPERTY_COMPRESSED_DATA_ENABLED = "compressedDataEnabled"; - private Boolean compressedDataEnabled; - - public static final String JSON_PROPERTY_CONNECT_ORDER = "connectOrder"; - private Integer connectOrder; - - public static final String JSON_PROPERTY_EGRESS_FLOW_WINDOW_SIZE = "egressFlowWindowSize"; - private Long egressFlowWindowSize; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_PASSWORD = "password"; - private String password; - - public static final String JSON_PROPERTY_QUEUE_BINDING = "queueBinding"; - private String queueBinding; - - public static final String JSON_PROPERTY_REMOTE_MSG_VPN_INTERFACE = "remoteMsgVpnInterface"; - private String remoteMsgVpnInterface; - - public static final String JSON_PROPERTY_REMOTE_MSG_VPN_LOCATION = "remoteMsgVpnLocation"; - private String remoteMsgVpnLocation; - - public static final String JSON_PROPERTY_REMOTE_MSG_VPN_NAME = "remoteMsgVpnName"; - private String remoteMsgVpnName; - - public static final String JSON_PROPERTY_TLS_ENABLED = "tlsEnabled"; - private Boolean tlsEnabled; - - public static final String JSON_PROPERTY_UNIDIRECTIONAL_CLIENT_PROFILE = "unidirectionalClientProfile"; - private String unidirectionalClientProfile; - - public MsgVpnBridgeRemoteMsgVpn() { - } - - public MsgVpnBridgeRemoteMsgVpn bridgeName(String bridgeName) { - - this.bridgeName = bridgeName; - return this; - } - - /** - * The name of the Bridge. - * @return bridgeName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_BRIDGE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getBridgeName() { - return bridgeName; - } - - - @JsonProperty(JSON_PROPERTY_BRIDGE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setBridgeName(String bridgeName) { - this.bridgeName = bridgeName; - } - - - public MsgVpnBridgeRemoteMsgVpn bridgeVirtualRouter(BridgeVirtualRouterEnum bridgeVirtualRouter) { - - this.bridgeVirtualRouter = bridgeVirtualRouter; - return this; - } - - /** - * The virtual router of the Bridge. The allowed values and their meaning are: <pre> \"primary\" - The Bridge is used for the primary virtual router. \"backup\" - The Bridge is used for the backup virtual router. \"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> - * @return bridgeVirtualRouter - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_BRIDGE_VIRTUAL_ROUTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public BridgeVirtualRouterEnum getBridgeVirtualRouter() { - return bridgeVirtualRouter; - } - - - @JsonProperty(JSON_PROPERTY_BRIDGE_VIRTUAL_ROUTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setBridgeVirtualRouter(BridgeVirtualRouterEnum bridgeVirtualRouter) { - this.bridgeVirtualRouter = bridgeVirtualRouter; - } - - - public MsgVpnBridgeRemoteMsgVpn clientUsername(String clientUsername) { - - this.clientUsername = clientUsername; - return this; - } - - /** - * The Client Username the Bridge uses to login to the remote Message VPN. This per remote Message VPN value overrides the value provided for the Bridge overall. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return clientUsername - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientUsername() { - return clientUsername; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientUsername(String clientUsername) { - this.clientUsername = clientUsername; - } - - - public MsgVpnBridgeRemoteMsgVpn compressedDataEnabled(Boolean compressedDataEnabled) { - - this.compressedDataEnabled = compressedDataEnabled; - return this; - } - - /** - * Enable or disable data compression for the remote Message VPN connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return compressedDataEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_COMPRESSED_DATA_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getCompressedDataEnabled() { - return compressedDataEnabled; - } - - - @JsonProperty(JSON_PROPERTY_COMPRESSED_DATA_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCompressedDataEnabled(Boolean compressedDataEnabled) { - this.compressedDataEnabled = compressedDataEnabled; - } - - - public MsgVpnBridgeRemoteMsgVpn connectOrder(Integer connectOrder) { - - this.connectOrder = connectOrder; - return this; - } - - /** - * The preference given to incoming connections from remote Message VPN hosts, from 1 (highest priority) to 4 (lowest priority). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`. - * @return connectOrder - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONNECT_ORDER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getConnectOrder() { - return connectOrder; - } - - - @JsonProperty(JSON_PROPERTY_CONNECT_ORDER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConnectOrder(Integer connectOrder) { - this.connectOrder = connectOrder; - } - - - public MsgVpnBridgeRemoteMsgVpn egressFlowWindowSize(Long egressFlowWindowSize) { - - this.egressFlowWindowSize = egressFlowWindowSize; - return this; - } - - /** - * The number of outstanding guaranteed messages that can be transmitted over the remote Message VPN connection before an acknowledgement is received. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`. - * @return egressFlowWindowSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EGRESS_FLOW_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getEgressFlowWindowSize() { - return egressFlowWindowSize; - } - - - @JsonProperty(JSON_PROPERTY_EGRESS_FLOW_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEgressFlowWindowSize(Long egressFlowWindowSize) { - this.egressFlowWindowSize = egressFlowWindowSize; - } - - - public MsgVpnBridgeRemoteMsgVpn enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public MsgVpnBridgeRemoteMsgVpn msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnBridgeRemoteMsgVpn password(String password) { - - this.password = password; - return this; - } - - /** - * The password for the Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return password - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getPassword() { - return password; - } - - - @JsonProperty(JSON_PROPERTY_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPassword(String password) { - this.password = password; - } - - - public MsgVpnBridgeRemoteMsgVpn queueBinding(String queueBinding) { - - this.queueBinding = queueBinding; - return this; - } - - /** - * The queue binding of the Bridge in the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return queueBinding - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_BINDING) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getQueueBinding() { - return queueBinding; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_BINDING) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueBinding(String queueBinding) { - this.queueBinding = queueBinding; - } - - - public MsgVpnBridgeRemoteMsgVpn remoteMsgVpnInterface(String remoteMsgVpnInterface) { - - this.remoteMsgVpnInterface = remoteMsgVpnInterface; - return this; - } - - /** - * The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name. - * @return remoteMsgVpnInterface - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_MSG_VPN_INTERFACE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteMsgVpnInterface() { - return remoteMsgVpnInterface; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_MSG_VPN_INTERFACE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteMsgVpnInterface(String remoteMsgVpnInterface) { - this.remoteMsgVpnInterface = remoteMsgVpnInterface; - } - - - public MsgVpnBridgeRemoteMsgVpn remoteMsgVpnLocation(String remoteMsgVpnLocation) { - - this.remoteMsgVpnLocation = remoteMsgVpnLocation; - return this; - } - - /** - * The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\"). - * @return remoteMsgVpnLocation - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_MSG_VPN_LOCATION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteMsgVpnLocation() { - return remoteMsgVpnLocation; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_MSG_VPN_LOCATION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteMsgVpnLocation(String remoteMsgVpnLocation) { - this.remoteMsgVpnLocation = remoteMsgVpnLocation; - } - - - public MsgVpnBridgeRemoteMsgVpn remoteMsgVpnName(String remoteMsgVpnName) { - - this.remoteMsgVpnName = remoteMsgVpnName; - return this; - } - - /** - * The name of the remote Message VPN. - * @return remoteMsgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteMsgVpnName() { - return remoteMsgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteMsgVpnName(String remoteMsgVpnName) { - this.remoteMsgVpnName = remoteMsgVpnName; - } - - - public MsgVpnBridgeRemoteMsgVpn tlsEnabled(Boolean tlsEnabled) { - - this.tlsEnabled = tlsEnabled; - return this; - } - - /** - * Enable or disable encryption (TLS) for the remote Message VPN connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return tlsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTlsEnabled() { - return tlsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsEnabled(Boolean tlsEnabled) { - this.tlsEnabled = tlsEnabled; - } - - - public MsgVpnBridgeRemoteMsgVpn unidirectionalClientProfile(String unidirectionalClientProfile) { - - this.unidirectionalClientProfile = unidirectionalClientProfile; - return this; - } - - /** - * The Client Profile for the unidirectional Bridge of the remote Message VPN. The Client Profile must exist in the local Message VPN, and it is used only for the TCP parameters. Note that the default client profile has a TCP maximum window size of 2MB. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#client-profile\"`. - * @return unidirectionalClientProfile - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_UNIDIRECTIONAL_CLIENT_PROFILE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUnidirectionalClientProfile() { - return unidirectionalClientProfile; - } - - - @JsonProperty(JSON_PROPERTY_UNIDIRECTIONAL_CLIENT_PROFILE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUnidirectionalClientProfile(String unidirectionalClientProfile) { - this.unidirectionalClientProfile = unidirectionalClientProfile; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnBridgeRemoteMsgVpn msgVpnBridgeRemoteMsgVpn = (MsgVpnBridgeRemoteMsgVpn) o; - return Objects.equals(this.bridgeName, msgVpnBridgeRemoteMsgVpn.bridgeName) && - Objects.equals(this.bridgeVirtualRouter, msgVpnBridgeRemoteMsgVpn.bridgeVirtualRouter) && - Objects.equals(this.clientUsername, msgVpnBridgeRemoteMsgVpn.clientUsername) && - Objects.equals(this.compressedDataEnabled, msgVpnBridgeRemoteMsgVpn.compressedDataEnabled) && - Objects.equals(this.connectOrder, msgVpnBridgeRemoteMsgVpn.connectOrder) && - Objects.equals(this.egressFlowWindowSize, msgVpnBridgeRemoteMsgVpn.egressFlowWindowSize) && - Objects.equals(this.enabled, msgVpnBridgeRemoteMsgVpn.enabled) && - Objects.equals(this.msgVpnName, msgVpnBridgeRemoteMsgVpn.msgVpnName) && - Objects.equals(this.password, msgVpnBridgeRemoteMsgVpn.password) && - Objects.equals(this.queueBinding, msgVpnBridgeRemoteMsgVpn.queueBinding) && - Objects.equals(this.remoteMsgVpnInterface, msgVpnBridgeRemoteMsgVpn.remoteMsgVpnInterface) && - Objects.equals(this.remoteMsgVpnLocation, msgVpnBridgeRemoteMsgVpn.remoteMsgVpnLocation) && - Objects.equals(this.remoteMsgVpnName, msgVpnBridgeRemoteMsgVpn.remoteMsgVpnName) && - Objects.equals(this.tlsEnabled, msgVpnBridgeRemoteMsgVpn.tlsEnabled) && - Objects.equals(this.unidirectionalClientProfile, msgVpnBridgeRemoteMsgVpn.unidirectionalClientProfile); - } - - @Override - public int hashCode() { - return Objects.hash(bridgeName, bridgeVirtualRouter, clientUsername, compressedDataEnabled, connectOrder, egressFlowWindowSize, enabled, msgVpnName, password, queueBinding, remoteMsgVpnInterface, remoteMsgVpnLocation, remoteMsgVpnName, tlsEnabled, unidirectionalClientProfile); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnBridgeRemoteMsgVpn {\n"); - sb.append(" bridgeName: ").append(toIndentedString(bridgeName)).append("\n"); - sb.append(" bridgeVirtualRouter: ").append(toIndentedString(bridgeVirtualRouter)).append("\n"); - sb.append(" clientUsername: ").append(toIndentedString(clientUsername)).append("\n"); - sb.append(" compressedDataEnabled: ").append(toIndentedString(compressedDataEnabled)).append("\n"); - sb.append(" connectOrder: ").append(toIndentedString(connectOrder)).append("\n"); - sb.append(" egressFlowWindowSize: ").append(toIndentedString(egressFlowWindowSize)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" password: ").append(toIndentedString(password)).append("\n"); - sb.append(" queueBinding: ").append(toIndentedString(queueBinding)).append("\n"); - sb.append(" remoteMsgVpnInterface: ").append(toIndentedString(remoteMsgVpnInterface)).append("\n"); - sb.append(" remoteMsgVpnLocation: ").append(toIndentedString(remoteMsgVpnLocation)).append("\n"); - sb.append(" remoteMsgVpnName: ").append(toIndentedString(remoteMsgVpnName)).append("\n"); - sb.append(" tlsEnabled: ").append(toIndentedString(tlsEnabled)).append("\n"); - sb.append(" unidirectionalClientProfile: ").append(toIndentedString(unidirectionalClientProfile)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnLinks.java deleted file mode 100644 index 37077d5ab..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnBridgeRemoteMsgVpnLinks - */ -@JsonPropertyOrder({ - MsgVpnBridgeRemoteMsgVpnLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnBridgeRemoteMsgVpnLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnBridgeRemoteMsgVpnLinks() { - } - - public MsgVpnBridgeRemoteMsgVpnLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Remote Message VPN object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnBridgeRemoteMsgVpnLinks msgVpnBridgeRemoteMsgVpnLinks = (MsgVpnBridgeRemoteMsgVpnLinks) o; - return Objects.equals(this.uri, msgVpnBridgeRemoteMsgVpnLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnBridgeRemoteMsgVpnLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnResponse.java deleted file mode 100644 index 1a458333a..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpnLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnBridgeRemoteMsgVpnResponse - */ -@JsonPropertyOrder({ - MsgVpnBridgeRemoteMsgVpnResponse.JSON_PROPERTY_DATA, - MsgVpnBridgeRemoteMsgVpnResponse.JSON_PROPERTY_LINKS, - MsgVpnBridgeRemoteMsgVpnResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnBridgeRemoteMsgVpnResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnBridgeRemoteMsgVpn data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnBridgeRemoteMsgVpnLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnBridgeRemoteMsgVpnResponse() { - } - - public MsgVpnBridgeRemoteMsgVpnResponse data(MsgVpnBridgeRemoteMsgVpn data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnBridgeRemoteMsgVpn getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnBridgeRemoteMsgVpn data) { - this.data = data; - } - - - public MsgVpnBridgeRemoteMsgVpnResponse links(MsgVpnBridgeRemoteMsgVpnLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnBridgeRemoteMsgVpnLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnBridgeRemoteMsgVpnLinks links) { - this.links = links; - } - - - public MsgVpnBridgeRemoteMsgVpnResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnBridgeRemoteMsgVpnResponse msgVpnBridgeRemoteMsgVpnResponse = (MsgVpnBridgeRemoteMsgVpnResponse) o; - return Objects.equals(this.data, msgVpnBridgeRemoteMsgVpnResponse.data) && - Objects.equals(this.links, msgVpnBridgeRemoteMsgVpnResponse.links) && - Objects.equals(this.meta, msgVpnBridgeRemoteMsgVpnResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnBridgeRemoteMsgVpnResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnsResponse.java deleted file mode 100644 index 54ccebbaa..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpnLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnBridgeRemoteMsgVpnsResponse - */ -@JsonPropertyOrder({ - MsgVpnBridgeRemoteMsgVpnsResponse.JSON_PROPERTY_DATA, - MsgVpnBridgeRemoteMsgVpnsResponse.JSON_PROPERTY_LINKS, - MsgVpnBridgeRemoteMsgVpnsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnBridgeRemoteMsgVpnsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnBridgeRemoteMsgVpnsResponse() { - } - - public MsgVpnBridgeRemoteMsgVpnsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnBridgeRemoteMsgVpnsResponse addDataItem(MsgVpnBridgeRemoteMsgVpn dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnBridgeRemoteMsgVpnsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnBridgeRemoteMsgVpnsResponse addLinksItem(MsgVpnBridgeRemoteMsgVpnLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnBridgeRemoteMsgVpnsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnBridgeRemoteMsgVpnsResponse msgVpnBridgeRemoteMsgVpnsResponse = (MsgVpnBridgeRemoteMsgVpnsResponse) o; - return Objects.equals(this.data, msgVpnBridgeRemoteMsgVpnsResponse.data) && - Objects.equals(this.links, msgVpnBridgeRemoteMsgVpnsResponse.links) && - Objects.equals(this.meta, msgVpnBridgeRemoteMsgVpnsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnBridgeRemoteMsgVpnsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscription.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscription.java deleted file mode 100644 index 6162a398d..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscription.java +++ /dev/null @@ -1,269 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnBridgeRemoteSubscription - */ -@JsonPropertyOrder({ - MsgVpnBridgeRemoteSubscription.JSON_PROPERTY_BRIDGE_NAME, - MsgVpnBridgeRemoteSubscription.JSON_PROPERTY_BRIDGE_VIRTUAL_ROUTER, - MsgVpnBridgeRemoteSubscription.JSON_PROPERTY_DELIVER_ALWAYS_ENABLED, - MsgVpnBridgeRemoteSubscription.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnBridgeRemoteSubscription.JSON_PROPERTY_REMOTE_SUBSCRIPTION_TOPIC -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnBridgeRemoteSubscription { - public static final String JSON_PROPERTY_BRIDGE_NAME = "bridgeName"; - private String bridgeName; - - /** - * The virtual router of the Bridge. The allowed values and their meaning are: <pre> \"primary\" - The Bridge is used for the primary virtual router. \"backup\" - The Bridge is used for the backup virtual router. \"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> - */ - public enum BridgeVirtualRouterEnum { - PRIMARY("primary"), - - BACKUP("backup"), - - AUTO("auto"); - - private String value; - - BridgeVirtualRouterEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static BridgeVirtualRouterEnum fromValue(String value) { - for (BridgeVirtualRouterEnum b : BridgeVirtualRouterEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_BRIDGE_VIRTUAL_ROUTER = "bridgeVirtualRouter"; - private BridgeVirtualRouterEnum bridgeVirtualRouter; - - public static final String JSON_PROPERTY_DELIVER_ALWAYS_ENABLED = "deliverAlwaysEnabled"; - private Boolean deliverAlwaysEnabled; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_REMOTE_SUBSCRIPTION_TOPIC = "remoteSubscriptionTopic"; - private String remoteSubscriptionTopic; - - public MsgVpnBridgeRemoteSubscription() { - } - - public MsgVpnBridgeRemoteSubscription bridgeName(String bridgeName) { - - this.bridgeName = bridgeName; - return this; - } - - /** - * The name of the Bridge. - * @return bridgeName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_BRIDGE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getBridgeName() { - return bridgeName; - } - - - @JsonProperty(JSON_PROPERTY_BRIDGE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setBridgeName(String bridgeName) { - this.bridgeName = bridgeName; - } - - - public MsgVpnBridgeRemoteSubscription bridgeVirtualRouter(BridgeVirtualRouterEnum bridgeVirtualRouter) { - - this.bridgeVirtualRouter = bridgeVirtualRouter; - return this; - } - - /** - * The virtual router of the Bridge. The allowed values and their meaning are: <pre> \"primary\" - The Bridge is used for the primary virtual router. \"backup\" - The Bridge is used for the backup virtual router. \"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> - * @return bridgeVirtualRouter - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_BRIDGE_VIRTUAL_ROUTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public BridgeVirtualRouterEnum getBridgeVirtualRouter() { - return bridgeVirtualRouter; - } - - - @JsonProperty(JSON_PROPERTY_BRIDGE_VIRTUAL_ROUTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setBridgeVirtualRouter(BridgeVirtualRouterEnum bridgeVirtualRouter) { - this.bridgeVirtualRouter = bridgeVirtualRouter; - } - - - public MsgVpnBridgeRemoteSubscription deliverAlwaysEnabled(Boolean deliverAlwaysEnabled) { - - this.deliverAlwaysEnabled = deliverAlwaysEnabled; - return this; - } - - /** - * Enable or disable deliver-always for the Bridge remote subscription topic instead of a deliver-to-one remote priority. A given topic for the Bridge may be deliver-to-one or deliver-always but not both. - * @return deliverAlwaysEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DELIVER_ALWAYS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getDeliverAlwaysEnabled() { - return deliverAlwaysEnabled; - } - - - @JsonProperty(JSON_PROPERTY_DELIVER_ALWAYS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDeliverAlwaysEnabled(Boolean deliverAlwaysEnabled) { - this.deliverAlwaysEnabled = deliverAlwaysEnabled; - } - - - public MsgVpnBridgeRemoteSubscription msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnBridgeRemoteSubscription remoteSubscriptionTopic(String remoteSubscriptionTopic) { - - this.remoteSubscriptionTopic = remoteSubscriptionTopic; - return this; - } - - /** - * The topic of the Bridge remote subscription. - * @return remoteSubscriptionTopic - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_SUBSCRIPTION_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteSubscriptionTopic() { - return remoteSubscriptionTopic; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_SUBSCRIPTION_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteSubscriptionTopic(String remoteSubscriptionTopic) { - this.remoteSubscriptionTopic = remoteSubscriptionTopic; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnBridgeRemoteSubscription msgVpnBridgeRemoteSubscription = (MsgVpnBridgeRemoteSubscription) o; - return Objects.equals(this.bridgeName, msgVpnBridgeRemoteSubscription.bridgeName) && - Objects.equals(this.bridgeVirtualRouter, msgVpnBridgeRemoteSubscription.bridgeVirtualRouter) && - Objects.equals(this.deliverAlwaysEnabled, msgVpnBridgeRemoteSubscription.deliverAlwaysEnabled) && - Objects.equals(this.msgVpnName, msgVpnBridgeRemoteSubscription.msgVpnName) && - Objects.equals(this.remoteSubscriptionTopic, msgVpnBridgeRemoteSubscription.remoteSubscriptionTopic); - } - - @Override - public int hashCode() { - return Objects.hash(bridgeName, bridgeVirtualRouter, deliverAlwaysEnabled, msgVpnName, remoteSubscriptionTopic); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnBridgeRemoteSubscription {\n"); - sb.append(" bridgeName: ").append(toIndentedString(bridgeName)).append("\n"); - sb.append(" bridgeVirtualRouter: ").append(toIndentedString(bridgeVirtualRouter)).append("\n"); - sb.append(" deliverAlwaysEnabled: ").append(toIndentedString(deliverAlwaysEnabled)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" remoteSubscriptionTopic: ").append(toIndentedString(remoteSubscriptionTopic)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionLinks.java deleted file mode 100644 index 6e2f06ca9..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnBridgeRemoteSubscriptionLinks - */ -@JsonPropertyOrder({ - MsgVpnBridgeRemoteSubscriptionLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnBridgeRemoteSubscriptionLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnBridgeRemoteSubscriptionLinks() { - } - - public MsgVpnBridgeRemoteSubscriptionLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Remote Subscription object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnBridgeRemoteSubscriptionLinks msgVpnBridgeRemoteSubscriptionLinks = (MsgVpnBridgeRemoteSubscriptionLinks) o; - return Objects.equals(this.uri, msgVpnBridgeRemoteSubscriptionLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnBridgeRemoteSubscriptionLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionResponse.java deleted file mode 100644 index c17a46bdd..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscriptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnBridgeRemoteSubscriptionResponse - */ -@JsonPropertyOrder({ - MsgVpnBridgeRemoteSubscriptionResponse.JSON_PROPERTY_DATA, - MsgVpnBridgeRemoteSubscriptionResponse.JSON_PROPERTY_LINKS, - MsgVpnBridgeRemoteSubscriptionResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnBridgeRemoteSubscriptionResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnBridgeRemoteSubscription data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnBridgeRemoteSubscriptionLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnBridgeRemoteSubscriptionResponse() { - } - - public MsgVpnBridgeRemoteSubscriptionResponse data(MsgVpnBridgeRemoteSubscription data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnBridgeRemoteSubscription getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnBridgeRemoteSubscription data) { - this.data = data; - } - - - public MsgVpnBridgeRemoteSubscriptionResponse links(MsgVpnBridgeRemoteSubscriptionLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnBridgeRemoteSubscriptionLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnBridgeRemoteSubscriptionLinks links) { - this.links = links; - } - - - public MsgVpnBridgeRemoteSubscriptionResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnBridgeRemoteSubscriptionResponse msgVpnBridgeRemoteSubscriptionResponse = (MsgVpnBridgeRemoteSubscriptionResponse) o; - return Objects.equals(this.data, msgVpnBridgeRemoteSubscriptionResponse.data) && - Objects.equals(this.links, msgVpnBridgeRemoteSubscriptionResponse.links) && - Objects.equals(this.meta, msgVpnBridgeRemoteSubscriptionResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnBridgeRemoteSubscriptionResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionsResponse.java deleted file mode 100644 index 92f673a39..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscriptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnBridgeRemoteSubscriptionsResponse - */ -@JsonPropertyOrder({ - MsgVpnBridgeRemoteSubscriptionsResponse.JSON_PROPERTY_DATA, - MsgVpnBridgeRemoteSubscriptionsResponse.JSON_PROPERTY_LINKS, - MsgVpnBridgeRemoteSubscriptionsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnBridgeRemoteSubscriptionsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnBridgeRemoteSubscriptionsResponse() { - } - - public MsgVpnBridgeRemoteSubscriptionsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnBridgeRemoteSubscriptionsResponse addDataItem(MsgVpnBridgeRemoteSubscription dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnBridgeRemoteSubscriptionsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnBridgeRemoteSubscriptionsResponse addLinksItem(MsgVpnBridgeRemoteSubscriptionLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnBridgeRemoteSubscriptionsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnBridgeRemoteSubscriptionsResponse msgVpnBridgeRemoteSubscriptionsResponse = (MsgVpnBridgeRemoteSubscriptionsResponse) o; - return Objects.equals(this.data, msgVpnBridgeRemoteSubscriptionsResponse.data) && - Objects.equals(this.links, msgVpnBridgeRemoteSubscriptionsResponse.links) && - Objects.equals(this.meta, msgVpnBridgeRemoteSubscriptionsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnBridgeRemoteSubscriptionsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeResponse.java deleted file mode 100644 index 0b25a59e3..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnBridgeResponse - */ -@JsonPropertyOrder({ - MsgVpnBridgeResponse.JSON_PROPERTY_DATA, - MsgVpnBridgeResponse.JSON_PROPERTY_LINKS, - MsgVpnBridgeResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnBridgeResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnBridge data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnBridgeLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnBridgeResponse() { - } - - public MsgVpnBridgeResponse data(MsgVpnBridge data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnBridge getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnBridge data) { - this.data = data; - } - - - public MsgVpnBridgeResponse links(MsgVpnBridgeLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnBridgeLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnBridgeLinks links) { - this.links = links; - } - - - public MsgVpnBridgeResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnBridgeResponse msgVpnBridgeResponse = (MsgVpnBridgeResponse) o; - return Objects.equals(this.data, msgVpnBridgeResponse.data) && - Objects.equals(this.links, msgVpnBridgeResponse.links) && - Objects.equals(this.meta, msgVpnBridgeResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnBridgeResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonName.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonName.java deleted file mode 100644 index f205e89ec..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonName.java +++ /dev/null @@ -1,237 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnBridgeTlsTrustedCommonName - */ -@JsonPropertyOrder({ - MsgVpnBridgeTlsTrustedCommonName.JSON_PROPERTY_BRIDGE_NAME, - MsgVpnBridgeTlsTrustedCommonName.JSON_PROPERTY_BRIDGE_VIRTUAL_ROUTER, - MsgVpnBridgeTlsTrustedCommonName.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnBridgeTlsTrustedCommonName.JSON_PROPERTY_TLS_TRUSTED_COMMON_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnBridgeTlsTrustedCommonName { - public static final String JSON_PROPERTY_BRIDGE_NAME = "bridgeName"; - private String bridgeName; - - /** - * The virtual router of the Bridge. The allowed values and their meaning are: <pre> \"primary\" - The Bridge is used for the primary virtual router. \"backup\" - The Bridge is used for the backup virtual router. \"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - */ - public enum BridgeVirtualRouterEnum { - PRIMARY("primary"), - - BACKUP("backup"), - - AUTO("auto"); - - private String value; - - BridgeVirtualRouterEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static BridgeVirtualRouterEnum fromValue(String value) { - for (BridgeVirtualRouterEnum b : BridgeVirtualRouterEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_BRIDGE_VIRTUAL_ROUTER = "bridgeVirtualRouter"; - private BridgeVirtualRouterEnum bridgeVirtualRouter; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_TLS_TRUSTED_COMMON_NAME = "tlsTrustedCommonName"; - private String tlsTrustedCommonName; - - public MsgVpnBridgeTlsTrustedCommonName() { - } - - public MsgVpnBridgeTlsTrustedCommonName bridgeName(String bridgeName) { - - this.bridgeName = bridgeName; - return this; - } - - /** - * The name of the Bridge. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * @return bridgeName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_BRIDGE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getBridgeName() { - return bridgeName; - } - - - @JsonProperty(JSON_PROPERTY_BRIDGE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setBridgeName(String bridgeName) { - this.bridgeName = bridgeName; - } - - - public MsgVpnBridgeTlsTrustedCommonName bridgeVirtualRouter(BridgeVirtualRouterEnum bridgeVirtualRouter) { - - this.bridgeVirtualRouter = bridgeVirtualRouter; - return this; - } - - /** - * The virtual router of the Bridge. The allowed values and their meaning are: <pre> \"primary\" - The Bridge is used for the primary virtual router. \"backup\" - The Bridge is used for the backup virtual router. \"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * @return bridgeVirtualRouter - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_BRIDGE_VIRTUAL_ROUTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public BridgeVirtualRouterEnum getBridgeVirtualRouter() { - return bridgeVirtualRouter; - } - - - @JsonProperty(JSON_PROPERTY_BRIDGE_VIRTUAL_ROUTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setBridgeVirtualRouter(BridgeVirtualRouterEnum bridgeVirtualRouter) { - this.bridgeVirtualRouter = bridgeVirtualRouter; - } - - - public MsgVpnBridgeTlsTrustedCommonName msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnBridgeTlsTrustedCommonName tlsTrustedCommonName(String tlsTrustedCommonName) { - - this.tlsTrustedCommonName = tlsTrustedCommonName; - return this; - } - - /** - * The expected trusted common name of the remote certificate. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * @return tlsTrustedCommonName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_TRUSTED_COMMON_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTlsTrustedCommonName() { - return tlsTrustedCommonName; - } - - - @JsonProperty(JSON_PROPERTY_TLS_TRUSTED_COMMON_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsTrustedCommonName(String tlsTrustedCommonName) { - this.tlsTrustedCommonName = tlsTrustedCommonName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnBridgeTlsTrustedCommonName msgVpnBridgeTlsTrustedCommonName = (MsgVpnBridgeTlsTrustedCommonName) o; - return Objects.equals(this.bridgeName, msgVpnBridgeTlsTrustedCommonName.bridgeName) && - Objects.equals(this.bridgeVirtualRouter, msgVpnBridgeTlsTrustedCommonName.bridgeVirtualRouter) && - Objects.equals(this.msgVpnName, msgVpnBridgeTlsTrustedCommonName.msgVpnName) && - Objects.equals(this.tlsTrustedCommonName, msgVpnBridgeTlsTrustedCommonName.tlsTrustedCommonName); - } - - @Override - public int hashCode() { - return Objects.hash(bridgeName, bridgeVirtualRouter, msgVpnName, tlsTrustedCommonName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnBridgeTlsTrustedCommonName {\n"); - sb.append(" bridgeName: ").append(toIndentedString(bridgeName)).append("\n"); - sb.append(" bridgeVirtualRouter: ").append(toIndentedString(bridgeVirtualRouter)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" tlsTrustedCommonName: ").append(toIndentedString(tlsTrustedCommonName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameLinks.java deleted file mode 100644 index 23dcfdd92..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnBridgeTlsTrustedCommonNameLinks - */ -@JsonPropertyOrder({ - MsgVpnBridgeTlsTrustedCommonNameLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnBridgeTlsTrustedCommonNameLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnBridgeTlsTrustedCommonNameLinks() { - } - - public MsgVpnBridgeTlsTrustedCommonNameLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Trusted Common Name object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnBridgeTlsTrustedCommonNameLinks msgVpnBridgeTlsTrustedCommonNameLinks = (MsgVpnBridgeTlsTrustedCommonNameLinks) o; - return Objects.equals(this.uri, msgVpnBridgeTlsTrustedCommonNameLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnBridgeTlsTrustedCommonNameLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameResponse.java deleted file mode 100644 index d3e71f0ff..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnBridgeTlsTrustedCommonNameResponse - */ -@JsonPropertyOrder({ - MsgVpnBridgeTlsTrustedCommonNameResponse.JSON_PROPERTY_DATA, - MsgVpnBridgeTlsTrustedCommonNameResponse.JSON_PROPERTY_LINKS, - MsgVpnBridgeTlsTrustedCommonNameResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnBridgeTlsTrustedCommonNameResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnBridgeTlsTrustedCommonName data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnBridgeTlsTrustedCommonNameLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnBridgeTlsTrustedCommonNameResponse() { - } - - public MsgVpnBridgeTlsTrustedCommonNameResponse data(MsgVpnBridgeTlsTrustedCommonName data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnBridgeTlsTrustedCommonName getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnBridgeTlsTrustedCommonName data) { - this.data = data; - } - - - public MsgVpnBridgeTlsTrustedCommonNameResponse links(MsgVpnBridgeTlsTrustedCommonNameLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnBridgeTlsTrustedCommonNameLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnBridgeTlsTrustedCommonNameLinks links) { - this.links = links; - } - - - public MsgVpnBridgeTlsTrustedCommonNameResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnBridgeTlsTrustedCommonNameResponse msgVpnBridgeTlsTrustedCommonNameResponse = (MsgVpnBridgeTlsTrustedCommonNameResponse) o; - return Objects.equals(this.data, msgVpnBridgeTlsTrustedCommonNameResponse.data) && - Objects.equals(this.links, msgVpnBridgeTlsTrustedCommonNameResponse.links) && - Objects.equals(this.meta, msgVpnBridgeTlsTrustedCommonNameResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnBridgeTlsTrustedCommonNameResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNamesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNamesResponse.java deleted file mode 100644 index 48f5e89d5..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNamesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnBridgeTlsTrustedCommonNamesResponse - */ -@JsonPropertyOrder({ - MsgVpnBridgeTlsTrustedCommonNamesResponse.JSON_PROPERTY_DATA, - MsgVpnBridgeTlsTrustedCommonNamesResponse.JSON_PROPERTY_LINKS, - MsgVpnBridgeTlsTrustedCommonNamesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnBridgeTlsTrustedCommonNamesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnBridgeTlsTrustedCommonNamesResponse() { - } - - public MsgVpnBridgeTlsTrustedCommonNamesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnBridgeTlsTrustedCommonNamesResponse addDataItem(MsgVpnBridgeTlsTrustedCommonName dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnBridgeTlsTrustedCommonNamesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnBridgeTlsTrustedCommonNamesResponse addLinksItem(MsgVpnBridgeTlsTrustedCommonNameLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnBridgeTlsTrustedCommonNamesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnBridgeTlsTrustedCommonNamesResponse msgVpnBridgeTlsTrustedCommonNamesResponse = (MsgVpnBridgeTlsTrustedCommonNamesResponse) o; - return Objects.equals(this.data, msgVpnBridgeTlsTrustedCommonNamesResponse.data) && - Objects.equals(this.links, msgVpnBridgeTlsTrustedCommonNamesResponse.links) && - Objects.equals(this.meta, msgVpnBridgeTlsTrustedCommonNamesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnBridgeTlsTrustedCommonNamesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgesResponse.java deleted file mode 100644 index 6969b922b..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnBridgesResponse - */ -@JsonPropertyOrder({ - MsgVpnBridgesResponse.JSON_PROPERTY_DATA, - MsgVpnBridgesResponse.JSON_PROPERTY_LINKS, - MsgVpnBridgesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnBridgesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnBridgesResponse() { - } - - public MsgVpnBridgesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnBridgesResponse addDataItem(MsgVpnBridge dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnBridgesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnBridgesResponse addLinksItem(MsgVpnBridgeLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnBridgesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnBridgesResponse msgVpnBridgesResponse = (MsgVpnBridgesResponse) o; - return Objects.equals(this.data, msgVpnBridgesResponse.data) && - Objects.equals(this.links, msgVpnBridgesResponse.links) && - Objects.equals(this.meta, msgVpnBridgesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnBridgesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRule.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRule.java deleted file mode 100644 index 0002b6d19..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRule.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnCertMatchingRule - */ -@JsonPropertyOrder({ - MsgVpnCertMatchingRule.JSON_PROPERTY_ENABLED, - MsgVpnCertMatchingRule.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnCertMatchingRule.JSON_PROPERTY_RULE_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnCertMatchingRule { - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_RULE_NAME = "ruleName"; - private String ruleName; - - public MsgVpnCertMatchingRule() { - } - - public MsgVpnCertMatchingRule enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable a certificate matching rule. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public MsgVpnCertMatchingRule msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnCertMatchingRule ruleName(String ruleName) { - - this.ruleName = ruleName; - return this; - } - - /** - * The name of the rule. - * @return ruleName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RULE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRuleName() { - return ruleName; - } - - - @JsonProperty(JSON_PROPERTY_RULE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRuleName(String ruleName) { - this.ruleName = ruleName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnCertMatchingRule msgVpnCertMatchingRule = (MsgVpnCertMatchingRule) o; - return Objects.equals(this.enabled, msgVpnCertMatchingRule.enabled) && - Objects.equals(this.msgVpnName, msgVpnCertMatchingRule.msgVpnName) && - Objects.equals(this.ruleName, msgVpnCertMatchingRule.ruleName); - } - - @Override - public int hashCode() { - return Objects.hash(enabled, msgVpnName, ruleName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnCertMatchingRule {\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" ruleName: ").append(toIndentedString(ruleName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilter.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilter.java deleted file mode 100644 index 3bb8037da..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilter.java +++ /dev/null @@ -1,232 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnCertMatchingRuleAttributeFilter - */ -@JsonPropertyOrder({ - MsgVpnCertMatchingRuleAttributeFilter.JSON_PROPERTY_ATTRIBUTE_NAME, - MsgVpnCertMatchingRuleAttributeFilter.JSON_PROPERTY_ATTRIBUTE_VALUE, - MsgVpnCertMatchingRuleAttributeFilter.JSON_PROPERTY_FILTER_NAME, - MsgVpnCertMatchingRuleAttributeFilter.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnCertMatchingRuleAttributeFilter.JSON_PROPERTY_RULE_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnCertMatchingRuleAttributeFilter { - public static final String JSON_PROPERTY_ATTRIBUTE_NAME = "attributeName"; - private String attributeName; - - public static final String JSON_PROPERTY_ATTRIBUTE_VALUE = "attributeValue"; - private String attributeValue; - - public static final String JSON_PROPERTY_FILTER_NAME = "filterName"; - private String filterName; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_RULE_NAME = "ruleName"; - private String ruleName; - - public MsgVpnCertMatchingRuleAttributeFilter() { - } - - public MsgVpnCertMatchingRuleAttributeFilter attributeName(String attributeName) { - - this.attributeName = attributeName; - return this; - } - - /** - * Client Username Attribute to be tested. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return attributeName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAttributeName() { - return attributeName; - } - - - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttributeName(String attributeName) { - this.attributeName = attributeName; - } - - - public MsgVpnCertMatchingRuleAttributeFilter attributeValue(String attributeValue) { - - this.attributeValue = attributeValue; - return this; - } - - /** - * Expected attribute value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return attributeValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAttributeValue() { - return attributeValue; - } - - - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttributeValue(String attributeValue) { - this.attributeValue = attributeValue; - } - - - public MsgVpnCertMatchingRuleAttributeFilter filterName(String filterName) { - - this.filterName = filterName; - return this; - } - - /** - * The name of the filter. - * @return filterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_FILTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getFilterName() { - return filterName; - } - - - @JsonProperty(JSON_PROPERTY_FILTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFilterName(String filterName) { - this.filterName = filterName; - } - - - public MsgVpnCertMatchingRuleAttributeFilter msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnCertMatchingRuleAttributeFilter ruleName(String ruleName) { - - this.ruleName = ruleName; - return this; - } - - /** - * The name of the rule. - * @return ruleName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RULE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRuleName() { - return ruleName; - } - - - @JsonProperty(JSON_PROPERTY_RULE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRuleName(String ruleName) { - this.ruleName = ruleName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnCertMatchingRuleAttributeFilter msgVpnCertMatchingRuleAttributeFilter = (MsgVpnCertMatchingRuleAttributeFilter) o; - return Objects.equals(this.attributeName, msgVpnCertMatchingRuleAttributeFilter.attributeName) && - Objects.equals(this.attributeValue, msgVpnCertMatchingRuleAttributeFilter.attributeValue) && - Objects.equals(this.filterName, msgVpnCertMatchingRuleAttributeFilter.filterName) && - Objects.equals(this.msgVpnName, msgVpnCertMatchingRuleAttributeFilter.msgVpnName) && - Objects.equals(this.ruleName, msgVpnCertMatchingRuleAttributeFilter.ruleName); - } - - @Override - public int hashCode() { - return Objects.hash(attributeName, attributeValue, filterName, msgVpnName, ruleName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnCertMatchingRuleAttributeFilter {\n"); - sb.append(" attributeName: ").append(toIndentedString(attributeName)).append("\n"); - sb.append(" attributeValue: ").append(toIndentedString(attributeValue)).append("\n"); - sb.append(" filterName: ").append(toIndentedString(filterName)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" ruleName: ").append(toIndentedString(ruleName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterLinks.java deleted file mode 100644 index 96a27d500..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnCertMatchingRuleAttributeFilterLinks - */ -@JsonPropertyOrder({ - MsgVpnCertMatchingRuleAttributeFilterLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnCertMatchingRuleAttributeFilterLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnCertMatchingRuleAttributeFilterLinks() { - } - - public MsgVpnCertMatchingRuleAttributeFilterLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Certificate Matching Rule Attribute Filter object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnCertMatchingRuleAttributeFilterLinks msgVpnCertMatchingRuleAttributeFilterLinks = (MsgVpnCertMatchingRuleAttributeFilterLinks) o; - return Objects.equals(this.uri, msgVpnCertMatchingRuleAttributeFilterLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnCertMatchingRuleAttributeFilterLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterResponse.java deleted file mode 100644 index 844ac8dfe..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnCertMatchingRuleAttributeFilterResponse - */ -@JsonPropertyOrder({ - MsgVpnCertMatchingRuleAttributeFilterResponse.JSON_PROPERTY_DATA, - MsgVpnCertMatchingRuleAttributeFilterResponse.JSON_PROPERTY_LINKS, - MsgVpnCertMatchingRuleAttributeFilterResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnCertMatchingRuleAttributeFilterResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnCertMatchingRuleAttributeFilter data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnCertMatchingRuleAttributeFilterLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnCertMatchingRuleAttributeFilterResponse() { - } - - public MsgVpnCertMatchingRuleAttributeFilterResponse data(MsgVpnCertMatchingRuleAttributeFilter data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnCertMatchingRuleAttributeFilter getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnCertMatchingRuleAttributeFilter data) { - this.data = data; - } - - - public MsgVpnCertMatchingRuleAttributeFilterResponse links(MsgVpnCertMatchingRuleAttributeFilterLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnCertMatchingRuleAttributeFilterLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnCertMatchingRuleAttributeFilterLinks links) { - this.links = links; - } - - - public MsgVpnCertMatchingRuleAttributeFilterResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnCertMatchingRuleAttributeFilterResponse msgVpnCertMatchingRuleAttributeFilterResponse = (MsgVpnCertMatchingRuleAttributeFilterResponse) o; - return Objects.equals(this.data, msgVpnCertMatchingRuleAttributeFilterResponse.data) && - Objects.equals(this.links, msgVpnCertMatchingRuleAttributeFilterResponse.links) && - Objects.equals(this.meta, msgVpnCertMatchingRuleAttributeFilterResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnCertMatchingRuleAttributeFilterResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFiltersResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFiltersResponse.java deleted file mode 100644 index 7005596e2..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFiltersResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnCertMatchingRuleAttributeFiltersResponse - */ -@JsonPropertyOrder({ - MsgVpnCertMatchingRuleAttributeFiltersResponse.JSON_PROPERTY_DATA, - MsgVpnCertMatchingRuleAttributeFiltersResponse.JSON_PROPERTY_LINKS, - MsgVpnCertMatchingRuleAttributeFiltersResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnCertMatchingRuleAttributeFiltersResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnCertMatchingRuleAttributeFiltersResponse() { - } - - public MsgVpnCertMatchingRuleAttributeFiltersResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnCertMatchingRuleAttributeFiltersResponse addDataItem(MsgVpnCertMatchingRuleAttributeFilter dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnCertMatchingRuleAttributeFiltersResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnCertMatchingRuleAttributeFiltersResponse addLinksItem(MsgVpnCertMatchingRuleAttributeFilterLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnCertMatchingRuleAttributeFiltersResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnCertMatchingRuleAttributeFiltersResponse msgVpnCertMatchingRuleAttributeFiltersResponse = (MsgVpnCertMatchingRuleAttributeFiltersResponse) o; - return Objects.equals(this.data, msgVpnCertMatchingRuleAttributeFiltersResponse.data) && - Objects.equals(this.links, msgVpnCertMatchingRuleAttributeFiltersResponse.links) && - Objects.equals(this.meta, msgVpnCertMatchingRuleAttributeFiltersResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnCertMatchingRuleAttributeFiltersResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleCondition.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleCondition.java deleted file mode 100644 index 623db1b7c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleCondition.java +++ /dev/null @@ -1,289 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnCertMatchingRuleCondition - */ -@JsonPropertyOrder({ - MsgVpnCertMatchingRuleCondition.JSON_PROPERTY_ATTRIBUTE, - MsgVpnCertMatchingRuleCondition.JSON_PROPERTY_EXPRESSION, - MsgVpnCertMatchingRuleCondition.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnCertMatchingRuleCondition.JSON_PROPERTY_RULE_NAME, - MsgVpnCertMatchingRuleCondition.JSON_PROPERTY_SOURCE -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnCertMatchingRuleCondition { - public static final String JSON_PROPERTY_ATTRIBUTE = "attribute"; - private String attribute; - - public static final String JSON_PROPERTY_EXPRESSION = "expression"; - private String expression; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_RULE_NAME = "ruleName"; - private String ruleName; - - /** - * Certificate field to be compared with the Attribute. The allowed values and their meaning are: <pre> \"certificate-thumbprint\" - The attribute is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate. \"common-name\" - The attribute is extracted from the certificate's first instance of the Common Name attribute in the Subject DN. \"common-name-last\" - The attribute is extracted from the certificate's last instance of the Common Name attribute in the Subject DN. \"subject-alternate-name-msupn\" - The attribute is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature. \"uid\" - The attribute is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN. \"uid-last\" - The attribute is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN. \"org-unit\" - The attribute is extracted from the certificate's first instance of the Org Unit attribute in the Subject DN. \"org-unit-last\" - The attribute is extracted from the certificate's last instance of the Org Unit attribute in the Subject DN. \"issuer\" - The attribute is extracted from the certificate's Issuer DN. \"subject\" - The attribute is extracted from the certificate's Subject DN. \"serial-number\" - The attribute is extracted from the certificate's Serial Number. \"dns-name\" - The attribute is extracted from the certificate's Subject Alt Name DNSName. \"ip-address\" - The attribute is extracted from the certificate's Subject Alt Name IPAddress. </pre> - */ - public enum SourceEnum { - CERTIFICATE_THUMBPRINT("certificate-thumbprint"), - - COMMON_NAME("common-name"), - - COMMON_NAME_LAST("common-name-last"), - - SUBJECT_ALTERNATE_NAME_MSUPN("subject-alternate-name-msupn"), - - UID("uid"), - - UID_LAST("uid-last"), - - ORG_UNIT("org-unit"), - - ORG_UNIT_LAST("org-unit-last"), - - ISSUER("issuer"), - - SUBJECT("subject"), - - SERIAL_NUMBER("serial-number"), - - DNS_NAME("dns-name"), - - IP_ADDRESS("ip-address"); - - private String value; - - SourceEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static SourceEnum fromValue(String value) { - for (SourceEnum b : SourceEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_SOURCE = "source"; - private SourceEnum source; - - public MsgVpnCertMatchingRuleCondition() { - } - - public MsgVpnCertMatchingRuleCondition attribute(String attribute) { - - this.attribute = attribute; - return this; - } - - /** - * Client Username Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The default value is `\"\"`. - * @return attribute - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ATTRIBUTE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAttribute() { - return attribute; - } - - - @JsonProperty(JSON_PROPERTY_ATTRIBUTE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttribute(String attribute) { - this.attribute = attribute; - } - - - public MsgVpnCertMatchingRuleCondition expression(String expression) { - - this.expression = expression; - return this; - } - - /** - * Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The default value is `\"\"`. - * @return expression - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EXPRESSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getExpression() { - return expression; - } - - - @JsonProperty(JSON_PROPERTY_EXPRESSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setExpression(String expression) { - this.expression = expression; - } - - - public MsgVpnCertMatchingRuleCondition msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnCertMatchingRuleCondition ruleName(String ruleName) { - - this.ruleName = ruleName; - return this; - } - - /** - * The name of the rule. - * @return ruleName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RULE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRuleName() { - return ruleName; - } - - - @JsonProperty(JSON_PROPERTY_RULE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRuleName(String ruleName) { - this.ruleName = ruleName; - } - - - public MsgVpnCertMatchingRuleCondition source(SourceEnum source) { - - this.source = source; - return this; - } - - /** - * Certificate field to be compared with the Attribute. The allowed values and their meaning are: <pre> \"certificate-thumbprint\" - The attribute is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate. \"common-name\" - The attribute is extracted from the certificate's first instance of the Common Name attribute in the Subject DN. \"common-name-last\" - The attribute is extracted from the certificate's last instance of the Common Name attribute in the Subject DN. \"subject-alternate-name-msupn\" - The attribute is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature. \"uid\" - The attribute is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN. \"uid-last\" - The attribute is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN. \"org-unit\" - The attribute is extracted from the certificate's first instance of the Org Unit attribute in the Subject DN. \"org-unit-last\" - The attribute is extracted from the certificate's last instance of the Org Unit attribute in the Subject DN. \"issuer\" - The attribute is extracted from the certificate's Issuer DN. \"subject\" - The attribute is extracted from the certificate's Subject DN. \"serial-number\" - The attribute is extracted from the certificate's Serial Number. \"dns-name\" - The attribute is extracted from the certificate's Subject Alt Name DNSName. \"ip-address\" - The attribute is extracted from the certificate's Subject Alt Name IPAddress. </pre> - * @return source - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SOURCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public SourceEnum getSource() { - return source; - } - - - @JsonProperty(JSON_PROPERTY_SOURCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSource(SourceEnum source) { - this.source = source; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnCertMatchingRuleCondition msgVpnCertMatchingRuleCondition = (MsgVpnCertMatchingRuleCondition) o; - return Objects.equals(this.attribute, msgVpnCertMatchingRuleCondition.attribute) && - Objects.equals(this.expression, msgVpnCertMatchingRuleCondition.expression) && - Objects.equals(this.msgVpnName, msgVpnCertMatchingRuleCondition.msgVpnName) && - Objects.equals(this.ruleName, msgVpnCertMatchingRuleCondition.ruleName) && - Objects.equals(this.source, msgVpnCertMatchingRuleCondition.source); - } - - @Override - public int hashCode() { - return Objects.hash(attribute, expression, msgVpnName, ruleName, source); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnCertMatchingRuleCondition {\n"); - sb.append(" attribute: ").append(toIndentedString(attribute)).append("\n"); - sb.append(" expression: ").append(toIndentedString(expression)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" ruleName: ").append(toIndentedString(ruleName)).append("\n"); - sb.append(" source: ").append(toIndentedString(source)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionLinks.java deleted file mode 100644 index 209ecb782..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnCertMatchingRuleConditionLinks - */ -@JsonPropertyOrder({ - MsgVpnCertMatchingRuleConditionLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnCertMatchingRuleConditionLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnCertMatchingRuleConditionLinks() { - } - - public MsgVpnCertMatchingRuleConditionLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Certificate Matching Rule Condition object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnCertMatchingRuleConditionLinks msgVpnCertMatchingRuleConditionLinks = (MsgVpnCertMatchingRuleConditionLinks) o; - return Objects.equals(this.uri, msgVpnCertMatchingRuleConditionLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnCertMatchingRuleConditionLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionResponse.java deleted file mode 100644 index b3de6176c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleConditionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnCertMatchingRuleConditionResponse - */ -@JsonPropertyOrder({ - MsgVpnCertMatchingRuleConditionResponse.JSON_PROPERTY_DATA, - MsgVpnCertMatchingRuleConditionResponse.JSON_PROPERTY_LINKS, - MsgVpnCertMatchingRuleConditionResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnCertMatchingRuleConditionResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnCertMatchingRuleCondition data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnCertMatchingRuleConditionLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnCertMatchingRuleConditionResponse() { - } - - public MsgVpnCertMatchingRuleConditionResponse data(MsgVpnCertMatchingRuleCondition data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnCertMatchingRuleCondition getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnCertMatchingRuleCondition data) { - this.data = data; - } - - - public MsgVpnCertMatchingRuleConditionResponse links(MsgVpnCertMatchingRuleConditionLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnCertMatchingRuleConditionLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnCertMatchingRuleConditionLinks links) { - this.links = links; - } - - - public MsgVpnCertMatchingRuleConditionResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnCertMatchingRuleConditionResponse msgVpnCertMatchingRuleConditionResponse = (MsgVpnCertMatchingRuleConditionResponse) o; - return Objects.equals(this.data, msgVpnCertMatchingRuleConditionResponse.data) && - Objects.equals(this.links, msgVpnCertMatchingRuleConditionResponse.links) && - Objects.equals(this.meta, msgVpnCertMatchingRuleConditionResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnCertMatchingRuleConditionResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionsResponse.java deleted file mode 100644 index e67534482..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleConditionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnCertMatchingRuleConditionsResponse - */ -@JsonPropertyOrder({ - MsgVpnCertMatchingRuleConditionsResponse.JSON_PROPERTY_DATA, - MsgVpnCertMatchingRuleConditionsResponse.JSON_PROPERTY_LINKS, - MsgVpnCertMatchingRuleConditionsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnCertMatchingRuleConditionsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnCertMatchingRuleConditionsResponse() { - } - - public MsgVpnCertMatchingRuleConditionsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnCertMatchingRuleConditionsResponse addDataItem(MsgVpnCertMatchingRuleCondition dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnCertMatchingRuleConditionsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnCertMatchingRuleConditionsResponse addLinksItem(MsgVpnCertMatchingRuleConditionLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnCertMatchingRuleConditionsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnCertMatchingRuleConditionsResponse msgVpnCertMatchingRuleConditionsResponse = (MsgVpnCertMatchingRuleConditionsResponse) o; - return Objects.equals(this.data, msgVpnCertMatchingRuleConditionsResponse.data) && - Objects.equals(this.links, msgVpnCertMatchingRuleConditionsResponse.links) && - Objects.equals(this.meta, msgVpnCertMatchingRuleConditionsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnCertMatchingRuleConditionsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleLinks.java deleted file mode 100644 index 3cba64c35..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleLinks.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnCertMatchingRuleLinks - */ -@JsonPropertyOrder({ - MsgVpnCertMatchingRuleLinks.JSON_PROPERTY_ATTRIBUTE_FILTERS_URI, - MsgVpnCertMatchingRuleLinks.JSON_PROPERTY_CONDITIONS_URI, - MsgVpnCertMatchingRuleLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnCertMatchingRuleLinks { - public static final String JSON_PROPERTY_ATTRIBUTE_FILTERS_URI = "attributeFiltersUri"; - private String attributeFiltersUri; - - public static final String JSON_PROPERTY_CONDITIONS_URI = "conditionsUri"; - private String conditionsUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnCertMatchingRuleLinks() { - } - - public MsgVpnCertMatchingRuleLinks attributeFiltersUri(String attributeFiltersUri) { - - this.attributeFiltersUri = attributeFiltersUri; - return this; - } - - /** - * The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Attribute Filter objects. Available since 2.28. - * @return attributeFiltersUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_FILTERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAttributeFiltersUri() { - return attributeFiltersUri; - } - - - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_FILTERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttributeFiltersUri(String attributeFiltersUri) { - this.attributeFiltersUri = attributeFiltersUri; - } - - - public MsgVpnCertMatchingRuleLinks conditionsUri(String conditionsUri) { - - this.conditionsUri = conditionsUri; - return this; - } - - /** - * The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Condition objects. - * @return conditionsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONDITIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getConditionsUri() { - return conditionsUri; - } - - - @JsonProperty(JSON_PROPERTY_CONDITIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConditionsUri(String conditionsUri) { - this.conditionsUri = conditionsUri; - } - - - public MsgVpnCertMatchingRuleLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Certificate Matching Rule object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnCertMatchingRuleLinks msgVpnCertMatchingRuleLinks = (MsgVpnCertMatchingRuleLinks) o; - return Objects.equals(this.attributeFiltersUri, msgVpnCertMatchingRuleLinks.attributeFiltersUri) && - Objects.equals(this.conditionsUri, msgVpnCertMatchingRuleLinks.conditionsUri) && - Objects.equals(this.uri, msgVpnCertMatchingRuleLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(attributeFiltersUri, conditionsUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnCertMatchingRuleLinks {\n"); - sb.append(" attributeFiltersUri: ").append(toIndentedString(attributeFiltersUri)).append("\n"); - sb.append(" conditionsUri: ").append(toIndentedString(conditionsUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleResponse.java deleted file mode 100644 index 370e87f10..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnCertMatchingRuleResponse - */ -@JsonPropertyOrder({ - MsgVpnCertMatchingRuleResponse.JSON_PROPERTY_DATA, - MsgVpnCertMatchingRuleResponse.JSON_PROPERTY_LINKS, - MsgVpnCertMatchingRuleResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnCertMatchingRuleResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnCertMatchingRule data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnCertMatchingRuleLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnCertMatchingRuleResponse() { - } - - public MsgVpnCertMatchingRuleResponse data(MsgVpnCertMatchingRule data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnCertMatchingRule getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnCertMatchingRule data) { - this.data = data; - } - - - public MsgVpnCertMatchingRuleResponse links(MsgVpnCertMatchingRuleLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnCertMatchingRuleLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnCertMatchingRuleLinks links) { - this.links = links; - } - - - public MsgVpnCertMatchingRuleResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnCertMatchingRuleResponse msgVpnCertMatchingRuleResponse = (MsgVpnCertMatchingRuleResponse) o; - return Objects.equals(this.data, msgVpnCertMatchingRuleResponse.data) && - Objects.equals(this.links, msgVpnCertMatchingRuleResponse.links) && - Objects.equals(this.meta, msgVpnCertMatchingRuleResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnCertMatchingRuleResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRulesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRulesResponse.java deleted file mode 100644 index 099674710..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRulesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnCertMatchingRulesResponse - */ -@JsonPropertyOrder({ - MsgVpnCertMatchingRulesResponse.JSON_PROPERTY_DATA, - MsgVpnCertMatchingRulesResponse.JSON_PROPERTY_LINKS, - MsgVpnCertMatchingRulesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnCertMatchingRulesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnCertMatchingRulesResponse() { - } - - public MsgVpnCertMatchingRulesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnCertMatchingRulesResponse addDataItem(MsgVpnCertMatchingRule dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnCertMatchingRulesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnCertMatchingRulesResponse addLinksItem(MsgVpnCertMatchingRuleLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnCertMatchingRulesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnCertMatchingRulesResponse msgVpnCertMatchingRulesResponse = (MsgVpnCertMatchingRulesResponse) o; - return Objects.equals(this.data, msgVpnCertMatchingRulesResponse.data) && - Objects.equals(this.links, msgVpnCertMatchingRulesResponse.links) && - Objects.equals(this.meta, msgVpnCertMatchingRulesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnCertMatchingRulesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfile.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfile.java deleted file mode 100644 index 4edf6dc93..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfile.java +++ /dev/null @@ -1,2063 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThresholdByPercent; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnClientProfile - */ -@JsonPropertyOrder({ - MsgVpnClientProfile.JSON_PROPERTY_ALLOW_BRIDGE_CONNECTIONS_ENABLED, - MsgVpnClientProfile.JSON_PROPERTY_ALLOW_CUT_THROUGH_FORWARDING_ENABLED, - MsgVpnClientProfile.JSON_PROPERTY_ALLOW_GUARANTEED_ENDPOINT_CREATE_DURABILITY, - MsgVpnClientProfile.JSON_PROPERTY_ALLOW_GUARANTEED_ENDPOINT_CREATE_ENABLED, - MsgVpnClientProfile.JSON_PROPERTY_ALLOW_GUARANTEED_MSG_RECEIVE_ENABLED, - MsgVpnClientProfile.JSON_PROPERTY_ALLOW_GUARANTEED_MSG_SEND_ENABLED, - MsgVpnClientProfile.JSON_PROPERTY_ALLOW_SHARED_SUBSCRIPTIONS_ENABLED, - MsgVpnClientProfile.JSON_PROPERTY_ALLOW_TRANSACTED_SESSIONS_ENABLED, - MsgVpnClientProfile.JSON_PROPERTY_API_QUEUE_MANAGEMENT_COPY_FROM_ON_CREATE_NAME, - MsgVpnClientProfile.JSON_PROPERTY_API_QUEUE_MANAGEMENT_COPY_FROM_ON_CREATE_TEMPLATE_NAME, - MsgVpnClientProfile.JSON_PROPERTY_API_TOPIC_ENDPOINT_MANAGEMENT_COPY_FROM_ON_CREATE_NAME, - MsgVpnClientProfile.JSON_PROPERTY_API_TOPIC_ENDPOINT_MANAGEMENT_COPY_FROM_ON_CREATE_TEMPLATE_NAME, - MsgVpnClientProfile.JSON_PROPERTY_CLIENT_PROFILE_NAME, - MsgVpnClientProfile.JSON_PROPERTY_COMPRESSION_ENABLED, - MsgVpnClientProfile.JSON_PROPERTY_ELIDING_DELAY, - MsgVpnClientProfile.JSON_PROPERTY_ELIDING_ENABLED, - MsgVpnClientProfile.JSON_PROPERTY_ELIDING_MAX_TOPIC_COUNT, - MsgVpnClientProfile.JSON_PROPERTY_EVENT_CLIENT_PROVISIONED_ENDPOINT_SPOOL_USAGE_THRESHOLD, - MsgVpnClientProfile.JSON_PROPERTY_EVENT_CONNECTION_COUNT_PER_CLIENT_USERNAME_THRESHOLD, - MsgVpnClientProfile.JSON_PROPERTY_EVENT_EGRESS_FLOW_COUNT_THRESHOLD, - MsgVpnClientProfile.JSON_PROPERTY_EVENT_ENDPOINT_COUNT_PER_CLIENT_USERNAME_THRESHOLD, - MsgVpnClientProfile.JSON_PROPERTY_EVENT_INGRESS_FLOW_COUNT_THRESHOLD, - MsgVpnClientProfile.JSON_PROPERTY_EVENT_SERVICE_SMF_CONNECTION_COUNT_PER_CLIENT_USERNAME_THRESHOLD, - MsgVpnClientProfile.JSON_PROPERTY_EVENT_SERVICE_WEB_CONNECTION_COUNT_PER_CLIENT_USERNAME_THRESHOLD, - MsgVpnClientProfile.JSON_PROPERTY_EVENT_SUBSCRIPTION_COUNT_THRESHOLD, - MsgVpnClientProfile.JSON_PROPERTY_EVENT_TRANSACTED_SESSION_COUNT_THRESHOLD, - MsgVpnClientProfile.JSON_PROPERTY_EVENT_TRANSACTION_COUNT_THRESHOLD, - MsgVpnClientProfile.JSON_PROPERTY_MAX_CONNECTION_COUNT_PER_CLIENT_USERNAME, - MsgVpnClientProfile.JSON_PROPERTY_MAX_EGRESS_FLOW_COUNT, - MsgVpnClientProfile.JSON_PROPERTY_MAX_ENDPOINT_COUNT_PER_CLIENT_USERNAME, - MsgVpnClientProfile.JSON_PROPERTY_MAX_INGRESS_FLOW_COUNT, - MsgVpnClientProfile.JSON_PROPERTY_MAX_MSGS_PER_TRANSACTION, - MsgVpnClientProfile.JSON_PROPERTY_MAX_SUBSCRIPTION_COUNT, - MsgVpnClientProfile.JSON_PROPERTY_MAX_TRANSACTED_SESSION_COUNT, - MsgVpnClientProfile.JSON_PROPERTY_MAX_TRANSACTION_COUNT, - MsgVpnClientProfile.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnClientProfile.JSON_PROPERTY_QUEUE_CONTROL1_MAX_DEPTH, - MsgVpnClientProfile.JSON_PROPERTY_QUEUE_CONTROL1_MIN_MSG_BURST, - MsgVpnClientProfile.JSON_PROPERTY_QUEUE_DIRECT1_MAX_DEPTH, - MsgVpnClientProfile.JSON_PROPERTY_QUEUE_DIRECT1_MIN_MSG_BURST, - MsgVpnClientProfile.JSON_PROPERTY_QUEUE_DIRECT2_MAX_DEPTH, - MsgVpnClientProfile.JSON_PROPERTY_QUEUE_DIRECT2_MIN_MSG_BURST, - MsgVpnClientProfile.JSON_PROPERTY_QUEUE_DIRECT3_MAX_DEPTH, - MsgVpnClientProfile.JSON_PROPERTY_QUEUE_DIRECT3_MIN_MSG_BURST, - MsgVpnClientProfile.JSON_PROPERTY_QUEUE_GUARANTEED1_MAX_DEPTH, - MsgVpnClientProfile.JSON_PROPERTY_QUEUE_GUARANTEED1_MIN_MSG_BURST, - MsgVpnClientProfile.JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_NO_SUBSCRIPTION_MATCH_ENABLED, - MsgVpnClientProfile.JSON_PROPERTY_REPLICATION_ALLOW_CLIENT_CONNECT_WHEN_STANDBY_ENABLED, - MsgVpnClientProfile.JSON_PROPERTY_SERVICE_MIN_KEEPALIVE_TIMEOUT, - MsgVpnClientProfile.JSON_PROPERTY_SERVICE_SMF_MAX_CONNECTION_COUNT_PER_CLIENT_USERNAME, - MsgVpnClientProfile.JSON_PROPERTY_SERVICE_SMF_MIN_KEEPALIVE_ENABLED, - MsgVpnClientProfile.JSON_PROPERTY_SERVICE_WEB_INACTIVE_TIMEOUT, - MsgVpnClientProfile.JSON_PROPERTY_SERVICE_WEB_MAX_CONNECTION_COUNT_PER_CLIENT_USERNAME, - MsgVpnClientProfile.JSON_PROPERTY_SERVICE_WEB_MAX_PAYLOAD, - MsgVpnClientProfile.JSON_PROPERTY_TCP_CONGESTION_WINDOW_SIZE, - MsgVpnClientProfile.JSON_PROPERTY_TCP_KEEPALIVE_COUNT, - MsgVpnClientProfile.JSON_PROPERTY_TCP_KEEPALIVE_IDLE_TIME, - MsgVpnClientProfile.JSON_PROPERTY_TCP_KEEPALIVE_INTERVAL, - MsgVpnClientProfile.JSON_PROPERTY_TCP_MAX_SEGMENT_SIZE, - MsgVpnClientProfile.JSON_PROPERTY_TCP_MAX_WINDOW_SIZE, - MsgVpnClientProfile.JSON_PROPERTY_TLS_ALLOW_DOWNGRADE_TO_PLAIN_TEXT_ENABLED -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnClientProfile { - public static final String JSON_PROPERTY_ALLOW_BRIDGE_CONNECTIONS_ENABLED = "allowBridgeConnectionsEnabled"; - private Boolean allowBridgeConnectionsEnabled; - - public static final String JSON_PROPERTY_ALLOW_CUT_THROUGH_FORWARDING_ENABLED = "allowCutThroughForwardingEnabled"; - private Boolean allowCutThroughForwardingEnabled; - - /** - * The types of Queues and Topic Endpoints that clients using the client-profile can create. Changing this value does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"all\"`. The allowed values and their meaning are: <pre> \"all\" - Client can create any type of endpoint. \"durable\" - Client can create only durable endpoints. \"non-durable\" - Client can create only non-durable endpoints. </pre> Available since 2.14. - */ - public enum AllowGuaranteedEndpointCreateDurabilityEnum { - ALL("all"), - - DURABLE("durable"), - - NON_DURABLE("non-durable"); - - private String value; - - AllowGuaranteedEndpointCreateDurabilityEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AllowGuaranteedEndpointCreateDurabilityEnum fromValue(String value) { - for (AllowGuaranteedEndpointCreateDurabilityEnum b : AllowGuaranteedEndpointCreateDurabilityEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_ALLOW_GUARANTEED_ENDPOINT_CREATE_DURABILITY = "allowGuaranteedEndpointCreateDurability"; - private AllowGuaranteedEndpointCreateDurabilityEnum allowGuaranteedEndpointCreateDurability; - - public static final String JSON_PROPERTY_ALLOW_GUARANTEED_ENDPOINT_CREATE_ENABLED = "allowGuaranteedEndpointCreateEnabled"; - private Boolean allowGuaranteedEndpointCreateEnabled; - - public static final String JSON_PROPERTY_ALLOW_GUARANTEED_MSG_RECEIVE_ENABLED = "allowGuaranteedMsgReceiveEnabled"; - private Boolean allowGuaranteedMsgReceiveEnabled; - - public static final String JSON_PROPERTY_ALLOW_GUARANTEED_MSG_SEND_ENABLED = "allowGuaranteedMsgSendEnabled"; - private Boolean allowGuaranteedMsgSendEnabled; - - public static final String JSON_PROPERTY_ALLOW_SHARED_SUBSCRIPTIONS_ENABLED = "allowSharedSubscriptionsEnabled"; - private Boolean allowSharedSubscriptionsEnabled; - - public static final String JSON_PROPERTY_ALLOW_TRANSACTED_SESSIONS_ENABLED = "allowTransactedSessionsEnabled"; - private Boolean allowTransactedSessionsEnabled; - - public static final String JSON_PROPERTY_API_QUEUE_MANAGEMENT_COPY_FROM_ON_CREATE_NAME = "apiQueueManagementCopyFromOnCreateName"; - private String apiQueueManagementCopyFromOnCreateName; - - public static final String JSON_PROPERTY_API_QUEUE_MANAGEMENT_COPY_FROM_ON_CREATE_TEMPLATE_NAME = "apiQueueManagementCopyFromOnCreateTemplateName"; - private String apiQueueManagementCopyFromOnCreateTemplateName; - - public static final String JSON_PROPERTY_API_TOPIC_ENDPOINT_MANAGEMENT_COPY_FROM_ON_CREATE_NAME = "apiTopicEndpointManagementCopyFromOnCreateName"; - private String apiTopicEndpointManagementCopyFromOnCreateName; - - public static final String JSON_PROPERTY_API_TOPIC_ENDPOINT_MANAGEMENT_COPY_FROM_ON_CREATE_TEMPLATE_NAME = "apiTopicEndpointManagementCopyFromOnCreateTemplateName"; - private String apiTopicEndpointManagementCopyFromOnCreateTemplateName; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_NAME = "clientProfileName"; - private String clientProfileName; - - public static final String JSON_PROPERTY_COMPRESSION_ENABLED = "compressionEnabled"; - private Boolean compressionEnabled; - - public static final String JSON_PROPERTY_ELIDING_DELAY = "elidingDelay"; - private Long elidingDelay; - - public static final String JSON_PROPERTY_ELIDING_ENABLED = "elidingEnabled"; - private Boolean elidingEnabled; - - public static final String JSON_PROPERTY_ELIDING_MAX_TOPIC_COUNT = "elidingMaxTopicCount"; - private Long elidingMaxTopicCount; - - public static final String JSON_PROPERTY_EVENT_CLIENT_PROVISIONED_ENDPOINT_SPOOL_USAGE_THRESHOLD = "eventClientProvisionedEndpointSpoolUsageThreshold"; - private EventThresholdByPercent eventClientProvisionedEndpointSpoolUsageThreshold; - - public static final String JSON_PROPERTY_EVENT_CONNECTION_COUNT_PER_CLIENT_USERNAME_THRESHOLD = "eventConnectionCountPerClientUsernameThreshold"; - private EventThreshold eventConnectionCountPerClientUsernameThreshold; - - public static final String JSON_PROPERTY_EVENT_EGRESS_FLOW_COUNT_THRESHOLD = "eventEgressFlowCountThreshold"; - private EventThreshold eventEgressFlowCountThreshold; - - public static final String JSON_PROPERTY_EVENT_ENDPOINT_COUNT_PER_CLIENT_USERNAME_THRESHOLD = "eventEndpointCountPerClientUsernameThreshold"; - private EventThreshold eventEndpointCountPerClientUsernameThreshold; - - public static final String JSON_PROPERTY_EVENT_INGRESS_FLOW_COUNT_THRESHOLD = "eventIngressFlowCountThreshold"; - private EventThreshold eventIngressFlowCountThreshold; - - public static final String JSON_PROPERTY_EVENT_SERVICE_SMF_CONNECTION_COUNT_PER_CLIENT_USERNAME_THRESHOLD = "eventServiceSmfConnectionCountPerClientUsernameThreshold"; - private EventThreshold eventServiceSmfConnectionCountPerClientUsernameThreshold; - - public static final String JSON_PROPERTY_EVENT_SERVICE_WEB_CONNECTION_COUNT_PER_CLIENT_USERNAME_THRESHOLD = "eventServiceWebConnectionCountPerClientUsernameThreshold"; - private EventThreshold eventServiceWebConnectionCountPerClientUsernameThreshold; - - public static final String JSON_PROPERTY_EVENT_SUBSCRIPTION_COUNT_THRESHOLD = "eventSubscriptionCountThreshold"; - private EventThreshold eventSubscriptionCountThreshold; - - public static final String JSON_PROPERTY_EVENT_TRANSACTED_SESSION_COUNT_THRESHOLD = "eventTransactedSessionCountThreshold"; - private EventThreshold eventTransactedSessionCountThreshold; - - public static final String JSON_PROPERTY_EVENT_TRANSACTION_COUNT_THRESHOLD = "eventTransactionCountThreshold"; - private EventThreshold eventTransactionCountThreshold; - - public static final String JSON_PROPERTY_MAX_CONNECTION_COUNT_PER_CLIENT_USERNAME = "maxConnectionCountPerClientUsername"; - private Long maxConnectionCountPerClientUsername; - - public static final String JSON_PROPERTY_MAX_EGRESS_FLOW_COUNT = "maxEgressFlowCount"; - private Long maxEgressFlowCount; - - public static final String JSON_PROPERTY_MAX_ENDPOINT_COUNT_PER_CLIENT_USERNAME = "maxEndpointCountPerClientUsername"; - private Long maxEndpointCountPerClientUsername; - - public static final String JSON_PROPERTY_MAX_INGRESS_FLOW_COUNT = "maxIngressFlowCount"; - private Long maxIngressFlowCount; - - public static final String JSON_PROPERTY_MAX_MSGS_PER_TRANSACTION = "maxMsgsPerTransaction"; - private Integer maxMsgsPerTransaction; - - public static final String JSON_PROPERTY_MAX_SUBSCRIPTION_COUNT = "maxSubscriptionCount"; - private Long maxSubscriptionCount; - - public static final String JSON_PROPERTY_MAX_TRANSACTED_SESSION_COUNT = "maxTransactedSessionCount"; - private Long maxTransactedSessionCount; - - public static final String JSON_PROPERTY_MAX_TRANSACTION_COUNT = "maxTransactionCount"; - private Long maxTransactionCount; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_QUEUE_CONTROL1_MAX_DEPTH = "queueControl1MaxDepth"; - private Integer queueControl1MaxDepth; - - public static final String JSON_PROPERTY_QUEUE_CONTROL1_MIN_MSG_BURST = "queueControl1MinMsgBurst"; - private Integer queueControl1MinMsgBurst; - - public static final String JSON_PROPERTY_QUEUE_DIRECT1_MAX_DEPTH = "queueDirect1MaxDepth"; - private Integer queueDirect1MaxDepth; - - public static final String JSON_PROPERTY_QUEUE_DIRECT1_MIN_MSG_BURST = "queueDirect1MinMsgBurst"; - private Integer queueDirect1MinMsgBurst; - - public static final String JSON_PROPERTY_QUEUE_DIRECT2_MAX_DEPTH = "queueDirect2MaxDepth"; - private Integer queueDirect2MaxDepth; - - public static final String JSON_PROPERTY_QUEUE_DIRECT2_MIN_MSG_BURST = "queueDirect2MinMsgBurst"; - private Integer queueDirect2MinMsgBurst; - - public static final String JSON_PROPERTY_QUEUE_DIRECT3_MAX_DEPTH = "queueDirect3MaxDepth"; - private Integer queueDirect3MaxDepth; - - public static final String JSON_PROPERTY_QUEUE_DIRECT3_MIN_MSG_BURST = "queueDirect3MinMsgBurst"; - private Integer queueDirect3MinMsgBurst; - - public static final String JSON_PROPERTY_QUEUE_GUARANTEED1_MAX_DEPTH = "queueGuaranteed1MaxDepth"; - private Integer queueGuaranteed1MaxDepth; - - public static final String JSON_PROPERTY_QUEUE_GUARANTEED1_MIN_MSG_BURST = "queueGuaranteed1MinMsgBurst"; - private Integer queueGuaranteed1MinMsgBurst; - - public static final String JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_NO_SUBSCRIPTION_MATCH_ENABLED = "rejectMsgToSenderOnNoSubscriptionMatchEnabled"; - private Boolean rejectMsgToSenderOnNoSubscriptionMatchEnabled; - - public static final String JSON_PROPERTY_REPLICATION_ALLOW_CLIENT_CONNECT_WHEN_STANDBY_ENABLED = "replicationAllowClientConnectWhenStandbyEnabled"; - private Boolean replicationAllowClientConnectWhenStandbyEnabled; - - public static final String JSON_PROPERTY_SERVICE_MIN_KEEPALIVE_TIMEOUT = "serviceMinKeepaliveTimeout"; - private Integer serviceMinKeepaliveTimeout; - - public static final String JSON_PROPERTY_SERVICE_SMF_MAX_CONNECTION_COUNT_PER_CLIENT_USERNAME = "serviceSmfMaxConnectionCountPerClientUsername"; - private Long serviceSmfMaxConnectionCountPerClientUsername; - - public static final String JSON_PROPERTY_SERVICE_SMF_MIN_KEEPALIVE_ENABLED = "serviceSmfMinKeepaliveEnabled"; - private Boolean serviceSmfMinKeepaliveEnabled; - - public static final String JSON_PROPERTY_SERVICE_WEB_INACTIVE_TIMEOUT = "serviceWebInactiveTimeout"; - private Long serviceWebInactiveTimeout; - - public static final String JSON_PROPERTY_SERVICE_WEB_MAX_CONNECTION_COUNT_PER_CLIENT_USERNAME = "serviceWebMaxConnectionCountPerClientUsername"; - private Long serviceWebMaxConnectionCountPerClientUsername; - - public static final String JSON_PROPERTY_SERVICE_WEB_MAX_PAYLOAD = "serviceWebMaxPayload"; - private Long serviceWebMaxPayload; - - public static final String JSON_PROPERTY_TCP_CONGESTION_WINDOW_SIZE = "tcpCongestionWindowSize"; - private Long tcpCongestionWindowSize; - - public static final String JSON_PROPERTY_TCP_KEEPALIVE_COUNT = "tcpKeepaliveCount"; - private Long tcpKeepaliveCount; - - public static final String JSON_PROPERTY_TCP_KEEPALIVE_IDLE_TIME = "tcpKeepaliveIdleTime"; - private Long tcpKeepaliveIdleTime; - - public static final String JSON_PROPERTY_TCP_KEEPALIVE_INTERVAL = "tcpKeepaliveInterval"; - private Long tcpKeepaliveInterval; - - public static final String JSON_PROPERTY_TCP_MAX_SEGMENT_SIZE = "tcpMaxSegmentSize"; - private Long tcpMaxSegmentSize; - - public static final String JSON_PROPERTY_TCP_MAX_WINDOW_SIZE = "tcpMaxWindowSize"; - private Long tcpMaxWindowSize; - - public static final String JSON_PROPERTY_TLS_ALLOW_DOWNGRADE_TO_PLAIN_TEXT_ENABLED = "tlsAllowDowngradeToPlainTextEnabled"; - private Boolean tlsAllowDowngradeToPlainTextEnabled; - - public MsgVpnClientProfile() { - } - - public MsgVpnClientProfile allowBridgeConnectionsEnabled(Boolean allowBridgeConnectionsEnabled) { - - this.allowBridgeConnectionsEnabled = allowBridgeConnectionsEnabled; - return this; - } - - /** - * Enable or disable allowing Bridge clients using the Client Profile to connect. Changing this setting does not affect existing Bridge client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return allowBridgeConnectionsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_BRIDGE_CONNECTIONS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowBridgeConnectionsEnabled() { - return allowBridgeConnectionsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_BRIDGE_CONNECTIONS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowBridgeConnectionsEnabled(Boolean allowBridgeConnectionsEnabled) { - this.allowBridgeConnectionsEnabled = allowBridgeConnectionsEnabled; - } - - - public MsgVpnClientProfile allowCutThroughForwardingEnabled(Boolean allowCutThroughForwardingEnabled) { - - this.allowCutThroughForwardingEnabled = allowCutThroughForwardingEnabled; - return this; - } - - /** - * Enable or disable allowing clients using the Client Profile to bind to endpoints with the cut-through forwarding delivery mode. Changing this value does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.22. This attribute has been deprecated. Please visit the Solace Product Lifecycle Policy web page for details on deprecated features. - * @return allowCutThroughForwardingEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_CUT_THROUGH_FORWARDING_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowCutThroughForwardingEnabled() { - return allowCutThroughForwardingEnabled; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_CUT_THROUGH_FORWARDING_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowCutThroughForwardingEnabled(Boolean allowCutThroughForwardingEnabled) { - this.allowCutThroughForwardingEnabled = allowCutThroughForwardingEnabled; - } - - - public MsgVpnClientProfile allowGuaranteedEndpointCreateDurability(AllowGuaranteedEndpointCreateDurabilityEnum allowGuaranteedEndpointCreateDurability) { - - this.allowGuaranteedEndpointCreateDurability = allowGuaranteedEndpointCreateDurability; - return this; - } - - /** - * The types of Queues and Topic Endpoints that clients using the client-profile can create. Changing this value does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"all\"`. The allowed values and their meaning are: <pre> \"all\" - Client can create any type of endpoint. \"durable\" - Client can create only durable endpoints. \"non-durable\" - Client can create only non-durable endpoints. </pre> Available since 2.14. - * @return allowGuaranteedEndpointCreateDurability - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_GUARANTEED_ENDPOINT_CREATE_DURABILITY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AllowGuaranteedEndpointCreateDurabilityEnum getAllowGuaranteedEndpointCreateDurability() { - return allowGuaranteedEndpointCreateDurability; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_GUARANTEED_ENDPOINT_CREATE_DURABILITY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowGuaranteedEndpointCreateDurability(AllowGuaranteedEndpointCreateDurabilityEnum allowGuaranteedEndpointCreateDurability) { - this.allowGuaranteedEndpointCreateDurability = allowGuaranteedEndpointCreateDurability; - } - - - public MsgVpnClientProfile allowGuaranteedEndpointCreateEnabled(Boolean allowGuaranteedEndpointCreateEnabled) { - - this.allowGuaranteedEndpointCreateEnabled = allowGuaranteedEndpointCreateEnabled; - return this; - } - - /** - * Enable or disable allowing clients using the Client Profile to create topic endponts or queues. Changing this value does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return allowGuaranteedEndpointCreateEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_GUARANTEED_ENDPOINT_CREATE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowGuaranteedEndpointCreateEnabled() { - return allowGuaranteedEndpointCreateEnabled; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_GUARANTEED_ENDPOINT_CREATE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowGuaranteedEndpointCreateEnabled(Boolean allowGuaranteedEndpointCreateEnabled) { - this.allowGuaranteedEndpointCreateEnabled = allowGuaranteedEndpointCreateEnabled; - } - - - public MsgVpnClientProfile allowGuaranteedMsgReceiveEnabled(Boolean allowGuaranteedMsgReceiveEnabled) { - - this.allowGuaranteedMsgReceiveEnabled = allowGuaranteedMsgReceiveEnabled; - return this; - } - - /** - * Enable or disable allowing clients using the Client Profile to receive guaranteed messages. Changing this setting does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return allowGuaranteedMsgReceiveEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_GUARANTEED_MSG_RECEIVE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowGuaranteedMsgReceiveEnabled() { - return allowGuaranteedMsgReceiveEnabled; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_GUARANTEED_MSG_RECEIVE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowGuaranteedMsgReceiveEnabled(Boolean allowGuaranteedMsgReceiveEnabled) { - this.allowGuaranteedMsgReceiveEnabled = allowGuaranteedMsgReceiveEnabled; - } - - - public MsgVpnClientProfile allowGuaranteedMsgSendEnabled(Boolean allowGuaranteedMsgSendEnabled) { - - this.allowGuaranteedMsgSendEnabled = allowGuaranteedMsgSendEnabled; - return this; - } - - /** - * Enable or disable allowing clients using the Client Profile to send guaranteed messages. Changing this setting does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return allowGuaranteedMsgSendEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_GUARANTEED_MSG_SEND_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowGuaranteedMsgSendEnabled() { - return allowGuaranteedMsgSendEnabled; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_GUARANTEED_MSG_SEND_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowGuaranteedMsgSendEnabled(Boolean allowGuaranteedMsgSendEnabled) { - this.allowGuaranteedMsgSendEnabled = allowGuaranteedMsgSendEnabled; - } - - - public MsgVpnClientProfile allowSharedSubscriptionsEnabled(Boolean allowSharedSubscriptionsEnabled) { - - this.allowSharedSubscriptionsEnabled = allowSharedSubscriptionsEnabled; - return this; - } - - /** - * Enable or disable allowing shared subscriptions. Changing this setting does not affect existing subscriptions. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.11. - * @return allowSharedSubscriptionsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_SHARED_SUBSCRIPTIONS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowSharedSubscriptionsEnabled() { - return allowSharedSubscriptionsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_SHARED_SUBSCRIPTIONS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowSharedSubscriptionsEnabled(Boolean allowSharedSubscriptionsEnabled) { - this.allowSharedSubscriptionsEnabled = allowSharedSubscriptionsEnabled; - } - - - public MsgVpnClientProfile allowTransactedSessionsEnabled(Boolean allowTransactedSessionsEnabled) { - - this.allowTransactedSessionsEnabled = allowTransactedSessionsEnabled; - return this; - } - - /** - * Enable or disable allowing clients using the Client Profile to establish transacted sessions. Changing this setting does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return allowTransactedSessionsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_TRANSACTED_SESSIONS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowTransactedSessionsEnabled() { - return allowTransactedSessionsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_TRANSACTED_SESSIONS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowTransactedSessionsEnabled(Boolean allowTransactedSessionsEnabled) { - this.allowTransactedSessionsEnabled = allowTransactedSessionsEnabled; - } - - - public MsgVpnClientProfile apiQueueManagementCopyFromOnCreateName(String apiQueueManagementCopyFromOnCreateName) { - - this.apiQueueManagementCopyFromOnCreateName = apiQueueManagementCopyFromOnCreateName; - return this; - } - - /** - * The name of a queue to copy settings from when a new queue is created by a client using the Client Profile. The referenced queue must exist in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.14. This attribute has been replaced with `apiQueueManagementCopyFromOnCreateTemplateName`. - * @return apiQueueManagementCopyFromOnCreateName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_API_QUEUE_MANAGEMENT_COPY_FROM_ON_CREATE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getApiQueueManagementCopyFromOnCreateName() { - return apiQueueManagementCopyFromOnCreateName; - } - - - @JsonProperty(JSON_PROPERTY_API_QUEUE_MANAGEMENT_COPY_FROM_ON_CREATE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setApiQueueManagementCopyFromOnCreateName(String apiQueueManagementCopyFromOnCreateName) { - this.apiQueueManagementCopyFromOnCreateName = apiQueueManagementCopyFromOnCreateName; - } - - - public MsgVpnClientProfile apiQueueManagementCopyFromOnCreateTemplateName(String apiQueueManagementCopyFromOnCreateTemplateName) { - - this.apiQueueManagementCopyFromOnCreateTemplateName = apiQueueManagementCopyFromOnCreateTemplateName; - return this; - } - - /** - * The name of a queue template to copy settings from when a new queue is created by a client using the Client Profile. If the referenced queue template does not exist, queue creation will fail when it tries to resolve this template. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14. - * @return apiQueueManagementCopyFromOnCreateTemplateName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_API_QUEUE_MANAGEMENT_COPY_FROM_ON_CREATE_TEMPLATE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getApiQueueManagementCopyFromOnCreateTemplateName() { - return apiQueueManagementCopyFromOnCreateTemplateName; - } - - - @JsonProperty(JSON_PROPERTY_API_QUEUE_MANAGEMENT_COPY_FROM_ON_CREATE_TEMPLATE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setApiQueueManagementCopyFromOnCreateTemplateName(String apiQueueManagementCopyFromOnCreateTemplateName) { - this.apiQueueManagementCopyFromOnCreateTemplateName = apiQueueManagementCopyFromOnCreateTemplateName; - } - - - public MsgVpnClientProfile apiTopicEndpointManagementCopyFromOnCreateName(String apiTopicEndpointManagementCopyFromOnCreateName) { - - this.apiTopicEndpointManagementCopyFromOnCreateName = apiTopicEndpointManagementCopyFromOnCreateName; - return this; - } - - /** - * The name of a topic endpoint to copy settings from when a new topic endpoint is created by a client using the Client Profile. The referenced topic endpoint must exist in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.14. This attribute has been replaced with `apiTopicEndpointManagementCopyFromOnCreateTemplateName`. - * @return apiTopicEndpointManagementCopyFromOnCreateName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_API_TOPIC_ENDPOINT_MANAGEMENT_COPY_FROM_ON_CREATE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getApiTopicEndpointManagementCopyFromOnCreateName() { - return apiTopicEndpointManagementCopyFromOnCreateName; - } - - - @JsonProperty(JSON_PROPERTY_API_TOPIC_ENDPOINT_MANAGEMENT_COPY_FROM_ON_CREATE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setApiTopicEndpointManagementCopyFromOnCreateName(String apiTopicEndpointManagementCopyFromOnCreateName) { - this.apiTopicEndpointManagementCopyFromOnCreateName = apiTopicEndpointManagementCopyFromOnCreateName; - } - - - public MsgVpnClientProfile apiTopicEndpointManagementCopyFromOnCreateTemplateName(String apiTopicEndpointManagementCopyFromOnCreateTemplateName) { - - this.apiTopicEndpointManagementCopyFromOnCreateTemplateName = apiTopicEndpointManagementCopyFromOnCreateTemplateName; - return this; - } - - /** - * The name of a topic endpoint template to copy settings from when a new topic endpoint is created by a client using the Client Profile. If the referenced topic endpoint template does not exist, topic endpoint creation will fail when it tries to resolve this template. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14. - * @return apiTopicEndpointManagementCopyFromOnCreateTemplateName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_API_TOPIC_ENDPOINT_MANAGEMENT_COPY_FROM_ON_CREATE_TEMPLATE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getApiTopicEndpointManagementCopyFromOnCreateTemplateName() { - return apiTopicEndpointManagementCopyFromOnCreateTemplateName; - } - - - @JsonProperty(JSON_PROPERTY_API_TOPIC_ENDPOINT_MANAGEMENT_COPY_FROM_ON_CREATE_TEMPLATE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setApiTopicEndpointManagementCopyFromOnCreateTemplateName(String apiTopicEndpointManagementCopyFromOnCreateTemplateName) { - this.apiTopicEndpointManagementCopyFromOnCreateTemplateName = apiTopicEndpointManagementCopyFromOnCreateTemplateName; - } - - - public MsgVpnClientProfile clientProfileName(String clientProfileName) { - - this.clientProfileName = clientProfileName; - return this; - } - - /** - * The name of the Client Profile. - * @return clientProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientProfileName() { - return clientProfileName; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileName(String clientProfileName) { - this.clientProfileName = clientProfileName; - } - - - public MsgVpnClientProfile compressionEnabled(Boolean compressionEnabled) { - - this.compressionEnabled = compressionEnabled; - return this; - } - - /** - * Enable or disable allowing clients using the Client Profile to use compression. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.10. - * @return compressionEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_COMPRESSION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getCompressionEnabled() { - return compressionEnabled; - } - - - @JsonProperty(JSON_PROPERTY_COMPRESSION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCompressionEnabled(Boolean compressionEnabled) { - this.compressionEnabled = compressionEnabled; - } - - - public MsgVpnClientProfile elidingDelay(Long elidingDelay) { - - this.elidingDelay = elidingDelay; - return this; - } - - /** - * The amount of time to delay the delivery of messages to clients using the Client Profile after the initial message has been delivered (the eliding delay interval), in milliseconds. A value of 0 means there is no delay in delivering messages to clients. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return elidingDelay - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ELIDING_DELAY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getElidingDelay() { - return elidingDelay; - } - - - @JsonProperty(JSON_PROPERTY_ELIDING_DELAY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setElidingDelay(Long elidingDelay) { - this.elidingDelay = elidingDelay; - } - - - public MsgVpnClientProfile elidingEnabled(Boolean elidingEnabled) { - - this.elidingEnabled = elidingEnabled; - return this; - } - - /** - * Enable or disable message eliding for clients using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return elidingEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ELIDING_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getElidingEnabled() { - return elidingEnabled; - } - - - @JsonProperty(JSON_PROPERTY_ELIDING_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setElidingEnabled(Boolean elidingEnabled) { - this.elidingEnabled = elidingEnabled; - } - - - public MsgVpnClientProfile elidingMaxTopicCount(Long elidingMaxTopicCount) { - - this.elidingMaxTopicCount = elidingMaxTopicCount; - return this; - } - - /** - * The maximum number of topics tracked for message eliding per client connection using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `256`. - * @return elidingMaxTopicCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ELIDING_MAX_TOPIC_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getElidingMaxTopicCount() { - return elidingMaxTopicCount; - } - - - @JsonProperty(JSON_PROPERTY_ELIDING_MAX_TOPIC_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setElidingMaxTopicCount(Long elidingMaxTopicCount) { - this.elidingMaxTopicCount = elidingMaxTopicCount; - } - - - public MsgVpnClientProfile eventClientProvisionedEndpointSpoolUsageThreshold(EventThresholdByPercent eventClientProvisionedEndpointSpoolUsageThreshold) { - - this.eventClientProvisionedEndpointSpoolUsageThreshold = eventClientProvisionedEndpointSpoolUsageThreshold; - return this; - } - - /** - * Get eventClientProvisionedEndpointSpoolUsageThreshold - * @return eventClientProvisionedEndpointSpoolUsageThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_CLIENT_PROVISIONED_ENDPOINT_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThresholdByPercent getEventClientProvisionedEndpointSpoolUsageThreshold() { - return eventClientProvisionedEndpointSpoolUsageThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_CLIENT_PROVISIONED_ENDPOINT_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventClientProvisionedEndpointSpoolUsageThreshold(EventThresholdByPercent eventClientProvisionedEndpointSpoolUsageThreshold) { - this.eventClientProvisionedEndpointSpoolUsageThreshold = eventClientProvisionedEndpointSpoolUsageThreshold; - } - - - public MsgVpnClientProfile eventConnectionCountPerClientUsernameThreshold(EventThreshold eventConnectionCountPerClientUsernameThreshold) { - - this.eventConnectionCountPerClientUsernameThreshold = eventConnectionCountPerClientUsernameThreshold; - return this; - } - - /** - * Get eventConnectionCountPerClientUsernameThreshold - * @return eventConnectionCountPerClientUsernameThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_CONNECTION_COUNT_PER_CLIENT_USERNAME_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventConnectionCountPerClientUsernameThreshold() { - return eventConnectionCountPerClientUsernameThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_CONNECTION_COUNT_PER_CLIENT_USERNAME_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventConnectionCountPerClientUsernameThreshold(EventThreshold eventConnectionCountPerClientUsernameThreshold) { - this.eventConnectionCountPerClientUsernameThreshold = eventConnectionCountPerClientUsernameThreshold; - } - - - public MsgVpnClientProfile eventEgressFlowCountThreshold(EventThreshold eventEgressFlowCountThreshold) { - - this.eventEgressFlowCountThreshold = eventEgressFlowCountThreshold; - return this; - } - - /** - * Get eventEgressFlowCountThreshold - * @return eventEgressFlowCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_EGRESS_FLOW_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventEgressFlowCountThreshold() { - return eventEgressFlowCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_EGRESS_FLOW_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventEgressFlowCountThreshold(EventThreshold eventEgressFlowCountThreshold) { - this.eventEgressFlowCountThreshold = eventEgressFlowCountThreshold; - } - - - public MsgVpnClientProfile eventEndpointCountPerClientUsernameThreshold(EventThreshold eventEndpointCountPerClientUsernameThreshold) { - - this.eventEndpointCountPerClientUsernameThreshold = eventEndpointCountPerClientUsernameThreshold; - return this; - } - - /** - * Get eventEndpointCountPerClientUsernameThreshold - * @return eventEndpointCountPerClientUsernameThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_ENDPOINT_COUNT_PER_CLIENT_USERNAME_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventEndpointCountPerClientUsernameThreshold() { - return eventEndpointCountPerClientUsernameThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_ENDPOINT_COUNT_PER_CLIENT_USERNAME_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventEndpointCountPerClientUsernameThreshold(EventThreshold eventEndpointCountPerClientUsernameThreshold) { - this.eventEndpointCountPerClientUsernameThreshold = eventEndpointCountPerClientUsernameThreshold; - } - - - public MsgVpnClientProfile eventIngressFlowCountThreshold(EventThreshold eventIngressFlowCountThreshold) { - - this.eventIngressFlowCountThreshold = eventIngressFlowCountThreshold; - return this; - } - - /** - * Get eventIngressFlowCountThreshold - * @return eventIngressFlowCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_INGRESS_FLOW_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventIngressFlowCountThreshold() { - return eventIngressFlowCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_INGRESS_FLOW_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventIngressFlowCountThreshold(EventThreshold eventIngressFlowCountThreshold) { - this.eventIngressFlowCountThreshold = eventIngressFlowCountThreshold; - } - - - public MsgVpnClientProfile eventServiceSmfConnectionCountPerClientUsernameThreshold(EventThreshold eventServiceSmfConnectionCountPerClientUsernameThreshold) { - - this.eventServiceSmfConnectionCountPerClientUsernameThreshold = eventServiceSmfConnectionCountPerClientUsernameThreshold; - return this; - } - - /** - * Get eventServiceSmfConnectionCountPerClientUsernameThreshold - * @return eventServiceSmfConnectionCountPerClientUsernameThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_SERVICE_SMF_CONNECTION_COUNT_PER_CLIENT_USERNAME_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventServiceSmfConnectionCountPerClientUsernameThreshold() { - return eventServiceSmfConnectionCountPerClientUsernameThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_SERVICE_SMF_CONNECTION_COUNT_PER_CLIENT_USERNAME_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventServiceSmfConnectionCountPerClientUsernameThreshold(EventThreshold eventServiceSmfConnectionCountPerClientUsernameThreshold) { - this.eventServiceSmfConnectionCountPerClientUsernameThreshold = eventServiceSmfConnectionCountPerClientUsernameThreshold; - } - - - public MsgVpnClientProfile eventServiceWebConnectionCountPerClientUsernameThreshold(EventThreshold eventServiceWebConnectionCountPerClientUsernameThreshold) { - - this.eventServiceWebConnectionCountPerClientUsernameThreshold = eventServiceWebConnectionCountPerClientUsernameThreshold; - return this; - } - - /** - * Get eventServiceWebConnectionCountPerClientUsernameThreshold - * @return eventServiceWebConnectionCountPerClientUsernameThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_SERVICE_WEB_CONNECTION_COUNT_PER_CLIENT_USERNAME_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventServiceWebConnectionCountPerClientUsernameThreshold() { - return eventServiceWebConnectionCountPerClientUsernameThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_SERVICE_WEB_CONNECTION_COUNT_PER_CLIENT_USERNAME_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventServiceWebConnectionCountPerClientUsernameThreshold(EventThreshold eventServiceWebConnectionCountPerClientUsernameThreshold) { - this.eventServiceWebConnectionCountPerClientUsernameThreshold = eventServiceWebConnectionCountPerClientUsernameThreshold; - } - - - public MsgVpnClientProfile eventSubscriptionCountThreshold(EventThreshold eventSubscriptionCountThreshold) { - - this.eventSubscriptionCountThreshold = eventSubscriptionCountThreshold; - return this; - } - - /** - * Get eventSubscriptionCountThreshold - * @return eventSubscriptionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_SUBSCRIPTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventSubscriptionCountThreshold() { - return eventSubscriptionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_SUBSCRIPTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventSubscriptionCountThreshold(EventThreshold eventSubscriptionCountThreshold) { - this.eventSubscriptionCountThreshold = eventSubscriptionCountThreshold; - } - - - public MsgVpnClientProfile eventTransactedSessionCountThreshold(EventThreshold eventTransactedSessionCountThreshold) { - - this.eventTransactedSessionCountThreshold = eventTransactedSessionCountThreshold; - return this; - } - - /** - * Get eventTransactedSessionCountThreshold - * @return eventTransactedSessionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_TRANSACTED_SESSION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventTransactedSessionCountThreshold() { - return eventTransactedSessionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_TRANSACTED_SESSION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventTransactedSessionCountThreshold(EventThreshold eventTransactedSessionCountThreshold) { - this.eventTransactedSessionCountThreshold = eventTransactedSessionCountThreshold; - } - - - public MsgVpnClientProfile eventTransactionCountThreshold(EventThreshold eventTransactionCountThreshold) { - - this.eventTransactionCountThreshold = eventTransactionCountThreshold; - return this; - } - - /** - * Get eventTransactionCountThreshold - * @return eventTransactionCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_TRANSACTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventTransactionCountThreshold() { - return eventTransactionCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_TRANSACTION_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventTransactionCountThreshold(EventThreshold eventTransactionCountThreshold) { - this.eventTransactionCountThreshold = eventTransactionCountThreshold; - } - - - public MsgVpnClientProfile maxConnectionCountPerClientUsername(Long maxConnectionCountPerClientUsername) { - - this.maxConnectionCountPerClientUsername = maxConnectionCountPerClientUsername; - return this; - } - - /** - * The maximum number of client connections per Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. - * @return maxConnectionCountPerClientUsername - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_CONNECTION_COUNT_PER_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxConnectionCountPerClientUsername() { - return maxConnectionCountPerClientUsername; - } - - - @JsonProperty(JSON_PROPERTY_MAX_CONNECTION_COUNT_PER_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxConnectionCountPerClientUsername(Long maxConnectionCountPerClientUsername) { - this.maxConnectionCountPerClientUsername = maxConnectionCountPerClientUsername; - } - - - public MsgVpnClientProfile maxEgressFlowCount(Long maxEgressFlowCount) { - - this.maxEgressFlowCount = maxEgressFlowCount; - return this; - } - - /** - * The maximum number of transmit flows that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. - * @return maxEgressFlowCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_EGRESS_FLOW_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxEgressFlowCount() { - return maxEgressFlowCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_EGRESS_FLOW_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxEgressFlowCount(Long maxEgressFlowCount) { - this.maxEgressFlowCount = maxEgressFlowCount; - } - - - public MsgVpnClientProfile maxEndpointCountPerClientUsername(Long maxEndpointCountPerClientUsername) { - - this.maxEndpointCountPerClientUsername = maxEndpointCountPerClientUsername; - return this; - } - - /** - * The maximum number of queues and topic endpoints that can be created by clients with the same Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. - * @return maxEndpointCountPerClientUsername - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_ENDPOINT_COUNT_PER_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxEndpointCountPerClientUsername() { - return maxEndpointCountPerClientUsername; - } - - - @JsonProperty(JSON_PROPERTY_MAX_ENDPOINT_COUNT_PER_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxEndpointCountPerClientUsername(Long maxEndpointCountPerClientUsername) { - this.maxEndpointCountPerClientUsername = maxEndpointCountPerClientUsername; - } - - - public MsgVpnClientProfile maxIngressFlowCount(Long maxIngressFlowCount) { - - this.maxIngressFlowCount = maxIngressFlowCount; - return this; - } - - /** - * The maximum number of receive flows that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. - * @return maxIngressFlowCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_INGRESS_FLOW_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxIngressFlowCount() { - return maxIngressFlowCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_INGRESS_FLOW_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxIngressFlowCount(Long maxIngressFlowCount) { - this.maxIngressFlowCount = maxIngressFlowCount; - } - - - public MsgVpnClientProfile maxMsgsPerTransaction(Integer maxMsgsPerTransaction) { - - this.maxMsgsPerTransaction = maxMsgsPerTransaction; - return this; - } - - /** - * The maximum number of publisher and consumer messages combined that is allowed within a transaction for each client associated with this client-profile. Exceeding this limit will result in a transaction prepare or commit failure. Changing this value during operation will not affect existing sessions. It is only validated at transaction creation time. Large transactions consume more resources and are more likely to require retrieving messages from the ADB or from disk to process the transaction prepare or commit requests. The transaction processing rate may diminish if a large number of messages must be retrieved from the ADB or from disk. Care should be taken to not use excessively large transactions needlessly to avoid exceeding resource limits and to avoid reducing the overall broker performance. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `256`. Available since 2.20. - * @return maxMsgsPerTransaction - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_MSGS_PER_TRANSACTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getMaxMsgsPerTransaction() { - return maxMsgsPerTransaction; - } - - - @JsonProperty(JSON_PROPERTY_MAX_MSGS_PER_TRANSACTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxMsgsPerTransaction(Integer maxMsgsPerTransaction) { - this.maxMsgsPerTransaction = maxMsgsPerTransaction; - } - - - public MsgVpnClientProfile maxSubscriptionCount(Long maxSubscriptionCount) { - - this.maxSubscriptionCount = maxSubscriptionCount; - return this; - } - - /** - * The maximum number of subscriptions per client using the Client Profile. This limit is not enforced when a client adds a subscription to an endpoint, except for MQTT QoS 1 subscriptions. In addition, this limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. - * @return maxSubscriptionCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_SUBSCRIPTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxSubscriptionCount() { - return maxSubscriptionCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_SUBSCRIPTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxSubscriptionCount(Long maxSubscriptionCount) { - this.maxSubscriptionCount = maxSubscriptionCount; - } - - - public MsgVpnClientProfile maxTransactedSessionCount(Long maxTransactedSessionCount) { - - this.maxTransactedSessionCount = maxTransactedSessionCount; - return this; - } - - /** - * The maximum number of transacted sessions that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10`. - * @return maxTransactedSessionCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_TRANSACTED_SESSION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxTransactedSessionCount() { - return maxTransactedSessionCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_TRANSACTED_SESSION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxTransactedSessionCount(Long maxTransactedSessionCount) { - this.maxTransactedSessionCount = maxTransactedSessionCount; - } - - - public MsgVpnClientProfile maxTransactionCount(Long maxTransactionCount) { - - this.maxTransactionCount = maxTransactionCount; - return this; - } - - /** - * The maximum number of transactions that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. - * @return maxTransactionCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_TRANSACTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxTransactionCount() { - return maxTransactionCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_TRANSACTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxTransactionCount(Long maxTransactionCount) { - this.maxTransactionCount = maxTransactionCount; - } - - - public MsgVpnClientProfile msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnClientProfile queueControl1MaxDepth(Integer queueControl1MaxDepth) { - - this.queueControl1MaxDepth = queueControl1MaxDepth; - return this; - } - - /** - * The maximum depth of the \"Control 1\" (C-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`. - * @return queueControl1MaxDepth - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_CONTROL1_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getQueueControl1MaxDepth() { - return queueControl1MaxDepth; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_CONTROL1_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueControl1MaxDepth(Integer queueControl1MaxDepth) { - this.queueControl1MaxDepth = queueControl1MaxDepth; - } - - - public MsgVpnClientProfile queueControl1MinMsgBurst(Integer queueControl1MinMsgBurst) { - - this.queueControl1MinMsgBurst = queueControl1MinMsgBurst; - return this; - } - - /** - * The number of messages that are always allowed entry into the \"Control 1\" (C-1) priority queue, regardless of the `queueControl1MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`. - * @return queueControl1MinMsgBurst - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_CONTROL1_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getQueueControl1MinMsgBurst() { - return queueControl1MinMsgBurst; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_CONTROL1_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueControl1MinMsgBurst(Integer queueControl1MinMsgBurst) { - this.queueControl1MinMsgBurst = queueControl1MinMsgBurst; - } - - - public MsgVpnClientProfile queueDirect1MaxDepth(Integer queueDirect1MaxDepth) { - - this.queueDirect1MaxDepth = queueDirect1MaxDepth; - return this; - } - - /** - * The maximum depth of the \"Direct 1\" (D-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`. - * @return queueDirect1MaxDepth - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_DIRECT1_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getQueueDirect1MaxDepth() { - return queueDirect1MaxDepth; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_DIRECT1_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueDirect1MaxDepth(Integer queueDirect1MaxDepth) { - this.queueDirect1MaxDepth = queueDirect1MaxDepth; - } - - - public MsgVpnClientProfile queueDirect1MinMsgBurst(Integer queueDirect1MinMsgBurst) { - - this.queueDirect1MinMsgBurst = queueDirect1MinMsgBurst; - return this; - } - - /** - * The number of messages that are always allowed entry into the \"Direct 1\" (D-1) priority queue, regardless of the `queueDirect1MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`. - * @return queueDirect1MinMsgBurst - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_DIRECT1_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getQueueDirect1MinMsgBurst() { - return queueDirect1MinMsgBurst; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_DIRECT1_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueDirect1MinMsgBurst(Integer queueDirect1MinMsgBurst) { - this.queueDirect1MinMsgBurst = queueDirect1MinMsgBurst; - } - - - public MsgVpnClientProfile queueDirect2MaxDepth(Integer queueDirect2MaxDepth) { - - this.queueDirect2MaxDepth = queueDirect2MaxDepth; - return this; - } - - /** - * The maximum depth of the \"Direct 2\" (D-2) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`. - * @return queueDirect2MaxDepth - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_DIRECT2_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getQueueDirect2MaxDepth() { - return queueDirect2MaxDepth; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_DIRECT2_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueDirect2MaxDepth(Integer queueDirect2MaxDepth) { - this.queueDirect2MaxDepth = queueDirect2MaxDepth; - } - - - public MsgVpnClientProfile queueDirect2MinMsgBurst(Integer queueDirect2MinMsgBurst) { - - this.queueDirect2MinMsgBurst = queueDirect2MinMsgBurst; - return this; - } - - /** - * The number of messages that are always allowed entry into the \"Direct 2\" (D-2) priority queue, regardless of the `queueDirect2MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`. - * @return queueDirect2MinMsgBurst - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_DIRECT2_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getQueueDirect2MinMsgBurst() { - return queueDirect2MinMsgBurst; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_DIRECT2_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueDirect2MinMsgBurst(Integer queueDirect2MinMsgBurst) { - this.queueDirect2MinMsgBurst = queueDirect2MinMsgBurst; - } - - - public MsgVpnClientProfile queueDirect3MaxDepth(Integer queueDirect3MaxDepth) { - - this.queueDirect3MaxDepth = queueDirect3MaxDepth; - return this; - } - - /** - * The maximum depth of the \"Direct 3\" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`. - * @return queueDirect3MaxDepth - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_DIRECT3_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getQueueDirect3MaxDepth() { - return queueDirect3MaxDepth; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_DIRECT3_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueDirect3MaxDepth(Integer queueDirect3MaxDepth) { - this.queueDirect3MaxDepth = queueDirect3MaxDepth; - } - - - public MsgVpnClientProfile queueDirect3MinMsgBurst(Integer queueDirect3MinMsgBurst) { - - this.queueDirect3MinMsgBurst = queueDirect3MinMsgBurst; - return this; - } - - /** - * The number of messages that are always allowed entry into the \"Direct 3\" (D-3) priority queue, regardless of the `queueDirect3MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`. - * @return queueDirect3MinMsgBurst - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_DIRECT3_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getQueueDirect3MinMsgBurst() { - return queueDirect3MinMsgBurst; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_DIRECT3_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueDirect3MinMsgBurst(Integer queueDirect3MinMsgBurst) { - this.queueDirect3MinMsgBurst = queueDirect3MinMsgBurst; - } - - - public MsgVpnClientProfile queueGuaranteed1MaxDepth(Integer queueGuaranteed1MaxDepth) { - - this.queueGuaranteed1MaxDepth = queueGuaranteed1MaxDepth; - return this; - } - - /** - * The maximum depth of the \"Guaranteed 1\" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`. - * @return queueGuaranteed1MaxDepth - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_GUARANTEED1_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getQueueGuaranteed1MaxDepth() { - return queueGuaranteed1MaxDepth; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_GUARANTEED1_MAX_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueGuaranteed1MaxDepth(Integer queueGuaranteed1MaxDepth) { - this.queueGuaranteed1MaxDepth = queueGuaranteed1MaxDepth; - } - - - public MsgVpnClientProfile queueGuaranteed1MinMsgBurst(Integer queueGuaranteed1MinMsgBurst) { - - this.queueGuaranteed1MinMsgBurst = queueGuaranteed1MinMsgBurst; - return this; - } - - /** - * The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-3) priority queue, regardless of the `queueGuaranteed1MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`. - * @return queueGuaranteed1MinMsgBurst - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_GUARANTEED1_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getQueueGuaranteed1MinMsgBurst() { - return queueGuaranteed1MinMsgBurst; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_GUARANTEED1_MIN_MSG_BURST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueGuaranteed1MinMsgBurst(Integer queueGuaranteed1MinMsgBurst) { - this.queueGuaranteed1MinMsgBurst = queueGuaranteed1MinMsgBurst; - } - - - public MsgVpnClientProfile rejectMsgToSenderOnNoSubscriptionMatchEnabled(Boolean rejectMsgToSenderOnNoSubscriptionMatchEnabled) { - - this.rejectMsgToSenderOnNoSubscriptionMatchEnabled = rejectMsgToSenderOnNoSubscriptionMatchEnabled; - return this; - } - - /** - * Enable or disable the sending of a negative acknowledgement (NACK) to a client using the Client Profile when discarding a guaranteed message due to no matching subscription found. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.2. - * @return rejectMsgToSenderOnNoSubscriptionMatchEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_NO_SUBSCRIPTION_MATCH_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRejectMsgToSenderOnNoSubscriptionMatchEnabled() { - return rejectMsgToSenderOnNoSubscriptionMatchEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_NO_SUBSCRIPTION_MATCH_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRejectMsgToSenderOnNoSubscriptionMatchEnabled(Boolean rejectMsgToSenderOnNoSubscriptionMatchEnabled) { - this.rejectMsgToSenderOnNoSubscriptionMatchEnabled = rejectMsgToSenderOnNoSubscriptionMatchEnabled; - } - - - public MsgVpnClientProfile replicationAllowClientConnectWhenStandbyEnabled(Boolean replicationAllowClientConnectWhenStandbyEnabled) { - - this.replicationAllowClientConnectWhenStandbyEnabled = replicationAllowClientConnectWhenStandbyEnabled; - return this; - } - - /** - * Enable or disable allowing clients using the Client Profile to connect to the Message VPN when its replication state is standby. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return replicationAllowClientConnectWhenStandbyEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_ALLOW_CLIENT_CONNECT_WHEN_STANDBY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getReplicationAllowClientConnectWhenStandbyEnabled() { - return replicationAllowClientConnectWhenStandbyEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_ALLOW_CLIENT_CONNECT_WHEN_STANDBY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationAllowClientConnectWhenStandbyEnabled(Boolean replicationAllowClientConnectWhenStandbyEnabled) { - this.replicationAllowClientConnectWhenStandbyEnabled = replicationAllowClientConnectWhenStandbyEnabled; - } - - - public MsgVpnClientProfile serviceMinKeepaliveTimeout(Integer serviceMinKeepaliveTimeout) { - - this.serviceMinKeepaliveTimeout = serviceMinKeepaliveTimeout; - return this; - } - - /** - * The minimum client keepalive timeout which will be enforced for client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30`. Available since 2.19. - * @return serviceMinKeepaliveTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_MIN_KEEPALIVE_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getServiceMinKeepaliveTimeout() { - return serviceMinKeepaliveTimeout; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_MIN_KEEPALIVE_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceMinKeepaliveTimeout(Integer serviceMinKeepaliveTimeout) { - this.serviceMinKeepaliveTimeout = serviceMinKeepaliveTimeout; - } - - - public MsgVpnClientProfile serviceSmfMaxConnectionCountPerClientUsername(Long serviceSmfMaxConnectionCountPerClientUsername) { - - this.serviceSmfMaxConnectionCountPerClientUsername = serviceSmfMaxConnectionCountPerClientUsername; - return this; - } - - /** - * The maximum number of SMF client connections per Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. - * @return serviceSmfMaxConnectionCountPerClientUsername - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_MAX_CONNECTION_COUNT_PER_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceSmfMaxConnectionCountPerClientUsername() { - return serviceSmfMaxConnectionCountPerClientUsername; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_MAX_CONNECTION_COUNT_PER_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSmfMaxConnectionCountPerClientUsername(Long serviceSmfMaxConnectionCountPerClientUsername) { - this.serviceSmfMaxConnectionCountPerClientUsername = serviceSmfMaxConnectionCountPerClientUsername; - } - - - public MsgVpnClientProfile serviceSmfMinKeepaliveEnabled(Boolean serviceSmfMinKeepaliveEnabled) { - - this.serviceSmfMinKeepaliveEnabled = serviceSmfMinKeepaliveEnabled; - return this; - } - - /** - * Enable or disable the enforcement of a minimum keepalive timeout for SMF clients. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.19. - * @return serviceSmfMinKeepaliveEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_MIN_KEEPALIVE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getServiceSmfMinKeepaliveEnabled() { - return serviceSmfMinKeepaliveEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_SMF_MIN_KEEPALIVE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceSmfMinKeepaliveEnabled(Boolean serviceSmfMinKeepaliveEnabled) { - this.serviceSmfMinKeepaliveEnabled = serviceSmfMinKeepaliveEnabled; - } - - - public MsgVpnClientProfile serviceWebInactiveTimeout(Long serviceWebInactiveTimeout) { - - this.serviceWebInactiveTimeout = serviceWebInactiveTimeout; - return this; - } - - /** - * The timeout for inactive Web Transport client sessions using the Client Profile, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30`. - * @return serviceWebInactiveTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_INACTIVE_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceWebInactiveTimeout() { - return serviceWebInactiveTimeout; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_INACTIVE_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceWebInactiveTimeout(Long serviceWebInactiveTimeout) { - this.serviceWebInactiveTimeout = serviceWebInactiveTimeout; - } - - - public MsgVpnClientProfile serviceWebMaxConnectionCountPerClientUsername(Long serviceWebMaxConnectionCountPerClientUsername) { - - this.serviceWebMaxConnectionCountPerClientUsername = serviceWebMaxConnectionCountPerClientUsername; - return this; - } - - /** - * The maximum number of Web Transport client connections per Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. - * @return serviceWebMaxConnectionCountPerClientUsername - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_MAX_CONNECTION_COUNT_PER_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceWebMaxConnectionCountPerClientUsername() { - return serviceWebMaxConnectionCountPerClientUsername; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_MAX_CONNECTION_COUNT_PER_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceWebMaxConnectionCountPerClientUsername(Long serviceWebMaxConnectionCountPerClientUsername) { - this.serviceWebMaxConnectionCountPerClientUsername = serviceWebMaxConnectionCountPerClientUsername; - } - - - public MsgVpnClientProfile serviceWebMaxPayload(Long serviceWebMaxPayload) { - - this.serviceWebMaxPayload = serviceWebMaxPayload; - return this; - } - - /** - * The maximum Web Transport payload size before fragmentation occurs for clients using the Client Profile, in bytes. The size of the header is not included. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000000`. - * @return serviceWebMaxPayload - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_MAX_PAYLOAD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getServiceWebMaxPayload() { - return serviceWebMaxPayload; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE_WEB_MAX_PAYLOAD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setServiceWebMaxPayload(Long serviceWebMaxPayload) { - this.serviceWebMaxPayload = serviceWebMaxPayload; - } - - - public MsgVpnClientProfile tcpCongestionWindowSize(Long tcpCongestionWindowSize) { - - this.tcpCongestionWindowSize = tcpCongestionWindowSize; - return this; - } - - /** - * The TCP initial congestion window size for clients using the Client Profile, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2`. - * @return tcpCongestionWindowSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TCP_CONGESTION_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getTcpCongestionWindowSize() { - return tcpCongestionWindowSize; - } - - - @JsonProperty(JSON_PROPERTY_TCP_CONGESTION_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTcpCongestionWindowSize(Long tcpCongestionWindowSize) { - this.tcpCongestionWindowSize = tcpCongestionWindowSize; - } - - - public MsgVpnClientProfile tcpKeepaliveCount(Long tcpKeepaliveCount) { - - this.tcpKeepaliveCount = tcpKeepaliveCount; - return this; - } - - /** - * The number of TCP keepalive retransmissions to a client using the Client Profile before declaring that it is not available. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`. - * @return tcpKeepaliveCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TCP_KEEPALIVE_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getTcpKeepaliveCount() { - return tcpKeepaliveCount; - } - - - @JsonProperty(JSON_PROPERTY_TCP_KEEPALIVE_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTcpKeepaliveCount(Long tcpKeepaliveCount) { - this.tcpKeepaliveCount = tcpKeepaliveCount; - } - - - public MsgVpnClientProfile tcpKeepaliveIdleTime(Long tcpKeepaliveIdleTime) { - - this.tcpKeepaliveIdleTime = tcpKeepaliveIdleTime; - return this; - } - - /** - * The amount of time a client connection using the Client Profile must remain idle before TCP begins sending keepalive probes, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. - * @return tcpKeepaliveIdleTime - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TCP_KEEPALIVE_IDLE_TIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getTcpKeepaliveIdleTime() { - return tcpKeepaliveIdleTime; - } - - - @JsonProperty(JSON_PROPERTY_TCP_KEEPALIVE_IDLE_TIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTcpKeepaliveIdleTime(Long tcpKeepaliveIdleTime) { - this.tcpKeepaliveIdleTime = tcpKeepaliveIdleTime; - } - - - public MsgVpnClientProfile tcpKeepaliveInterval(Long tcpKeepaliveInterval) { - - this.tcpKeepaliveInterval = tcpKeepaliveInterval; - return this; - } - - /** - * The amount of time between TCP keepalive retransmissions to a client using the Client Profile when no acknowledgement is received, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. - * @return tcpKeepaliveInterval - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TCP_KEEPALIVE_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getTcpKeepaliveInterval() { - return tcpKeepaliveInterval; - } - - - @JsonProperty(JSON_PROPERTY_TCP_KEEPALIVE_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTcpKeepaliveInterval(Long tcpKeepaliveInterval) { - this.tcpKeepaliveInterval = tcpKeepaliveInterval; - } - - - public MsgVpnClientProfile tcpMaxSegmentSize(Long tcpMaxSegmentSize) { - - this.tcpMaxSegmentSize = tcpMaxSegmentSize; - return this; - } - - /** - * The TCP maximum segment size for clients using the Client Profile, in bytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1460`. - * @return tcpMaxSegmentSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TCP_MAX_SEGMENT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getTcpMaxSegmentSize() { - return tcpMaxSegmentSize; - } - - - @JsonProperty(JSON_PROPERTY_TCP_MAX_SEGMENT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTcpMaxSegmentSize(Long tcpMaxSegmentSize) { - this.tcpMaxSegmentSize = tcpMaxSegmentSize; - } - - - public MsgVpnClientProfile tcpMaxWindowSize(Long tcpMaxWindowSize) { - - this.tcpMaxWindowSize = tcpMaxWindowSize; - return this; - } - - /** - * The TCP maximum window size for clients using the Client Profile, in kilobytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `256`. - * @return tcpMaxWindowSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TCP_MAX_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getTcpMaxWindowSize() { - return tcpMaxWindowSize; - } - - - @JsonProperty(JSON_PROPERTY_TCP_MAX_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTcpMaxWindowSize(Long tcpMaxWindowSize) { - this.tcpMaxWindowSize = tcpMaxWindowSize; - } - - - public MsgVpnClientProfile tlsAllowDowngradeToPlainTextEnabled(Boolean tlsAllowDowngradeToPlainTextEnabled) { - - this.tlsAllowDowngradeToPlainTextEnabled = tlsAllowDowngradeToPlainTextEnabled; - return this; - } - - /** - * Enable or disable allowing a client using the Client Profile to downgrade an encrypted connection to plain text. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.8. - * @return tlsAllowDowngradeToPlainTextEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_ALLOW_DOWNGRADE_TO_PLAIN_TEXT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTlsAllowDowngradeToPlainTextEnabled() { - return tlsAllowDowngradeToPlainTextEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TLS_ALLOW_DOWNGRADE_TO_PLAIN_TEXT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsAllowDowngradeToPlainTextEnabled(Boolean tlsAllowDowngradeToPlainTextEnabled) { - this.tlsAllowDowngradeToPlainTextEnabled = tlsAllowDowngradeToPlainTextEnabled; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnClientProfile msgVpnClientProfile = (MsgVpnClientProfile) o; - return Objects.equals(this.allowBridgeConnectionsEnabled, msgVpnClientProfile.allowBridgeConnectionsEnabled) && - Objects.equals(this.allowCutThroughForwardingEnabled, msgVpnClientProfile.allowCutThroughForwardingEnabled) && - Objects.equals(this.allowGuaranteedEndpointCreateDurability, msgVpnClientProfile.allowGuaranteedEndpointCreateDurability) && - Objects.equals(this.allowGuaranteedEndpointCreateEnabled, msgVpnClientProfile.allowGuaranteedEndpointCreateEnabled) && - Objects.equals(this.allowGuaranteedMsgReceiveEnabled, msgVpnClientProfile.allowGuaranteedMsgReceiveEnabled) && - Objects.equals(this.allowGuaranteedMsgSendEnabled, msgVpnClientProfile.allowGuaranteedMsgSendEnabled) && - Objects.equals(this.allowSharedSubscriptionsEnabled, msgVpnClientProfile.allowSharedSubscriptionsEnabled) && - Objects.equals(this.allowTransactedSessionsEnabled, msgVpnClientProfile.allowTransactedSessionsEnabled) && - Objects.equals(this.apiQueueManagementCopyFromOnCreateName, msgVpnClientProfile.apiQueueManagementCopyFromOnCreateName) && - Objects.equals(this.apiQueueManagementCopyFromOnCreateTemplateName, msgVpnClientProfile.apiQueueManagementCopyFromOnCreateTemplateName) && - Objects.equals(this.apiTopicEndpointManagementCopyFromOnCreateName, msgVpnClientProfile.apiTopicEndpointManagementCopyFromOnCreateName) && - Objects.equals(this.apiTopicEndpointManagementCopyFromOnCreateTemplateName, msgVpnClientProfile.apiTopicEndpointManagementCopyFromOnCreateTemplateName) && - Objects.equals(this.clientProfileName, msgVpnClientProfile.clientProfileName) && - Objects.equals(this.compressionEnabled, msgVpnClientProfile.compressionEnabled) && - Objects.equals(this.elidingDelay, msgVpnClientProfile.elidingDelay) && - Objects.equals(this.elidingEnabled, msgVpnClientProfile.elidingEnabled) && - Objects.equals(this.elidingMaxTopicCount, msgVpnClientProfile.elidingMaxTopicCount) && - Objects.equals(this.eventClientProvisionedEndpointSpoolUsageThreshold, msgVpnClientProfile.eventClientProvisionedEndpointSpoolUsageThreshold) && - Objects.equals(this.eventConnectionCountPerClientUsernameThreshold, msgVpnClientProfile.eventConnectionCountPerClientUsernameThreshold) && - Objects.equals(this.eventEgressFlowCountThreshold, msgVpnClientProfile.eventEgressFlowCountThreshold) && - Objects.equals(this.eventEndpointCountPerClientUsernameThreshold, msgVpnClientProfile.eventEndpointCountPerClientUsernameThreshold) && - Objects.equals(this.eventIngressFlowCountThreshold, msgVpnClientProfile.eventIngressFlowCountThreshold) && - Objects.equals(this.eventServiceSmfConnectionCountPerClientUsernameThreshold, msgVpnClientProfile.eventServiceSmfConnectionCountPerClientUsernameThreshold) && - Objects.equals(this.eventServiceWebConnectionCountPerClientUsernameThreshold, msgVpnClientProfile.eventServiceWebConnectionCountPerClientUsernameThreshold) && - Objects.equals(this.eventSubscriptionCountThreshold, msgVpnClientProfile.eventSubscriptionCountThreshold) && - Objects.equals(this.eventTransactedSessionCountThreshold, msgVpnClientProfile.eventTransactedSessionCountThreshold) && - Objects.equals(this.eventTransactionCountThreshold, msgVpnClientProfile.eventTransactionCountThreshold) && - Objects.equals(this.maxConnectionCountPerClientUsername, msgVpnClientProfile.maxConnectionCountPerClientUsername) && - Objects.equals(this.maxEgressFlowCount, msgVpnClientProfile.maxEgressFlowCount) && - Objects.equals(this.maxEndpointCountPerClientUsername, msgVpnClientProfile.maxEndpointCountPerClientUsername) && - Objects.equals(this.maxIngressFlowCount, msgVpnClientProfile.maxIngressFlowCount) && - Objects.equals(this.maxMsgsPerTransaction, msgVpnClientProfile.maxMsgsPerTransaction) && - Objects.equals(this.maxSubscriptionCount, msgVpnClientProfile.maxSubscriptionCount) && - Objects.equals(this.maxTransactedSessionCount, msgVpnClientProfile.maxTransactedSessionCount) && - Objects.equals(this.maxTransactionCount, msgVpnClientProfile.maxTransactionCount) && - Objects.equals(this.msgVpnName, msgVpnClientProfile.msgVpnName) && - Objects.equals(this.queueControl1MaxDepth, msgVpnClientProfile.queueControl1MaxDepth) && - Objects.equals(this.queueControl1MinMsgBurst, msgVpnClientProfile.queueControl1MinMsgBurst) && - Objects.equals(this.queueDirect1MaxDepth, msgVpnClientProfile.queueDirect1MaxDepth) && - Objects.equals(this.queueDirect1MinMsgBurst, msgVpnClientProfile.queueDirect1MinMsgBurst) && - Objects.equals(this.queueDirect2MaxDepth, msgVpnClientProfile.queueDirect2MaxDepth) && - Objects.equals(this.queueDirect2MinMsgBurst, msgVpnClientProfile.queueDirect2MinMsgBurst) && - Objects.equals(this.queueDirect3MaxDepth, msgVpnClientProfile.queueDirect3MaxDepth) && - Objects.equals(this.queueDirect3MinMsgBurst, msgVpnClientProfile.queueDirect3MinMsgBurst) && - Objects.equals(this.queueGuaranteed1MaxDepth, msgVpnClientProfile.queueGuaranteed1MaxDepth) && - Objects.equals(this.queueGuaranteed1MinMsgBurst, msgVpnClientProfile.queueGuaranteed1MinMsgBurst) && - Objects.equals(this.rejectMsgToSenderOnNoSubscriptionMatchEnabled, msgVpnClientProfile.rejectMsgToSenderOnNoSubscriptionMatchEnabled) && - Objects.equals(this.replicationAllowClientConnectWhenStandbyEnabled, msgVpnClientProfile.replicationAllowClientConnectWhenStandbyEnabled) && - Objects.equals(this.serviceMinKeepaliveTimeout, msgVpnClientProfile.serviceMinKeepaliveTimeout) && - Objects.equals(this.serviceSmfMaxConnectionCountPerClientUsername, msgVpnClientProfile.serviceSmfMaxConnectionCountPerClientUsername) && - Objects.equals(this.serviceSmfMinKeepaliveEnabled, msgVpnClientProfile.serviceSmfMinKeepaliveEnabled) && - Objects.equals(this.serviceWebInactiveTimeout, msgVpnClientProfile.serviceWebInactiveTimeout) && - Objects.equals(this.serviceWebMaxConnectionCountPerClientUsername, msgVpnClientProfile.serviceWebMaxConnectionCountPerClientUsername) && - Objects.equals(this.serviceWebMaxPayload, msgVpnClientProfile.serviceWebMaxPayload) && - Objects.equals(this.tcpCongestionWindowSize, msgVpnClientProfile.tcpCongestionWindowSize) && - Objects.equals(this.tcpKeepaliveCount, msgVpnClientProfile.tcpKeepaliveCount) && - Objects.equals(this.tcpKeepaliveIdleTime, msgVpnClientProfile.tcpKeepaliveIdleTime) && - Objects.equals(this.tcpKeepaliveInterval, msgVpnClientProfile.tcpKeepaliveInterval) && - Objects.equals(this.tcpMaxSegmentSize, msgVpnClientProfile.tcpMaxSegmentSize) && - Objects.equals(this.tcpMaxWindowSize, msgVpnClientProfile.tcpMaxWindowSize) && - Objects.equals(this.tlsAllowDowngradeToPlainTextEnabled, msgVpnClientProfile.tlsAllowDowngradeToPlainTextEnabled); - } - - @Override - public int hashCode() { - return Objects.hash(allowBridgeConnectionsEnabled, allowCutThroughForwardingEnabled, allowGuaranteedEndpointCreateDurability, allowGuaranteedEndpointCreateEnabled, allowGuaranteedMsgReceiveEnabled, allowGuaranteedMsgSendEnabled, allowSharedSubscriptionsEnabled, allowTransactedSessionsEnabled, apiQueueManagementCopyFromOnCreateName, apiQueueManagementCopyFromOnCreateTemplateName, apiTopicEndpointManagementCopyFromOnCreateName, apiTopicEndpointManagementCopyFromOnCreateTemplateName, clientProfileName, compressionEnabled, elidingDelay, elidingEnabled, elidingMaxTopicCount, eventClientProvisionedEndpointSpoolUsageThreshold, eventConnectionCountPerClientUsernameThreshold, eventEgressFlowCountThreshold, eventEndpointCountPerClientUsernameThreshold, eventIngressFlowCountThreshold, eventServiceSmfConnectionCountPerClientUsernameThreshold, eventServiceWebConnectionCountPerClientUsernameThreshold, eventSubscriptionCountThreshold, eventTransactedSessionCountThreshold, eventTransactionCountThreshold, maxConnectionCountPerClientUsername, maxEgressFlowCount, maxEndpointCountPerClientUsername, maxIngressFlowCount, maxMsgsPerTransaction, maxSubscriptionCount, maxTransactedSessionCount, maxTransactionCount, msgVpnName, queueControl1MaxDepth, queueControl1MinMsgBurst, queueDirect1MaxDepth, queueDirect1MinMsgBurst, queueDirect2MaxDepth, queueDirect2MinMsgBurst, queueDirect3MaxDepth, queueDirect3MinMsgBurst, queueGuaranteed1MaxDepth, queueGuaranteed1MinMsgBurst, rejectMsgToSenderOnNoSubscriptionMatchEnabled, replicationAllowClientConnectWhenStandbyEnabled, serviceMinKeepaliveTimeout, serviceSmfMaxConnectionCountPerClientUsername, serviceSmfMinKeepaliveEnabled, serviceWebInactiveTimeout, serviceWebMaxConnectionCountPerClientUsername, serviceWebMaxPayload, tcpCongestionWindowSize, tcpKeepaliveCount, tcpKeepaliveIdleTime, tcpKeepaliveInterval, tcpMaxSegmentSize, tcpMaxWindowSize, tlsAllowDowngradeToPlainTextEnabled); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnClientProfile {\n"); - sb.append(" allowBridgeConnectionsEnabled: ").append(toIndentedString(allowBridgeConnectionsEnabled)).append("\n"); - sb.append(" allowCutThroughForwardingEnabled: ").append(toIndentedString(allowCutThroughForwardingEnabled)).append("\n"); - sb.append(" allowGuaranteedEndpointCreateDurability: ").append(toIndentedString(allowGuaranteedEndpointCreateDurability)).append("\n"); - sb.append(" allowGuaranteedEndpointCreateEnabled: ").append(toIndentedString(allowGuaranteedEndpointCreateEnabled)).append("\n"); - sb.append(" allowGuaranteedMsgReceiveEnabled: ").append(toIndentedString(allowGuaranteedMsgReceiveEnabled)).append("\n"); - sb.append(" allowGuaranteedMsgSendEnabled: ").append(toIndentedString(allowGuaranteedMsgSendEnabled)).append("\n"); - sb.append(" allowSharedSubscriptionsEnabled: ").append(toIndentedString(allowSharedSubscriptionsEnabled)).append("\n"); - sb.append(" allowTransactedSessionsEnabled: ").append(toIndentedString(allowTransactedSessionsEnabled)).append("\n"); - sb.append(" apiQueueManagementCopyFromOnCreateName: ").append(toIndentedString(apiQueueManagementCopyFromOnCreateName)).append("\n"); - sb.append(" apiQueueManagementCopyFromOnCreateTemplateName: ").append(toIndentedString(apiQueueManagementCopyFromOnCreateTemplateName)).append("\n"); - sb.append(" apiTopicEndpointManagementCopyFromOnCreateName: ").append(toIndentedString(apiTopicEndpointManagementCopyFromOnCreateName)).append("\n"); - sb.append(" apiTopicEndpointManagementCopyFromOnCreateTemplateName: ").append(toIndentedString(apiTopicEndpointManagementCopyFromOnCreateTemplateName)).append("\n"); - sb.append(" clientProfileName: ").append(toIndentedString(clientProfileName)).append("\n"); - sb.append(" compressionEnabled: ").append(toIndentedString(compressionEnabled)).append("\n"); - sb.append(" elidingDelay: ").append(toIndentedString(elidingDelay)).append("\n"); - sb.append(" elidingEnabled: ").append(toIndentedString(elidingEnabled)).append("\n"); - sb.append(" elidingMaxTopicCount: ").append(toIndentedString(elidingMaxTopicCount)).append("\n"); - sb.append(" eventClientProvisionedEndpointSpoolUsageThreshold: ").append(toIndentedString(eventClientProvisionedEndpointSpoolUsageThreshold)).append("\n"); - sb.append(" eventConnectionCountPerClientUsernameThreshold: ").append(toIndentedString(eventConnectionCountPerClientUsernameThreshold)).append("\n"); - sb.append(" eventEgressFlowCountThreshold: ").append(toIndentedString(eventEgressFlowCountThreshold)).append("\n"); - sb.append(" eventEndpointCountPerClientUsernameThreshold: ").append(toIndentedString(eventEndpointCountPerClientUsernameThreshold)).append("\n"); - sb.append(" eventIngressFlowCountThreshold: ").append(toIndentedString(eventIngressFlowCountThreshold)).append("\n"); - sb.append(" eventServiceSmfConnectionCountPerClientUsernameThreshold: ").append(toIndentedString(eventServiceSmfConnectionCountPerClientUsernameThreshold)).append("\n"); - sb.append(" eventServiceWebConnectionCountPerClientUsernameThreshold: ").append(toIndentedString(eventServiceWebConnectionCountPerClientUsernameThreshold)).append("\n"); - sb.append(" eventSubscriptionCountThreshold: ").append(toIndentedString(eventSubscriptionCountThreshold)).append("\n"); - sb.append(" eventTransactedSessionCountThreshold: ").append(toIndentedString(eventTransactedSessionCountThreshold)).append("\n"); - sb.append(" eventTransactionCountThreshold: ").append(toIndentedString(eventTransactionCountThreshold)).append("\n"); - sb.append(" maxConnectionCountPerClientUsername: ").append(toIndentedString(maxConnectionCountPerClientUsername)).append("\n"); - sb.append(" maxEgressFlowCount: ").append(toIndentedString(maxEgressFlowCount)).append("\n"); - sb.append(" maxEndpointCountPerClientUsername: ").append(toIndentedString(maxEndpointCountPerClientUsername)).append("\n"); - sb.append(" maxIngressFlowCount: ").append(toIndentedString(maxIngressFlowCount)).append("\n"); - sb.append(" maxMsgsPerTransaction: ").append(toIndentedString(maxMsgsPerTransaction)).append("\n"); - sb.append(" maxSubscriptionCount: ").append(toIndentedString(maxSubscriptionCount)).append("\n"); - sb.append(" maxTransactedSessionCount: ").append(toIndentedString(maxTransactedSessionCount)).append("\n"); - sb.append(" maxTransactionCount: ").append(toIndentedString(maxTransactionCount)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" queueControl1MaxDepth: ").append(toIndentedString(queueControl1MaxDepth)).append("\n"); - sb.append(" queueControl1MinMsgBurst: ").append(toIndentedString(queueControl1MinMsgBurst)).append("\n"); - sb.append(" queueDirect1MaxDepth: ").append(toIndentedString(queueDirect1MaxDepth)).append("\n"); - sb.append(" queueDirect1MinMsgBurst: ").append(toIndentedString(queueDirect1MinMsgBurst)).append("\n"); - sb.append(" queueDirect2MaxDepth: ").append(toIndentedString(queueDirect2MaxDepth)).append("\n"); - sb.append(" queueDirect2MinMsgBurst: ").append(toIndentedString(queueDirect2MinMsgBurst)).append("\n"); - sb.append(" queueDirect3MaxDepth: ").append(toIndentedString(queueDirect3MaxDepth)).append("\n"); - sb.append(" queueDirect3MinMsgBurst: ").append(toIndentedString(queueDirect3MinMsgBurst)).append("\n"); - sb.append(" queueGuaranteed1MaxDepth: ").append(toIndentedString(queueGuaranteed1MaxDepth)).append("\n"); - sb.append(" queueGuaranteed1MinMsgBurst: ").append(toIndentedString(queueGuaranteed1MinMsgBurst)).append("\n"); - sb.append(" rejectMsgToSenderOnNoSubscriptionMatchEnabled: ").append(toIndentedString(rejectMsgToSenderOnNoSubscriptionMatchEnabled)).append("\n"); - sb.append(" replicationAllowClientConnectWhenStandbyEnabled: ").append(toIndentedString(replicationAllowClientConnectWhenStandbyEnabled)).append("\n"); - sb.append(" serviceMinKeepaliveTimeout: ").append(toIndentedString(serviceMinKeepaliveTimeout)).append("\n"); - sb.append(" serviceSmfMaxConnectionCountPerClientUsername: ").append(toIndentedString(serviceSmfMaxConnectionCountPerClientUsername)).append("\n"); - sb.append(" serviceSmfMinKeepaliveEnabled: ").append(toIndentedString(serviceSmfMinKeepaliveEnabled)).append("\n"); - sb.append(" serviceWebInactiveTimeout: ").append(toIndentedString(serviceWebInactiveTimeout)).append("\n"); - sb.append(" serviceWebMaxConnectionCountPerClientUsername: ").append(toIndentedString(serviceWebMaxConnectionCountPerClientUsername)).append("\n"); - sb.append(" serviceWebMaxPayload: ").append(toIndentedString(serviceWebMaxPayload)).append("\n"); - sb.append(" tcpCongestionWindowSize: ").append(toIndentedString(tcpCongestionWindowSize)).append("\n"); - sb.append(" tcpKeepaliveCount: ").append(toIndentedString(tcpKeepaliveCount)).append("\n"); - sb.append(" tcpKeepaliveIdleTime: ").append(toIndentedString(tcpKeepaliveIdleTime)).append("\n"); - sb.append(" tcpKeepaliveInterval: ").append(toIndentedString(tcpKeepaliveInterval)).append("\n"); - sb.append(" tcpMaxSegmentSize: ").append(toIndentedString(tcpMaxSegmentSize)).append("\n"); - sb.append(" tcpMaxWindowSize: ").append(toIndentedString(tcpMaxWindowSize)).append("\n"); - sb.append(" tlsAllowDowngradeToPlainTextEnabled: ").append(toIndentedString(tlsAllowDowngradeToPlainTextEnabled)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileLinks.java deleted file mode 100644 index bc0cd4f70..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnClientProfileLinks - */ -@JsonPropertyOrder({ - MsgVpnClientProfileLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnClientProfileLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnClientProfileLinks() { - } - - public MsgVpnClientProfileLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Client Profile object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnClientProfileLinks msgVpnClientProfileLinks = (MsgVpnClientProfileLinks) o; - return Objects.equals(this.uri, msgVpnClientProfileLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnClientProfileLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileResponse.java deleted file mode 100644 index c5677801b..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfileLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnClientProfileResponse - */ -@JsonPropertyOrder({ - MsgVpnClientProfileResponse.JSON_PROPERTY_DATA, - MsgVpnClientProfileResponse.JSON_PROPERTY_LINKS, - MsgVpnClientProfileResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnClientProfileResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnClientProfile data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnClientProfileLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnClientProfileResponse() { - } - - public MsgVpnClientProfileResponse data(MsgVpnClientProfile data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnClientProfile getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnClientProfile data) { - this.data = data; - } - - - public MsgVpnClientProfileResponse links(MsgVpnClientProfileLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnClientProfileLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnClientProfileLinks links) { - this.links = links; - } - - - public MsgVpnClientProfileResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnClientProfileResponse msgVpnClientProfileResponse = (MsgVpnClientProfileResponse) o; - return Objects.equals(this.data, msgVpnClientProfileResponse.data) && - Objects.equals(this.links, msgVpnClientProfileResponse.links) && - Objects.equals(this.meta, msgVpnClientProfileResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnClientProfileResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfilesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfilesResponse.java deleted file mode 100644 index 8c2325c83..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfilesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfileLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnClientProfilesResponse - */ -@JsonPropertyOrder({ - MsgVpnClientProfilesResponse.JSON_PROPERTY_DATA, - MsgVpnClientProfilesResponse.JSON_PROPERTY_LINKS, - MsgVpnClientProfilesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnClientProfilesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnClientProfilesResponse() { - } - - public MsgVpnClientProfilesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnClientProfilesResponse addDataItem(MsgVpnClientProfile dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnClientProfilesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnClientProfilesResponse addLinksItem(MsgVpnClientProfileLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnClientProfilesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnClientProfilesResponse msgVpnClientProfilesResponse = (MsgVpnClientProfilesResponse) o; - return Objects.equals(this.data, msgVpnClientProfilesResponse.data) && - Objects.equals(this.links, msgVpnClientProfilesResponse.links) && - Objects.equals(this.meta, msgVpnClientProfilesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnClientProfilesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsername.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsername.java deleted file mode 100644 index ddbe5c108..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsername.java +++ /dev/null @@ -1,328 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnClientUsername - */ -@JsonPropertyOrder({ - MsgVpnClientUsername.JSON_PROPERTY_ACL_PROFILE_NAME, - MsgVpnClientUsername.JSON_PROPERTY_CLIENT_PROFILE_NAME, - MsgVpnClientUsername.JSON_PROPERTY_CLIENT_USERNAME, - MsgVpnClientUsername.JSON_PROPERTY_ENABLED, - MsgVpnClientUsername.JSON_PROPERTY_GUARANTEED_ENDPOINT_PERMISSION_OVERRIDE_ENABLED, - MsgVpnClientUsername.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnClientUsername.JSON_PROPERTY_PASSWORD, - MsgVpnClientUsername.JSON_PROPERTY_SUBSCRIPTION_MANAGER_ENABLED -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnClientUsername { - public static final String JSON_PROPERTY_ACL_PROFILE_NAME = "aclProfileName"; - private String aclProfileName; - - public static final String JSON_PROPERTY_CLIENT_PROFILE_NAME = "clientProfileName"; - private String clientProfileName; - - public static final String JSON_PROPERTY_CLIENT_USERNAME = "clientUsername"; - private String clientUsername; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_GUARANTEED_ENDPOINT_PERMISSION_OVERRIDE_ENABLED = "guaranteedEndpointPermissionOverrideEnabled"; - private Boolean guaranteedEndpointPermissionOverrideEnabled; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_PASSWORD = "password"; - private String password; - - public static final String JSON_PROPERTY_SUBSCRIPTION_MANAGER_ENABLED = "subscriptionManagerEnabled"; - private Boolean subscriptionManagerEnabled; - - public MsgVpnClientUsername() { - } - - public MsgVpnClientUsername aclProfileName(String aclProfileName) { - - this.aclProfileName = aclProfileName; - return this; - } - - /** - * The ACL Profile of the Client Username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`. - * @return aclProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAclProfileName() { - return aclProfileName; - } - - - @JsonProperty(JSON_PROPERTY_ACL_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAclProfileName(String aclProfileName) { - this.aclProfileName = aclProfileName; - } - - - public MsgVpnClientUsername clientProfileName(String clientProfileName) { - - this.clientProfileName = clientProfileName; - return this; - } - - /** - * The Client Profile of the Client Username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`. - * @return clientProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientProfileName() { - return clientProfileName; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileName(String clientProfileName) { - this.clientProfileName = clientProfileName; - } - - - public MsgVpnClientUsername clientUsername(String clientUsername) { - - this.clientUsername = clientUsername; - return this; - } - - /** - * The name of the Client Username. - * @return clientUsername - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientUsername() { - return clientUsername; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientUsername(String clientUsername) { - this.clientUsername = clientUsername; - } - - - public MsgVpnClientUsername enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the Client Username. When disabled, all clients currently connected as the Client Username are disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public MsgVpnClientUsername guaranteedEndpointPermissionOverrideEnabled(Boolean guaranteedEndpointPermissionOverrideEnabled) { - - this.guaranteedEndpointPermissionOverrideEnabled = guaranteedEndpointPermissionOverrideEnabled; - return this; - } - - /** - * Enable or disable guaranteed endpoint permission override for the Client Username. When enabled all guaranteed endpoints may be accessed, modified or deleted with the same permission as the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return guaranteedEndpointPermissionOverrideEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_ENDPOINT_PERMISSION_OVERRIDE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getGuaranteedEndpointPermissionOverrideEnabled() { - return guaranteedEndpointPermissionOverrideEnabled; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_ENDPOINT_PERMISSION_OVERRIDE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedEndpointPermissionOverrideEnabled(Boolean guaranteedEndpointPermissionOverrideEnabled) { - this.guaranteedEndpointPermissionOverrideEnabled = guaranteedEndpointPermissionOverrideEnabled; - } - - - public MsgVpnClientUsername msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnClientUsername password(String password) { - - this.password = password; - return this; - } - - /** - * The password for the Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return password - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getPassword() { - return password; - } - - - @JsonProperty(JSON_PROPERTY_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPassword(String password) { - this.password = password; - } - - - public MsgVpnClientUsername subscriptionManagerEnabled(Boolean subscriptionManagerEnabled) { - - this.subscriptionManagerEnabled = subscriptionManagerEnabled; - return this; - } - - /** - * Enable or disable the subscription management capability of the Client Username. This is the ability to manage subscriptions on behalf of other Client Usernames. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return subscriptionManagerEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SUBSCRIPTION_MANAGER_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getSubscriptionManagerEnabled() { - return subscriptionManagerEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SUBSCRIPTION_MANAGER_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubscriptionManagerEnabled(Boolean subscriptionManagerEnabled) { - this.subscriptionManagerEnabled = subscriptionManagerEnabled; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnClientUsername msgVpnClientUsername = (MsgVpnClientUsername) o; - return Objects.equals(this.aclProfileName, msgVpnClientUsername.aclProfileName) && - Objects.equals(this.clientProfileName, msgVpnClientUsername.clientProfileName) && - Objects.equals(this.clientUsername, msgVpnClientUsername.clientUsername) && - Objects.equals(this.enabled, msgVpnClientUsername.enabled) && - Objects.equals(this.guaranteedEndpointPermissionOverrideEnabled, msgVpnClientUsername.guaranteedEndpointPermissionOverrideEnabled) && - Objects.equals(this.msgVpnName, msgVpnClientUsername.msgVpnName) && - Objects.equals(this.password, msgVpnClientUsername.password) && - Objects.equals(this.subscriptionManagerEnabled, msgVpnClientUsername.subscriptionManagerEnabled); - } - - @Override - public int hashCode() { - return Objects.hash(aclProfileName, clientProfileName, clientUsername, enabled, guaranteedEndpointPermissionOverrideEnabled, msgVpnName, password, subscriptionManagerEnabled); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnClientUsername {\n"); - sb.append(" aclProfileName: ").append(toIndentedString(aclProfileName)).append("\n"); - sb.append(" clientProfileName: ").append(toIndentedString(clientProfileName)).append("\n"); - sb.append(" clientUsername: ").append(toIndentedString(clientUsername)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" guaranteedEndpointPermissionOverrideEnabled: ").append(toIndentedString(guaranteedEndpointPermissionOverrideEnabled)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" password: ").append(toIndentedString(password)).append("\n"); - sb.append(" subscriptionManagerEnabled: ").append(toIndentedString(subscriptionManagerEnabled)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttribute.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttribute.java deleted file mode 100644 index 43319ce79..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttribute.java +++ /dev/null @@ -1,200 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnClientUsernameAttribute - */ -@JsonPropertyOrder({ - MsgVpnClientUsernameAttribute.JSON_PROPERTY_ATTRIBUTE_NAME, - MsgVpnClientUsernameAttribute.JSON_PROPERTY_ATTRIBUTE_VALUE, - MsgVpnClientUsernameAttribute.JSON_PROPERTY_CLIENT_USERNAME, - MsgVpnClientUsernameAttribute.JSON_PROPERTY_MSG_VPN_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnClientUsernameAttribute { - public static final String JSON_PROPERTY_ATTRIBUTE_NAME = "attributeName"; - private String attributeName; - - public static final String JSON_PROPERTY_ATTRIBUTE_VALUE = "attributeValue"; - private String attributeValue; - - public static final String JSON_PROPERTY_CLIENT_USERNAME = "clientUsername"; - private String clientUsername; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public MsgVpnClientUsernameAttribute() { - } - - public MsgVpnClientUsernameAttribute attributeName(String attributeName) { - - this.attributeName = attributeName; - return this; - } - - /** - * The name of the Attribute. - * @return attributeName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAttributeName() { - return attributeName; - } - - - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttributeName(String attributeName) { - this.attributeName = attributeName; - } - - - public MsgVpnClientUsernameAttribute attributeValue(String attributeValue) { - - this.attributeValue = attributeValue; - return this; - } - - /** - * The value of the Attribute. - * @return attributeValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAttributeValue() { - return attributeValue; - } - - - @JsonProperty(JSON_PROPERTY_ATTRIBUTE_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttributeValue(String attributeValue) { - this.attributeValue = attributeValue; - } - - - public MsgVpnClientUsernameAttribute clientUsername(String clientUsername) { - - this.clientUsername = clientUsername; - return this; - } - - /** - * The name of the Client Username. - * @return clientUsername - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientUsername() { - return clientUsername; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientUsername(String clientUsername) { - this.clientUsername = clientUsername; - } - - - public MsgVpnClientUsernameAttribute msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnClientUsernameAttribute msgVpnClientUsernameAttribute = (MsgVpnClientUsernameAttribute) o; - return Objects.equals(this.attributeName, msgVpnClientUsernameAttribute.attributeName) && - Objects.equals(this.attributeValue, msgVpnClientUsernameAttribute.attributeValue) && - Objects.equals(this.clientUsername, msgVpnClientUsernameAttribute.clientUsername) && - Objects.equals(this.msgVpnName, msgVpnClientUsernameAttribute.msgVpnName); - } - - @Override - public int hashCode() { - return Objects.hash(attributeName, attributeValue, clientUsername, msgVpnName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnClientUsernameAttribute {\n"); - sb.append(" attributeName: ").append(toIndentedString(attributeName)).append("\n"); - sb.append(" attributeValue: ").append(toIndentedString(attributeValue)).append("\n"); - sb.append(" clientUsername: ").append(toIndentedString(clientUsername)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeLinks.java deleted file mode 100644 index 5fe36a8b6..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnClientUsernameAttributeLinks - */ -@JsonPropertyOrder({ - MsgVpnClientUsernameAttributeLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnClientUsernameAttributeLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnClientUsernameAttributeLinks() { - } - - public MsgVpnClientUsernameAttributeLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Client Username Attribute object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnClientUsernameAttributeLinks msgVpnClientUsernameAttributeLinks = (MsgVpnClientUsernameAttributeLinks) o; - return Objects.equals(this.uri, msgVpnClientUsernameAttributeLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnClientUsernameAttributeLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeResponse.java deleted file mode 100644 index 8cffad0d1..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttributeLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnClientUsernameAttributeResponse - */ -@JsonPropertyOrder({ - MsgVpnClientUsernameAttributeResponse.JSON_PROPERTY_DATA, - MsgVpnClientUsernameAttributeResponse.JSON_PROPERTY_LINKS, - MsgVpnClientUsernameAttributeResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnClientUsernameAttributeResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnClientUsernameAttribute data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnClientUsernameAttributeLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnClientUsernameAttributeResponse() { - } - - public MsgVpnClientUsernameAttributeResponse data(MsgVpnClientUsernameAttribute data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnClientUsernameAttribute getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnClientUsernameAttribute data) { - this.data = data; - } - - - public MsgVpnClientUsernameAttributeResponse links(MsgVpnClientUsernameAttributeLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnClientUsernameAttributeLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnClientUsernameAttributeLinks links) { - this.links = links; - } - - - public MsgVpnClientUsernameAttributeResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnClientUsernameAttributeResponse msgVpnClientUsernameAttributeResponse = (MsgVpnClientUsernameAttributeResponse) o; - return Objects.equals(this.data, msgVpnClientUsernameAttributeResponse.data) && - Objects.equals(this.links, msgVpnClientUsernameAttributeResponse.links) && - Objects.equals(this.meta, msgVpnClientUsernameAttributeResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnClientUsernameAttributeResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributesResponse.java deleted file mode 100644 index b314d0ff8..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttributeLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnClientUsernameAttributesResponse - */ -@JsonPropertyOrder({ - MsgVpnClientUsernameAttributesResponse.JSON_PROPERTY_DATA, - MsgVpnClientUsernameAttributesResponse.JSON_PROPERTY_LINKS, - MsgVpnClientUsernameAttributesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnClientUsernameAttributesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnClientUsernameAttributesResponse() { - } - - public MsgVpnClientUsernameAttributesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnClientUsernameAttributesResponse addDataItem(MsgVpnClientUsernameAttribute dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnClientUsernameAttributesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnClientUsernameAttributesResponse addLinksItem(MsgVpnClientUsernameAttributeLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnClientUsernameAttributesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnClientUsernameAttributesResponse msgVpnClientUsernameAttributesResponse = (MsgVpnClientUsernameAttributesResponse) o; - return Objects.equals(this.data, msgVpnClientUsernameAttributesResponse.data) && - Objects.equals(this.links, msgVpnClientUsernameAttributesResponse.links) && - Objects.equals(this.meta, msgVpnClientUsernameAttributesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnClientUsernameAttributesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameLinks.java deleted file mode 100644 index 20d1ad612..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameLinks.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnClientUsernameLinks - */ -@JsonPropertyOrder({ - MsgVpnClientUsernameLinks.JSON_PROPERTY_ATTRIBUTES_URI, - MsgVpnClientUsernameLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnClientUsernameLinks { - public static final String JSON_PROPERTY_ATTRIBUTES_URI = "attributesUri"; - private String attributesUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnClientUsernameLinks() { - } - - public MsgVpnClientUsernameLinks attributesUri(String attributesUri) { - - this.attributesUri = attributesUri; - return this; - } - - /** - * The URI of this Client Username's collection of Client Username Attribute objects. Available since 2.27. - * @return attributesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ATTRIBUTES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAttributesUri() { - return attributesUri; - } - - - @JsonProperty(JSON_PROPERTY_ATTRIBUTES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttributesUri(String attributesUri) { - this.attributesUri = attributesUri; - } - - - public MsgVpnClientUsernameLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Client Username object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnClientUsernameLinks msgVpnClientUsernameLinks = (MsgVpnClientUsernameLinks) o; - return Objects.equals(this.attributesUri, msgVpnClientUsernameLinks.attributesUri) && - Objects.equals(this.uri, msgVpnClientUsernameLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(attributesUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnClientUsernameLinks {\n"); - sb.append(" attributesUri: ").append(toIndentedString(attributesUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameResponse.java deleted file mode 100644 index 8aa5fed6b..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsername; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnClientUsernameResponse - */ -@JsonPropertyOrder({ - MsgVpnClientUsernameResponse.JSON_PROPERTY_DATA, - MsgVpnClientUsernameResponse.JSON_PROPERTY_LINKS, - MsgVpnClientUsernameResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnClientUsernameResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnClientUsername data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnClientUsernameLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnClientUsernameResponse() { - } - - public MsgVpnClientUsernameResponse data(MsgVpnClientUsername data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnClientUsername getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnClientUsername data) { - this.data = data; - } - - - public MsgVpnClientUsernameResponse links(MsgVpnClientUsernameLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnClientUsernameLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnClientUsernameLinks links) { - this.links = links; - } - - - public MsgVpnClientUsernameResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnClientUsernameResponse msgVpnClientUsernameResponse = (MsgVpnClientUsernameResponse) o; - return Objects.equals(this.data, msgVpnClientUsernameResponse.data) && - Objects.equals(this.links, msgVpnClientUsernameResponse.links) && - Objects.equals(this.meta, msgVpnClientUsernameResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnClientUsernameResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernamesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernamesResponse.java deleted file mode 100644 index 2902d1ac9..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernamesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsername; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnClientUsernamesResponse - */ -@JsonPropertyOrder({ - MsgVpnClientUsernamesResponse.JSON_PROPERTY_DATA, - MsgVpnClientUsernamesResponse.JSON_PROPERTY_LINKS, - MsgVpnClientUsernamesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnClientUsernamesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnClientUsernamesResponse() { - } - - public MsgVpnClientUsernamesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnClientUsernamesResponse addDataItem(MsgVpnClientUsername dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnClientUsernamesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnClientUsernamesResponse addLinksItem(MsgVpnClientUsernameLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnClientUsernamesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnClientUsernamesResponse msgVpnClientUsernamesResponse = (MsgVpnClientUsernamesResponse) o; - return Objects.equals(this.data, msgVpnClientUsernamesResponse.data) && - Objects.equals(this.links, msgVpnClientUsernamesResponse.links) && - Objects.equals(this.meta, msgVpnClientUsernamesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnClientUsernamesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCache.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCache.java deleted file mode 100644 index 255b170e4..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCache.java +++ /dev/null @@ -1,329 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCache - */ -@JsonPropertyOrder({ - MsgVpnDistributedCache.JSON_PROPERTY_CACHE_NAME, - MsgVpnDistributedCache.JSON_PROPERTY_CACHE_VIRTUAL_ROUTER, - MsgVpnDistributedCache.JSON_PROPERTY_ENABLED, - MsgVpnDistributedCache.JSON_PROPERTY_HEARTBEAT, - MsgVpnDistributedCache.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnDistributedCache.JSON_PROPERTY_SCHEDULED_DELETE_MSG_DAY_LIST, - MsgVpnDistributedCache.JSON_PROPERTY_SCHEDULED_DELETE_MSG_TIME_LIST -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCache { - public static final String JSON_PROPERTY_CACHE_NAME = "cacheName"; - private String cacheName; - - /** - * The virtual router of the Distributed Cache. The default value is `\"auto\"`. The allowed values and their meaning are: <pre> \"auto\" - The Distributed Cache is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> Available since 2.28. - */ - public enum CacheVirtualRouterEnum { - AUTO("auto"); - - private String value; - - CacheVirtualRouterEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static CacheVirtualRouterEnum fromValue(String value) { - for (CacheVirtualRouterEnum b : CacheVirtualRouterEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_CACHE_VIRTUAL_ROUTER = "cacheVirtualRouter"; - private CacheVirtualRouterEnum cacheVirtualRouter; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_HEARTBEAT = "heartbeat"; - private Long heartbeat; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_SCHEDULED_DELETE_MSG_DAY_LIST = "scheduledDeleteMsgDayList"; - private String scheduledDeleteMsgDayList; - - public static final String JSON_PROPERTY_SCHEDULED_DELETE_MSG_TIME_LIST = "scheduledDeleteMsgTimeList"; - private String scheduledDeleteMsgTimeList; - - public MsgVpnDistributedCache() { - } - - public MsgVpnDistributedCache cacheName(String cacheName) { - - this.cacheName = cacheName; - return this; - } - - /** - * The name of the Distributed Cache. - * @return cacheName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CACHE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCacheName() { - return cacheName; - } - - - @JsonProperty(JSON_PROPERTY_CACHE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCacheName(String cacheName) { - this.cacheName = cacheName; - } - - - public MsgVpnDistributedCache cacheVirtualRouter(CacheVirtualRouterEnum cacheVirtualRouter) { - - this.cacheVirtualRouter = cacheVirtualRouter; - return this; - } - - /** - * The virtual router of the Distributed Cache. The default value is `\"auto\"`. The allowed values and their meaning are: <pre> \"auto\" - The Distributed Cache is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> Available since 2.28. - * @return cacheVirtualRouter - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CACHE_VIRTUAL_ROUTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public CacheVirtualRouterEnum getCacheVirtualRouter() { - return cacheVirtualRouter; - } - - - @JsonProperty(JSON_PROPERTY_CACHE_VIRTUAL_ROUTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCacheVirtualRouter(CacheVirtualRouterEnum cacheVirtualRouter) { - this.cacheVirtualRouter = cacheVirtualRouter; - } - - - public MsgVpnDistributedCache enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the Distributed Cache. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public MsgVpnDistributedCache heartbeat(Long heartbeat) { - - this.heartbeat = heartbeat; - return this; - } - - /** - * The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the message broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10`. - * @return heartbeat - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_HEARTBEAT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getHeartbeat() { - return heartbeat; - } - - - @JsonProperty(JSON_PROPERTY_HEARTBEAT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHeartbeat(Long heartbeat) { - this.heartbeat = heartbeat; - } - - - public MsgVpnDistributedCache msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnDistributedCache scheduledDeleteMsgDayList(String scheduledDeleteMsgDayList) { - - this.scheduledDeleteMsgDayList = scheduledDeleteMsgDayList; - return this; - } - - /** - * The scheduled delete message day(s), specified as \"daily\" or a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. The empty-string (\"\") can also be specified, indicating no schedule is configured (\"scheduledDeleteMsgTimeList\" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return scheduledDeleteMsgDayList - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SCHEDULED_DELETE_MSG_DAY_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getScheduledDeleteMsgDayList() { - return scheduledDeleteMsgDayList; - } - - - @JsonProperty(JSON_PROPERTY_SCHEDULED_DELETE_MSG_DAY_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setScheduledDeleteMsgDayList(String scheduledDeleteMsgDayList) { - this.scheduledDeleteMsgDayList = scheduledDeleteMsgDayList; - } - - - public MsgVpnDistributedCache scheduledDeleteMsgTimeList(String scheduledDeleteMsgTimeList) { - - this.scheduledDeleteMsgTimeList = scheduledDeleteMsgTimeList; - return this; - } - - /** - * The scheduled delete message time(s), specified as \"hourly\" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. The empty-string (\"\") can also be specified, indicating no schedule is configured (\"scheduledDeleteMsgDayList\" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return scheduledDeleteMsgTimeList - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SCHEDULED_DELETE_MSG_TIME_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getScheduledDeleteMsgTimeList() { - return scheduledDeleteMsgTimeList; - } - - - @JsonProperty(JSON_PROPERTY_SCHEDULED_DELETE_MSG_TIME_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setScheduledDeleteMsgTimeList(String scheduledDeleteMsgTimeList) { - this.scheduledDeleteMsgTimeList = scheduledDeleteMsgTimeList; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCache msgVpnDistributedCache = (MsgVpnDistributedCache) o; - return Objects.equals(this.cacheName, msgVpnDistributedCache.cacheName) && - Objects.equals(this.cacheVirtualRouter, msgVpnDistributedCache.cacheVirtualRouter) && - Objects.equals(this.enabled, msgVpnDistributedCache.enabled) && - Objects.equals(this.heartbeat, msgVpnDistributedCache.heartbeat) && - Objects.equals(this.msgVpnName, msgVpnDistributedCache.msgVpnName) && - Objects.equals(this.scheduledDeleteMsgDayList, msgVpnDistributedCache.scheduledDeleteMsgDayList) && - Objects.equals(this.scheduledDeleteMsgTimeList, msgVpnDistributedCache.scheduledDeleteMsgTimeList); - } - - @Override - public int hashCode() { - return Objects.hash(cacheName, cacheVirtualRouter, enabled, heartbeat, msgVpnName, scheduledDeleteMsgDayList, scheduledDeleteMsgTimeList); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCache {\n"); - sb.append(" cacheName: ").append(toIndentedString(cacheName)).append("\n"); - sb.append(" cacheVirtualRouter: ").append(toIndentedString(cacheVirtualRouter)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" heartbeat: ").append(toIndentedString(heartbeat)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" scheduledDeleteMsgDayList: ").append(toIndentedString(scheduledDeleteMsgDayList)).append("\n"); - sb.append(" scheduledDeleteMsgTimeList: ").append(toIndentedString(scheduledDeleteMsgTimeList)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheCluster.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheCluster.java deleted file mode 100644 index c8c236de6..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheCluster.java +++ /dev/null @@ -1,746 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThresholdByPercent; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThresholdByValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheCluster - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheCluster.JSON_PROPERTY_CACHE_NAME, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_CLUSTER_NAME, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_DELIVER_TO_ONE_OVERRIDE_ENABLED, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_ENABLED, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_EVENT_DATA_BYTE_RATE_THRESHOLD, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_EVENT_DATA_MSG_RATE_THRESHOLD, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_EVENT_MAX_MEMORY_THRESHOLD, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_EVENT_MAX_TOPICS_THRESHOLD, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_EVENT_REQUEST_QUEUE_DEPTH_THRESHOLD, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_EVENT_REQUEST_RATE_THRESHOLD, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_EVENT_RESPONSE_RATE_THRESHOLD, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_GLOBAL_CACHING_ENABLED, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_GLOBAL_CACHING_HEARTBEAT, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_GLOBAL_CACHING_TOPIC_LIFETIME, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_MAX_MEMORY, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_MAX_MSGS_PER_TOPIC, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_MAX_REQUEST_QUEUE_DEPTH, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_MAX_TOPIC_COUNT, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_MSG_LIFETIME, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnDistributedCacheCluster.JSON_PROPERTY_NEW_TOPIC_ADVERTISEMENT_ENABLED -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheCluster { - public static final String JSON_PROPERTY_CACHE_NAME = "cacheName"; - private String cacheName; - - public static final String JSON_PROPERTY_CLUSTER_NAME = "clusterName"; - private String clusterName; - - public static final String JSON_PROPERTY_DELIVER_TO_ONE_OVERRIDE_ENABLED = "deliverToOneOverrideEnabled"; - private Boolean deliverToOneOverrideEnabled; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_EVENT_DATA_BYTE_RATE_THRESHOLD = "eventDataByteRateThreshold"; - private EventThresholdByValue eventDataByteRateThreshold; - - public static final String JSON_PROPERTY_EVENT_DATA_MSG_RATE_THRESHOLD = "eventDataMsgRateThreshold"; - private EventThresholdByValue eventDataMsgRateThreshold; - - public static final String JSON_PROPERTY_EVENT_MAX_MEMORY_THRESHOLD = "eventMaxMemoryThreshold"; - private EventThresholdByPercent eventMaxMemoryThreshold; - - public static final String JSON_PROPERTY_EVENT_MAX_TOPICS_THRESHOLD = "eventMaxTopicsThreshold"; - private EventThresholdByPercent eventMaxTopicsThreshold; - - public static final String JSON_PROPERTY_EVENT_REQUEST_QUEUE_DEPTH_THRESHOLD = "eventRequestQueueDepthThreshold"; - private EventThresholdByPercent eventRequestQueueDepthThreshold; - - public static final String JSON_PROPERTY_EVENT_REQUEST_RATE_THRESHOLD = "eventRequestRateThreshold"; - private EventThresholdByValue eventRequestRateThreshold; - - public static final String JSON_PROPERTY_EVENT_RESPONSE_RATE_THRESHOLD = "eventResponseRateThreshold"; - private EventThresholdByValue eventResponseRateThreshold; - - public static final String JSON_PROPERTY_GLOBAL_CACHING_ENABLED = "globalCachingEnabled"; - private Boolean globalCachingEnabled; - - public static final String JSON_PROPERTY_GLOBAL_CACHING_HEARTBEAT = "globalCachingHeartbeat"; - private Long globalCachingHeartbeat; - - public static final String JSON_PROPERTY_GLOBAL_CACHING_TOPIC_LIFETIME = "globalCachingTopicLifetime"; - private Long globalCachingTopicLifetime; - - public static final String JSON_PROPERTY_MAX_MEMORY = "maxMemory"; - private Long maxMemory; - - public static final String JSON_PROPERTY_MAX_MSGS_PER_TOPIC = "maxMsgsPerTopic"; - private Long maxMsgsPerTopic; - - public static final String JSON_PROPERTY_MAX_REQUEST_QUEUE_DEPTH = "maxRequestQueueDepth"; - private Long maxRequestQueueDepth; - - public static final String JSON_PROPERTY_MAX_TOPIC_COUNT = "maxTopicCount"; - private Long maxTopicCount; - - public static final String JSON_PROPERTY_MSG_LIFETIME = "msgLifetime"; - private Long msgLifetime; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_NEW_TOPIC_ADVERTISEMENT_ENABLED = "newTopicAdvertisementEnabled"; - private Boolean newTopicAdvertisementEnabled; - - public MsgVpnDistributedCacheCluster() { - } - - public MsgVpnDistributedCacheCluster cacheName(String cacheName) { - - this.cacheName = cacheName; - return this; - } - - /** - * The name of the Distributed Cache. - * @return cacheName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CACHE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCacheName() { - return cacheName; - } - - - @JsonProperty(JSON_PROPERTY_CACHE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCacheName(String cacheName) { - this.cacheName = cacheName; - } - - - public MsgVpnDistributedCacheCluster clusterName(String clusterName) { - - this.clusterName = clusterName; - return this; - } - - /** - * The name of the Cache Cluster. - * @return clusterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClusterName() { - return clusterName; - } - - - @JsonProperty(JSON_PROPERTY_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClusterName(String clusterName) { - this.clusterName = clusterName; - } - - - public MsgVpnDistributedCacheCluster deliverToOneOverrideEnabled(Boolean deliverToOneOverrideEnabled) { - - this.deliverToOneOverrideEnabled = deliverToOneOverrideEnabled; - return this; - } - - /** - * Enable or disable deliver-to-one override for the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return deliverToOneOverrideEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DELIVER_TO_ONE_OVERRIDE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getDeliverToOneOverrideEnabled() { - return deliverToOneOverrideEnabled; - } - - - @JsonProperty(JSON_PROPERTY_DELIVER_TO_ONE_OVERRIDE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDeliverToOneOverrideEnabled(Boolean deliverToOneOverrideEnabled) { - this.deliverToOneOverrideEnabled = deliverToOneOverrideEnabled; - } - - - public MsgVpnDistributedCacheCluster enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public MsgVpnDistributedCacheCluster eventDataByteRateThreshold(EventThresholdByValue eventDataByteRateThreshold) { - - this.eventDataByteRateThreshold = eventDataByteRateThreshold; - return this; - } - - /** - * Get eventDataByteRateThreshold - * @return eventDataByteRateThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_DATA_BYTE_RATE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThresholdByValue getEventDataByteRateThreshold() { - return eventDataByteRateThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_DATA_BYTE_RATE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventDataByteRateThreshold(EventThresholdByValue eventDataByteRateThreshold) { - this.eventDataByteRateThreshold = eventDataByteRateThreshold; - } - - - public MsgVpnDistributedCacheCluster eventDataMsgRateThreshold(EventThresholdByValue eventDataMsgRateThreshold) { - - this.eventDataMsgRateThreshold = eventDataMsgRateThreshold; - return this; - } - - /** - * Get eventDataMsgRateThreshold - * @return eventDataMsgRateThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_DATA_MSG_RATE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThresholdByValue getEventDataMsgRateThreshold() { - return eventDataMsgRateThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_DATA_MSG_RATE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventDataMsgRateThreshold(EventThresholdByValue eventDataMsgRateThreshold) { - this.eventDataMsgRateThreshold = eventDataMsgRateThreshold; - } - - - public MsgVpnDistributedCacheCluster eventMaxMemoryThreshold(EventThresholdByPercent eventMaxMemoryThreshold) { - - this.eventMaxMemoryThreshold = eventMaxMemoryThreshold; - return this; - } - - /** - * Get eventMaxMemoryThreshold - * @return eventMaxMemoryThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_MAX_MEMORY_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThresholdByPercent getEventMaxMemoryThreshold() { - return eventMaxMemoryThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_MAX_MEMORY_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventMaxMemoryThreshold(EventThresholdByPercent eventMaxMemoryThreshold) { - this.eventMaxMemoryThreshold = eventMaxMemoryThreshold; - } - - - public MsgVpnDistributedCacheCluster eventMaxTopicsThreshold(EventThresholdByPercent eventMaxTopicsThreshold) { - - this.eventMaxTopicsThreshold = eventMaxTopicsThreshold; - return this; - } - - /** - * Get eventMaxTopicsThreshold - * @return eventMaxTopicsThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_MAX_TOPICS_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThresholdByPercent getEventMaxTopicsThreshold() { - return eventMaxTopicsThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_MAX_TOPICS_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventMaxTopicsThreshold(EventThresholdByPercent eventMaxTopicsThreshold) { - this.eventMaxTopicsThreshold = eventMaxTopicsThreshold; - } - - - public MsgVpnDistributedCacheCluster eventRequestQueueDepthThreshold(EventThresholdByPercent eventRequestQueueDepthThreshold) { - - this.eventRequestQueueDepthThreshold = eventRequestQueueDepthThreshold; - return this; - } - - /** - * Get eventRequestQueueDepthThreshold - * @return eventRequestQueueDepthThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_REQUEST_QUEUE_DEPTH_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThresholdByPercent getEventRequestQueueDepthThreshold() { - return eventRequestQueueDepthThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_REQUEST_QUEUE_DEPTH_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventRequestQueueDepthThreshold(EventThresholdByPercent eventRequestQueueDepthThreshold) { - this.eventRequestQueueDepthThreshold = eventRequestQueueDepthThreshold; - } - - - public MsgVpnDistributedCacheCluster eventRequestRateThreshold(EventThresholdByValue eventRequestRateThreshold) { - - this.eventRequestRateThreshold = eventRequestRateThreshold; - return this; - } - - /** - * Get eventRequestRateThreshold - * @return eventRequestRateThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_REQUEST_RATE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThresholdByValue getEventRequestRateThreshold() { - return eventRequestRateThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_REQUEST_RATE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventRequestRateThreshold(EventThresholdByValue eventRequestRateThreshold) { - this.eventRequestRateThreshold = eventRequestRateThreshold; - } - - - public MsgVpnDistributedCacheCluster eventResponseRateThreshold(EventThresholdByValue eventResponseRateThreshold) { - - this.eventResponseRateThreshold = eventResponseRateThreshold; - return this; - } - - /** - * Get eventResponseRateThreshold - * @return eventResponseRateThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_RESPONSE_RATE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThresholdByValue getEventResponseRateThreshold() { - return eventResponseRateThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_RESPONSE_RATE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventResponseRateThreshold(EventThresholdByValue eventResponseRateThreshold) { - this.eventResponseRateThreshold = eventResponseRateThreshold; - } - - - public MsgVpnDistributedCacheCluster globalCachingEnabled(Boolean globalCachingEnabled) { - - this.globalCachingEnabled = globalCachingEnabled; - return this; - } - - /** - * Enable or disable global caching for the Cache Cluster. When enabled, the Cache Instances will fetch topics from remote Home Cache Clusters when requested, and subscribe to those topics to cache them locally. When disabled, the Cache Instances will remove all subscriptions and cached messages for topics from remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return globalCachingEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GLOBAL_CACHING_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getGlobalCachingEnabled() { - return globalCachingEnabled; - } - - - @JsonProperty(JSON_PROPERTY_GLOBAL_CACHING_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGlobalCachingEnabled(Boolean globalCachingEnabled) { - this.globalCachingEnabled = globalCachingEnabled; - } - - - public MsgVpnDistributedCacheCluster globalCachingHeartbeat(Long globalCachingHeartbeat) { - - this.globalCachingHeartbeat = globalCachingHeartbeat; - return this; - } - - /** - * The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. - * @return globalCachingHeartbeat - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GLOBAL_CACHING_HEARTBEAT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getGlobalCachingHeartbeat() { - return globalCachingHeartbeat; - } - - - @JsonProperty(JSON_PROPERTY_GLOBAL_CACHING_HEARTBEAT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGlobalCachingHeartbeat(Long globalCachingHeartbeat) { - this.globalCachingHeartbeat = globalCachingHeartbeat; - } - - - public MsgVpnDistributedCacheCluster globalCachingTopicLifetime(Long globalCachingTopicLifetime) { - - this.globalCachingTopicLifetime = globalCachingTopicLifetime; - return this; - } - - /** - * The topic lifetime, in seconds. If no client requests are received for a given global topic over the duration of the topic lifetime, then the Cache Instance will remove the subscription and cached messages for that topic. A value of 0 disables aging. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3600`. - * @return globalCachingTopicLifetime - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GLOBAL_CACHING_TOPIC_LIFETIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getGlobalCachingTopicLifetime() { - return globalCachingTopicLifetime; - } - - - @JsonProperty(JSON_PROPERTY_GLOBAL_CACHING_TOPIC_LIFETIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGlobalCachingTopicLifetime(Long globalCachingTopicLifetime) { - this.globalCachingTopicLifetime = globalCachingTopicLifetime; - } - - - public MsgVpnDistributedCacheCluster maxMemory(Long maxMemory) { - - this.maxMemory = maxMemory; - return this; - } - - /** - * The maximum memory usage, in megabytes (MB), for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2048`. - * @return maxMemory - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_MEMORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxMemory() { - return maxMemory; - } - - - @JsonProperty(JSON_PROPERTY_MAX_MEMORY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxMemory(Long maxMemory) { - this.maxMemory = maxMemory; - } - - - public MsgVpnDistributedCacheCluster maxMsgsPerTopic(Long maxMsgsPerTopic) { - - this.maxMsgsPerTopic = maxMsgsPerTopic; - return this; - } - - /** - * The maximum number of messages per topic for each Cache Instance in the Cache Cluster. When at the maximum, old messages are removed as new messages arrive. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. - * @return maxMsgsPerTopic - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_MSGS_PER_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxMsgsPerTopic() { - return maxMsgsPerTopic; - } - - - @JsonProperty(JSON_PROPERTY_MAX_MSGS_PER_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxMsgsPerTopic(Long maxMsgsPerTopic) { - this.maxMsgsPerTopic = maxMsgsPerTopic; - } - - - public MsgVpnDistributedCacheCluster maxRequestQueueDepth(Long maxRequestQueueDepth) { - - this.maxRequestQueueDepth = maxRequestQueueDepth; - return this; - } - - /** - * The maximum queue depth for cache requests received by the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `100000`. - * @return maxRequestQueueDepth - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_REQUEST_QUEUE_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxRequestQueueDepth() { - return maxRequestQueueDepth; - } - - - @JsonProperty(JSON_PROPERTY_MAX_REQUEST_QUEUE_DEPTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxRequestQueueDepth(Long maxRequestQueueDepth) { - this.maxRequestQueueDepth = maxRequestQueueDepth; - } - - - public MsgVpnDistributedCacheCluster maxTopicCount(Long maxTopicCount) { - - this.maxTopicCount = maxTopicCount; - return this; - } - - /** - * The maximum number of topics for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2000000`. - * @return maxTopicCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_TOPIC_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxTopicCount() { - return maxTopicCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_TOPIC_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxTopicCount(Long maxTopicCount) { - this.maxTopicCount = maxTopicCount; - } - - - public MsgVpnDistributedCacheCluster msgLifetime(Long msgLifetime) { - - this.msgLifetime = msgLifetime; - return this; - } - - /** - * The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the Cache Instance will remove the message. A lifetime of 0 results in the message being retained indefinitely. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return msgLifetime - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_LIFETIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMsgLifetime() { - return msgLifetime; - } - - - @JsonProperty(JSON_PROPERTY_MSG_LIFETIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgLifetime(Long msgLifetime) { - this.msgLifetime = msgLifetime; - } - - - public MsgVpnDistributedCacheCluster msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnDistributedCacheCluster newTopicAdvertisementEnabled(Boolean newTopicAdvertisementEnabled) { - - this.newTopicAdvertisementEnabled = newTopicAdvertisementEnabled; - return this; - } - - /** - * Enable or disable the advertising, onto the message bus, of new topics learned by each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return newTopicAdvertisementEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_NEW_TOPIC_ADVERTISEMENT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getNewTopicAdvertisementEnabled() { - return newTopicAdvertisementEnabled; - } - - - @JsonProperty(JSON_PROPERTY_NEW_TOPIC_ADVERTISEMENT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setNewTopicAdvertisementEnabled(Boolean newTopicAdvertisementEnabled) { - this.newTopicAdvertisementEnabled = newTopicAdvertisementEnabled; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheCluster msgVpnDistributedCacheCluster = (MsgVpnDistributedCacheCluster) o; - return Objects.equals(this.cacheName, msgVpnDistributedCacheCluster.cacheName) && - Objects.equals(this.clusterName, msgVpnDistributedCacheCluster.clusterName) && - Objects.equals(this.deliverToOneOverrideEnabled, msgVpnDistributedCacheCluster.deliverToOneOverrideEnabled) && - Objects.equals(this.enabled, msgVpnDistributedCacheCluster.enabled) && - Objects.equals(this.eventDataByteRateThreshold, msgVpnDistributedCacheCluster.eventDataByteRateThreshold) && - Objects.equals(this.eventDataMsgRateThreshold, msgVpnDistributedCacheCluster.eventDataMsgRateThreshold) && - Objects.equals(this.eventMaxMemoryThreshold, msgVpnDistributedCacheCluster.eventMaxMemoryThreshold) && - Objects.equals(this.eventMaxTopicsThreshold, msgVpnDistributedCacheCluster.eventMaxTopicsThreshold) && - Objects.equals(this.eventRequestQueueDepthThreshold, msgVpnDistributedCacheCluster.eventRequestQueueDepthThreshold) && - Objects.equals(this.eventRequestRateThreshold, msgVpnDistributedCacheCluster.eventRequestRateThreshold) && - Objects.equals(this.eventResponseRateThreshold, msgVpnDistributedCacheCluster.eventResponseRateThreshold) && - Objects.equals(this.globalCachingEnabled, msgVpnDistributedCacheCluster.globalCachingEnabled) && - Objects.equals(this.globalCachingHeartbeat, msgVpnDistributedCacheCluster.globalCachingHeartbeat) && - Objects.equals(this.globalCachingTopicLifetime, msgVpnDistributedCacheCluster.globalCachingTopicLifetime) && - Objects.equals(this.maxMemory, msgVpnDistributedCacheCluster.maxMemory) && - Objects.equals(this.maxMsgsPerTopic, msgVpnDistributedCacheCluster.maxMsgsPerTopic) && - Objects.equals(this.maxRequestQueueDepth, msgVpnDistributedCacheCluster.maxRequestQueueDepth) && - Objects.equals(this.maxTopicCount, msgVpnDistributedCacheCluster.maxTopicCount) && - Objects.equals(this.msgLifetime, msgVpnDistributedCacheCluster.msgLifetime) && - Objects.equals(this.msgVpnName, msgVpnDistributedCacheCluster.msgVpnName) && - Objects.equals(this.newTopicAdvertisementEnabled, msgVpnDistributedCacheCluster.newTopicAdvertisementEnabled); - } - - @Override - public int hashCode() { - return Objects.hash(cacheName, clusterName, deliverToOneOverrideEnabled, enabled, eventDataByteRateThreshold, eventDataMsgRateThreshold, eventMaxMemoryThreshold, eventMaxTopicsThreshold, eventRequestQueueDepthThreshold, eventRequestRateThreshold, eventResponseRateThreshold, globalCachingEnabled, globalCachingHeartbeat, globalCachingTopicLifetime, maxMemory, maxMsgsPerTopic, maxRequestQueueDepth, maxTopicCount, msgLifetime, msgVpnName, newTopicAdvertisementEnabled); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheCluster {\n"); - sb.append(" cacheName: ").append(toIndentedString(cacheName)).append("\n"); - sb.append(" clusterName: ").append(toIndentedString(clusterName)).append("\n"); - sb.append(" deliverToOneOverrideEnabled: ").append(toIndentedString(deliverToOneOverrideEnabled)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" eventDataByteRateThreshold: ").append(toIndentedString(eventDataByteRateThreshold)).append("\n"); - sb.append(" eventDataMsgRateThreshold: ").append(toIndentedString(eventDataMsgRateThreshold)).append("\n"); - sb.append(" eventMaxMemoryThreshold: ").append(toIndentedString(eventMaxMemoryThreshold)).append("\n"); - sb.append(" eventMaxTopicsThreshold: ").append(toIndentedString(eventMaxTopicsThreshold)).append("\n"); - sb.append(" eventRequestQueueDepthThreshold: ").append(toIndentedString(eventRequestQueueDepthThreshold)).append("\n"); - sb.append(" eventRequestRateThreshold: ").append(toIndentedString(eventRequestRateThreshold)).append("\n"); - sb.append(" eventResponseRateThreshold: ").append(toIndentedString(eventResponseRateThreshold)).append("\n"); - sb.append(" globalCachingEnabled: ").append(toIndentedString(globalCachingEnabled)).append("\n"); - sb.append(" globalCachingHeartbeat: ").append(toIndentedString(globalCachingHeartbeat)).append("\n"); - sb.append(" globalCachingTopicLifetime: ").append(toIndentedString(globalCachingTopicLifetime)).append("\n"); - sb.append(" maxMemory: ").append(toIndentedString(maxMemory)).append("\n"); - sb.append(" maxMsgsPerTopic: ").append(toIndentedString(maxMsgsPerTopic)).append("\n"); - sb.append(" maxRequestQueueDepth: ").append(toIndentedString(maxRequestQueueDepth)).append("\n"); - sb.append(" maxTopicCount: ").append(toIndentedString(maxTopicCount)).append("\n"); - sb.append(" msgLifetime: ").append(toIndentedString(msgLifetime)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" newTopicAdvertisementEnabled: ").append(toIndentedString(newTopicAdvertisementEnabled)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.java deleted file mode 100644 index 3a7f3ac5b..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.java +++ /dev/null @@ -1,200 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterGlobalCachingHomeCluster - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.JSON_PROPERTY_CACHE_NAME, - MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.JSON_PROPERTY_CLUSTER_NAME, - MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.JSON_PROPERTY_HOME_CLUSTER_NAME, - MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.JSON_PROPERTY_MSG_VPN_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterGlobalCachingHomeCluster { - public static final String JSON_PROPERTY_CACHE_NAME = "cacheName"; - private String cacheName; - - public static final String JSON_PROPERTY_CLUSTER_NAME = "clusterName"; - private String clusterName; - - public static final String JSON_PROPERTY_HOME_CLUSTER_NAME = "homeClusterName"; - private String homeClusterName; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public MsgVpnDistributedCacheClusterGlobalCachingHomeCluster() { - } - - public MsgVpnDistributedCacheClusterGlobalCachingHomeCluster cacheName(String cacheName) { - - this.cacheName = cacheName; - return this; - } - - /** - * The name of the Distributed Cache. - * @return cacheName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CACHE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCacheName() { - return cacheName; - } - - - @JsonProperty(JSON_PROPERTY_CACHE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCacheName(String cacheName) { - this.cacheName = cacheName; - } - - - public MsgVpnDistributedCacheClusterGlobalCachingHomeCluster clusterName(String clusterName) { - - this.clusterName = clusterName; - return this; - } - - /** - * The name of the Cache Cluster. - * @return clusterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClusterName() { - return clusterName; - } - - - @JsonProperty(JSON_PROPERTY_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClusterName(String clusterName) { - this.clusterName = clusterName; - } - - - public MsgVpnDistributedCacheClusterGlobalCachingHomeCluster homeClusterName(String homeClusterName) { - - this.homeClusterName = homeClusterName; - return this; - } - - /** - * The name of the remote Home Cache Cluster. - * @return homeClusterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_HOME_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getHomeClusterName() { - return homeClusterName; - } - - - @JsonProperty(JSON_PROPERTY_HOME_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHomeClusterName(String homeClusterName) { - this.homeClusterName = homeClusterName; - } - - - public MsgVpnDistributedCacheClusterGlobalCachingHomeCluster msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterGlobalCachingHomeCluster msgVpnDistributedCacheClusterGlobalCachingHomeCluster = (MsgVpnDistributedCacheClusterGlobalCachingHomeCluster) o; - return Objects.equals(this.cacheName, msgVpnDistributedCacheClusterGlobalCachingHomeCluster.cacheName) && - Objects.equals(this.clusterName, msgVpnDistributedCacheClusterGlobalCachingHomeCluster.clusterName) && - Objects.equals(this.homeClusterName, msgVpnDistributedCacheClusterGlobalCachingHomeCluster.homeClusterName) && - Objects.equals(this.msgVpnName, msgVpnDistributedCacheClusterGlobalCachingHomeCluster.msgVpnName); - } - - @Override - public int hashCode() { - return Objects.hash(cacheName, clusterName, homeClusterName, msgVpnName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterGlobalCachingHomeCluster {\n"); - sb.append(" cacheName: ").append(toIndentedString(cacheName)).append("\n"); - sb.append(" clusterName: ").append(toIndentedString(clusterName)).append("\n"); - sb.append(" homeClusterName: ").append(toIndentedString(homeClusterName)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks.java deleted file mode 100644 index e3f854676..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks.JSON_PROPERTY_TOPIC_PREFIXES_URI, - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks { - public static final String JSON_PROPERTY_TOPIC_PREFIXES_URI = "topicPrefixesUri"; - private String topicPrefixesUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks() { - } - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks topicPrefixesUri(String topicPrefixesUri) { - - this.topicPrefixesUri = topicPrefixesUri; - return this; - } - - /** - * The URI of this Home Cache Cluster's collection of Topic Prefix objects. - * @return topicPrefixesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOPIC_PREFIXES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTopicPrefixesUri() { - return topicPrefixesUri; - } - - - @JsonProperty(JSON_PROPERTY_TOPIC_PREFIXES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTopicPrefixesUri(String topicPrefixesUri) { - this.topicPrefixesUri = topicPrefixesUri; - } - - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Home Cache Cluster object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks msgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks = (MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks) o; - return Objects.equals(this.topicPrefixesUri, msgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks.topicPrefixesUri) && - Objects.equals(this.uri, msgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(topicPrefixesUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks {\n"); - sb.append(" topicPrefixesUri: ").append(toIndentedString(topicPrefixesUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.java deleted file mode 100644 index 2eac291cd..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.JSON_PROPERTY_DATA, - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.JSON_PROPERTY_LINKS, - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnDistributedCacheClusterGlobalCachingHomeCluster data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse() { - } - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse data(MsgVpnDistributedCacheClusterGlobalCachingHomeCluster data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnDistributedCacheClusterGlobalCachingHomeCluster getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnDistributedCacheClusterGlobalCachingHomeCluster data) { - this.data = data; - } - - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse links(MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks links) { - this.links = links; - } - - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse msgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse = (MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse) o; - return Objects.equals(this.data, msgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.data) && - Objects.equals(this.links, msgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.links) && - Objects.equals(this.meta, msgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.java deleted file mode 100644 index 2d5df9f1e..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.java +++ /dev/null @@ -1,232 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.JSON_PROPERTY_CACHE_NAME, - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.JSON_PROPERTY_CLUSTER_NAME, - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.JSON_PROPERTY_HOME_CLUSTER_NAME, - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.JSON_PROPERTY_TOPIC_PREFIX -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix { - public static final String JSON_PROPERTY_CACHE_NAME = "cacheName"; - private String cacheName; - - public static final String JSON_PROPERTY_CLUSTER_NAME = "clusterName"; - private String clusterName; - - public static final String JSON_PROPERTY_HOME_CLUSTER_NAME = "homeClusterName"; - private String homeClusterName; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_TOPIC_PREFIX = "topicPrefix"; - private String topicPrefix; - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix() { - } - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix cacheName(String cacheName) { - - this.cacheName = cacheName; - return this; - } - - /** - * The name of the Distributed Cache. - * @return cacheName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CACHE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCacheName() { - return cacheName; - } - - - @JsonProperty(JSON_PROPERTY_CACHE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCacheName(String cacheName) { - this.cacheName = cacheName; - } - - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix clusterName(String clusterName) { - - this.clusterName = clusterName; - return this; - } - - /** - * The name of the Cache Cluster. - * @return clusterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClusterName() { - return clusterName; - } - - - @JsonProperty(JSON_PROPERTY_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClusterName(String clusterName) { - this.clusterName = clusterName; - } - - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix homeClusterName(String homeClusterName) { - - this.homeClusterName = homeClusterName; - return this; - } - - /** - * The name of the remote Home Cache Cluster. - * @return homeClusterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_HOME_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getHomeClusterName() { - return homeClusterName; - } - - - @JsonProperty(JSON_PROPERTY_HOME_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHomeClusterName(String homeClusterName) { - this.homeClusterName = homeClusterName; - } - - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix topicPrefix(String topicPrefix) { - - this.topicPrefix = topicPrefix; - return this; - } - - /** - * A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. - * @return topicPrefix - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOPIC_PREFIX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTopicPrefix() { - return topicPrefix; - } - - - @JsonProperty(JSON_PROPERTY_TOPIC_PREFIX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTopicPrefix(String topicPrefix) { - this.topicPrefix = topicPrefix; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix msgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix = (MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix) o; - return Objects.equals(this.cacheName, msgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.cacheName) && - Objects.equals(this.clusterName, msgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.clusterName) && - Objects.equals(this.homeClusterName, msgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.homeClusterName) && - Objects.equals(this.msgVpnName, msgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.msgVpnName) && - Objects.equals(this.topicPrefix, msgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.topicPrefix); - } - - @Override - public int hashCode() { - return Objects.hash(cacheName, clusterName, homeClusterName, msgVpnName, topicPrefix); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix {\n"); - sb.append(" cacheName: ").append(toIndentedString(cacheName)).append("\n"); - sb.append(" clusterName: ").append(toIndentedString(clusterName)).append("\n"); - sb.append(" homeClusterName: ").append(toIndentedString(homeClusterName)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" topicPrefix: ").append(toIndentedString(topicPrefix)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks.java deleted file mode 100644 index c15c9eca6..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks() { - } - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Topic Prefix object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks msgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks = (MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks) o; - return Objects.equals(this.uri, msgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.java deleted file mode 100644 index 541b578f6..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.JSON_PROPERTY_DATA, - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.JSON_PROPERTY_LINKS, - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse() { - } - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse data(MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix data) { - this.data = data; - } - - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse links(MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks links) { - this.links = links; - } - - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse msgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse = (MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse) o; - return Objects.equals(this.data, msgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.data) && - Objects.equals(this.links, msgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.links) && - Objects.equals(this.meta, msgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.java deleted file mode 100644 index fe4f3ad8e..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.JSON_PROPERTY_DATA, - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.JSON_PROPERTY_LINKS, - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse() { - } - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse addDataItem(MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse addLinksItem(MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse msgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse = (MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse) o; - return Objects.equals(this.data, msgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.data) && - Objects.equals(this.links, msgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.links) && - Objects.equals(this.meta, msgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.java deleted file mode 100644 index 55d3159e4..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.JSON_PROPERTY_DATA, - MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.JSON_PROPERTY_LINKS, - MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse() { - } - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse addDataItem(MsgVpnDistributedCacheClusterGlobalCachingHomeCluster dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse addLinksItem(MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse msgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse = (MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse) o; - return Objects.equals(this.data, msgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.data) && - Objects.equals(this.links, msgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.links) && - Objects.equals(this.meta, msgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstance.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstance.java deleted file mode 100644 index 238bd44c0..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstance.java +++ /dev/null @@ -1,296 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterInstance - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterInstance.JSON_PROPERTY_AUTO_START_ENABLED, - MsgVpnDistributedCacheClusterInstance.JSON_PROPERTY_CACHE_NAME, - MsgVpnDistributedCacheClusterInstance.JSON_PROPERTY_CLUSTER_NAME, - MsgVpnDistributedCacheClusterInstance.JSON_PROPERTY_ENABLED, - MsgVpnDistributedCacheClusterInstance.JSON_PROPERTY_INSTANCE_NAME, - MsgVpnDistributedCacheClusterInstance.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnDistributedCacheClusterInstance.JSON_PROPERTY_STOP_ON_LOST_MSG_ENABLED -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterInstance { - public static final String JSON_PROPERTY_AUTO_START_ENABLED = "autoStartEnabled"; - private Boolean autoStartEnabled; - - public static final String JSON_PROPERTY_CACHE_NAME = "cacheName"; - private String cacheName; - - public static final String JSON_PROPERTY_CLUSTER_NAME = "clusterName"; - private String clusterName; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_INSTANCE_NAME = "instanceName"; - private String instanceName; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_STOP_ON_LOST_MSG_ENABLED = "stopOnLostMsgEnabled"; - private Boolean stopOnLostMsgEnabled; - - public MsgVpnDistributedCacheClusterInstance() { - } - - public MsgVpnDistributedCacheClusterInstance autoStartEnabled(Boolean autoStartEnabled) { - - this.autoStartEnabled = autoStartEnabled; - return this; - } - - /** - * Enable or disable auto-start for the Cache Instance. When enabled, the Cache Instance will automatically attempt to transition from the Stopped operational state to Up whenever it restarts or reconnects to the message broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return autoStartEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTO_START_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAutoStartEnabled() { - return autoStartEnabled; - } - - - @JsonProperty(JSON_PROPERTY_AUTO_START_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAutoStartEnabled(Boolean autoStartEnabled) { - this.autoStartEnabled = autoStartEnabled; - } - - - public MsgVpnDistributedCacheClusterInstance cacheName(String cacheName) { - - this.cacheName = cacheName; - return this; - } - - /** - * The name of the Distributed Cache. - * @return cacheName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CACHE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCacheName() { - return cacheName; - } - - - @JsonProperty(JSON_PROPERTY_CACHE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCacheName(String cacheName) { - this.cacheName = cacheName; - } - - - public MsgVpnDistributedCacheClusterInstance clusterName(String clusterName) { - - this.clusterName = clusterName; - return this; - } - - /** - * The name of the Cache Cluster. - * @return clusterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClusterName() { - return clusterName; - } - - - @JsonProperty(JSON_PROPERTY_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClusterName(String clusterName) { - this.clusterName = clusterName; - } - - - public MsgVpnDistributedCacheClusterInstance enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the Cache Instance. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public MsgVpnDistributedCacheClusterInstance instanceName(String instanceName) { - - this.instanceName = instanceName; - return this; - } - - /** - * The name of the Cache Instance. - * @return instanceName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_INSTANCE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getInstanceName() { - return instanceName; - } - - - @JsonProperty(JSON_PROPERTY_INSTANCE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setInstanceName(String instanceName) { - this.instanceName = instanceName; - } - - - public MsgVpnDistributedCacheClusterInstance msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnDistributedCacheClusterInstance stopOnLostMsgEnabled(Boolean stopOnLostMsgEnabled) { - - this.stopOnLostMsgEnabled = stopOnLostMsgEnabled; - return this; - } - - /** - * Enable or disable stop-on-lost-message for the Cache Instance. When enabled, the Cache Instance will transition to the stopped operational state upon losing a message. When stopped, it cannot accept or respond to cache requests, but continues to cache messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return stopOnLostMsgEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_STOP_ON_LOST_MSG_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getStopOnLostMsgEnabled() { - return stopOnLostMsgEnabled; - } - - - @JsonProperty(JSON_PROPERTY_STOP_ON_LOST_MSG_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setStopOnLostMsgEnabled(Boolean stopOnLostMsgEnabled) { - this.stopOnLostMsgEnabled = stopOnLostMsgEnabled; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterInstance msgVpnDistributedCacheClusterInstance = (MsgVpnDistributedCacheClusterInstance) o; - return Objects.equals(this.autoStartEnabled, msgVpnDistributedCacheClusterInstance.autoStartEnabled) && - Objects.equals(this.cacheName, msgVpnDistributedCacheClusterInstance.cacheName) && - Objects.equals(this.clusterName, msgVpnDistributedCacheClusterInstance.clusterName) && - Objects.equals(this.enabled, msgVpnDistributedCacheClusterInstance.enabled) && - Objects.equals(this.instanceName, msgVpnDistributedCacheClusterInstance.instanceName) && - Objects.equals(this.msgVpnName, msgVpnDistributedCacheClusterInstance.msgVpnName) && - Objects.equals(this.stopOnLostMsgEnabled, msgVpnDistributedCacheClusterInstance.stopOnLostMsgEnabled); - } - - @Override - public int hashCode() { - return Objects.hash(autoStartEnabled, cacheName, clusterName, enabled, instanceName, msgVpnName, stopOnLostMsgEnabled); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterInstance {\n"); - sb.append(" autoStartEnabled: ").append(toIndentedString(autoStartEnabled)).append("\n"); - sb.append(" cacheName: ").append(toIndentedString(cacheName)).append("\n"); - sb.append(" clusterName: ").append(toIndentedString(clusterName)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" instanceName: ").append(toIndentedString(instanceName)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" stopOnLostMsgEnabled: ").append(toIndentedString(stopOnLostMsgEnabled)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceLinks.java deleted file mode 100644 index 5ec63f44c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterInstanceLinks - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterInstanceLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterInstanceLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnDistributedCacheClusterInstanceLinks() { - } - - public MsgVpnDistributedCacheClusterInstanceLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Cache Instance object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterInstanceLinks msgVpnDistributedCacheClusterInstanceLinks = (MsgVpnDistributedCacheClusterInstanceLinks) o; - return Objects.equals(this.uri, msgVpnDistributedCacheClusterInstanceLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterInstanceLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceResponse.java deleted file mode 100644 index dcb60aa36..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstance; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstanceLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterInstanceResponse - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterInstanceResponse.JSON_PROPERTY_DATA, - MsgVpnDistributedCacheClusterInstanceResponse.JSON_PROPERTY_LINKS, - MsgVpnDistributedCacheClusterInstanceResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterInstanceResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnDistributedCacheClusterInstance data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnDistributedCacheClusterInstanceLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnDistributedCacheClusterInstanceResponse() { - } - - public MsgVpnDistributedCacheClusterInstanceResponse data(MsgVpnDistributedCacheClusterInstance data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnDistributedCacheClusterInstance getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnDistributedCacheClusterInstance data) { - this.data = data; - } - - - public MsgVpnDistributedCacheClusterInstanceResponse links(MsgVpnDistributedCacheClusterInstanceLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnDistributedCacheClusterInstanceLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnDistributedCacheClusterInstanceLinks links) { - this.links = links; - } - - - public MsgVpnDistributedCacheClusterInstanceResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterInstanceResponse msgVpnDistributedCacheClusterInstanceResponse = (MsgVpnDistributedCacheClusterInstanceResponse) o; - return Objects.equals(this.data, msgVpnDistributedCacheClusterInstanceResponse.data) && - Objects.equals(this.links, msgVpnDistributedCacheClusterInstanceResponse.links) && - Objects.equals(this.meta, msgVpnDistributedCacheClusterInstanceResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterInstanceResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstancesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstancesResponse.java deleted file mode 100644 index 53cb814d3..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstancesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstance; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstanceLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterInstancesResponse - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterInstancesResponse.JSON_PROPERTY_DATA, - MsgVpnDistributedCacheClusterInstancesResponse.JSON_PROPERTY_LINKS, - MsgVpnDistributedCacheClusterInstancesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterInstancesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnDistributedCacheClusterInstancesResponse() { - } - - public MsgVpnDistributedCacheClusterInstancesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnDistributedCacheClusterInstancesResponse addDataItem(MsgVpnDistributedCacheClusterInstance dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnDistributedCacheClusterInstancesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnDistributedCacheClusterInstancesResponse addLinksItem(MsgVpnDistributedCacheClusterInstanceLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnDistributedCacheClusterInstancesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterInstancesResponse msgVpnDistributedCacheClusterInstancesResponse = (MsgVpnDistributedCacheClusterInstancesResponse) o; - return Objects.equals(this.data, msgVpnDistributedCacheClusterInstancesResponse.data) && - Objects.equals(this.links, msgVpnDistributedCacheClusterInstancesResponse.links) && - Objects.equals(this.meta, msgVpnDistributedCacheClusterInstancesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterInstancesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterLinks.java deleted file mode 100644 index 7141c27de..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterLinks.java +++ /dev/null @@ -1,200 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterLinks - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterLinks.JSON_PROPERTY_GLOBAL_CACHING_HOME_CLUSTERS_URI, - MsgVpnDistributedCacheClusterLinks.JSON_PROPERTY_INSTANCES_URI, - MsgVpnDistributedCacheClusterLinks.JSON_PROPERTY_TOPICS_URI, - MsgVpnDistributedCacheClusterLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterLinks { - public static final String JSON_PROPERTY_GLOBAL_CACHING_HOME_CLUSTERS_URI = "globalCachingHomeClustersUri"; - private String globalCachingHomeClustersUri; - - public static final String JSON_PROPERTY_INSTANCES_URI = "instancesUri"; - private String instancesUri; - - public static final String JSON_PROPERTY_TOPICS_URI = "topicsUri"; - private String topicsUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnDistributedCacheClusterLinks() { - } - - public MsgVpnDistributedCacheClusterLinks globalCachingHomeClustersUri(String globalCachingHomeClustersUri) { - - this.globalCachingHomeClustersUri = globalCachingHomeClustersUri; - return this; - } - - /** - * The URI of this Cache Cluster's collection of Home Cache Cluster objects. - * @return globalCachingHomeClustersUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GLOBAL_CACHING_HOME_CLUSTERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getGlobalCachingHomeClustersUri() { - return globalCachingHomeClustersUri; - } - - - @JsonProperty(JSON_PROPERTY_GLOBAL_CACHING_HOME_CLUSTERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGlobalCachingHomeClustersUri(String globalCachingHomeClustersUri) { - this.globalCachingHomeClustersUri = globalCachingHomeClustersUri; - } - - - public MsgVpnDistributedCacheClusterLinks instancesUri(String instancesUri) { - - this.instancesUri = instancesUri; - return this; - } - - /** - * The URI of this Cache Cluster's collection of Cache Instance objects. - * @return instancesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_INSTANCES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getInstancesUri() { - return instancesUri; - } - - - @JsonProperty(JSON_PROPERTY_INSTANCES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setInstancesUri(String instancesUri) { - this.instancesUri = instancesUri; - } - - - public MsgVpnDistributedCacheClusterLinks topicsUri(String topicsUri) { - - this.topicsUri = topicsUri; - return this; - } - - /** - * The URI of this Cache Cluster's collection of Topic objects. - * @return topicsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOPICS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTopicsUri() { - return topicsUri; - } - - - @JsonProperty(JSON_PROPERTY_TOPICS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTopicsUri(String topicsUri) { - this.topicsUri = topicsUri; - } - - - public MsgVpnDistributedCacheClusterLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Cache Cluster object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterLinks msgVpnDistributedCacheClusterLinks = (MsgVpnDistributedCacheClusterLinks) o; - return Objects.equals(this.globalCachingHomeClustersUri, msgVpnDistributedCacheClusterLinks.globalCachingHomeClustersUri) && - Objects.equals(this.instancesUri, msgVpnDistributedCacheClusterLinks.instancesUri) && - Objects.equals(this.topicsUri, msgVpnDistributedCacheClusterLinks.topicsUri) && - Objects.equals(this.uri, msgVpnDistributedCacheClusterLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(globalCachingHomeClustersUri, instancesUri, topicsUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterLinks {\n"); - sb.append(" globalCachingHomeClustersUri: ").append(toIndentedString(globalCachingHomeClustersUri)).append("\n"); - sb.append(" instancesUri: ").append(toIndentedString(instancesUri)).append("\n"); - sb.append(" topicsUri: ").append(toIndentedString(topicsUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterResponse.java deleted file mode 100644 index 2b0ac7f81..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterResponse - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterResponse.JSON_PROPERTY_DATA, - MsgVpnDistributedCacheClusterResponse.JSON_PROPERTY_LINKS, - MsgVpnDistributedCacheClusterResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnDistributedCacheCluster data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnDistributedCacheClusterLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnDistributedCacheClusterResponse() { - } - - public MsgVpnDistributedCacheClusterResponse data(MsgVpnDistributedCacheCluster data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnDistributedCacheCluster getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnDistributedCacheCluster data) { - this.data = data; - } - - - public MsgVpnDistributedCacheClusterResponse links(MsgVpnDistributedCacheClusterLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnDistributedCacheClusterLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnDistributedCacheClusterLinks links) { - this.links = links; - } - - - public MsgVpnDistributedCacheClusterResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterResponse msgVpnDistributedCacheClusterResponse = (MsgVpnDistributedCacheClusterResponse) o; - return Objects.equals(this.data, msgVpnDistributedCacheClusterResponse.data) && - Objects.equals(this.links, msgVpnDistributedCacheClusterResponse.links) && - Objects.equals(this.meta, msgVpnDistributedCacheClusterResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopic.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopic.java deleted file mode 100644 index 9e6a62e8f..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopic.java +++ /dev/null @@ -1,200 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterTopic - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterTopic.JSON_PROPERTY_CACHE_NAME, - MsgVpnDistributedCacheClusterTopic.JSON_PROPERTY_CLUSTER_NAME, - MsgVpnDistributedCacheClusterTopic.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnDistributedCacheClusterTopic.JSON_PROPERTY_TOPIC -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterTopic { - public static final String JSON_PROPERTY_CACHE_NAME = "cacheName"; - private String cacheName; - - public static final String JSON_PROPERTY_CLUSTER_NAME = "clusterName"; - private String clusterName; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_TOPIC = "topic"; - private String topic; - - public MsgVpnDistributedCacheClusterTopic() { - } - - public MsgVpnDistributedCacheClusterTopic cacheName(String cacheName) { - - this.cacheName = cacheName; - return this; - } - - /** - * The name of the Distributed Cache. - * @return cacheName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CACHE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCacheName() { - return cacheName; - } - - - @JsonProperty(JSON_PROPERTY_CACHE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCacheName(String cacheName) { - this.cacheName = cacheName; - } - - - public MsgVpnDistributedCacheClusterTopic clusterName(String clusterName) { - - this.clusterName = clusterName; - return this; - } - - /** - * The name of the Cache Cluster. - * @return clusterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClusterName() { - return clusterName; - } - - - @JsonProperty(JSON_PROPERTY_CLUSTER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClusterName(String clusterName) { - this.clusterName = clusterName; - } - - - public MsgVpnDistributedCacheClusterTopic msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnDistributedCacheClusterTopic topic(String topic) { - - this.topic = topic; - return this; - } - - /** - * The value of the Topic in the form a/b/c. - * @return topic - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTopic() { - return topic; - } - - - @JsonProperty(JSON_PROPERTY_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTopic(String topic) { - this.topic = topic; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterTopic msgVpnDistributedCacheClusterTopic = (MsgVpnDistributedCacheClusterTopic) o; - return Objects.equals(this.cacheName, msgVpnDistributedCacheClusterTopic.cacheName) && - Objects.equals(this.clusterName, msgVpnDistributedCacheClusterTopic.clusterName) && - Objects.equals(this.msgVpnName, msgVpnDistributedCacheClusterTopic.msgVpnName) && - Objects.equals(this.topic, msgVpnDistributedCacheClusterTopic.topic); - } - - @Override - public int hashCode() { - return Objects.hash(cacheName, clusterName, msgVpnName, topic); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterTopic {\n"); - sb.append(" cacheName: ").append(toIndentedString(cacheName)).append("\n"); - sb.append(" clusterName: ").append(toIndentedString(clusterName)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" topic: ").append(toIndentedString(topic)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicLinks.java deleted file mode 100644 index 7c548ce8b..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterTopicLinks - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterTopicLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterTopicLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnDistributedCacheClusterTopicLinks() { - } - - public MsgVpnDistributedCacheClusterTopicLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Topic object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterTopicLinks msgVpnDistributedCacheClusterTopicLinks = (MsgVpnDistributedCacheClusterTopicLinks) o; - return Objects.equals(this.uri, msgVpnDistributedCacheClusterTopicLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterTopicLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicResponse.java deleted file mode 100644 index 55e6565d6..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopicLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterTopicResponse - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterTopicResponse.JSON_PROPERTY_DATA, - MsgVpnDistributedCacheClusterTopicResponse.JSON_PROPERTY_LINKS, - MsgVpnDistributedCacheClusterTopicResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterTopicResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnDistributedCacheClusterTopic data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnDistributedCacheClusterTopicLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnDistributedCacheClusterTopicResponse() { - } - - public MsgVpnDistributedCacheClusterTopicResponse data(MsgVpnDistributedCacheClusterTopic data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnDistributedCacheClusterTopic getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnDistributedCacheClusterTopic data) { - this.data = data; - } - - - public MsgVpnDistributedCacheClusterTopicResponse links(MsgVpnDistributedCacheClusterTopicLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnDistributedCacheClusterTopicLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnDistributedCacheClusterTopicLinks links) { - this.links = links; - } - - - public MsgVpnDistributedCacheClusterTopicResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterTopicResponse msgVpnDistributedCacheClusterTopicResponse = (MsgVpnDistributedCacheClusterTopicResponse) o; - return Objects.equals(this.data, msgVpnDistributedCacheClusterTopicResponse.data) && - Objects.equals(this.links, msgVpnDistributedCacheClusterTopicResponse.links) && - Objects.equals(this.meta, msgVpnDistributedCacheClusterTopicResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterTopicResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicsResponse.java deleted file mode 100644 index b0974e74c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopicLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClusterTopicsResponse - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClusterTopicsResponse.JSON_PROPERTY_DATA, - MsgVpnDistributedCacheClusterTopicsResponse.JSON_PROPERTY_LINKS, - MsgVpnDistributedCacheClusterTopicsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClusterTopicsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnDistributedCacheClusterTopicsResponse() { - } - - public MsgVpnDistributedCacheClusterTopicsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnDistributedCacheClusterTopicsResponse addDataItem(MsgVpnDistributedCacheClusterTopic dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnDistributedCacheClusterTopicsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnDistributedCacheClusterTopicsResponse addLinksItem(MsgVpnDistributedCacheClusterTopicLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnDistributedCacheClusterTopicsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClusterTopicsResponse msgVpnDistributedCacheClusterTopicsResponse = (MsgVpnDistributedCacheClusterTopicsResponse) o; - return Objects.equals(this.data, msgVpnDistributedCacheClusterTopicsResponse.data) && - Objects.equals(this.links, msgVpnDistributedCacheClusterTopicsResponse.links) && - Objects.equals(this.meta, msgVpnDistributedCacheClusterTopicsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClusterTopicsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClustersResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClustersResponse.java deleted file mode 100644 index e7beebaed..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClustersResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheClustersResponse - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheClustersResponse.JSON_PROPERTY_DATA, - MsgVpnDistributedCacheClustersResponse.JSON_PROPERTY_LINKS, - MsgVpnDistributedCacheClustersResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheClustersResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnDistributedCacheClustersResponse() { - } - - public MsgVpnDistributedCacheClustersResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnDistributedCacheClustersResponse addDataItem(MsgVpnDistributedCacheCluster dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnDistributedCacheClustersResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnDistributedCacheClustersResponse addLinksItem(MsgVpnDistributedCacheClusterLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnDistributedCacheClustersResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheClustersResponse msgVpnDistributedCacheClustersResponse = (MsgVpnDistributedCacheClustersResponse) o; - return Objects.equals(this.data, msgVpnDistributedCacheClustersResponse.data) && - Objects.equals(this.links, msgVpnDistributedCacheClustersResponse.links) && - Objects.equals(this.meta, msgVpnDistributedCacheClustersResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheClustersResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheLinks.java deleted file mode 100644 index 6a1aacaf8..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheLinks.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheLinks - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheLinks.JSON_PROPERTY_CLUSTERS_URI, - MsgVpnDistributedCacheLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheLinks { - public static final String JSON_PROPERTY_CLUSTERS_URI = "clustersUri"; - private String clustersUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnDistributedCacheLinks() { - } - - public MsgVpnDistributedCacheLinks clustersUri(String clustersUri) { - - this.clustersUri = clustersUri; - return this; - } - - /** - * The URI of this Distributed Cache's collection of Cache Cluster objects. - * @return clustersUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLUSTERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClustersUri() { - return clustersUri; - } - - - @JsonProperty(JSON_PROPERTY_CLUSTERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClustersUri(String clustersUri) { - this.clustersUri = clustersUri; - } - - - public MsgVpnDistributedCacheLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Distributed Cache object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheLinks msgVpnDistributedCacheLinks = (MsgVpnDistributedCacheLinks) o; - return Objects.equals(this.clustersUri, msgVpnDistributedCacheLinks.clustersUri) && - Objects.equals(this.uri, msgVpnDistributedCacheLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(clustersUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheLinks {\n"); - sb.append(" clustersUri: ").append(toIndentedString(clustersUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheResponse.java deleted file mode 100644 index b2214c13b..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCacheResponse - */ -@JsonPropertyOrder({ - MsgVpnDistributedCacheResponse.JSON_PROPERTY_DATA, - MsgVpnDistributedCacheResponse.JSON_PROPERTY_LINKS, - MsgVpnDistributedCacheResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCacheResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnDistributedCache data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnDistributedCacheLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnDistributedCacheResponse() { - } - - public MsgVpnDistributedCacheResponse data(MsgVpnDistributedCache data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnDistributedCache getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnDistributedCache data) { - this.data = data; - } - - - public MsgVpnDistributedCacheResponse links(MsgVpnDistributedCacheLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnDistributedCacheLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnDistributedCacheLinks links) { - this.links = links; - } - - - public MsgVpnDistributedCacheResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCacheResponse msgVpnDistributedCacheResponse = (MsgVpnDistributedCacheResponse) o; - return Objects.equals(this.data, msgVpnDistributedCacheResponse.data) && - Objects.equals(this.links, msgVpnDistributedCacheResponse.links) && - Objects.equals(this.meta, msgVpnDistributedCacheResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCacheResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCachesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCachesResponse.java deleted file mode 100644 index 6b6a48aa0..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCachesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDistributedCachesResponse - */ -@JsonPropertyOrder({ - MsgVpnDistributedCachesResponse.JSON_PROPERTY_DATA, - MsgVpnDistributedCachesResponse.JSON_PROPERTY_LINKS, - MsgVpnDistributedCachesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDistributedCachesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnDistributedCachesResponse() { - } - - public MsgVpnDistributedCachesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnDistributedCachesResponse addDataItem(MsgVpnDistributedCache dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnDistributedCachesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnDistributedCachesResponse addLinksItem(MsgVpnDistributedCacheLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnDistributedCachesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDistributedCachesResponse msgVpnDistributedCachesResponse = (MsgVpnDistributedCachesResponse) o; - return Objects.equals(this.data, msgVpnDistributedCachesResponse.data) && - Objects.equals(this.links, msgVpnDistributedCachesResponse.links) && - Objects.equals(this.meta, msgVpnDistributedCachesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDistributedCachesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridge.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridge.java deleted file mode 100644 index 62063fa59..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridge.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDmrBridge - */ -@JsonPropertyOrder({ - MsgVpnDmrBridge.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnDmrBridge.JSON_PROPERTY_REMOTE_MSG_VPN_NAME, - MsgVpnDmrBridge.JSON_PROPERTY_REMOTE_NODE_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDmrBridge { - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_REMOTE_MSG_VPN_NAME = "remoteMsgVpnName"; - private String remoteMsgVpnName; - - public static final String JSON_PROPERTY_REMOTE_NODE_NAME = "remoteNodeName"; - private String remoteNodeName; - - public MsgVpnDmrBridge() { - } - - public MsgVpnDmrBridge msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnDmrBridge remoteMsgVpnName(String remoteMsgVpnName) { - - this.remoteMsgVpnName = remoteMsgVpnName; - return this; - } - - /** - * The remote Message VPN of the DMR Bridge. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return remoteMsgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteMsgVpnName() { - return remoteMsgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteMsgVpnName(String remoteMsgVpnName) { - this.remoteMsgVpnName = remoteMsgVpnName; - } - - - public MsgVpnDmrBridge remoteNodeName(String remoteNodeName) { - - this.remoteNodeName = remoteNodeName; - return this; - } - - /** - * The name of the node at the remote end of the DMR Bridge. - * @return remoteNodeName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_NODE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteNodeName() { - return remoteNodeName; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_NODE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteNodeName(String remoteNodeName) { - this.remoteNodeName = remoteNodeName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDmrBridge msgVpnDmrBridge = (MsgVpnDmrBridge) o; - return Objects.equals(this.msgVpnName, msgVpnDmrBridge.msgVpnName) && - Objects.equals(this.remoteMsgVpnName, msgVpnDmrBridge.remoteMsgVpnName) && - Objects.equals(this.remoteNodeName, msgVpnDmrBridge.remoteNodeName); - } - - @Override - public int hashCode() { - return Objects.hash(msgVpnName, remoteMsgVpnName, remoteNodeName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDmrBridge {\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" remoteMsgVpnName: ").append(toIndentedString(remoteMsgVpnName)).append("\n"); - sb.append(" remoteNodeName: ").append(toIndentedString(remoteNodeName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeLinks.java deleted file mode 100644 index 2129e3d69..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDmrBridgeLinks - */ -@JsonPropertyOrder({ - MsgVpnDmrBridgeLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDmrBridgeLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnDmrBridgeLinks() { - } - - public MsgVpnDmrBridgeLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this DMR Bridge object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDmrBridgeLinks msgVpnDmrBridgeLinks = (MsgVpnDmrBridgeLinks) o; - return Objects.equals(this.uri, msgVpnDmrBridgeLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDmrBridgeLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeResponse.java deleted file mode 100644 index 955f5408e..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridgeLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDmrBridgeResponse - */ -@JsonPropertyOrder({ - MsgVpnDmrBridgeResponse.JSON_PROPERTY_DATA, - MsgVpnDmrBridgeResponse.JSON_PROPERTY_LINKS, - MsgVpnDmrBridgeResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDmrBridgeResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnDmrBridge data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnDmrBridgeLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnDmrBridgeResponse() { - } - - public MsgVpnDmrBridgeResponse data(MsgVpnDmrBridge data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnDmrBridge getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnDmrBridge data) { - this.data = data; - } - - - public MsgVpnDmrBridgeResponse links(MsgVpnDmrBridgeLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnDmrBridgeLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnDmrBridgeLinks links) { - this.links = links; - } - - - public MsgVpnDmrBridgeResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDmrBridgeResponse msgVpnDmrBridgeResponse = (MsgVpnDmrBridgeResponse) o; - return Objects.equals(this.data, msgVpnDmrBridgeResponse.data) && - Objects.equals(this.links, msgVpnDmrBridgeResponse.links) && - Objects.equals(this.meta, msgVpnDmrBridgeResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDmrBridgeResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgesResponse.java deleted file mode 100644 index 154a53ffc..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridgeLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnDmrBridgesResponse - */ -@JsonPropertyOrder({ - MsgVpnDmrBridgesResponse.JSON_PROPERTY_DATA, - MsgVpnDmrBridgesResponse.JSON_PROPERTY_LINKS, - MsgVpnDmrBridgesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnDmrBridgesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnDmrBridgesResponse() { - } - - public MsgVpnDmrBridgesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnDmrBridgesResponse addDataItem(MsgVpnDmrBridge dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnDmrBridgesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnDmrBridgesResponse addLinksItem(MsgVpnDmrBridgeLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnDmrBridgesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnDmrBridgesResponse msgVpnDmrBridgesResponse = (MsgVpnDmrBridgesResponse) o; - return Objects.equals(this.data, msgVpnDmrBridgesResponse.data) && - Objects.equals(this.links, msgVpnDmrBridgesResponse.links) && - Objects.equals(this.meta, msgVpnDmrBridgesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnDmrBridgesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoriesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoriesResponse.java deleted file mode 100644 index a9dfd60b3..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoriesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactory; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactoryLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnJndiConnectionFactoriesResponse - */ -@JsonPropertyOrder({ - MsgVpnJndiConnectionFactoriesResponse.JSON_PROPERTY_DATA, - MsgVpnJndiConnectionFactoriesResponse.JSON_PROPERTY_LINKS, - MsgVpnJndiConnectionFactoriesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnJndiConnectionFactoriesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnJndiConnectionFactoriesResponse() { - } - - public MsgVpnJndiConnectionFactoriesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnJndiConnectionFactoriesResponse addDataItem(MsgVpnJndiConnectionFactory dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnJndiConnectionFactoriesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnJndiConnectionFactoriesResponse addLinksItem(MsgVpnJndiConnectionFactoryLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnJndiConnectionFactoriesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnJndiConnectionFactoriesResponse msgVpnJndiConnectionFactoriesResponse = (MsgVpnJndiConnectionFactoriesResponse) o; - return Objects.equals(this.data, msgVpnJndiConnectionFactoriesResponse.data) && - Objects.equals(this.links, msgVpnJndiConnectionFactoriesResponse.links) && - Objects.equals(this.meta, msgVpnJndiConnectionFactoriesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnJndiConnectionFactoriesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactory.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactory.java deleted file mode 100644 index 5680ec924..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactory.java +++ /dev/null @@ -1,1419 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnJndiConnectionFactory - */ -@JsonPropertyOrder({ - MsgVpnJndiConnectionFactory.JSON_PROPERTY_ALLOW_DUPLICATE_CLIENT_ID_ENABLED, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_CLIENT_DESCRIPTION, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_CLIENT_ID, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_CONNECTION_FACTORY_NAME, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_DTO_RECEIVE_OVERRIDE_ENABLED, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_DTO_RECEIVE_SUBSCRIBER_LOCAL_PRIORITY, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_DTO_RECEIVE_SUBSCRIBER_NETWORK_PRIORITY, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_DTO_SEND_ENABLED, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_DYNAMIC_ENDPOINT_CREATE_DURABLE_ENABLED, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_DYNAMIC_ENDPOINT_RESPECT_TTL_ENABLED, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_GUARANTEED_RECEIVE_ACK_TIMEOUT, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_GUARANTEED_RECEIVE_RECONNECT_RETRY_COUNT, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_GUARANTEED_RECEIVE_RECONNECT_RETRY_WAIT, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_GUARANTEED_RECEIVE_WINDOW_SIZE, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_GUARANTEED_RECEIVE_WINDOW_SIZE_ACK_THRESHOLD, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_GUARANTEED_SEND_ACK_TIMEOUT, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_GUARANTEED_SEND_WINDOW_SIZE, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_MESSAGING_DEFAULT_DELIVERY_MODE, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_MESSAGING_DEFAULT_DMQ_ELIGIBLE_ENABLED, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_MESSAGING_DEFAULT_ELIDING_ELIGIBLE_ENABLED, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_MESSAGING_JMSX_USER_ID_ENABLED, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_MESSAGING_TEXT_IN_XML_PAYLOAD_ENABLED, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_COMPRESSION_LEVEL, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_CONNECT_RETRY_COUNT, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_CONNECT_RETRY_PER_HOST_COUNT, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_CONNECT_TIMEOUT, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_DIRECT_TRANSPORT_ENABLED, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_KEEPALIVE_COUNT, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_KEEPALIVE_ENABLED, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_KEEPALIVE_INTERVAL, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_MSG_CALLBACK_ON_IO_THREAD_ENABLED, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_OPTIMIZE_DIRECT_ENABLED, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_PORT, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_READ_TIMEOUT, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_RECEIVE_BUFFER_SIZE, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_RECONNECT_RETRY_COUNT, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_RECONNECT_RETRY_WAIT, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_SEND_BUFFER_SIZE, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_TRANSPORT_TCP_NO_DELAY_ENABLED, - MsgVpnJndiConnectionFactory.JSON_PROPERTY_XA_ENABLED -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnJndiConnectionFactory { - public static final String JSON_PROPERTY_ALLOW_DUPLICATE_CLIENT_ID_ENABLED = "allowDuplicateClientIdEnabled"; - private Boolean allowDuplicateClientIdEnabled; - - public static final String JSON_PROPERTY_CLIENT_DESCRIPTION = "clientDescription"; - private String clientDescription; - - public static final String JSON_PROPERTY_CLIENT_ID = "clientId"; - private String clientId; - - public static final String JSON_PROPERTY_CONNECTION_FACTORY_NAME = "connectionFactoryName"; - private String connectionFactoryName; - - public static final String JSON_PROPERTY_DTO_RECEIVE_OVERRIDE_ENABLED = "dtoReceiveOverrideEnabled"; - private Boolean dtoReceiveOverrideEnabled; - - public static final String JSON_PROPERTY_DTO_RECEIVE_SUBSCRIBER_LOCAL_PRIORITY = "dtoReceiveSubscriberLocalPriority"; - private Integer dtoReceiveSubscriberLocalPriority; - - public static final String JSON_PROPERTY_DTO_RECEIVE_SUBSCRIBER_NETWORK_PRIORITY = "dtoReceiveSubscriberNetworkPriority"; - private Integer dtoReceiveSubscriberNetworkPriority; - - public static final String JSON_PROPERTY_DTO_SEND_ENABLED = "dtoSendEnabled"; - private Boolean dtoSendEnabled; - - public static final String JSON_PROPERTY_DYNAMIC_ENDPOINT_CREATE_DURABLE_ENABLED = "dynamicEndpointCreateDurableEnabled"; - private Boolean dynamicEndpointCreateDurableEnabled; - - public static final String JSON_PROPERTY_DYNAMIC_ENDPOINT_RESPECT_TTL_ENABLED = "dynamicEndpointRespectTtlEnabled"; - private Boolean dynamicEndpointRespectTtlEnabled; - - public static final String JSON_PROPERTY_GUARANTEED_RECEIVE_ACK_TIMEOUT = "guaranteedReceiveAckTimeout"; - private Integer guaranteedReceiveAckTimeout; - - public static final String JSON_PROPERTY_GUARANTEED_RECEIVE_RECONNECT_RETRY_COUNT = "guaranteedReceiveReconnectRetryCount"; - private Integer guaranteedReceiveReconnectRetryCount; - - public static final String JSON_PROPERTY_GUARANTEED_RECEIVE_RECONNECT_RETRY_WAIT = "guaranteedReceiveReconnectRetryWait"; - private Integer guaranteedReceiveReconnectRetryWait; - - public static final String JSON_PROPERTY_GUARANTEED_RECEIVE_WINDOW_SIZE = "guaranteedReceiveWindowSize"; - private Integer guaranteedReceiveWindowSize; - - public static final String JSON_PROPERTY_GUARANTEED_RECEIVE_WINDOW_SIZE_ACK_THRESHOLD = "guaranteedReceiveWindowSizeAckThreshold"; - private Integer guaranteedReceiveWindowSizeAckThreshold; - - public static final String JSON_PROPERTY_GUARANTEED_SEND_ACK_TIMEOUT = "guaranteedSendAckTimeout"; - private Integer guaranteedSendAckTimeout; - - public static final String JSON_PROPERTY_GUARANTEED_SEND_WINDOW_SIZE = "guaranteedSendWindowSize"; - private Integer guaranteedSendWindowSize; - - /** - * The default delivery mode for messages sent by the Publisher (Producer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"persistent\"`. The allowed values and their meaning are: <pre> \"persistent\" - The broker spools messages (persists in the Message Spool) as part of the send operation. \"non-persistent\" - The broker does not spool messages (does not persist in the Message Spool) as part of the send operation. </pre> - */ - public enum MessagingDefaultDeliveryModeEnum { - PERSISTENT("persistent"), - - NON_PERSISTENT("non-persistent"); - - private String value; - - MessagingDefaultDeliveryModeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static MessagingDefaultDeliveryModeEnum fromValue(String value) { - for (MessagingDefaultDeliveryModeEnum b : MessagingDefaultDeliveryModeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_MESSAGING_DEFAULT_DELIVERY_MODE = "messagingDefaultDeliveryMode"; - private MessagingDefaultDeliveryModeEnum messagingDefaultDeliveryMode; - - public static final String JSON_PROPERTY_MESSAGING_DEFAULT_DMQ_ELIGIBLE_ENABLED = "messagingDefaultDmqEligibleEnabled"; - private Boolean messagingDefaultDmqEligibleEnabled; - - public static final String JSON_PROPERTY_MESSAGING_DEFAULT_ELIDING_ELIGIBLE_ENABLED = "messagingDefaultElidingEligibleEnabled"; - private Boolean messagingDefaultElidingEligibleEnabled; - - public static final String JSON_PROPERTY_MESSAGING_JMSX_USER_ID_ENABLED = "messagingJmsxUserIdEnabled"; - private Boolean messagingJmsxUserIdEnabled; - - public static final String JSON_PROPERTY_MESSAGING_TEXT_IN_XML_PAYLOAD_ENABLED = "messagingTextInXmlPayloadEnabled"; - private Boolean messagingTextInXmlPayloadEnabled; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_TRANSPORT_COMPRESSION_LEVEL = "transportCompressionLevel"; - private Integer transportCompressionLevel; - - public static final String JSON_PROPERTY_TRANSPORT_CONNECT_RETRY_COUNT = "transportConnectRetryCount"; - private Integer transportConnectRetryCount; - - public static final String JSON_PROPERTY_TRANSPORT_CONNECT_RETRY_PER_HOST_COUNT = "transportConnectRetryPerHostCount"; - private Integer transportConnectRetryPerHostCount; - - public static final String JSON_PROPERTY_TRANSPORT_CONNECT_TIMEOUT = "transportConnectTimeout"; - private Integer transportConnectTimeout; - - public static final String JSON_PROPERTY_TRANSPORT_DIRECT_TRANSPORT_ENABLED = "transportDirectTransportEnabled"; - private Boolean transportDirectTransportEnabled; - - public static final String JSON_PROPERTY_TRANSPORT_KEEPALIVE_COUNT = "transportKeepaliveCount"; - private Integer transportKeepaliveCount; - - public static final String JSON_PROPERTY_TRANSPORT_KEEPALIVE_ENABLED = "transportKeepaliveEnabled"; - private Boolean transportKeepaliveEnabled; - - public static final String JSON_PROPERTY_TRANSPORT_KEEPALIVE_INTERVAL = "transportKeepaliveInterval"; - private Integer transportKeepaliveInterval; - - public static final String JSON_PROPERTY_TRANSPORT_MSG_CALLBACK_ON_IO_THREAD_ENABLED = "transportMsgCallbackOnIoThreadEnabled"; - private Boolean transportMsgCallbackOnIoThreadEnabled; - - public static final String JSON_PROPERTY_TRANSPORT_OPTIMIZE_DIRECT_ENABLED = "transportOptimizeDirectEnabled"; - private Boolean transportOptimizeDirectEnabled; - - public static final String JSON_PROPERTY_TRANSPORT_PORT = "transportPort"; - private Integer transportPort; - - public static final String JSON_PROPERTY_TRANSPORT_READ_TIMEOUT = "transportReadTimeout"; - private Integer transportReadTimeout; - - public static final String JSON_PROPERTY_TRANSPORT_RECEIVE_BUFFER_SIZE = "transportReceiveBufferSize"; - private Integer transportReceiveBufferSize; - - public static final String JSON_PROPERTY_TRANSPORT_RECONNECT_RETRY_COUNT = "transportReconnectRetryCount"; - private Integer transportReconnectRetryCount; - - public static final String JSON_PROPERTY_TRANSPORT_RECONNECT_RETRY_WAIT = "transportReconnectRetryWait"; - private Integer transportReconnectRetryWait; - - public static final String JSON_PROPERTY_TRANSPORT_SEND_BUFFER_SIZE = "transportSendBufferSize"; - private Integer transportSendBufferSize; - - public static final String JSON_PROPERTY_TRANSPORT_TCP_NO_DELAY_ENABLED = "transportTcpNoDelayEnabled"; - private Boolean transportTcpNoDelayEnabled; - - public static final String JSON_PROPERTY_XA_ENABLED = "xaEnabled"; - private Boolean xaEnabled; - - public MsgVpnJndiConnectionFactory() { - } - - public MsgVpnJndiConnectionFactory allowDuplicateClientIdEnabled(Boolean allowDuplicateClientIdEnabled) { - - this.allowDuplicateClientIdEnabled = allowDuplicateClientIdEnabled; - return this; - } - - /** - * Enable or disable whether new JMS connections can use the same Client identifier (ID) as an existing connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.3. - * @return allowDuplicateClientIdEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_DUPLICATE_CLIENT_ID_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowDuplicateClientIdEnabled() { - return allowDuplicateClientIdEnabled; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_DUPLICATE_CLIENT_ID_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowDuplicateClientIdEnabled(Boolean allowDuplicateClientIdEnabled) { - this.allowDuplicateClientIdEnabled = allowDuplicateClientIdEnabled; - } - - - public MsgVpnJndiConnectionFactory clientDescription(String clientDescription) { - - this.clientDescription = clientDescription; - return this; - } - - /** - * The description of the Client. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return clientDescription - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientDescription() { - return clientDescription; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientDescription(String clientDescription) { - this.clientDescription = clientDescription; - } - - - public MsgVpnJndiConnectionFactory clientId(String clientId) { - - this.clientId = clientId; - return this; - } - - /** - * The Client identifier (ID). If not specified, a unique value for it will be generated. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return clientId - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientId() { - return clientId; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientId(String clientId) { - this.clientId = clientId; - } - - - public MsgVpnJndiConnectionFactory connectionFactoryName(String connectionFactoryName) { - - this.connectionFactoryName = connectionFactoryName; - return this; - } - - /** - * The name of the JMS Connection Factory. - * @return connectionFactoryName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONNECTION_FACTORY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getConnectionFactoryName() { - return connectionFactoryName; - } - - - @JsonProperty(JSON_PROPERTY_CONNECTION_FACTORY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConnectionFactoryName(String connectionFactoryName) { - this.connectionFactoryName = connectionFactoryName; - } - - - public MsgVpnJndiConnectionFactory dtoReceiveOverrideEnabled(Boolean dtoReceiveOverrideEnabled) { - - this.dtoReceiveOverrideEnabled = dtoReceiveOverrideEnabled; - return this; - } - - /** - * Enable or disable overriding by the Subscriber (Consumer) of the deliver-to-one (DTO) property on messages. When enabled, the Subscriber can receive all DTO tagged messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return dtoReceiveOverrideEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DTO_RECEIVE_OVERRIDE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getDtoReceiveOverrideEnabled() { - return dtoReceiveOverrideEnabled; - } - - - @JsonProperty(JSON_PROPERTY_DTO_RECEIVE_OVERRIDE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDtoReceiveOverrideEnabled(Boolean dtoReceiveOverrideEnabled) { - this.dtoReceiveOverrideEnabled = dtoReceiveOverrideEnabled; - } - - - public MsgVpnJndiConnectionFactory dtoReceiveSubscriberLocalPriority(Integer dtoReceiveSubscriberLocalPriority) { - - this.dtoReceiveSubscriberLocalPriority = dtoReceiveSubscriberLocalPriority; - return this; - } - - /** - * The priority for receiving deliver-to-one (DTO) messages by the Subscriber (Consumer) if the messages are published on the local broker that the Subscriber is directly connected to. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. - * @return dtoReceiveSubscriberLocalPriority - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DTO_RECEIVE_SUBSCRIBER_LOCAL_PRIORITY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getDtoReceiveSubscriberLocalPriority() { - return dtoReceiveSubscriberLocalPriority; - } - - - @JsonProperty(JSON_PROPERTY_DTO_RECEIVE_SUBSCRIBER_LOCAL_PRIORITY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDtoReceiveSubscriberLocalPriority(Integer dtoReceiveSubscriberLocalPriority) { - this.dtoReceiveSubscriberLocalPriority = dtoReceiveSubscriberLocalPriority; - } - - - public MsgVpnJndiConnectionFactory dtoReceiveSubscriberNetworkPriority(Integer dtoReceiveSubscriberNetworkPriority) { - - this.dtoReceiveSubscriberNetworkPriority = dtoReceiveSubscriberNetworkPriority; - return this; - } - - /** - * The priority for receiving deliver-to-one (DTO) messages by the Subscriber (Consumer) if the messages are published on a remote broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. - * @return dtoReceiveSubscriberNetworkPriority - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DTO_RECEIVE_SUBSCRIBER_NETWORK_PRIORITY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getDtoReceiveSubscriberNetworkPriority() { - return dtoReceiveSubscriberNetworkPriority; - } - - - @JsonProperty(JSON_PROPERTY_DTO_RECEIVE_SUBSCRIBER_NETWORK_PRIORITY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDtoReceiveSubscriberNetworkPriority(Integer dtoReceiveSubscriberNetworkPriority) { - this.dtoReceiveSubscriberNetworkPriority = dtoReceiveSubscriberNetworkPriority; - } - - - public MsgVpnJndiConnectionFactory dtoSendEnabled(Boolean dtoSendEnabled) { - - this.dtoSendEnabled = dtoSendEnabled; - return this; - } - - /** - * Enable or disable the deliver-to-one (DTO) property on messages sent by the Publisher (Producer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return dtoSendEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DTO_SEND_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getDtoSendEnabled() { - return dtoSendEnabled; - } - - - @JsonProperty(JSON_PROPERTY_DTO_SEND_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDtoSendEnabled(Boolean dtoSendEnabled) { - this.dtoSendEnabled = dtoSendEnabled; - } - - - public MsgVpnJndiConnectionFactory dynamicEndpointCreateDurableEnabled(Boolean dynamicEndpointCreateDurableEnabled) { - - this.dynamicEndpointCreateDurableEnabled = dynamicEndpointCreateDurableEnabled; - return this; - } - - /** - * Enable or disable whether a durable endpoint will be dynamically created on the broker when the client calls \"Session.createDurableSubscriber()\" or \"Session.createQueue()\". The created endpoint respects the message time-to-live (TTL) according to the \"dynamicEndpointRespectTtlEnabled\" property. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return dynamicEndpointCreateDurableEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DYNAMIC_ENDPOINT_CREATE_DURABLE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getDynamicEndpointCreateDurableEnabled() { - return dynamicEndpointCreateDurableEnabled; - } - - - @JsonProperty(JSON_PROPERTY_DYNAMIC_ENDPOINT_CREATE_DURABLE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDynamicEndpointCreateDurableEnabled(Boolean dynamicEndpointCreateDurableEnabled) { - this.dynamicEndpointCreateDurableEnabled = dynamicEndpointCreateDurableEnabled; - } - - - public MsgVpnJndiConnectionFactory dynamicEndpointRespectTtlEnabled(Boolean dynamicEndpointRespectTtlEnabled) { - - this.dynamicEndpointRespectTtlEnabled = dynamicEndpointRespectTtlEnabled; - return this; - } - - /** - * Enable or disable whether dynamically created durable and non-durable endpoints respect the message time-to-live (TTL) property. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return dynamicEndpointRespectTtlEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DYNAMIC_ENDPOINT_RESPECT_TTL_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getDynamicEndpointRespectTtlEnabled() { - return dynamicEndpointRespectTtlEnabled; - } - - - @JsonProperty(JSON_PROPERTY_DYNAMIC_ENDPOINT_RESPECT_TTL_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDynamicEndpointRespectTtlEnabled(Boolean dynamicEndpointRespectTtlEnabled) { - this.dynamicEndpointRespectTtlEnabled = dynamicEndpointRespectTtlEnabled; - } - - - public MsgVpnJndiConnectionFactory guaranteedReceiveAckTimeout(Integer guaranteedReceiveAckTimeout) { - - this.guaranteedReceiveAckTimeout = guaranteedReceiveAckTimeout; - return this; - } - - /** - * The timeout for sending the acknowledgement (ACK) for guaranteed messages received by the Subscriber (Consumer), in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. - * @return guaranteedReceiveAckTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_RECEIVE_ACK_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getGuaranteedReceiveAckTimeout() { - return guaranteedReceiveAckTimeout; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_RECEIVE_ACK_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedReceiveAckTimeout(Integer guaranteedReceiveAckTimeout) { - this.guaranteedReceiveAckTimeout = guaranteedReceiveAckTimeout; - } - - - public MsgVpnJndiConnectionFactory guaranteedReceiveReconnectRetryCount(Integer guaranteedReceiveReconnectRetryCount) { - - this.guaranteedReceiveReconnectRetryCount = guaranteedReceiveReconnectRetryCount; - return this; - } - - /** - * The maximum number of attempts to reconnect to the host or list of hosts after the guaranteed messaging connection has been lost. The value \"-1\" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. Available since 2.14. - * @return guaranteedReceiveReconnectRetryCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_RECEIVE_RECONNECT_RETRY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getGuaranteedReceiveReconnectRetryCount() { - return guaranteedReceiveReconnectRetryCount; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_RECEIVE_RECONNECT_RETRY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedReceiveReconnectRetryCount(Integer guaranteedReceiveReconnectRetryCount) { - this.guaranteedReceiveReconnectRetryCount = guaranteedReceiveReconnectRetryCount; - } - - - public MsgVpnJndiConnectionFactory guaranteedReceiveReconnectRetryWait(Integer guaranteedReceiveReconnectRetryWait) { - - this.guaranteedReceiveReconnectRetryWait = guaranteedReceiveReconnectRetryWait; - return this; - } - - /** - * The amount of time to wait before making another attempt to connect or reconnect to the host after the guaranteed messaging connection has been lost, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`. Available since 2.14. - * @return guaranteedReceiveReconnectRetryWait - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_RECEIVE_RECONNECT_RETRY_WAIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getGuaranteedReceiveReconnectRetryWait() { - return guaranteedReceiveReconnectRetryWait; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_RECEIVE_RECONNECT_RETRY_WAIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedReceiveReconnectRetryWait(Integer guaranteedReceiveReconnectRetryWait) { - this.guaranteedReceiveReconnectRetryWait = guaranteedReceiveReconnectRetryWait; - } - - - public MsgVpnJndiConnectionFactory guaranteedReceiveWindowSize(Integer guaranteedReceiveWindowSize) { - - this.guaranteedReceiveWindowSize = guaranteedReceiveWindowSize; - return this; - } - - /** - * The size of the window for guaranteed messages received by the Subscriber (Consumer), in messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `18`. - * @return guaranteedReceiveWindowSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_RECEIVE_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getGuaranteedReceiveWindowSize() { - return guaranteedReceiveWindowSize; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_RECEIVE_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedReceiveWindowSize(Integer guaranteedReceiveWindowSize) { - this.guaranteedReceiveWindowSize = guaranteedReceiveWindowSize; - } - - - public MsgVpnJndiConnectionFactory guaranteedReceiveWindowSizeAckThreshold(Integer guaranteedReceiveWindowSizeAckThreshold) { - - this.guaranteedReceiveWindowSizeAckThreshold = guaranteedReceiveWindowSizeAckThreshold; - return this; - } - - /** - * The threshold for sending the acknowledgement (ACK) for guaranteed messages received by the Subscriber (Consumer) as a percentage of `guaranteedReceiveWindowSize`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `60`. - * @return guaranteedReceiveWindowSizeAckThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_RECEIVE_WINDOW_SIZE_ACK_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getGuaranteedReceiveWindowSizeAckThreshold() { - return guaranteedReceiveWindowSizeAckThreshold; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_RECEIVE_WINDOW_SIZE_ACK_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedReceiveWindowSizeAckThreshold(Integer guaranteedReceiveWindowSizeAckThreshold) { - this.guaranteedReceiveWindowSizeAckThreshold = guaranteedReceiveWindowSizeAckThreshold; - } - - - public MsgVpnJndiConnectionFactory guaranteedSendAckTimeout(Integer guaranteedSendAckTimeout) { - - this.guaranteedSendAckTimeout = guaranteedSendAckTimeout; - return this; - } - - /** - * The timeout for receiving the acknowledgement (ACK) for guaranteed messages sent by the Publisher (Producer), in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2000`. - * @return guaranteedSendAckTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_SEND_ACK_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getGuaranteedSendAckTimeout() { - return guaranteedSendAckTimeout; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_SEND_ACK_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedSendAckTimeout(Integer guaranteedSendAckTimeout) { - this.guaranteedSendAckTimeout = guaranteedSendAckTimeout; - } - - - public MsgVpnJndiConnectionFactory guaranteedSendWindowSize(Integer guaranteedSendWindowSize) { - - this.guaranteedSendWindowSize = guaranteedSendWindowSize; - return this; - } - - /** - * The size of the window for non-persistent guaranteed messages sent by the Publisher (Producer), in messages. For persistent messages the window size is fixed at 1. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`. - * @return guaranteedSendWindowSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GUARANTEED_SEND_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getGuaranteedSendWindowSize() { - return guaranteedSendWindowSize; - } - - - @JsonProperty(JSON_PROPERTY_GUARANTEED_SEND_WINDOW_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGuaranteedSendWindowSize(Integer guaranteedSendWindowSize) { - this.guaranteedSendWindowSize = guaranteedSendWindowSize; - } - - - public MsgVpnJndiConnectionFactory messagingDefaultDeliveryMode(MessagingDefaultDeliveryModeEnum messagingDefaultDeliveryMode) { - - this.messagingDefaultDeliveryMode = messagingDefaultDeliveryMode; - return this; - } - - /** - * The default delivery mode for messages sent by the Publisher (Producer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"persistent\"`. The allowed values and their meaning are: <pre> \"persistent\" - The broker spools messages (persists in the Message Spool) as part of the send operation. \"non-persistent\" - The broker does not spool messages (does not persist in the Message Spool) as part of the send operation. </pre> - * @return messagingDefaultDeliveryMode - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MESSAGING_DEFAULT_DELIVERY_MODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MessagingDefaultDeliveryModeEnum getMessagingDefaultDeliveryMode() { - return messagingDefaultDeliveryMode; - } - - - @JsonProperty(JSON_PROPERTY_MESSAGING_DEFAULT_DELIVERY_MODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessagingDefaultDeliveryMode(MessagingDefaultDeliveryModeEnum messagingDefaultDeliveryMode) { - this.messagingDefaultDeliveryMode = messagingDefaultDeliveryMode; - } - - - public MsgVpnJndiConnectionFactory messagingDefaultDmqEligibleEnabled(Boolean messagingDefaultDmqEligibleEnabled) { - - this.messagingDefaultDmqEligibleEnabled = messagingDefaultDmqEligibleEnabled; - return this; - } - - /** - * Enable or disable whether messages sent by the Publisher (Producer) are Dead Message Queue (DMQ) eligible by default. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return messagingDefaultDmqEligibleEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MESSAGING_DEFAULT_DMQ_ELIGIBLE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getMessagingDefaultDmqEligibleEnabled() { - return messagingDefaultDmqEligibleEnabled; - } - - - @JsonProperty(JSON_PROPERTY_MESSAGING_DEFAULT_DMQ_ELIGIBLE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessagingDefaultDmqEligibleEnabled(Boolean messagingDefaultDmqEligibleEnabled) { - this.messagingDefaultDmqEligibleEnabled = messagingDefaultDmqEligibleEnabled; - } - - - public MsgVpnJndiConnectionFactory messagingDefaultElidingEligibleEnabled(Boolean messagingDefaultElidingEligibleEnabled) { - - this.messagingDefaultElidingEligibleEnabled = messagingDefaultElidingEligibleEnabled; - return this; - } - - /** - * Enable or disable whether messages sent by the Publisher (Producer) are Eliding eligible by default. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return messagingDefaultElidingEligibleEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MESSAGING_DEFAULT_ELIDING_ELIGIBLE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getMessagingDefaultElidingEligibleEnabled() { - return messagingDefaultElidingEligibleEnabled; - } - - - @JsonProperty(JSON_PROPERTY_MESSAGING_DEFAULT_ELIDING_ELIGIBLE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessagingDefaultElidingEligibleEnabled(Boolean messagingDefaultElidingEligibleEnabled) { - this.messagingDefaultElidingEligibleEnabled = messagingDefaultElidingEligibleEnabled; - } - - - public MsgVpnJndiConnectionFactory messagingJmsxUserIdEnabled(Boolean messagingJmsxUserIdEnabled) { - - this.messagingJmsxUserIdEnabled = messagingJmsxUserIdEnabled; - return this; - } - - /** - * Enable or disable inclusion (adding or replacing) of the JMSXUserID property in messages sent by the Publisher (Producer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return messagingJmsxUserIdEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MESSAGING_JMSX_USER_ID_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getMessagingJmsxUserIdEnabled() { - return messagingJmsxUserIdEnabled; - } - - - @JsonProperty(JSON_PROPERTY_MESSAGING_JMSX_USER_ID_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessagingJmsxUserIdEnabled(Boolean messagingJmsxUserIdEnabled) { - this.messagingJmsxUserIdEnabled = messagingJmsxUserIdEnabled; - } - - - public MsgVpnJndiConnectionFactory messagingTextInXmlPayloadEnabled(Boolean messagingTextInXmlPayloadEnabled) { - - this.messagingTextInXmlPayloadEnabled = messagingTextInXmlPayloadEnabled; - return this; - } - - /** - * Enable or disable encoding of JMS text messages in Publisher (Producer) messages as XML payload. When disabled, JMS text messages are encoded as a binary attachment. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return messagingTextInXmlPayloadEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MESSAGING_TEXT_IN_XML_PAYLOAD_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getMessagingTextInXmlPayloadEnabled() { - return messagingTextInXmlPayloadEnabled; - } - - - @JsonProperty(JSON_PROPERTY_MESSAGING_TEXT_IN_XML_PAYLOAD_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessagingTextInXmlPayloadEnabled(Boolean messagingTextInXmlPayloadEnabled) { - this.messagingTextInXmlPayloadEnabled = messagingTextInXmlPayloadEnabled; - } - - - public MsgVpnJndiConnectionFactory msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnJndiConnectionFactory transportCompressionLevel(Integer transportCompressionLevel) { - - this.transportCompressionLevel = transportCompressionLevel; - return this; - } - - /** - * The ZLIB compression level for the connection to the broker. The value \"0\" means no compression, and the value \"-1\" means the compression level is specified in the JNDI Properties file. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. - * @return transportCompressionLevel - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_COMPRESSION_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getTransportCompressionLevel() { - return transportCompressionLevel; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_COMPRESSION_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportCompressionLevel(Integer transportCompressionLevel) { - this.transportCompressionLevel = transportCompressionLevel; - } - - - public MsgVpnJndiConnectionFactory transportConnectRetryCount(Integer transportConnectRetryCount) { - - this.transportConnectRetryCount = transportConnectRetryCount; - return this; - } - - /** - * The maximum number of retry attempts to establish an initial connection to the host or list of hosts. The value \"0\" means a single attempt (no retries), and the value \"-1\" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return transportConnectRetryCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_CONNECT_RETRY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getTransportConnectRetryCount() { - return transportConnectRetryCount; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_CONNECT_RETRY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportConnectRetryCount(Integer transportConnectRetryCount) { - this.transportConnectRetryCount = transportConnectRetryCount; - } - - - public MsgVpnJndiConnectionFactory transportConnectRetryPerHostCount(Integer transportConnectRetryPerHostCount) { - - this.transportConnectRetryPerHostCount = transportConnectRetryPerHostCount; - return this; - } - - /** - * The maximum number of retry attempts to establish an initial connection to each host on the list of hosts. The value \"0\" means a single attempt (no retries), and the value \"-1\" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return transportConnectRetryPerHostCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_CONNECT_RETRY_PER_HOST_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getTransportConnectRetryPerHostCount() { - return transportConnectRetryPerHostCount; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_CONNECT_RETRY_PER_HOST_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportConnectRetryPerHostCount(Integer transportConnectRetryPerHostCount) { - this.transportConnectRetryPerHostCount = transportConnectRetryPerHostCount; - } - - - public MsgVpnJndiConnectionFactory transportConnectTimeout(Integer transportConnectTimeout) { - - this.transportConnectTimeout = transportConnectTimeout; - return this; - } - - /** - * The timeout for establishing an initial connection to the broker, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30000`. - * @return transportConnectTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_CONNECT_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getTransportConnectTimeout() { - return transportConnectTimeout; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_CONNECT_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportConnectTimeout(Integer transportConnectTimeout) { - this.transportConnectTimeout = transportConnectTimeout; - } - - - public MsgVpnJndiConnectionFactory transportDirectTransportEnabled(Boolean transportDirectTransportEnabled) { - - this.transportDirectTransportEnabled = transportDirectTransportEnabled; - return this; - } - - /** - * Enable or disable usage of the Direct Transport mode for sending non-persistent messages. When disabled, the Guaranteed Transport mode is used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return transportDirectTransportEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_DIRECT_TRANSPORT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTransportDirectTransportEnabled() { - return transportDirectTransportEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_DIRECT_TRANSPORT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportDirectTransportEnabled(Boolean transportDirectTransportEnabled) { - this.transportDirectTransportEnabled = transportDirectTransportEnabled; - } - - - public MsgVpnJndiConnectionFactory transportKeepaliveCount(Integer transportKeepaliveCount) { - - this.transportKeepaliveCount = transportKeepaliveCount; - return this; - } - - /** - * The maximum number of consecutive application-level keepalive messages sent without the broker response before the connection to the broker is closed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. - * @return transportKeepaliveCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_KEEPALIVE_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getTransportKeepaliveCount() { - return transportKeepaliveCount; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_KEEPALIVE_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportKeepaliveCount(Integer transportKeepaliveCount) { - this.transportKeepaliveCount = transportKeepaliveCount; - } - - - public MsgVpnJndiConnectionFactory transportKeepaliveEnabled(Boolean transportKeepaliveEnabled) { - - this.transportKeepaliveEnabled = transportKeepaliveEnabled; - return this; - } - - /** - * Enable or disable usage of application-level keepalive messages to maintain a connection with the broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return transportKeepaliveEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_KEEPALIVE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTransportKeepaliveEnabled() { - return transportKeepaliveEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_KEEPALIVE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportKeepaliveEnabled(Boolean transportKeepaliveEnabled) { - this.transportKeepaliveEnabled = transportKeepaliveEnabled; - } - - - public MsgVpnJndiConnectionFactory transportKeepaliveInterval(Integer transportKeepaliveInterval) { - - this.transportKeepaliveInterval = transportKeepaliveInterval; - return this; - } - - /** - * The interval between application-level keepalive messages, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`. - * @return transportKeepaliveInterval - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_KEEPALIVE_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getTransportKeepaliveInterval() { - return transportKeepaliveInterval; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_KEEPALIVE_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportKeepaliveInterval(Integer transportKeepaliveInterval) { - this.transportKeepaliveInterval = transportKeepaliveInterval; - } - - - public MsgVpnJndiConnectionFactory transportMsgCallbackOnIoThreadEnabled(Boolean transportMsgCallbackOnIoThreadEnabled) { - - this.transportMsgCallbackOnIoThreadEnabled = transportMsgCallbackOnIoThreadEnabled; - return this; - } - - /** - * Enable or disable delivery of asynchronous messages directly from the I/O thread. Contact support before enabling this property. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return transportMsgCallbackOnIoThreadEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_MSG_CALLBACK_ON_IO_THREAD_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTransportMsgCallbackOnIoThreadEnabled() { - return transportMsgCallbackOnIoThreadEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_MSG_CALLBACK_ON_IO_THREAD_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportMsgCallbackOnIoThreadEnabled(Boolean transportMsgCallbackOnIoThreadEnabled) { - this.transportMsgCallbackOnIoThreadEnabled = transportMsgCallbackOnIoThreadEnabled; - } - - - public MsgVpnJndiConnectionFactory transportOptimizeDirectEnabled(Boolean transportOptimizeDirectEnabled) { - - this.transportOptimizeDirectEnabled = transportOptimizeDirectEnabled; - return this; - } - - /** - * Enable or disable optimization for the Direct Transport delivery mode. If enabled, the client application is limited to one Publisher (Producer) and one non-durable Subscriber (Consumer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return transportOptimizeDirectEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_OPTIMIZE_DIRECT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTransportOptimizeDirectEnabled() { - return transportOptimizeDirectEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_OPTIMIZE_DIRECT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportOptimizeDirectEnabled(Boolean transportOptimizeDirectEnabled) { - this.transportOptimizeDirectEnabled = transportOptimizeDirectEnabled; - } - - - public MsgVpnJndiConnectionFactory transportPort(Integer transportPort) { - - this.transportPort = transportPort; - return this; - } - - /** - * The connection port number on the broker for SMF clients. The value \"-1\" means the port is specified in the JNDI Properties file. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. - * @return transportPort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getTransportPort() { - return transportPort; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportPort(Integer transportPort) { - this.transportPort = transportPort; - } - - - public MsgVpnJndiConnectionFactory transportReadTimeout(Integer transportReadTimeout) { - - this.transportReadTimeout = transportReadTimeout; - return this; - } - - /** - * The timeout for reading a reply from the broker, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. - * @return transportReadTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_READ_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getTransportReadTimeout() { - return transportReadTimeout; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_READ_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportReadTimeout(Integer transportReadTimeout) { - this.transportReadTimeout = transportReadTimeout; - } - - - public MsgVpnJndiConnectionFactory transportReceiveBufferSize(Integer transportReceiveBufferSize) { - - this.transportReceiveBufferSize = transportReceiveBufferSize; - return this; - } - - /** - * The size of the receive socket buffer, in bytes. It corresponds to the SO_RCVBUF socket option. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `65536`. - * @return transportReceiveBufferSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_RECEIVE_BUFFER_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getTransportReceiveBufferSize() { - return transportReceiveBufferSize; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_RECEIVE_BUFFER_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportReceiveBufferSize(Integer transportReceiveBufferSize) { - this.transportReceiveBufferSize = transportReceiveBufferSize; - } - - - public MsgVpnJndiConnectionFactory transportReconnectRetryCount(Integer transportReconnectRetryCount) { - - this.transportReconnectRetryCount = transportReconnectRetryCount; - return this; - } - - /** - * The maximum number of attempts to reconnect to the host or list of hosts after the connection has been lost. The value \"-1\" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. - * @return transportReconnectRetryCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_RECONNECT_RETRY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getTransportReconnectRetryCount() { - return transportReconnectRetryCount; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_RECONNECT_RETRY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportReconnectRetryCount(Integer transportReconnectRetryCount) { - this.transportReconnectRetryCount = transportReconnectRetryCount; - } - - - public MsgVpnJndiConnectionFactory transportReconnectRetryWait(Integer transportReconnectRetryWait) { - - this.transportReconnectRetryWait = transportReconnectRetryWait; - return this; - } - - /** - * The amount of time before making another attempt to connect or reconnect to the host after the connection has been lost, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`. - * @return transportReconnectRetryWait - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_RECONNECT_RETRY_WAIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getTransportReconnectRetryWait() { - return transportReconnectRetryWait; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_RECONNECT_RETRY_WAIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportReconnectRetryWait(Integer transportReconnectRetryWait) { - this.transportReconnectRetryWait = transportReconnectRetryWait; - } - - - public MsgVpnJndiConnectionFactory transportSendBufferSize(Integer transportSendBufferSize) { - - this.transportSendBufferSize = transportSendBufferSize; - return this; - } - - /** - * The size of the send socket buffer, in bytes. It corresponds to the SO_SNDBUF socket option. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `65536`. - * @return transportSendBufferSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_SEND_BUFFER_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getTransportSendBufferSize() { - return transportSendBufferSize; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_SEND_BUFFER_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportSendBufferSize(Integer transportSendBufferSize) { - this.transportSendBufferSize = transportSendBufferSize; - } - - - public MsgVpnJndiConnectionFactory transportTcpNoDelayEnabled(Boolean transportTcpNoDelayEnabled) { - - this.transportTcpNoDelayEnabled = transportTcpNoDelayEnabled; - return this; - } - - /** - * Enable or disable the TCP_NODELAY option. When enabled, Nagle's algorithm for TCP/IP congestion control (RFC 896) is disabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return transportTcpNoDelayEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TRANSPORT_TCP_NO_DELAY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTransportTcpNoDelayEnabled() { - return transportTcpNoDelayEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TRANSPORT_TCP_NO_DELAY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTransportTcpNoDelayEnabled(Boolean transportTcpNoDelayEnabled) { - this.transportTcpNoDelayEnabled = transportTcpNoDelayEnabled; - } - - - public MsgVpnJndiConnectionFactory xaEnabled(Boolean xaEnabled) { - - this.xaEnabled = xaEnabled; - return this; - } - - /** - * Enable or disable this as an XA Connection Factory. When enabled, the Connection Factory can be cast to \"XAConnectionFactory\", \"XAQueueConnectionFactory\" or \"XATopicConnectionFactory\". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return xaEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_XA_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getXaEnabled() { - return xaEnabled; - } - - - @JsonProperty(JSON_PROPERTY_XA_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setXaEnabled(Boolean xaEnabled) { - this.xaEnabled = xaEnabled; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnJndiConnectionFactory msgVpnJndiConnectionFactory = (MsgVpnJndiConnectionFactory) o; - return Objects.equals(this.allowDuplicateClientIdEnabled, msgVpnJndiConnectionFactory.allowDuplicateClientIdEnabled) && - Objects.equals(this.clientDescription, msgVpnJndiConnectionFactory.clientDescription) && - Objects.equals(this.clientId, msgVpnJndiConnectionFactory.clientId) && - Objects.equals(this.connectionFactoryName, msgVpnJndiConnectionFactory.connectionFactoryName) && - Objects.equals(this.dtoReceiveOverrideEnabled, msgVpnJndiConnectionFactory.dtoReceiveOverrideEnabled) && - Objects.equals(this.dtoReceiveSubscriberLocalPriority, msgVpnJndiConnectionFactory.dtoReceiveSubscriberLocalPriority) && - Objects.equals(this.dtoReceiveSubscriberNetworkPriority, msgVpnJndiConnectionFactory.dtoReceiveSubscriberNetworkPriority) && - Objects.equals(this.dtoSendEnabled, msgVpnJndiConnectionFactory.dtoSendEnabled) && - Objects.equals(this.dynamicEndpointCreateDurableEnabled, msgVpnJndiConnectionFactory.dynamicEndpointCreateDurableEnabled) && - Objects.equals(this.dynamicEndpointRespectTtlEnabled, msgVpnJndiConnectionFactory.dynamicEndpointRespectTtlEnabled) && - Objects.equals(this.guaranteedReceiveAckTimeout, msgVpnJndiConnectionFactory.guaranteedReceiveAckTimeout) && - Objects.equals(this.guaranteedReceiveReconnectRetryCount, msgVpnJndiConnectionFactory.guaranteedReceiveReconnectRetryCount) && - Objects.equals(this.guaranteedReceiveReconnectRetryWait, msgVpnJndiConnectionFactory.guaranteedReceiveReconnectRetryWait) && - Objects.equals(this.guaranteedReceiveWindowSize, msgVpnJndiConnectionFactory.guaranteedReceiveWindowSize) && - Objects.equals(this.guaranteedReceiveWindowSizeAckThreshold, msgVpnJndiConnectionFactory.guaranteedReceiveWindowSizeAckThreshold) && - Objects.equals(this.guaranteedSendAckTimeout, msgVpnJndiConnectionFactory.guaranteedSendAckTimeout) && - Objects.equals(this.guaranteedSendWindowSize, msgVpnJndiConnectionFactory.guaranteedSendWindowSize) && - Objects.equals(this.messagingDefaultDeliveryMode, msgVpnJndiConnectionFactory.messagingDefaultDeliveryMode) && - Objects.equals(this.messagingDefaultDmqEligibleEnabled, msgVpnJndiConnectionFactory.messagingDefaultDmqEligibleEnabled) && - Objects.equals(this.messagingDefaultElidingEligibleEnabled, msgVpnJndiConnectionFactory.messagingDefaultElidingEligibleEnabled) && - Objects.equals(this.messagingJmsxUserIdEnabled, msgVpnJndiConnectionFactory.messagingJmsxUserIdEnabled) && - Objects.equals(this.messagingTextInXmlPayloadEnabled, msgVpnJndiConnectionFactory.messagingTextInXmlPayloadEnabled) && - Objects.equals(this.msgVpnName, msgVpnJndiConnectionFactory.msgVpnName) && - Objects.equals(this.transportCompressionLevel, msgVpnJndiConnectionFactory.transportCompressionLevel) && - Objects.equals(this.transportConnectRetryCount, msgVpnJndiConnectionFactory.transportConnectRetryCount) && - Objects.equals(this.transportConnectRetryPerHostCount, msgVpnJndiConnectionFactory.transportConnectRetryPerHostCount) && - Objects.equals(this.transportConnectTimeout, msgVpnJndiConnectionFactory.transportConnectTimeout) && - Objects.equals(this.transportDirectTransportEnabled, msgVpnJndiConnectionFactory.transportDirectTransportEnabled) && - Objects.equals(this.transportKeepaliveCount, msgVpnJndiConnectionFactory.transportKeepaliveCount) && - Objects.equals(this.transportKeepaliveEnabled, msgVpnJndiConnectionFactory.transportKeepaliveEnabled) && - Objects.equals(this.transportKeepaliveInterval, msgVpnJndiConnectionFactory.transportKeepaliveInterval) && - Objects.equals(this.transportMsgCallbackOnIoThreadEnabled, msgVpnJndiConnectionFactory.transportMsgCallbackOnIoThreadEnabled) && - Objects.equals(this.transportOptimizeDirectEnabled, msgVpnJndiConnectionFactory.transportOptimizeDirectEnabled) && - Objects.equals(this.transportPort, msgVpnJndiConnectionFactory.transportPort) && - Objects.equals(this.transportReadTimeout, msgVpnJndiConnectionFactory.transportReadTimeout) && - Objects.equals(this.transportReceiveBufferSize, msgVpnJndiConnectionFactory.transportReceiveBufferSize) && - Objects.equals(this.transportReconnectRetryCount, msgVpnJndiConnectionFactory.transportReconnectRetryCount) && - Objects.equals(this.transportReconnectRetryWait, msgVpnJndiConnectionFactory.transportReconnectRetryWait) && - Objects.equals(this.transportSendBufferSize, msgVpnJndiConnectionFactory.transportSendBufferSize) && - Objects.equals(this.transportTcpNoDelayEnabled, msgVpnJndiConnectionFactory.transportTcpNoDelayEnabled) && - Objects.equals(this.xaEnabled, msgVpnJndiConnectionFactory.xaEnabled); - } - - @Override - public int hashCode() { - return Objects.hash(allowDuplicateClientIdEnabled, clientDescription, clientId, connectionFactoryName, dtoReceiveOverrideEnabled, dtoReceiveSubscriberLocalPriority, dtoReceiveSubscriberNetworkPriority, dtoSendEnabled, dynamicEndpointCreateDurableEnabled, dynamicEndpointRespectTtlEnabled, guaranteedReceiveAckTimeout, guaranteedReceiveReconnectRetryCount, guaranteedReceiveReconnectRetryWait, guaranteedReceiveWindowSize, guaranteedReceiveWindowSizeAckThreshold, guaranteedSendAckTimeout, guaranteedSendWindowSize, messagingDefaultDeliveryMode, messagingDefaultDmqEligibleEnabled, messagingDefaultElidingEligibleEnabled, messagingJmsxUserIdEnabled, messagingTextInXmlPayloadEnabled, msgVpnName, transportCompressionLevel, transportConnectRetryCount, transportConnectRetryPerHostCount, transportConnectTimeout, transportDirectTransportEnabled, transportKeepaliveCount, transportKeepaliveEnabled, transportKeepaliveInterval, transportMsgCallbackOnIoThreadEnabled, transportOptimizeDirectEnabled, transportPort, transportReadTimeout, transportReceiveBufferSize, transportReconnectRetryCount, transportReconnectRetryWait, transportSendBufferSize, transportTcpNoDelayEnabled, xaEnabled); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnJndiConnectionFactory {\n"); - sb.append(" allowDuplicateClientIdEnabled: ").append(toIndentedString(allowDuplicateClientIdEnabled)).append("\n"); - sb.append(" clientDescription: ").append(toIndentedString(clientDescription)).append("\n"); - sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); - sb.append(" connectionFactoryName: ").append(toIndentedString(connectionFactoryName)).append("\n"); - sb.append(" dtoReceiveOverrideEnabled: ").append(toIndentedString(dtoReceiveOverrideEnabled)).append("\n"); - sb.append(" dtoReceiveSubscriberLocalPriority: ").append(toIndentedString(dtoReceiveSubscriberLocalPriority)).append("\n"); - sb.append(" dtoReceiveSubscriberNetworkPriority: ").append(toIndentedString(dtoReceiveSubscriberNetworkPriority)).append("\n"); - sb.append(" dtoSendEnabled: ").append(toIndentedString(dtoSendEnabled)).append("\n"); - sb.append(" dynamicEndpointCreateDurableEnabled: ").append(toIndentedString(dynamicEndpointCreateDurableEnabled)).append("\n"); - sb.append(" dynamicEndpointRespectTtlEnabled: ").append(toIndentedString(dynamicEndpointRespectTtlEnabled)).append("\n"); - sb.append(" guaranteedReceiveAckTimeout: ").append(toIndentedString(guaranteedReceiveAckTimeout)).append("\n"); - sb.append(" guaranteedReceiveReconnectRetryCount: ").append(toIndentedString(guaranteedReceiveReconnectRetryCount)).append("\n"); - sb.append(" guaranteedReceiveReconnectRetryWait: ").append(toIndentedString(guaranteedReceiveReconnectRetryWait)).append("\n"); - sb.append(" guaranteedReceiveWindowSize: ").append(toIndentedString(guaranteedReceiveWindowSize)).append("\n"); - sb.append(" guaranteedReceiveWindowSizeAckThreshold: ").append(toIndentedString(guaranteedReceiveWindowSizeAckThreshold)).append("\n"); - sb.append(" guaranteedSendAckTimeout: ").append(toIndentedString(guaranteedSendAckTimeout)).append("\n"); - sb.append(" guaranteedSendWindowSize: ").append(toIndentedString(guaranteedSendWindowSize)).append("\n"); - sb.append(" messagingDefaultDeliveryMode: ").append(toIndentedString(messagingDefaultDeliveryMode)).append("\n"); - sb.append(" messagingDefaultDmqEligibleEnabled: ").append(toIndentedString(messagingDefaultDmqEligibleEnabled)).append("\n"); - sb.append(" messagingDefaultElidingEligibleEnabled: ").append(toIndentedString(messagingDefaultElidingEligibleEnabled)).append("\n"); - sb.append(" messagingJmsxUserIdEnabled: ").append(toIndentedString(messagingJmsxUserIdEnabled)).append("\n"); - sb.append(" messagingTextInXmlPayloadEnabled: ").append(toIndentedString(messagingTextInXmlPayloadEnabled)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" transportCompressionLevel: ").append(toIndentedString(transportCompressionLevel)).append("\n"); - sb.append(" transportConnectRetryCount: ").append(toIndentedString(transportConnectRetryCount)).append("\n"); - sb.append(" transportConnectRetryPerHostCount: ").append(toIndentedString(transportConnectRetryPerHostCount)).append("\n"); - sb.append(" transportConnectTimeout: ").append(toIndentedString(transportConnectTimeout)).append("\n"); - sb.append(" transportDirectTransportEnabled: ").append(toIndentedString(transportDirectTransportEnabled)).append("\n"); - sb.append(" transportKeepaliveCount: ").append(toIndentedString(transportKeepaliveCount)).append("\n"); - sb.append(" transportKeepaliveEnabled: ").append(toIndentedString(transportKeepaliveEnabled)).append("\n"); - sb.append(" transportKeepaliveInterval: ").append(toIndentedString(transportKeepaliveInterval)).append("\n"); - sb.append(" transportMsgCallbackOnIoThreadEnabled: ").append(toIndentedString(transportMsgCallbackOnIoThreadEnabled)).append("\n"); - sb.append(" transportOptimizeDirectEnabled: ").append(toIndentedString(transportOptimizeDirectEnabled)).append("\n"); - sb.append(" transportPort: ").append(toIndentedString(transportPort)).append("\n"); - sb.append(" transportReadTimeout: ").append(toIndentedString(transportReadTimeout)).append("\n"); - sb.append(" transportReceiveBufferSize: ").append(toIndentedString(transportReceiveBufferSize)).append("\n"); - sb.append(" transportReconnectRetryCount: ").append(toIndentedString(transportReconnectRetryCount)).append("\n"); - sb.append(" transportReconnectRetryWait: ").append(toIndentedString(transportReconnectRetryWait)).append("\n"); - sb.append(" transportSendBufferSize: ").append(toIndentedString(transportSendBufferSize)).append("\n"); - sb.append(" transportTcpNoDelayEnabled: ").append(toIndentedString(transportTcpNoDelayEnabled)).append("\n"); - sb.append(" xaEnabled: ").append(toIndentedString(xaEnabled)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryLinks.java deleted file mode 100644 index 32462c21c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnJndiConnectionFactoryLinks - */ -@JsonPropertyOrder({ - MsgVpnJndiConnectionFactoryLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnJndiConnectionFactoryLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnJndiConnectionFactoryLinks() { - } - - public MsgVpnJndiConnectionFactoryLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this JNDI Connection Factory object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnJndiConnectionFactoryLinks msgVpnJndiConnectionFactoryLinks = (MsgVpnJndiConnectionFactoryLinks) o; - return Objects.equals(this.uri, msgVpnJndiConnectionFactoryLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnJndiConnectionFactoryLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryResponse.java deleted file mode 100644 index 2222c99ac..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactory; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactoryLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnJndiConnectionFactoryResponse - */ -@JsonPropertyOrder({ - MsgVpnJndiConnectionFactoryResponse.JSON_PROPERTY_DATA, - MsgVpnJndiConnectionFactoryResponse.JSON_PROPERTY_LINKS, - MsgVpnJndiConnectionFactoryResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnJndiConnectionFactoryResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnJndiConnectionFactory data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnJndiConnectionFactoryLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnJndiConnectionFactoryResponse() { - } - - public MsgVpnJndiConnectionFactoryResponse data(MsgVpnJndiConnectionFactory data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnJndiConnectionFactory getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnJndiConnectionFactory data) { - this.data = data; - } - - - public MsgVpnJndiConnectionFactoryResponse links(MsgVpnJndiConnectionFactoryLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnJndiConnectionFactoryLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnJndiConnectionFactoryLinks links) { - this.links = links; - } - - - public MsgVpnJndiConnectionFactoryResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnJndiConnectionFactoryResponse msgVpnJndiConnectionFactoryResponse = (MsgVpnJndiConnectionFactoryResponse) o; - return Objects.equals(this.data, msgVpnJndiConnectionFactoryResponse.data) && - Objects.equals(this.links, msgVpnJndiConnectionFactoryResponse.links) && - Objects.equals(this.meta, msgVpnJndiConnectionFactoryResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnJndiConnectionFactoryResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueue.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueue.java deleted file mode 100644 index 6ea1aa766..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueue.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnJndiQueue - */ -@JsonPropertyOrder({ - MsgVpnJndiQueue.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnJndiQueue.JSON_PROPERTY_PHYSICAL_NAME, - MsgVpnJndiQueue.JSON_PROPERTY_QUEUE_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnJndiQueue { - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_PHYSICAL_NAME = "physicalName"; - private String physicalName; - - public static final String JSON_PROPERTY_QUEUE_NAME = "queueName"; - private String queueName; - - public MsgVpnJndiQueue() { - } - - public MsgVpnJndiQueue msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnJndiQueue physicalName(String physicalName) { - - this.physicalName = physicalName; - return this; - } - - /** - * The physical name of the JMS Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return physicalName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PHYSICAL_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getPhysicalName() { - return physicalName; - } - - - @JsonProperty(JSON_PROPERTY_PHYSICAL_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPhysicalName(String physicalName) { - this.physicalName = physicalName; - } - - - public MsgVpnJndiQueue queueName(String queueName) { - - this.queueName = queueName; - return this; - } - - /** - * The JNDI name of the JMS Queue. - * @return queueName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getQueueName() { - return queueName; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueName(String queueName) { - this.queueName = queueName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnJndiQueue msgVpnJndiQueue = (MsgVpnJndiQueue) o; - return Objects.equals(this.msgVpnName, msgVpnJndiQueue.msgVpnName) && - Objects.equals(this.physicalName, msgVpnJndiQueue.physicalName) && - Objects.equals(this.queueName, msgVpnJndiQueue.queueName); - } - - @Override - public int hashCode() { - return Objects.hash(msgVpnName, physicalName, queueName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnJndiQueue {\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" physicalName: ").append(toIndentedString(physicalName)).append("\n"); - sb.append(" queueName: ").append(toIndentedString(queueName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueLinks.java deleted file mode 100644 index 3b5040114..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnJndiQueueLinks - */ -@JsonPropertyOrder({ - MsgVpnJndiQueueLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnJndiQueueLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnJndiQueueLinks() { - } - - public MsgVpnJndiQueueLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this JNDI Queue object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnJndiQueueLinks msgVpnJndiQueueLinks = (MsgVpnJndiQueueLinks) o; - return Objects.equals(this.uri, msgVpnJndiQueueLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnJndiQueueLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueResponse.java deleted file mode 100644 index cdbfc70fb..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueueLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnJndiQueueResponse - */ -@JsonPropertyOrder({ - MsgVpnJndiQueueResponse.JSON_PROPERTY_DATA, - MsgVpnJndiQueueResponse.JSON_PROPERTY_LINKS, - MsgVpnJndiQueueResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnJndiQueueResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnJndiQueue data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnJndiQueueLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnJndiQueueResponse() { - } - - public MsgVpnJndiQueueResponse data(MsgVpnJndiQueue data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnJndiQueue getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnJndiQueue data) { - this.data = data; - } - - - public MsgVpnJndiQueueResponse links(MsgVpnJndiQueueLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnJndiQueueLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnJndiQueueLinks links) { - this.links = links; - } - - - public MsgVpnJndiQueueResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnJndiQueueResponse msgVpnJndiQueueResponse = (MsgVpnJndiQueueResponse) o; - return Objects.equals(this.data, msgVpnJndiQueueResponse.data) && - Objects.equals(this.links, msgVpnJndiQueueResponse.links) && - Objects.equals(this.meta, msgVpnJndiQueueResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnJndiQueueResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueuesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueuesResponse.java deleted file mode 100644 index d7cefa5c8..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueuesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueueLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnJndiQueuesResponse - */ -@JsonPropertyOrder({ - MsgVpnJndiQueuesResponse.JSON_PROPERTY_DATA, - MsgVpnJndiQueuesResponse.JSON_PROPERTY_LINKS, - MsgVpnJndiQueuesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnJndiQueuesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnJndiQueuesResponse() { - } - - public MsgVpnJndiQueuesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnJndiQueuesResponse addDataItem(MsgVpnJndiQueue dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnJndiQueuesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnJndiQueuesResponse addLinksItem(MsgVpnJndiQueueLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnJndiQueuesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnJndiQueuesResponse msgVpnJndiQueuesResponse = (MsgVpnJndiQueuesResponse) o; - return Objects.equals(this.data, msgVpnJndiQueuesResponse.data) && - Objects.equals(this.links, msgVpnJndiQueuesResponse.links) && - Objects.equals(this.meta, msgVpnJndiQueuesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnJndiQueuesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopic.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopic.java deleted file mode 100644 index 9b13ea586..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopic.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnJndiTopic - */ -@JsonPropertyOrder({ - MsgVpnJndiTopic.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnJndiTopic.JSON_PROPERTY_PHYSICAL_NAME, - MsgVpnJndiTopic.JSON_PROPERTY_TOPIC_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnJndiTopic { - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_PHYSICAL_NAME = "physicalName"; - private String physicalName; - - public static final String JSON_PROPERTY_TOPIC_NAME = "topicName"; - private String topicName; - - public MsgVpnJndiTopic() { - } - - public MsgVpnJndiTopic msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnJndiTopic physicalName(String physicalName) { - - this.physicalName = physicalName; - return this; - } - - /** - * The physical name of the JMS Topic. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return physicalName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PHYSICAL_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getPhysicalName() { - return physicalName; - } - - - @JsonProperty(JSON_PROPERTY_PHYSICAL_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPhysicalName(String physicalName) { - this.physicalName = physicalName; - } - - - public MsgVpnJndiTopic topicName(String topicName) { - - this.topicName = topicName; - return this; - } - - /** - * The JNDI name of the JMS Topic. - * @return topicName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOPIC_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTopicName() { - return topicName; - } - - - @JsonProperty(JSON_PROPERTY_TOPIC_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTopicName(String topicName) { - this.topicName = topicName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnJndiTopic msgVpnJndiTopic = (MsgVpnJndiTopic) o; - return Objects.equals(this.msgVpnName, msgVpnJndiTopic.msgVpnName) && - Objects.equals(this.physicalName, msgVpnJndiTopic.physicalName) && - Objects.equals(this.topicName, msgVpnJndiTopic.topicName); - } - - @Override - public int hashCode() { - return Objects.hash(msgVpnName, physicalName, topicName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnJndiTopic {\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" physicalName: ").append(toIndentedString(physicalName)).append("\n"); - sb.append(" topicName: ").append(toIndentedString(topicName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicLinks.java deleted file mode 100644 index 53cce3c2b..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnJndiTopicLinks - */ -@JsonPropertyOrder({ - MsgVpnJndiTopicLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnJndiTopicLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnJndiTopicLinks() { - } - - public MsgVpnJndiTopicLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this JNDI Topic object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnJndiTopicLinks msgVpnJndiTopicLinks = (MsgVpnJndiTopicLinks) o; - return Objects.equals(this.uri, msgVpnJndiTopicLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnJndiTopicLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicResponse.java deleted file mode 100644 index 5199d40e3..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopicLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnJndiTopicResponse - */ -@JsonPropertyOrder({ - MsgVpnJndiTopicResponse.JSON_PROPERTY_DATA, - MsgVpnJndiTopicResponse.JSON_PROPERTY_LINKS, - MsgVpnJndiTopicResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnJndiTopicResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnJndiTopic data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnJndiTopicLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnJndiTopicResponse() { - } - - public MsgVpnJndiTopicResponse data(MsgVpnJndiTopic data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnJndiTopic getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnJndiTopic data) { - this.data = data; - } - - - public MsgVpnJndiTopicResponse links(MsgVpnJndiTopicLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnJndiTopicLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnJndiTopicLinks links) { - this.links = links; - } - - - public MsgVpnJndiTopicResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnJndiTopicResponse msgVpnJndiTopicResponse = (MsgVpnJndiTopicResponse) o; - return Objects.equals(this.data, msgVpnJndiTopicResponse.data) && - Objects.equals(this.links, msgVpnJndiTopicResponse.links) && - Objects.equals(this.meta, msgVpnJndiTopicResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnJndiTopicResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicsResponse.java deleted file mode 100644 index fcc65775d..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopicLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnJndiTopicsResponse - */ -@JsonPropertyOrder({ - MsgVpnJndiTopicsResponse.JSON_PROPERTY_DATA, - MsgVpnJndiTopicsResponse.JSON_PROPERTY_LINKS, - MsgVpnJndiTopicsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnJndiTopicsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnJndiTopicsResponse() { - } - - public MsgVpnJndiTopicsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnJndiTopicsResponse addDataItem(MsgVpnJndiTopic dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnJndiTopicsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnJndiTopicsResponse addLinksItem(MsgVpnJndiTopicLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnJndiTopicsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnJndiTopicsResponse msgVpnJndiTopicsResponse = (MsgVpnJndiTopicsResponse) o; - return Objects.equals(this.data, msgVpnJndiTopicsResponse.data) && - Objects.equals(this.links, msgVpnJndiTopicsResponse.links) && - Objects.equals(this.meta, msgVpnJndiTopicsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnJndiTopicsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnLinks.java deleted file mode 100644 index 2dda8eb67..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnLinks.java +++ /dev/null @@ -1,840 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnLinks - */ -@JsonPropertyOrder({ - MsgVpnLinks.JSON_PROPERTY_ACL_PROFILES_URI, - MsgVpnLinks.JSON_PROPERTY_AUTHENTICATION_OAUTH_PROFILES_URI, - MsgVpnLinks.JSON_PROPERTY_AUTHENTICATION_OAUTH_PROVIDERS_URI, - MsgVpnLinks.JSON_PROPERTY_AUTHORIZATION_GROUPS_URI, - MsgVpnLinks.JSON_PROPERTY_BRIDGES_URI, - MsgVpnLinks.JSON_PROPERTY_CERT_MATCHING_RULES_URI, - MsgVpnLinks.JSON_PROPERTY_CLIENT_PROFILES_URI, - MsgVpnLinks.JSON_PROPERTY_CLIENT_USERNAMES_URI, - MsgVpnLinks.JSON_PROPERTY_DISTRIBUTED_CACHES_URI, - MsgVpnLinks.JSON_PROPERTY_DMR_BRIDGES_URI, - MsgVpnLinks.JSON_PROPERTY_JNDI_CONNECTION_FACTORIES_URI, - MsgVpnLinks.JSON_PROPERTY_JNDI_QUEUES_URI, - MsgVpnLinks.JSON_PROPERTY_JNDI_TOPICS_URI, - MsgVpnLinks.JSON_PROPERTY_MQTT_RETAIN_CACHES_URI, - MsgVpnLinks.JSON_PROPERTY_MQTT_SESSIONS_URI, - MsgVpnLinks.JSON_PROPERTY_QUEUE_TEMPLATES_URI, - MsgVpnLinks.JSON_PROPERTY_QUEUES_URI, - MsgVpnLinks.JSON_PROPERTY_REPLAY_LOGS_URI, - MsgVpnLinks.JSON_PROPERTY_REPLICATED_TOPICS_URI, - MsgVpnLinks.JSON_PROPERTY_REST_DELIVERY_POINTS_URI, - MsgVpnLinks.JSON_PROPERTY_SEQUENCED_TOPICS_URI, - MsgVpnLinks.JSON_PROPERTY_TOPIC_ENDPOINT_TEMPLATES_URI, - MsgVpnLinks.JSON_PROPERTY_TOPIC_ENDPOINTS_URI, - MsgVpnLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnLinks { - public static final String JSON_PROPERTY_ACL_PROFILES_URI = "aclProfilesUri"; - private String aclProfilesUri; - - public static final String JSON_PROPERTY_AUTHENTICATION_OAUTH_PROFILES_URI = "authenticationOauthProfilesUri"; - private String authenticationOauthProfilesUri; - - public static final String JSON_PROPERTY_AUTHENTICATION_OAUTH_PROVIDERS_URI = "authenticationOauthProvidersUri"; - private String authenticationOauthProvidersUri; - - public static final String JSON_PROPERTY_AUTHORIZATION_GROUPS_URI = "authorizationGroupsUri"; - private String authorizationGroupsUri; - - public static final String JSON_PROPERTY_BRIDGES_URI = "bridgesUri"; - private String bridgesUri; - - public static final String JSON_PROPERTY_CERT_MATCHING_RULES_URI = "certMatchingRulesUri"; - private String certMatchingRulesUri; - - public static final String JSON_PROPERTY_CLIENT_PROFILES_URI = "clientProfilesUri"; - private String clientProfilesUri; - - public static final String JSON_PROPERTY_CLIENT_USERNAMES_URI = "clientUsernamesUri"; - private String clientUsernamesUri; - - public static final String JSON_PROPERTY_DISTRIBUTED_CACHES_URI = "distributedCachesUri"; - private String distributedCachesUri; - - public static final String JSON_PROPERTY_DMR_BRIDGES_URI = "dmrBridgesUri"; - private String dmrBridgesUri; - - public static final String JSON_PROPERTY_JNDI_CONNECTION_FACTORIES_URI = "jndiConnectionFactoriesUri"; - private String jndiConnectionFactoriesUri; - - public static final String JSON_PROPERTY_JNDI_QUEUES_URI = "jndiQueuesUri"; - private String jndiQueuesUri; - - public static final String JSON_PROPERTY_JNDI_TOPICS_URI = "jndiTopicsUri"; - private String jndiTopicsUri; - - public static final String JSON_PROPERTY_MQTT_RETAIN_CACHES_URI = "mqttRetainCachesUri"; - private String mqttRetainCachesUri; - - public static final String JSON_PROPERTY_MQTT_SESSIONS_URI = "mqttSessionsUri"; - private String mqttSessionsUri; - - public static final String JSON_PROPERTY_QUEUE_TEMPLATES_URI = "queueTemplatesUri"; - private String queueTemplatesUri; - - public static final String JSON_PROPERTY_QUEUES_URI = "queuesUri"; - private String queuesUri; - - public static final String JSON_PROPERTY_REPLAY_LOGS_URI = "replayLogsUri"; - private String replayLogsUri; - - public static final String JSON_PROPERTY_REPLICATED_TOPICS_URI = "replicatedTopicsUri"; - private String replicatedTopicsUri; - - public static final String JSON_PROPERTY_REST_DELIVERY_POINTS_URI = "restDeliveryPointsUri"; - private String restDeliveryPointsUri; - - public static final String JSON_PROPERTY_SEQUENCED_TOPICS_URI = "sequencedTopicsUri"; - private String sequencedTopicsUri; - - public static final String JSON_PROPERTY_TOPIC_ENDPOINT_TEMPLATES_URI = "topicEndpointTemplatesUri"; - private String topicEndpointTemplatesUri; - - public static final String JSON_PROPERTY_TOPIC_ENDPOINTS_URI = "topicEndpointsUri"; - private String topicEndpointsUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnLinks() { - } - - public MsgVpnLinks aclProfilesUri(String aclProfilesUri) { - - this.aclProfilesUri = aclProfilesUri; - return this; - } - - /** - * The URI of this Message VPN's collection of ACL Profile objects. - * @return aclProfilesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACL_PROFILES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAclProfilesUri() { - return aclProfilesUri; - } - - - @JsonProperty(JSON_PROPERTY_ACL_PROFILES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAclProfilesUri(String aclProfilesUri) { - this.aclProfilesUri = aclProfilesUri; - } - - - public MsgVpnLinks authenticationOauthProfilesUri(String authenticationOauthProfilesUri) { - - this.authenticationOauthProfilesUri = authenticationOauthProfilesUri; - return this; - } - - /** - * The URI of this Message VPN's collection of OAuth Profile objects. Available since 2.25. - * @return authenticationOauthProfilesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_PROFILES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationOauthProfilesUri() { - return authenticationOauthProfilesUri; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_PROFILES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationOauthProfilesUri(String authenticationOauthProfilesUri) { - this.authenticationOauthProfilesUri = authenticationOauthProfilesUri; - } - - - public MsgVpnLinks authenticationOauthProvidersUri(String authenticationOauthProvidersUri) { - - this.authenticationOauthProvidersUri = authenticationOauthProvidersUri; - return this; - } - - /** - * The URI of this Message VPN's collection of OAuth Provider objects. Deprecated since 2.25. Replaced by authenticationOauthProfiles. - * @return authenticationOauthProvidersUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_PROVIDERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationOauthProvidersUri() { - return authenticationOauthProvidersUri; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_PROVIDERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationOauthProvidersUri(String authenticationOauthProvidersUri) { - this.authenticationOauthProvidersUri = authenticationOauthProvidersUri; - } - - - public MsgVpnLinks authorizationGroupsUri(String authorizationGroupsUri) { - - this.authorizationGroupsUri = authorizationGroupsUri; - return this; - } - - /** - * The URI of this Message VPN's collection of Authorization Group objects. - * @return authorizationGroupsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_GROUPS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthorizationGroupsUri() { - return authorizationGroupsUri; - } - - - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_GROUPS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthorizationGroupsUri(String authorizationGroupsUri) { - this.authorizationGroupsUri = authorizationGroupsUri; - } - - - public MsgVpnLinks bridgesUri(String bridgesUri) { - - this.bridgesUri = bridgesUri; - return this; - } - - /** - * The URI of this Message VPN's collection of Bridge objects. - * @return bridgesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_BRIDGES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getBridgesUri() { - return bridgesUri; - } - - - @JsonProperty(JSON_PROPERTY_BRIDGES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setBridgesUri(String bridgesUri) { - this.bridgesUri = bridgesUri; - } - - - public MsgVpnLinks certMatchingRulesUri(String certMatchingRulesUri) { - - this.certMatchingRulesUri = certMatchingRulesUri; - return this; - } - - /** - * The URI of this Message VPN's collection of Certificate Matching Rule objects. Available since 2.27. - * @return certMatchingRulesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CERT_MATCHING_RULES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCertMatchingRulesUri() { - return certMatchingRulesUri; - } - - - @JsonProperty(JSON_PROPERTY_CERT_MATCHING_RULES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCertMatchingRulesUri(String certMatchingRulesUri) { - this.certMatchingRulesUri = certMatchingRulesUri; - } - - - public MsgVpnLinks clientProfilesUri(String clientProfilesUri) { - - this.clientProfilesUri = clientProfilesUri; - return this; - } - - /** - * The URI of this Message VPN's collection of Client Profile objects. - * @return clientProfilesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientProfilesUri() { - return clientProfilesUri; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfilesUri(String clientProfilesUri) { - this.clientProfilesUri = clientProfilesUri; - } - - - public MsgVpnLinks clientUsernamesUri(String clientUsernamesUri) { - - this.clientUsernamesUri = clientUsernamesUri; - return this; - } - - /** - * The URI of this Message VPN's collection of Client Username objects. - * @return clientUsernamesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_USERNAMES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientUsernamesUri() { - return clientUsernamesUri; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_USERNAMES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientUsernamesUri(String clientUsernamesUri) { - this.clientUsernamesUri = clientUsernamesUri; - } - - - public MsgVpnLinks distributedCachesUri(String distributedCachesUri) { - - this.distributedCachesUri = distributedCachesUri; - return this; - } - - /** - * The URI of this Message VPN's collection of Distributed Cache objects. Available since 2.11. - * @return distributedCachesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DISTRIBUTED_CACHES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDistributedCachesUri() { - return distributedCachesUri; - } - - - @JsonProperty(JSON_PROPERTY_DISTRIBUTED_CACHES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDistributedCachesUri(String distributedCachesUri) { - this.distributedCachesUri = distributedCachesUri; - } - - - public MsgVpnLinks dmrBridgesUri(String dmrBridgesUri) { - - this.dmrBridgesUri = dmrBridgesUri; - return this; - } - - /** - * The URI of this Message VPN's collection of DMR Bridge objects. Available since 2.11. - * @return dmrBridgesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DMR_BRIDGES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDmrBridgesUri() { - return dmrBridgesUri; - } - - - @JsonProperty(JSON_PROPERTY_DMR_BRIDGES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDmrBridgesUri(String dmrBridgesUri) { - this.dmrBridgesUri = dmrBridgesUri; - } - - - public MsgVpnLinks jndiConnectionFactoriesUri(String jndiConnectionFactoriesUri) { - - this.jndiConnectionFactoriesUri = jndiConnectionFactoriesUri; - return this; - } - - /** - * The URI of this Message VPN's collection of JNDI Connection Factory objects. Available since 2.2. - * @return jndiConnectionFactoriesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_JNDI_CONNECTION_FACTORIES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getJndiConnectionFactoriesUri() { - return jndiConnectionFactoriesUri; - } - - - @JsonProperty(JSON_PROPERTY_JNDI_CONNECTION_FACTORIES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setJndiConnectionFactoriesUri(String jndiConnectionFactoriesUri) { - this.jndiConnectionFactoriesUri = jndiConnectionFactoriesUri; - } - - - public MsgVpnLinks jndiQueuesUri(String jndiQueuesUri) { - - this.jndiQueuesUri = jndiQueuesUri; - return this; - } - - /** - * The URI of this Message VPN's collection of JNDI Queue objects. Available since 2.2. - * @return jndiQueuesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_JNDI_QUEUES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getJndiQueuesUri() { - return jndiQueuesUri; - } - - - @JsonProperty(JSON_PROPERTY_JNDI_QUEUES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setJndiQueuesUri(String jndiQueuesUri) { - this.jndiQueuesUri = jndiQueuesUri; - } - - - public MsgVpnLinks jndiTopicsUri(String jndiTopicsUri) { - - this.jndiTopicsUri = jndiTopicsUri; - return this; - } - - /** - * The URI of this Message VPN's collection of JNDI Topic objects. Available since 2.2. - * @return jndiTopicsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_JNDI_TOPICS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getJndiTopicsUri() { - return jndiTopicsUri; - } - - - @JsonProperty(JSON_PROPERTY_JNDI_TOPICS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setJndiTopicsUri(String jndiTopicsUri) { - this.jndiTopicsUri = jndiTopicsUri; - } - - - public MsgVpnLinks mqttRetainCachesUri(String mqttRetainCachesUri) { - - this.mqttRetainCachesUri = mqttRetainCachesUri; - return this; - } - - /** - * The URI of this Message VPN's collection of MQTT Retain Cache objects. Available since 2.11. - * @return mqttRetainCachesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MQTT_RETAIN_CACHES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMqttRetainCachesUri() { - return mqttRetainCachesUri; - } - - - @JsonProperty(JSON_PROPERTY_MQTT_RETAIN_CACHES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMqttRetainCachesUri(String mqttRetainCachesUri) { - this.mqttRetainCachesUri = mqttRetainCachesUri; - } - - - public MsgVpnLinks mqttSessionsUri(String mqttSessionsUri) { - - this.mqttSessionsUri = mqttSessionsUri; - return this; - } - - /** - * The URI of this Message VPN's collection of MQTT Session objects. Available since 2.1. - * @return mqttSessionsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MQTT_SESSIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMqttSessionsUri() { - return mqttSessionsUri; - } - - - @JsonProperty(JSON_PROPERTY_MQTT_SESSIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMqttSessionsUri(String mqttSessionsUri) { - this.mqttSessionsUri = mqttSessionsUri; - } - - - public MsgVpnLinks queueTemplatesUri(String queueTemplatesUri) { - - this.queueTemplatesUri = queueTemplatesUri; - return this; - } - - /** - * The URI of this Message VPN's collection of Queue Template objects. Available since 2.14. - * @return queueTemplatesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_TEMPLATES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getQueueTemplatesUri() { - return queueTemplatesUri; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_TEMPLATES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueTemplatesUri(String queueTemplatesUri) { - this.queueTemplatesUri = queueTemplatesUri; - } - - - public MsgVpnLinks queuesUri(String queuesUri) { - - this.queuesUri = queuesUri; - return this; - } - - /** - * The URI of this Message VPN's collection of Queue objects. - * @return queuesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getQueuesUri() { - return queuesUri; - } - - - @JsonProperty(JSON_PROPERTY_QUEUES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueuesUri(String queuesUri) { - this.queuesUri = queuesUri; - } - - - public MsgVpnLinks replayLogsUri(String replayLogsUri) { - - this.replayLogsUri = replayLogsUri; - return this; - } - - /** - * The URI of this Message VPN's collection of Replay Log objects. Available since 2.10. - * @return replayLogsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLAY_LOGS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getReplayLogsUri() { - return replayLogsUri; - } - - - @JsonProperty(JSON_PROPERTY_REPLAY_LOGS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplayLogsUri(String replayLogsUri) { - this.replayLogsUri = replayLogsUri; - } - - - public MsgVpnLinks replicatedTopicsUri(String replicatedTopicsUri) { - - this.replicatedTopicsUri = replicatedTopicsUri; - return this; - } - - /** - * The URI of this Message VPN's collection of Replicated Topic objects. Available since 2.1. - * @return replicatedTopicsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATED_TOPICS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getReplicatedTopicsUri() { - return replicatedTopicsUri; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATED_TOPICS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicatedTopicsUri(String replicatedTopicsUri) { - this.replicatedTopicsUri = replicatedTopicsUri; - } - - - public MsgVpnLinks restDeliveryPointsUri(String restDeliveryPointsUri) { - - this.restDeliveryPointsUri = restDeliveryPointsUri; - return this; - } - - /** - * The URI of this Message VPN's collection of REST Delivery Point objects. - * @return restDeliveryPointsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REST_DELIVERY_POINTS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRestDeliveryPointsUri() { - return restDeliveryPointsUri; - } - - - @JsonProperty(JSON_PROPERTY_REST_DELIVERY_POINTS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRestDeliveryPointsUri(String restDeliveryPointsUri) { - this.restDeliveryPointsUri = restDeliveryPointsUri; - } - - - public MsgVpnLinks sequencedTopicsUri(String sequencedTopicsUri) { - - this.sequencedTopicsUri = sequencedTopicsUri; - return this; - } - - /** - * The URI of this Message VPN's collection of Sequenced Topic objects. - * @return sequencedTopicsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SEQUENCED_TOPICS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSequencedTopicsUri() { - return sequencedTopicsUri; - } - - - @JsonProperty(JSON_PROPERTY_SEQUENCED_TOPICS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSequencedTopicsUri(String sequencedTopicsUri) { - this.sequencedTopicsUri = sequencedTopicsUri; - } - - - public MsgVpnLinks topicEndpointTemplatesUri(String topicEndpointTemplatesUri) { - - this.topicEndpointTemplatesUri = topicEndpointTemplatesUri; - return this; - } - - /** - * The URI of this Message VPN's collection of Topic Endpoint Template objects. Available since 2.14. - * @return topicEndpointTemplatesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOPIC_ENDPOINT_TEMPLATES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTopicEndpointTemplatesUri() { - return topicEndpointTemplatesUri; - } - - - @JsonProperty(JSON_PROPERTY_TOPIC_ENDPOINT_TEMPLATES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTopicEndpointTemplatesUri(String topicEndpointTemplatesUri) { - this.topicEndpointTemplatesUri = topicEndpointTemplatesUri; - } - - - public MsgVpnLinks topicEndpointsUri(String topicEndpointsUri) { - - this.topicEndpointsUri = topicEndpointsUri; - return this; - } - - /** - * The URI of this Message VPN's collection of Topic Endpoint objects. Available since 2.1. - * @return topicEndpointsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOPIC_ENDPOINTS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTopicEndpointsUri() { - return topicEndpointsUri; - } - - - @JsonProperty(JSON_PROPERTY_TOPIC_ENDPOINTS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTopicEndpointsUri(String topicEndpointsUri) { - this.topicEndpointsUri = topicEndpointsUri; - } - - - public MsgVpnLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Message VPN object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnLinks msgVpnLinks = (MsgVpnLinks) o; - return Objects.equals(this.aclProfilesUri, msgVpnLinks.aclProfilesUri) && - Objects.equals(this.authenticationOauthProfilesUri, msgVpnLinks.authenticationOauthProfilesUri) && - Objects.equals(this.authenticationOauthProvidersUri, msgVpnLinks.authenticationOauthProvidersUri) && - Objects.equals(this.authorizationGroupsUri, msgVpnLinks.authorizationGroupsUri) && - Objects.equals(this.bridgesUri, msgVpnLinks.bridgesUri) && - Objects.equals(this.certMatchingRulesUri, msgVpnLinks.certMatchingRulesUri) && - Objects.equals(this.clientProfilesUri, msgVpnLinks.clientProfilesUri) && - Objects.equals(this.clientUsernamesUri, msgVpnLinks.clientUsernamesUri) && - Objects.equals(this.distributedCachesUri, msgVpnLinks.distributedCachesUri) && - Objects.equals(this.dmrBridgesUri, msgVpnLinks.dmrBridgesUri) && - Objects.equals(this.jndiConnectionFactoriesUri, msgVpnLinks.jndiConnectionFactoriesUri) && - Objects.equals(this.jndiQueuesUri, msgVpnLinks.jndiQueuesUri) && - Objects.equals(this.jndiTopicsUri, msgVpnLinks.jndiTopicsUri) && - Objects.equals(this.mqttRetainCachesUri, msgVpnLinks.mqttRetainCachesUri) && - Objects.equals(this.mqttSessionsUri, msgVpnLinks.mqttSessionsUri) && - Objects.equals(this.queueTemplatesUri, msgVpnLinks.queueTemplatesUri) && - Objects.equals(this.queuesUri, msgVpnLinks.queuesUri) && - Objects.equals(this.replayLogsUri, msgVpnLinks.replayLogsUri) && - Objects.equals(this.replicatedTopicsUri, msgVpnLinks.replicatedTopicsUri) && - Objects.equals(this.restDeliveryPointsUri, msgVpnLinks.restDeliveryPointsUri) && - Objects.equals(this.sequencedTopicsUri, msgVpnLinks.sequencedTopicsUri) && - Objects.equals(this.topicEndpointTemplatesUri, msgVpnLinks.topicEndpointTemplatesUri) && - Objects.equals(this.topicEndpointsUri, msgVpnLinks.topicEndpointsUri) && - Objects.equals(this.uri, msgVpnLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(aclProfilesUri, authenticationOauthProfilesUri, authenticationOauthProvidersUri, authorizationGroupsUri, bridgesUri, certMatchingRulesUri, clientProfilesUri, clientUsernamesUri, distributedCachesUri, dmrBridgesUri, jndiConnectionFactoriesUri, jndiQueuesUri, jndiTopicsUri, mqttRetainCachesUri, mqttSessionsUri, queueTemplatesUri, queuesUri, replayLogsUri, replicatedTopicsUri, restDeliveryPointsUri, sequencedTopicsUri, topicEndpointTemplatesUri, topicEndpointsUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnLinks {\n"); - sb.append(" aclProfilesUri: ").append(toIndentedString(aclProfilesUri)).append("\n"); - sb.append(" authenticationOauthProfilesUri: ").append(toIndentedString(authenticationOauthProfilesUri)).append("\n"); - sb.append(" authenticationOauthProvidersUri: ").append(toIndentedString(authenticationOauthProvidersUri)).append("\n"); - sb.append(" authorizationGroupsUri: ").append(toIndentedString(authorizationGroupsUri)).append("\n"); - sb.append(" bridgesUri: ").append(toIndentedString(bridgesUri)).append("\n"); - sb.append(" certMatchingRulesUri: ").append(toIndentedString(certMatchingRulesUri)).append("\n"); - sb.append(" clientProfilesUri: ").append(toIndentedString(clientProfilesUri)).append("\n"); - sb.append(" clientUsernamesUri: ").append(toIndentedString(clientUsernamesUri)).append("\n"); - sb.append(" distributedCachesUri: ").append(toIndentedString(distributedCachesUri)).append("\n"); - sb.append(" dmrBridgesUri: ").append(toIndentedString(dmrBridgesUri)).append("\n"); - sb.append(" jndiConnectionFactoriesUri: ").append(toIndentedString(jndiConnectionFactoriesUri)).append("\n"); - sb.append(" jndiQueuesUri: ").append(toIndentedString(jndiQueuesUri)).append("\n"); - sb.append(" jndiTopicsUri: ").append(toIndentedString(jndiTopicsUri)).append("\n"); - sb.append(" mqttRetainCachesUri: ").append(toIndentedString(mqttRetainCachesUri)).append("\n"); - sb.append(" mqttSessionsUri: ").append(toIndentedString(mqttSessionsUri)).append("\n"); - sb.append(" queueTemplatesUri: ").append(toIndentedString(queueTemplatesUri)).append("\n"); - sb.append(" queuesUri: ").append(toIndentedString(queuesUri)).append("\n"); - sb.append(" replayLogsUri: ").append(toIndentedString(replayLogsUri)).append("\n"); - sb.append(" replicatedTopicsUri: ").append(toIndentedString(replicatedTopicsUri)).append("\n"); - sb.append(" restDeliveryPointsUri: ").append(toIndentedString(restDeliveryPointsUri)).append("\n"); - sb.append(" sequencedTopicsUri: ").append(toIndentedString(sequencedTopicsUri)).append("\n"); - sb.append(" topicEndpointTemplatesUri: ").append(toIndentedString(topicEndpointTemplatesUri)).append("\n"); - sb.append(" topicEndpointsUri: ").append(toIndentedString(topicEndpointsUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCache.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCache.java deleted file mode 100644 index f569ad1f8..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCache.java +++ /dev/null @@ -1,200 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnMqttRetainCache - */ -@JsonPropertyOrder({ - MsgVpnMqttRetainCache.JSON_PROPERTY_CACHE_NAME, - MsgVpnMqttRetainCache.JSON_PROPERTY_ENABLED, - MsgVpnMqttRetainCache.JSON_PROPERTY_MSG_LIFETIME, - MsgVpnMqttRetainCache.JSON_PROPERTY_MSG_VPN_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnMqttRetainCache { - public static final String JSON_PROPERTY_CACHE_NAME = "cacheName"; - private String cacheName; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_MSG_LIFETIME = "msgLifetime"; - private Long msgLifetime; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public MsgVpnMqttRetainCache() { - } - - public MsgVpnMqttRetainCache cacheName(String cacheName) { - - this.cacheName = cacheName; - return this; - } - - /** - * The name of the MQTT Retain Cache. - * @return cacheName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CACHE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCacheName() { - return cacheName; - } - - - @JsonProperty(JSON_PROPERTY_CACHE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCacheName(String cacheName) { - this.cacheName = cacheName; - } - - - public MsgVpnMqttRetainCache enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable this MQTT Retain Cache. When the cache is disabled, neither retain messages nor retain requests will be delivered by the cache. However, live retain messages will continue to be delivered to currently connected MQTT clients. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public MsgVpnMqttRetainCache msgLifetime(Long msgLifetime) { - - this.msgLifetime = msgLifetime; - return this; - } - - /** - * The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the cache will remove the message. A lifetime of 0 results in the message being retained indefinitely, otherwise it must be 3 seconds or more. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return msgLifetime - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_LIFETIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMsgLifetime() { - return msgLifetime; - } - - - @JsonProperty(JSON_PROPERTY_MSG_LIFETIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgLifetime(Long msgLifetime) { - this.msgLifetime = msgLifetime; - } - - - public MsgVpnMqttRetainCache msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnMqttRetainCache msgVpnMqttRetainCache = (MsgVpnMqttRetainCache) o; - return Objects.equals(this.cacheName, msgVpnMqttRetainCache.cacheName) && - Objects.equals(this.enabled, msgVpnMqttRetainCache.enabled) && - Objects.equals(this.msgLifetime, msgVpnMqttRetainCache.msgLifetime) && - Objects.equals(this.msgVpnName, msgVpnMqttRetainCache.msgVpnName); - } - - @Override - public int hashCode() { - return Objects.hash(cacheName, enabled, msgLifetime, msgVpnName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnMqttRetainCache {\n"); - sb.append(" cacheName: ").append(toIndentedString(cacheName)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" msgLifetime: ").append(toIndentedString(msgLifetime)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheLinks.java deleted file mode 100644 index f977d38f3..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnMqttRetainCacheLinks - */ -@JsonPropertyOrder({ - MsgVpnMqttRetainCacheLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnMqttRetainCacheLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnMqttRetainCacheLinks() { - } - - public MsgVpnMqttRetainCacheLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this MQTT Retain Cache object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnMqttRetainCacheLinks msgVpnMqttRetainCacheLinks = (MsgVpnMqttRetainCacheLinks) o; - return Objects.equals(this.uri, msgVpnMqttRetainCacheLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnMqttRetainCacheLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheResponse.java deleted file mode 100644 index b3ec7115e..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCacheLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnMqttRetainCacheResponse - */ -@JsonPropertyOrder({ - MsgVpnMqttRetainCacheResponse.JSON_PROPERTY_DATA, - MsgVpnMqttRetainCacheResponse.JSON_PROPERTY_LINKS, - MsgVpnMqttRetainCacheResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnMqttRetainCacheResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnMqttRetainCache data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnMqttRetainCacheLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnMqttRetainCacheResponse() { - } - - public MsgVpnMqttRetainCacheResponse data(MsgVpnMqttRetainCache data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnMqttRetainCache getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnMqttRetainCache data) { - this.data = data; - } - - - public MsgVpnMqttRetainCacheResponse links(MsgVpnMqttRetainCacheLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnMqttRetainCacheLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnMqttRetainCacheLinks links) { - this.links = links; - } - - - public MsgVpnMqttRetainCacheResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnMqttRetainCacheResponse msgVpnMqttRetainCacheResponse = (MsgVpnMqttRetainCacheResponse) o; - return Objects.equals(this.data, msgVpnMqttRetainCacheResponse.data) && - Objects.equals(this.links, msgVpnMqttRetainCacheResponse.links) && - Objects.equals(this.meta, msgVpnMqttRetainCacheResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnMqttRetainCacheResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCachesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCachesResponse.java deleted file mode 100644 index 978ecdae7..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCachesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCacheLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnMqttRetainCachesResponse - */ -@JsonPropertyOrder({ - MsgVpnMqttRetainCachesResponse.JSON_PROPERTY_DATA, - MsgVpnMqttRetainCachesResponse.JSON_PROPERTY_LINKS, - MsgVpnMqttRetainCachesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnMqttRetainCachesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnMqttRetainCachesResponse() { - } - - public MsgVpnMqttRetainCachesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnMqttRetainCachesResponse addDataItem(MsgVpnMqttRetainCache dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnMqttRetainCachesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnMqttRetainCachesResponse addLinksItem(MsgVpnMqttRetainCacheLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnMqttRetainCachesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnMqttRetainCachesResponse msgVpnMqttRetainCachesResponse = (MsgVpnMqttRetainCachesResponse) o; - return Objects.equals(this.data, msgVpnMqttRetainCachesResponse.data) && - Objects.equals(this.links, msgVpnMqttRetainCachesResponse.links) && - Objects.equals(this.meta, msgVpnMqttRetainCachesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnMqttRetainCachesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSession.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSession.java deleted file mode 100644 index 0d483688c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSession.java +++ /dev/null @@ -1,787 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnMqttSession - */ -@JsonPropertyOrder({ - MsgVpnMqttSession.JSON_PROPERTY_ENABLED, - MsgVpnMqttSession.JSON_PROPERTY_MQTT_SESSION_CLIENT_ID, - MsgVpnMqttSession.JSON_PROPERTY_MQTT_SESSION_VIRTUAL_ROUTER, - MsgVpnMqttSession.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnMqttSession.JSON_PROPERTY_OWNER, - MsgVpnMqttSession.JSON_PROPERTY_QUEUE_CONSUMER_ACK_PROPAGATION_ENABLED, - MsgVpnMqttSession.JSON_PROPERTY_QUEUE_DEAD_MSG_QUEUE, - MsgVpnMqttSession.JSON_PROPERTY_QUEUE_EVENT_BIND_COUNT_THRESHOLD, - MsgVpnMqttSession.JSON_PROPERTY_QUEUE_EVENT_MSG_SPOOL_USAGE_THRESHOLD, - MsgVpnMqttSession.JSON_PROPERTY_QUEUE_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD, - MsgVpnMqttSession.JSON_PROPERTY_QUEUE_MAX_BIND_COUNT, - MsgVpnMqttSession.JSON_PROPERTY_QUEUE_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW, - MsgVpnMqttSession.JSON_PROPERTY_QUEUE_MAX_MSG_SIZE, - MsgVpnMqttSession.JSON_PROPERTY_QUEUE_MAX_MSG_SPOOL_USAGE, - MsgVpnMqttSession.JSON_PROPERTY_QUEUE_MAX_REDELIVERY_COUNT, - MsgVpnMqttSession.JSON_PROPERTY_QUEUE_MAX_TTL, - MsgVpnMqttSession.JSON_PROPERTY_QUEUE_REJECT_LOW_PRIORITY_MSG_ENABLED, - MsgVpnMqttSession.JSON_PROPERTY_QUEUE_REJECT_LOW_PRIORITY_MSG_LIMIT, - MsgVpnMqttSession.JSON_PROPERTY_QUEUE_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR, - MsgVpnMqttSession.JSON_PROPERTY_QUEUE_RESPECT_TTL_ENABLED -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnMqttSession { - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_MQTT_SESSION_CLIENT_ID = "mqttSessionClientId"; - private String mqttSessionClientId; - - /** - * The virtual router of the MQTT Session. The allowed values and their meaning are: <pre> \"primary\" - The MQTT Session belongs to the primary virtual router. \"backup\" - The MQTT Session belongs to the backup virtual router. \"auto\" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> - */ - public enum MqttSessionVirtualRouterEnum { - PRIMARY("primary"), - - BACKUP("backup"), - - AUTO("auto"); - - private String value; - - MqttSessionVirtualRouterEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static MqttSessionVirtualRouterEnum fromValue(String value) { - for (MqttSessionVirtualRouterEnum b : MqttSessionVirtualRouterEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_MQTT_SESSION_VIRTUAL_ROUTER = "mqttSessionVirtualRouter"; - private MqttSessionVirtualRouterEnum mqttSessionVirtualRouter; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_OWNER = "owner"; - private String owner; - - public static final String JSON_PROPERTY_QUEUE_CONSUMER_ACK_PROPAGATION_ENABLED = "queueConsumerAckPropagationEnabled"; - private Boolean queueConsumerAckPropagationEnabled; - - public static final String JSON_PROPERTY_QUEUE_DEAD_MSG_QUEUE = "queueDeadMsgQueue"; - private String queueDeadMsgQueue; - - public static final String JSON_PROPERTY_QUEUE_EVENT_BIND_COUNT_THRESHOLD = "queueEventBindCountThreshold"; - private EventThreshold queueEventBindCountThreshold; - - public static final String JSON_PROPERTY_QUEUE_EVENT_MSG_SPOOL_USAGE_THRESHOLD = "queueEventMsgSpoolUsageThreshold"; - private EventThreshold queueEventMsgSpoolUsageThreshold; - - public static final String JSON_PROPERTY_QUEUE_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD = "queueEventRejectLowPriorityMsgLimitThreshold"; - private EventThreshold queueEventRejectLowPriorityMsgLimitThreshold; - - public static final String JSON_PROPERTY_QUEUE_MAX_BIND_COUNT = "queueMaxBindCount"; - private Long queueMaxBindCount; - - public static final String JSON_PROPERTY_QUEUE_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW = "queueMaxDeliveredUnackedMsgsPerFlow"; - private Long queueMaxDeliveredUnackedMsgsPerFlow; - - public static final String JSON_PROPERTY_QUEUE_MAX_MSG_SIZE = "queueMaxMsgSize"; - private Integer queueMaxMsgSize; - - public static final String JSON_PROPERTY_QUEUE_MAX_MSG_SPOOL_USAGE = "queueMaxMsgSpoolUsage"; - private Long queueMaxMsgSpoolUsage; - - public static final String JSON_PROPERTY_QUEUE_MAX_REDELIVERY_COUNT = "queueMaxRedeliveryCount"; - private Long queueMaxRedeliveryCount; - - public static final String JSON_PROPERTY_QUEUE_MAX_TTL = "queueMaxTtl"; - private Long queueMaxTtl; - - public static final String JSON_PROPERTY_QUEUE_REJECT_LOW_PRIORITY_MSG_ENABLED = "queueRejectLowPriorityMsgEnabled"; - private Boolean queueRejectLowPriorityMsgEnabled; - - public static final String JSON_PROPERTY_QUEUE_REJECT_LOW_PRIORITY_MSG_LIMIT = "queueRejectLowPriorityMsgLimit"; - private Long queueRejectLowPriorityMsgLimit; - - /** - * Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-queue-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> Available since 2.14. - */ - public enum QueueRejectMsgToSenderOnDiscardBehaviorEnum { - ALWAYS("always"), - - WHEN_QUEUE_ENABLED("when-queue-enabled"), - - NEVER("never"); - - private String value; - - QueueRejectMsgToSenderOnDiscardBehaviorEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static QueueRejectMsgToSenderOnDiscardBehaviorEnum fromValue(String value) { - for (QueueRejectMsgToSenderOnDiscardBehaviorEnum b : QueueRejectMsgToSenderOnDiscardBehaviorEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_QUEUE_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR = "queueRejectMsgToSenderOnDiscardBehavior"; - private QueueRejectMsgToSenderOnDiscardBehaviorEnum queueRejectMsgToSenderOnDiscardBehavior; - - public static final String JSON_PROPERTY_QUEUE_RESPECT_TTL_ENABLED = "queueRespectTtlEnabled"; - private Boolean queueRespectTtlEnabled; - - public MsgVpnMqttSession() { - } - - public MsgVpnMqttSession enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the MQTT Session. When disabled, the client is disconnected, new messages matching QoS 0 subscriptions are discarded, and new messages matching QoS 1 subscriptions are stored for future delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public MsgVpnMqttSession mqttSessionClientId(String mqttSessionClientId) { - - this.mqttSessionClientId = mqttSessionClientId; - return this; - } - - /** - * The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - * @return mqttSessionClientId - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MQTT_SESSION_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMqttSessionClientId() { - return mqttSessionClientId; - } - - - @JsonProperty(JSON_PROPERTY_MQTT_SESSION_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMqttSessionClientId(String mqttSessionClientId) { - this.mqttSessionClientId = mqttSessionClientId; - } - - - public MsgVpnMqttSession mqttSessionVirtualRouter(MqttSessionVirtualRouterEnum mqttSessionVirtualRouter) { - - this.mqttSessionVirtualRouter = mqttSessionVirtualRouter; - return this; - } - - /** - * The virtual router of the MQTT Session. The allowed values and their meaning are: <pre> \"primary\" - The MQTT Session belongs to the primary virtual router. \"backup\" - The MQTT Session belongs to the backup virtual router. \"auto\" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> - * @return mqttSessionVirtualRouter - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MQTT_SESSION_VIRTUAL_ROUTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MqttSessionVirtualRouterEnum getMqttSessionVirtualRouter() { - return mqttSessionVirtualRouter; - } - - - @JsonProperty(JSON_PROPERTY_MQTT_SESSION_VIRTUAL_ROUTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMqttSessionVirtualRouter(MqttSessionVirtualRouterEnum mqttSessionVirtualRouter) { - this.mqttSessionVirtualRouter = mqttSessionVirtualRouter; - } - - - public MsgVpnMqttSession msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnMqttSession owner(String owner) { - - this.owner = owner; - return this; - } - - /** - * The owner of the MQTT Session. For externally-created sessions this defaults to the Client Username of the connecting client. For management-created sessions this defaults to empty. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return owner - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OWNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOwner() { - return owner; - } - - - @JsonProperty(JSON_PROPERTY_OWNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOwner(String owner) { - this.owner = owner; - } - - - public MsgVpnMqttSession queueConsumerAckPropagationEnabled(Boolean queueConsumerAckPropagationEnabled) { - - this.queueConsumerAckPropagationEnabled = queueConsumerAckPropagationEnabled; - return this; - } - - /** - * Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.14. - * @return queueConsumerAckPropagationEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_CONSUMER_ACK_PROPAGATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getQueueConsumerAckPropagationEnabled() { - return queueConsumerAckPropagationEnabled; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_CONSUMER_ACK_PROPAGATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueConsumerAckPropagationEnabled(Boolean queueConsumerAckPropagationEnabled) { - this.queueConsumerAckPropagationEnabled = queueConsumerAckPropagationEnabled; - } - - - public MsgVpnMqttSession queueDeadMsgQueue(String queueDeadMsgQueue) { - - this.queueDeadMsgQueue = queueDeadMsgQueue; - return this; - } - - /** - * The name of the Dead Message Queue (DMQ) used by the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.14. - * @return queueDeadMsgQueue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_DEAD_MSG_QUEUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getQueueDeadMsgQueue() { - return queueDeadMsgQueue; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_DEAD_MSG_QUEUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueDeadMsgQueue(String queueDeadMsgQueue) { - this.queueDeadMsgQueue = queueDeadMsgQueue; - } - - - public MsgVpnMqttSession queueEventBindCountThreshold(EventThreshold queueEventBindCountThreshold) { - - this.queueEventBindCountThreshold = queueEventBindCountThreshold; - return this; - } - - /** - * Get queueEventBindCountThreshold - * @return queueEventBindCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_EVENT_BIND_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getQueueEventBindCountThreshold() { - return queueEventBindCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_EVENT_BIND_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueEventBindCountThreshold(EventThreshold queueEventBindCountThreshold) { - this.queueEventBindCountThreshold = queueEventBindCountThreshold; - } - - - public MsgVpnMqttSession queueEventMsgSpoolUsageThreshold(EventThreshold queueEventMsgSpoolUsageThreshold) { - - this.queueEventMsgSpoolUsageThreshold = queueEventMsgSpoolUsageThreshold; - return this; - } - - /** - * Get queueEventMsgSpoolUsageThreshold - * @return queueEventMsgSpoolUsageThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_EVENT_MSG_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getQueueEventMsgSpoolUsageThreshold() { - return queueEventMsgSpoolUsageThreshold; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_EVENT_MSG_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueEventMsgSpoolUsageThreshold(EventThreshold queueEventMsgSpoolUsageThreshold) { - this.queueEventMsgSpoolUsageThreshold = queueEventMsgSpoolUsageThreshold; - } - - - public MsgVpnMqttSession queueEventRejectLowPriorityMsgLimitThreshold(EventThreshold queueEventRejectLowPriorityMsgLimitThreshold) { - - this.queueEventRejectLowPriorityMsgLimitThreshold = queueEventRejectLowPriorityMsgLimitThreshold; - return this; - } - - /** - * Get queueEventRejectLowPriorityMsgLimitThreshold - * @return queueEventRejectLowPriorityMsgLimitThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getQueueEventRejectLowPriorityMsgLimitThreshold() { - return queueEventRejectLowPriorityMsgLimitThreshold; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueEventRejectLowPriorityMsgLimitThreshold(EventThreshold queueEventRejectLowPriorityMsgLimitThreshold) { - this.queueEventRejectLowPriorityMsgLimitThreshold = queueEventRejectLowPriorityMsgLimitThreshold; - } - - - public MsgVpnMqttSession queueMaxBindCount(Long queueMaxBindCount) { - - this.queueMaxBindCount = queueMaxBindCount; - return this; - } - - /** - * The maximum number of consumer flows that can bind to the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since 2.14. - * @return queueMaxBindCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_BIND_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getQueueMaxBindCount() { - return queueMaxBindCount; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_BIND_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueMaxBindCount(Long queueMaxBindCount) { - this.queueMaxBindCount = queueMaxBindCount; - } - - - public MsgVpnMqttSession queueMaxDeliveredUnackedMsgsPerFlow(Long queueMaxDeliveredUnackedMsgsPerFlow) { - - this.queueMaxDeliveredUnackedMsgsPerFlow = queueMaxDeliveredUnackedMsgsPerFlow; - return this; - } - - /** - * The maximum number of messages delivered but not acknowledged per flow for the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. Available since 2.14. - * @return queueMaxDeliveredUnackedMsgsPerFlow - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getQueueMaxDeliveredUnackedMsgsPerFlow() { - return queueMaxDeliveredUnackedMsgsPerFlow; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueMaxDeliveredUnackedMsgsPerFlow(Long queueMaxDeliveredUnackedMsgsPerFlow) { - this.queueMaxDeliveredUnackedMsgsPerFlow = queueMaxDeliveredUnackedMsgsPerFlow; - } - - - public MsgVpnMqttSession queueMaxMsgSize(Integer queueMaxMsgSize) { - - this.queueMaxMsgSize = queueMaxMsgSize; - return this; - } - - /** - * The maximum message size allowed in the MQTT Session Queue, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. Available since 2.14. - * @return queueMaxMsgSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_MSG_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getQueueMaxMsgSize() { - return queueMaxMsgSize; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_MSG_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueMaxMsgSize(Integer queueMaxMsgSize) { - this.queueMaxMsgSize = queueMaxMsgSize; - } - - - public MsgVpnMqttSession queueMaxMsgSpoolUsage(Long queueMaxMsgSpoolUsage) { - - this.queueMaxMsgSpoolUsage = queueMaxMsgSpoolUsage; - return this; - } - - /** - * The maximum message spool usage allowed by the MQTT Session Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`. Available since 2.14. - * @return queueMaxMsgSpoolUsage - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_MSG_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getQueueMaxMsgSpoolUsage() { - return queueMaxMsgSpoolUsage; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_MSG_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueMaxMsgSpoolUsage(Long queueMaxMsgSpoolUsage) { - this.queueMaxMsgSpoolUsage = queueMaxMsgSpoolUsage; - } - - - public MsgVpnMqttSession queueMaxRedeliveryCount(Long queueMaxRedeliveryCount) { - - this.queueMaxRedeliveryCount = queueMaxRedeliveryCount; - return this; - } - - /** - * The maximum number of times the MQTT Session Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14. - * @return queueMaxRedeliveryCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_REDELIVERY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getQueueMaxRedeliveryCount() { - return queueMaxRedeliveryCount; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_REDELIVERY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueMaxRedeliveryCount(Long queueMaxRedeliveryCount) { - this.queueMaxRedeliveryCount = queueMaxRedeliveryCount; - } - - - public MsgVpnMqttSession queueMaxTtl(Long queueMaxTtl) { - - this.queueMaxTtl = queueMaxTtl; - return this; - } - - /** - * The maximum time in seconds a message can stay in the MQTT Session Queue when `queueRespectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `queueMaxTtl` configured for the MQTT Session Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14. - * @return queueMaxTtl - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_TTL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getQueueMaxTtl() { - return queueMaxTtl; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_MAX_TTL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueMaxTtl(Long queueMaxTtl) { - this.queueMaxTtl = queueMaxTtl; - } - - - public MsgVpnMqttSession queueRejectLowPriorityMsgEnabled(Boolean queueRejectLowPriorityMsgEnabled) { - - this.queueRejectLowPriorityMsgEnabled = queueRejectLowPriorityMsgEnabled; - return this; - } - - /** - * Enable or disable the checking of low priority messages against the `queueRejectLowPriorityMsgLimit`. This may only be enabled if `queueRejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.14. - * @return queueRejectLowPriorityMsgEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_REJECT_LOW_PRIORITY_MSG_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getQueueRejectLowPriorityMsgEnabled() { - return queueRejectLowPriorityMsgEnabled; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_REJECT_LOW_PRIORITY_MSG_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueRejectLowPriorityMsgEnabled(Boolean queueRejectLowPriorityMsgEnabled) { - this.queueRejectLowPriorityMsgEnabled = queueRejectLowPriorityMsgEnabled; - } - - - public MsgVpnMqttSession queueRejectLowPriorityMsgLimit(Long queueRejectLowPriorityMsgLimit) { - - this.queueRejectLowPriorityMsgLimit = queueRejectLowPriorityMsgLimit; - return this; - } - - /** - * The number of messages of any priority in the MQTT Session Queue above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14. - * @return queueRejectLowPriorityMsgLimit - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_REJECT_LOW_PRIORITY_MSG_LIMIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getQueueRejectLowPriorityMsgLimit() { - return queueRejectLowPriorityMsgLimit; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_REJECT_LOW_PRIORITY_MSG_LIMIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueRejectLowPriorityMsgLimit(Long queueRejectLowPriorityMsgLimit) { - this.queueRejectLowPriorityMsgLimit = queueRejectLowPriorityMsgLimit; - } - - - public MsgVpnMqttSession queueRejectMsgToSenderOnDiscardBehavior(QueueRejectMsgToSenderOnDiscardBehaviorEnum queueRejectMsgToSenderOnDiscardBehavior) { - - this.queueRejectMsgToSenderOnDiscardBehavior = queueRejectMsgToSenderOnDiscardBehavior; - return this; - } - - /** - * Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-queue-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> Available since 2.14. - * @return queueRejectMsgToSenderOnDiscardBehavior - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public QueueRejectMsgToSenderOnDiscardBehaviorEnum getQueueRejectMsgToSenderOnDiscardBehavior() { - return queueRejectMsgToSenderOnDiscardBehavior; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueRejectMsgToSenderOnDiscardBehavior(QueueRejectMsgToSenderOnDiscardBehaviorEnum queueRejectMsgToSenderOnDiscardBehavior) { - this.queueRejectMsgToSenderOnDiscardBehavior = queueRejectMsgToSenderOnDiscardBehavior; - } - - - public MsgVpnMqttSession queueRespectTtlEnabled(Boolean queueRespectTtlEnabled) { - - this.queueRespectTtlEnabled = queueRespectTtlEnabled; - return this; - } - - /** - * Enable or disable the respecting of the time-to-live (TTL) for messages in the MQTT Session Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.14. - * @return queueRespectTtlEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_RESPECT_TTL_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getQueueRespectTtlEnabled() { - return queueRespectTtlEnabled; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_RESPECT_TTL_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueRespectTtlEnabled(Boolean queueRespectTtlEnabled) { - this.queueRespectTtlEnabled = queueRespectTtlEnabled; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnMqttSession msgVpnMqttSession = (MsgVpnMqttSession) o; - return Objects.equals(this.enabled, msgVpnMqttSession.enabled) && - Objects.equals(this.mqttSessionClientId, msgVpnMqttSession.mqttSessionClientId) && - Objects.equals(this.mqttSessionVirtualRouter, msgVpnMqttSession.mqttSessionVirtualRouter) && - Objects.equals(this.msgVpnName, msgVpnMqttSession.msgVpnName) && - Objects.equals(this.owner, msgVpnMqttSession.owner) && - Objects.equals(this.queueConsumerAckPropagationEnabled, msgVpnMqttSession.queueConsumerAckPropagationEnabled) && - Objects.equals(this.queueDeadMsgQueue, msgVpnMqttSession.queueDeadMsgQueue) && - Objects.equals(this.queueEventBindCountThreshold, msgVpnMqttSession.queueEventBindCountThreshold) && - Objects.equals(this.queueEventMsgSpoolUsageThreshold, msgVpnMqttSession.queueEventMsgSpoolUsageThreshold) && - Objects.equals(this.queueEventRejectLowPriorityMsgLimitThreshold, msgVpnMqttSession.queueEventRejectLowPriorityMsgLimitThreshold) && - Objects.equals(this.queueMaxBindCount, msgVpnMqttSession.queueMaxBindCount) && - Objects.equals(this.queueMaxDeliveredUnackedMsgsPerFlow, msgVpnMqttSession.queueMaxDeliveredUnackedMsgsPerFlow) && - Objects.equals(this.queueMaxMsgSize, msgVpnMqttSession.queueMaxMsgSize) && - Objects.equals(this.queueMaxMsgSpoolUsage, msgVpnMqttSession.queueMaxMsgSpoolUsage) && - Objects.equals(this.queueMaxRedeliveryCount, msgVpnMqttSession.queueMaxRedeliveryCount) && - Objects.equals(this.queueMaxTtl, msgVpnMqttSession.queueMaxTtl) && - Objects.equals(this.queueRejectLowPriorityMsgEnabled, msgVpnMqttSession.queueRejectLowPriorityMsgEnabled) && - Objects.equals(this.queueRejectLowPriorityMsgLimit, msgVpnMqttSession.queueRejectLowPriorityMsgLimit) && - Objects.equals(this.queueRejectMsgToSenderOnDiscardBehavior, msgVpnMqttSession.queueRejectMsgToSenderOnDiscardBehavior) && - Objects.equals(this.queueRespectTtlEnabled, msgVpnMqttSession.queueRespectTtlEnabled); - } - - @Override - public int hashCode() { - return Objects.hash(enabled, mqttSessionClientId, mqttSessionVirtualRouter, msgVpnName, owner, queueConsumerAckPropagationEnabled, queueDeadMsgQueue, queueEventBindCountThreshold, queueEventMsgSpoolUsageThreshold, queueEventRejectLowPriorityMsgLimitThreshold, queueMaxBindCount, queueMaxDeliveredUnackedMsgsPerFlow, queueMaxMsgSize, queueMaxMsgSpoolUsage, queueMaxRedeliveryCount, queueMaxTtl, queueRejectLowPriorityMsgEnabled, queueRejectLowPriorityMsgLimit, queueRejectMsgToSenderOnDiscardBehavior, queueRespectTtlEnabled); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnMqttSession {\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" mqttSessionClientId: ").append(toIndentedString(mqttSessionClientId)).append("\n"); - sb.append(" mqttSessionVirtualRouter: ").append(toIndentedString(mqttSessionVirtualRouter)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" owner: ").append(toIndentedString(owner)).append("\n"); - sb.append(" queueConsumerAckPropagationEnabled: ").append(toIndentedString(queueConsumerAckPropagationEnabled)).append("\n"); - sb.append(" queueDeadMsgQueue: ").append(toIndentedString(queueDeadMsgQueue)).append("\n"); - sb.append(" queueEventBindCountThreshold: ").append(toIndentedString(queueEventBindCountThreshold)).append("\n"); - sb.append(" queueEventMsgSpoolUsageThreshold: ").append(toIndentedString(queueEventMsgSpoolUsageThreshold)).append("\n"); - sb.append(" queueEventRejectLowPriorityMsgLimitThreshold: ").append(toIndentedString(queueEventRejectLowPriorityMsgLimitThreshold)).append("\n"); - sb.append(" queueMaxBindCount: ").append(toIndentedString(queueMaxBindCount)).append("\n"); - sb.append(" queueMaxDeliveredUnackedMsgsPerFlow: ").append(toIndentedString(queueMaxDeliveredUnackedMsgsPerFlow)).append("\n"); - sb.append(" queueMaxMsgSize: ").append(toIndentedString(queueMaxMsgSize)).append("\n"); - sb.append(" queueMaxMsgSpoolUsage: ").append(toIndentedString(queueMaxMsgSpoolUsage)).append("\n"); - sb.append(" queueMaxRedeliveryCount: ").append(toIndentedString(queueMaxRedeliveryCount)).append("\n"); - sb.append(" queueMaxTtl: ").append(toIndentedString(queueMaxTtl)).append("\n"); - sb.append(" queueRejectLowPriorityMsgEnabled: ").append(toIndentedString(queueRejectLowPriorityMsgEnabled)).append("\n"); - sb.append(" queueRejectLowPriorityMsgLimit: ").append(toIndentedString(queueRejectLowPriorityMsgLimit)).append("\n"); - sb.append(" queueRejectMsgToSenderOnDiscardBehavior: ").append(toIndentedString(queueRejectMsgToSenderOnDiscardBehavior)).append("\n"); - sb.append(" queueRespectTtlEnabled: ").append(toIndentedString(queueRespectTtlEnabled)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionLinks.java deleted file mode 100644 index b823ad00a..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionLinks.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnMqttSessionLinks - */ -@JsonPropertyOrder({ - MsgVpnMqttSessionLinks.JSON_PROPERTY_SUBSCRIPTIONS_URI, - MsgVpnMqttSessionLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnMqttSessionLinks { - public static final String JSON_PROPERTY_SUBSCRIPTIONS_URI = "subscriptionsUri"; - private String subscriptionsUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnMqttSessionLinks() { - } - - public MsgVpnMqttSessionLinks subscriptionsUri(String subscriptionsUri) { - - this.subscriptionsUri = subscriptionsUri; - return this; - } - - /** - * The URI of this MQTT Session's collection of Subscription objects. - * @return subscriptionsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SUBSCRIPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSubscriptionsUri() { - return subscriptionsUri; - } - - - @JsonProperty(JSON_PROPERTY_SUBSCRIPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubscriptionsUri(String subscriptionsUri) { - this.subscriptionsUri = subscriptionsUri; - } - - - public MsgVpnMqttSessionLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this MQTT Session object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnMqttSessionLinks msgVpnMqttSessionLinks = (MsgVpnMqttSessionLinks) o; - return Objects.equals(this.subscriptionsUri, msgVpnMqttSessionLinks.subscriptionsUri) && - Objects.equals(this.uri, msgVpnMqttSessionLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(subscriptionsUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnMqttSessionLinks {\n"); - sb.append(" subscriptionsUri: ").append(toIndentedString(subscriptionsUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionResponse.java deleted file mode 100644 index 32f86eeb1..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSession; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnMqttSessionResponse - */ -@JsonPropertyOrder({ - MsgVpnMqttSessionResponse.JSON_PROPERTY_DATA, - MsgVpnMqttSessionResponse.JSON_PROPERTY_LINKS, - MsgVpnMqttSessionResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnMqttSessionResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnMqttSession data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnMqttSessionLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnMqttSessionResponse() { - } - - public MsgVpnMqttSessionResponse data(MsgVpnMqttSession data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnMqttSession getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnMqttSession data) { - this.data = data; - } - - - public MsgVpnMqttSessionResponse links(MsgVpnMqttSessionLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnMqttSessionLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnMqttSessionLinks links) { - this.links = links; - } - - - public MsgVpnMqttSessionResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnMqttSessionResponse msgVpnMqttSessionResponse = (MsgVpnMqttSessionResponse) o; - return Objects.equals(this.data, msgVpnMqttSessionResponse.data) && - Objects.equals(this.links, msgVpnMqttSessionResponse.links) && - Objects.equals(this.meta, msgVpnMqttSessionResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnMqttSessionResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscription.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscription.java deleted file mode 100644 index 712a7ae7d..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscription.java +++ /dev/null @@ -1,269 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnMqttSessionSubscription - */ -@JsonPropertyOrder({ - MsgVpnMqttSessionSubscription.JSON_PROPERTY_MQTT_SESSION_CLIENT_ID, - MsgVpnMqttSessionSubscription.JSON_PROPERTY_MQTT_SESSION_VIRTUAL_ROUTER, - MsgVpnMqttSessionSubscription.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnMqttSessionSubscription.JSON_PROPERTY_SUBSCRIPTION_QOS, - MsgVpnMqttSessionSubscription.JSON_PROPERTY_SUBSCRIPTION_TOPIC -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnMqttSessionSubscription { - public static final String JSON_PROPERTY_MQTT_SESSION_CLIENT_ID = "mqttSessionClientId"; - private String mqttSessionClientId; - - /** - * The virtual router of the MQTT Session. The allowed values and their meaning are: <pre> \"primary\" - The MQTT Session belongs to the primary virtual router. \"backup\" - The MQTT Session belongs to the backup virtual router. \"auto\" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> - */ - public enum MqttSessionVirtualRouterEnum { - PRIMARY("primary"), - - BACKUP("backup"), - - AUTO("auto"); - - private String value; - - MqttSessionVirtualRouterEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static MqttSessionVirtualRouterEnum fromValue(String value) { - for (MqttSessionVirtualRouterEnum b : MqttSessionVirtualRouterEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_MQTT_SESSION_VIRTUAL_ROUTER = "mqttSessionVirtualRouter"; - private MqttSessionVirtualRouterEnum mqttSessionVirtualRouter; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_SUBSCRIPTION_QOS = "subscriptionQos"; - private Long subscriptionQos; - - public static final String JSON_PROPERTY_SUBSCRIPTION_TOPIC = "subscriptionTopic"; - private String subscriptionTopic; - - public MsgVpnMqttSessionSubscription() { - } - - public MsgVpnMqttSessionSubscription mqttSessionClientId(String mqttSessionClientId) { - - this.mqttSessionClientId = mqttSessionClientId; - return this; - } - - /** - * The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet. - * @return mqttSessionClientId - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MQTT_SESSION_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMqttSessionClientId() { - return mqttSessionClientId; - } - - - @JsonProperty(JSON_PROPERTY_MQTT_SESSION_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMqttSessionClientId(String mqttSessionClientId) { - this.mqttSessionClientId = mqttSessionClientId; - } - - - public MsgVpnMqttSessionSubscription mqttSessionVirtualRouter(MqttSessionVirtualRouterEnum mqttSessionVirtualRouter) { - - this.mqttSessionVirtualRouter = mqttSessionVirtualRouter; - return this; - } - - /** - * The virtual router of the MQTT Session. The allowed values and their meaning are: <pre> \"primary\" - The MQTT Session belongs to the primary virtual router. \"backup\" - The MQTT Session belongs to the backup virtual router. \"auto\" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role. </pre> - * @return mqttSessionVirtualRouter - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MQTT_SESSION_VIRTUAL_ROUTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MqttSessionVirtualRouterEnum getMqttSessionVirtualRouter() { - return mqttSessionVirtualRouter; - } - - - @JsonProperty(JSON_PROPERTY_MQTT_SESSION_VIRTUAL_ROUTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMqttSessionVirtualRouter(MqttSessionVirtualRouterEnum mqttSessionVirtualRouter) { - this.mqttSessionVirtualRouter = mqttSessionVirtualRouter; - } - - - public MsgVpnMqttSessionSubscription msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnMqttSessionSubscription subscriptionQos(Long subscriptionQos) { - - this.subscriptionQos = subscriptionQos; - return this; - } - - /** - * The quality of service (QoS) for the subscription as either 0 (deliver at most once) or 1 (deliver at least once). QoS 2 is not supported, but QoS 2 messages attracted by QoS 0 or QoS 1 subscriptions are accepted and delivered accordingly. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return subscriptionQos - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SUBSCRIPTION_QOS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getSubscriptionQos() { - return subscriptionQos; - } - - - @JsonProperty(JSON_PROPERTY_SUBSCRIPTION_QOS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubscriptionQos(Long subscriptionQos) { - this.subscriptionQos = subscriptionQos; - } - - - public MsgVpnMqttSessionSubscription subscriptionTopic(String subscriptionTopic) { - - this.subscriptionTopic = subscriptionTopic; - return this; - } - - /** - * The MQTT subscription topic. - * @return subscriptionTopic - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SUBSCRIPTION_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSubscriptionTopic() { - return subscriptionTopic; - } - - - @JsonProperty(JSON_PROPERTY_SUBSCRIPTION_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubscriptionTopic(String subscriptionTopic) { - this.subscriptionTopic = subscriptionTopic; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnMqttSessionSubscription msgVpnMqttSessionSubscription = (MsgVpnMqttSessionSubscription) o; - return Objects.equals(this.mqttSessionClientId, msgVpnMqttSessionSubscription.mqttSessionClientId) && - Objects.equals(this.mqttSessionVirtualRouter, msgVpnMqttSessionSubscription.mqttSessionVirtualRouter) && - Objects.equals(this.msgVpnName, msgVpnMqttSessionSubscription.msgVpnName) && - Objects.equals(this.subscriptionQos, msgVpnMqttSessionSubscription.subscriptionQos) && - Objects.equals(this.subscriptionTopic, msgVpnMqttSessionSubscription.subscriptionTopic); - } - - @Override - public int hashCode() { - return Objects.hash(mqttSessionClientId, mqttSessionVirtualRouter, msgVpnName, subscriptionQos, subscriptionTopic); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnMqttSessionSubscription {\n"); - sb.append(" mqttSessionClientId: ").append(toIndentedString(mqttSessionClientId)).append("\n"); - sb.append(" mqttSessionVirtualRouter: ").append(toIndentedString(mqttSessionVirtualRouter)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" subscriptionQos: ").append(toIndentedString(subscriptionQos)).append("\n"); - sb.append(" subscriptionTopic: ").append(toIndentedString(subscriptionTopic)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionLinks.java deleted file mode 100644 index 1f52511f3..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnMqttSessionSubscriptionLinks - */ -@JsonPropertyOrder({ - MsgVpnMqttSessionSubscriptionLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnMqttSessionSubscriptionLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnMqttSessionSubscriptionLinks() { - } - - public MsgVpnMqttSessionSubscriptionLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Subscription object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnMqttSessionSubscriptionLinks msgVpnMqttSessionSubscriptionLinks = (MsgVpnMqttSessionSubscriptionLinks) o; - return Objects.equals(this.uri, msgVpnMqttSessionSubscriptionLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnMqttSessionSubscriptionLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionResponse.java deleted file mode 100644 index 210832366..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscriptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnMqttSessionSubscriptionResponse - */ -@JsonPropertyOrder({ - MsgVpnMqttSessionSubscriptionResponse.JSON_PROPERTY_DATA, - MsgVpnMqttSessionSubscriptionResponse.JSON_PROPERTY_LINKS, - MsgVpnMqttSessionSubscriptionResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnMqttSessionSubscriptionResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnMqttSessionSubscription data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnMqttSessionSubscriptionLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnMqttSessionSubscriptionResponse() { - } - - public MsgVpnMqttSessionSubscriptionResponse data(MsgVpnMqttSessionSubscription data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnMqttSessionSubscription getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnMqttSessionSubscription data) { - this.data = data; - } - - - public MsgVpnMqttSessionSubscriptionResponse links(MsgVpnMqttSessionSubscriptionLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnMqttSessionSubscriptionLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnMqttSessionSubscriptionLinks links) { - this.links = links; - } - - - public MsgVpnMqttSessionSubscriptionResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnMqttSessionSubscriptionResponse msgVpnMqttSessionSubscriptionResponse = (MsgVpnMqttSessionSubscriptionResponse) o; - return Objects.equals(this.data, msgVpnMqttSessionSubscriptionResponse.data) && - Objects.equals(this.links, msgVpnMqttSessionSubscriptionResponse.links) && - Objects.equals(this.meta, msgVpnMqttSessionSubscriptionResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnMqttSessionSubscriptionResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionsResponse.java deleted file mode 100644 index 84838783e..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscriptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnMqttSessionSubscriptionsResponse - */ -@JsonPropertyOrder({ - MsgVpnMqttSessionSubscriptionsResponse.JSON_PROPERTY_DATA, - MsgVpnMqttSessionSubscriptionsResponse.JSON_PROPERTY_LINKS, - MsgVpnMqttSessionSubscriptionsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnMqttSessionSubscriptionsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnMqttSessionSubscriptionsResponse() { - } - - public MsgVpnMqttSessionSubscriptionsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnMqttSessionSubscriptionsResponse addDataItem(MsgVpnMqttSessionSubscription dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnMqttSessionSubscriptionsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnMqttSessionSubscriptionsResponse addLinksItem(MsgVpnMqttSessionSubscriptionLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnMqttSessionSubscriptionsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnMqttSessionSubscriptionsResponse msgVpnMqttSessionSubscriptionsResponse = (MsgVpnMqttSessionSubscriptionsResponse) o; - return Objects.equals(this.data, msgVpnMqttSessionSubscriptionsResponse.data) && - Objects.equals(this.links, msgVpnMqttSessionSubscriptionsResponse.links) && - Objects.equals(this.meta, msgVpnMqttSessionSubscriptionsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnMqttSessionSubscriptionsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionsResponse.java deleted file mode 100644 index bc250e31c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSession; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnMqttSessionsResponse - */ -@JsonPropertyOrder({ - MsgVpnMqttSessionsResponse.JSON_PROPERTY_DATA, - MsgVpnMqttSessionsResponse.JSON_PROPERTY_LINKS, - MsgVpnMqttSessionsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnMqttSessionsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnMqttSessionsResponse() { - } - - public MsgVpnMqttSessionsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnMqttSessionsResponse addDataItem(MsgVpnMqttSession dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnMqttSessionsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnMqttSessionsResponse addLinksItem(MsgVpnMqttSessionLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnMqttSessionsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnMqttSessionsResponse msgVpnMqttSessionsResponse = (MsgVpnMqttSessionsResponse) o; - return Objects.equals(this.data, msgVpnMqttSessionsResponse.data) && - Objects.equals(this.links, msgVpnMqttSessionsResponse.links) && - Objects.equals(this.meta, msgVpnMqttSessionsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnMqttSessionsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueue.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueue.java deleted file mode 100644 index d1fa41eb8..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueue.java +++ /dev/null @@ -1,1018 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnQueue - */ -@JsonPropertyOrder({ - MsgVpnQueue.JSON_PROPERTY_ACCESS_TYPE, - MsgVpnQueue.JSON_PROPERTY_CONSUMER_ACK_PROPAGATION_ENABLED, - MsgVpnQueue.JSON_PROPERTY_DEAD_MSG_QUEUE, - MsgVpnQueue.JSON_PROPERTY_DELIVERY_COUNT_ENABLED, - MsgVpnQueue.JSON_PROPERTY_DELIVERY_DELAY, - MsgVpnQueue.JSON_PROPERTY_EGRESS_ENABLED, - MsgVpnQueue.JSON_PROPERTY_EVENT_BIND_COUNT_THRESHOLD, - MsgVpnQueue.JSON_PROPERTY_EVENT_MSG_SPOOL_USAGE_THRESHOLD, - MsgVpnQueue.JSON_PROPERTY_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD, - MsgVpnQueue.JSON_PROPERTY_INGRESS_ENABLED, - MsgVpnQueue.JSON_PROPERTY_MAX_BIND_COUNT, - MsgVpnQueue.JSON_PROPERTY_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW, - MsgVpnQueue.JSON_PROPERTY_MAX_MSG_SIZE, - MsgVpnQueue.JSON_PROPERTY_MAX_MSG_SPOOL_USAGE, - MsgVpnQueue.JSON_PROPERTY_MAX_REDELIVERY_COUNT, - MsgVpnQueue.JSON_PROPERTY_MAX_TTL, - MsgVpnQueue.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnQueue.JSON_PROPERTY_OWNER, - MsgVpnQueue.JSON_PROPERTY_PERMISSION, - MsgVpnQueue.JSON_PROPERTY_QUEUE_NAME, - MsgVpnQueue.JSON_PROPERTY_REDELIVERY_ENABLED, - MsgVpnQueue.JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_ENABLED, - MsgVpnQueue.JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_LIMIT, - MsgVpnQueue.JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR, - MsgVpnQueue.JSON_PROPERTY_RESPECT_MSG_PRIORITY_ENABLED, - MsgVpnQueue.JSON_PROPERTY_RESPECT_TTL_ENABLED -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnQueue { - /** - * The access type for delivering messages to consumer flows bound to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are: <pre> \"exclusive\" - Exclusive delivery of messages to the first bound consumer flow. \"non-exclusive\" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion. </pre> - */ - public enum AccessTypeEnum { - EXCLUSIVE("exclusive"), - - NON_EXCLUSIVE("non-exclusive"); - - private String value; - - AccessTypeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AccessTypeEnum fromValue(String value) { - for (AccessTypeEnum b : AccessTypeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_ACCESS_TYPE = "accessType"; - private AccessTypeEnum accessType; - - public static final String JSON_PROPERTY_CONSUMER_ACK_PROPAGATION_ENABLED = "consumerAckPropagationEnabled"; - private Boolean consumerAckPropagationEnabled; - - public static final String JSON_PROPERTY_DEAD_MSG_QUEUE = "deadMsgQueue"; - private String deadMsgQueue; - - public static final String JSON_PROPERTY_DELIVERY_COUNT_ENABLED = "deliveryCountEnabled"; - private Boolean deliveryCountEnabled; - - public static final String JSON_PROPERTY_DELIVERY_DELAY = "deliveryDelay"; - private Long deliveryDelay; - - public static final String JSON_PROPERTY_EGRESS_ENABLED = "egressEnabled"; - private Boolean egressEnabled; - - public static final String JSON_PROPERTY_EVENT_BIND_COUNT_THRESHOLD = "eventBindCountThreshold"; - private EventThreshold eventBindCountThreshold; - - public static final String JSON_PROPERTY_EVENT_MSG_SPOOL_USAGE_THRESHOLD = "eventMsgSpoolUsageThreshold"; - private EventThreshold eventMsgSpoolUsageThreshold; - - public static final String JSON_PROPERTY_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD = "eventRejectLowPriorityMsgLimitThreshold"; - private EventThreshold eventRejectLowPriorityMsgLimitThreshold; - - public static final String JSON_PROPERTY_INGRESS_ENABLED = "ingressEnabled"; - private Boolean ingressEnabled; - - public static final String JSON_PROPERTY_MAX_BIND_COUNT = "maxBindCount"; - private Long maxBindCount; - - public static final String JSON_PROPERTY_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW = "maxDeliveredUnackedMsgsPerFlow"; - private Long maxDeliveredUnackedMsgsPerFlow; - - public static final String JSON_PROPERTY_MAX_MSG_SIZE = "maxMsgSize"; - private Integer maxMsgSize; - - public static final String JSON_PROPERTY_MAX_MSG_SPOOL_USAGE = "maxMsgSpoolUsage"; - private Long maxMsgSpoolUsage; - - public static final String JSON_PROPERTY_MAX_REDELIVERY_COUNT = "maxRedeliveryCount"; - private Long maxRedeliveryCount; - - public static final String JSON_PROPERTY_MAX_TTL = "maxTtl"; - private Long maxTtl; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_OWNER = "owner"; - private String owner; - - /** - * The permission level for all consumers of the Queue, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are: <pre> \"no-access\" - Disallows all access. \"read-only\" - Read-only access to the messages. \"consume\" - Consume (read and remove) messages. \"modify-topic\" - Consume messages or modify the topic/selector. \"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. </pre> - */ - public enum PermissionEnum { - NO_ACCESS("no-access"), - - READ_ONLY("read-only"), - - CONSUME("consume"), - - MODIFY_TOPIC("modify-topic"), - - DELETE("delete"); - - private String value; - - PermissionEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static PermissionEnum fromValue(String value) { - for (PermissionEnum b : PermissionEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_PERMISSION = "permission"; - private PermissionEnum permission; - - public static final String JSON_PROPERTY_QUEUE_NAME = "queueName"; - private String queueName; - - public static final String JSON_PROPERTY_REDELIVERY_ENABLED = "redeliveryEnabled"; - private Boolean redeliveryEnabled; - - public static final String JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_ENABLED = "rejectLowPriorityMsgEnabled"; - private Boolean rejectLowPriorityMsgEnabled; - - public static final String JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_LIMIT = "rejectLowPriorityMsgLimit"; - private Long rejectLowPriorityMsgLimit; - - /** - * Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-queue-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> Available since 2.1. - */ - public enum RejectMsgToSenderOnDiscardBehaviorEnum { - ALWAYS("always"), - - WHEN_QUEUE_ENABLED("when-queue-enabled"), - - NEVER("never"); - - private String value; - - RejectMsgToSenderOnDiscardBehaviorEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static RejectMsgToSenderOnDiscardBehaviorEnum fromValue(String value) { - for (RejectMsgToSenderOnDiscardBehaviorEnum b : RejectMsgToSenderOnDiscardBehaviorEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR = "rejectMsgToSenderOnDiscardBehavior"; - private RejectMsgToSenderOnDiscardBehaviorEnum rejectMsgToSenderOnDiscardBehavior; - - public static final String JSON_PROPERTY_RESPECT_MSG_PRIORITY_ENABLED = "respectMsgPriorityEnabled"; - private Boolean respectMsgPriorityEnabled; - - public static final String JSON_PROPERTY_RESPECT_TTL_ENABLED = "respectTtlEnabled"; - private Boolean respectTtlEnabled; - - public MsgVpnQueue() { - } - - public MsgVpnQueue accessType(AccessTypeEnum accessType) { - - this.accessType = accessType; - return this; - } - - /** - * The access type for delivering messages to consumer flows bound to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are: <pre> \"exclusive\" - Exclusive delivery of messages to the first bound consumer flow. \"non-exclusive\" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion. </pre> - * @return accessType - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACCESS_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AccessTypeEnum getAccessType() { - return accessType; - } - - - @JsonProperty(JSON_PROPERTY_ACCESS_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccessType(AccessTypeEnum accessType) { - this.accessType = accessType; - } - - - public MsgVpnQueue consumerAckPropagationEnabled(Boolean consumerAckPropagationEnabled) { - - this.consumerAckPropagationEnabled = consumerAckPropagationEnabled; - return this; - } - - /** - * Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return consumerAckPropagationEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONSUMER_ACK_PROPAGATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getConsumerAckPropagationEnabled() { - return consumerAckPropagationEnabled; - } - - - @JsonProperty(JSON_PROPERTY_CONSUMER_ACK_PROPAGATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConsumerAckPropagationEnabled(Boolean consumerAckPropagationEnabled) { - this.consumerAckPropagationEnabled = consumerAckPropagationEnabled; - } - - - public MsgVpnQueue deadMsgQueue(String deadMsgQueue) { - - this.deadMsgQueue = deadMsgQueue; - return this; - } - - /** - * The name of the Dead Message Queue (DMQ) used by the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.2. - * @return deadMsgQueue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DEAD_MSG_QUEUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDeadMsgQueue() { - return deadMsgQueue; - } - - - @JsonProperty(JSON_PROPERTY_DEAD_MSG_QUEUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDeadMsgQueue(String deadMsgQueue) { - this.deadMsgQueue = deadMsgQueue; - } - - - public MsgVpnQueue deliveryCountEnabled(Boolean deliveryCountEnabled) { - - this.deliveryCountEnabled = deliveryCountEnabled; - return this; - } - - /** - * Enable or disable the ability for client applications to query the message delivery count of messages received from the Queue. This is a controlled availability feature. Please contact support to find out if this feature is supported for your use case. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.19. - * @return deliveryCountEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DELIVERY_COUNT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getDeliveryCountEnabled() { - return deliveryCountEnabled; - } - - - @JsonProperty(JSON_PROPERTY_DELIVERY_COUNT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDeliveryCountEnabled(Boolean deliveryCountEnabled) { - this.deliveryCountEnabled = deliveryCountEnabled; - } - - - public MsgVpnQueue deliveryDelay(Long deliveryDelay) { - - this.deliveryDelay = deliveryDelay; - return this; - } - - /** - * The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22. - * @return deliveryDelay - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DELIVERY_DELAY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getDeliveryDelay() { - return deliveryDelay; - } - - - @JsonProperty(JSON_PROPERTY_DELIVERY_DELAY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDeliveryDelay(Long deliveryDelay) { - this.deliveryDelay = deliveryDelay; - } - - - public MsgVpnQueue egressEnabled(Boolean egressEnabled) { - - this.egressEnabled = egressEnabled; - return this; - } - - /** - * Enable or disable the transmission of messages from the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return egressEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EGRESS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEgressEnabled() { - return egressEnabled; - } - - - @JsonProperty(JSON_PROPERTY_EGRESS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEgressEnabled(Boolean egressEnabled) { - this.egressEnabled = egressEnabled; - } - - - public MsgVpnQueue eventBindCountThreshold(EventThreshold eventBindCountThreshold) { - - this.eventBindCountThreshold = eventBindCountThreshold; - return this; - } - - /** - * Get eventBindCountThreshold - * @return eventBindCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_BIND_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventBindCountThreshold() { - return eventBindCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_BIND_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventBindCountThreshold(EventThreshold eventBindCountThreshold) { - this.eventBindCountThreshold = eventBindCountThreshold; - } - - - public MsgVpnQueue eventMsgSpoolUsageThreshold(EventThreshold eventMsgSpoolUsageThreshold) { - - this.eventMsgSpoolUsageThreshold = eventMsgSpoolUsageThreshold; - return this; - } - - /** - * Get eventMsgSpoolUsageThreshold - * @return eventMsgSpoolUsageThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_MSG_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventMsgSpoolUsageThreshold() { - return eventMsgSpoolUsageThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_MSG_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventMsgSpoolUsageThreshold(EventThreshold eventMsgSpoolUsageThreshold) { - this.eventMsgSpoolUsageThreshold = eventMsgSpoolUsageThreshold; - } - - - public MsgVpnQueue eventRejectLowPriorityMsgLimitThreshold(EventThreshold eventRejectLowPriorityMsgLimitThreshold) { - - this.eventRejectLowPriorityMsgLimitThreshold = eventRejectLowPriorityMsgLimitThreshold; - return this; - } - - /** - * Get eventRejectLowPriorityMsgLimitThreshold - * @return eventRejectLowPriorityMsgLimitThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventRejectLowPriorityMsgLimitThreshold() { - return eventRejectLowPriorityMsgLimitThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventRejectLowPriorityMsgLimitThreshold(EventThreshold eventRejectLowPriorityMsgLimitThreshold) { - this.eventRejectLowPriorityMsgLimitThreshold = eventRejectLowPriorityMsgLimitThreshold; - } - - - public MsgVpnQueue ingressEnabled(Boolean ingressEnabled) { - - this.ingressEnabled = ingressEnabled; - return this; - } - - /** - * Enable or disable the reception of messages to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return ingressEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_INGRESS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getIngressEnabled() { - return ingressEnabled; - } - - - @JsonProperty(JSON_PROPERTY_INGRESS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIngressEnabled(Boolean ingressEnabled) { - this.ingressEnabled = ingressEnabled; - } - - - public MsgVpnQueue maxBindCount(Long maxBindCount) { - - this.maxBindCount = maxBindCount; - return this; - } - - /** - * The maximum number of consumer flows that can bind to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. - * @return maxBindCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_BIND_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxBindCount() { - return maxBindCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_BIND_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxBindCount(Long maxBindCount) { - this.maxBindCount = maxBindCount; - } - - - public MsgVpnQueue maxDeliveredUnackedMsgsPerFlow(Long maxDeliveredUnackedMsgsPerFlow) { - - this.maxDeliveredUnackedMsgsPerFlow = maxDeliveredUnackedMsgsPerFlow; - return this; - } - - /** - * The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. - * @return maxDeliveredUnackedMsgsPerFlow - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxDeliveredUnackedMsgsPerFlow() { - return maxDeliveredUnackedMsgsPerFlow; - } - - - @JsonProperty(JSON_PROPERTY_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxDeliveredUnackedMsgsPerFlow(Long maxDeliveredUnackedMsgsPerFlow) { - this.maxDeliveredUnackedMsgsPerFlow = maxDeliveredUnackedMsgsPerFlow; - } - - - public MsgVpnQueue maxMsgSize(Integer maxMsgSize) { - - this.maxMsgSize = maxMsgSize; - return this; - } - - /** - * The maximum message size allowed in the Queue, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. - * @return maxMsgSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_MSG_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getMaxMsgSize() { - return maxMsgSize; - } - - - @JsonProperty(JSON_PROPERTY_MAX_MSG_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxMsgSize(Integer maxMsgSize) { - this.maxMsgSize = maxMsgSize; - } - - - public MsgVpnQueue maxMsgSpoolUsage(Long maxMsgSpoolUsage) { - - this.maxMsgSpoolUsage = maxMsgSpoolUsage; - return this; - } - - /** - * The maximum message spool usage allowed by the Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`. - * @return maxMsgSpoolUsage - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_MSG_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxMsgSpoolUsage() { - return maxMsgSpoolUsage; - } - - - @JsonProperty(JSON_PROPERTY_MAX_MSG_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxMsgSpoolUsage(Long maxMsgSpoolUsage) { - this.maxMsgSpoolUsage = maxMsgSpoolUsage; - } - - - public MsgVpnQueue maxRedeliveryCount(Long maxRedeliveryCount) { - - this.maxRedeliveryCount = maxRedeliveryCount; - return this; - } - - /** - * The maximum number of times the Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return maxRedeliveryCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_REDELIVERY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxRedeliveryCount() { - return maxRedeliveryCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_REDELIVERY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxRedeliveryCount(Long maxRedeliveryCount) { - this.maxRedeliveryCount = maxRedeliveryCount; - } - - - public MsgVpnQueue maxTtl(Long maxTtl) { - - this.maxTtl = maxTtl; - return this; - } - - /** - * The maximum time in seconds a message can stay in the Queue when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return maxTtl - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_TTL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxTtl() { - return maxTtl; - } - - - @JsonProperty(JSON_PROPERTY_MAX_TTL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxTtl(Long maxTtl) { - this.maxTtl = maxTtl; - } - - - public MsgVpnQueue msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnQueue owner(String owner) { - - this.owner = owner; - return this; - } - - /** - * The Client Username that owns the Queue and has permission equivalent to `\"delete\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return owner - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OWNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOwner() { - return owner; - } - - - @JsonProperty(JSON_PROPERTY_OWNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOwner(String owner) { - this.owner = owner; - } - - - public MsgVpnQueue permission(PermissionEnum permission) { - - this.permission = permission; - return this; - } - - /** - * The permission level for all consumers of the Queue, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are: <pre> \"no-access\" - Disallows all access. \"read-only\" - Read-only access to the messages. \"consume\" - Consume (read and remove) messages. \"modify-topic\" - Consume messages or modify the topic/selector. \"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. </pre> - * @return permission - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PERMISSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PermissionEnum getPermission() { - return permission; - } - - - @JsonProperty(JSON_PROPERTY_PERMISSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPermission(PermissionEnum permission) { - this.permission = permission; - } - - - public MsgVpnQueue queueName(String queueName) { - - this.queueName = queueName; - return this; - } - - /** - * The name of the Queue. - * @return queueName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getQueueName() { - return queueName; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueName(String queueName) { - this.queueName = queueName; - } - - - public MsgVpnQueue redeliveryEnabled(Boolean redeliveryEnabled) { - - this.redeliveryEnabled = redeliveryEnabled; - return this; - } - - /** - * Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the queue more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18. - * @return redeliveryEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REDELIVERY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRedeliveryEnabled() { - return redeliveryEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REDELIVERY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRedeliveryEnabled(Boolean redeliveryEnabled) { - this.redeliveryEnabled = redeliveryEnabled; - } - - - public MsgVpnQueue rejectLowPriorityMsgEnabled(Boolean rejectLowPriorityMsgEnabled) { - - this.rejectLowPriorityMsgEnabled = rejectLowPriorityMsgEnabled; - return this; - } - - /** - * Enable or disable the checking of low priority messages against the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return rejectLowPriorityMsgEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRejectLowPriorityMsgEnabled() { - return rejectLowPriorityMsgEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRejectLowPriorityMsgEnabled(Boolean rejectLowPriorityMsgEnabled) { - this.rejectLowPriorityMsgEnabled = rejectLowPriorityMsgEnabled; - } - - - public MsgVpnQueue rejectLowPriorityMsgLimit(Long rejectLowPriorityMsgLimit) { - - this.rejectLowPriorityMsgLimit = rejectLowPriorityMsgLimit; - return this; - } - - /** - * The number of messages of any priority in the Queue above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return rejectLowPriorityMsgLimit - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_LIMIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getRejectLowPriorityMsgLimit() { - return rejectLowPriorityMsgLimit; - } - - - @JsonProperty(JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_LIMIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRejectLowPriorityMsgLimit(Long rejectLowPriorityMsgLimit) { - this.rejectLowPriorityMsgLimit = rejectLowPriorityMsgLimit; - } - - - public MsgVpnQueue rejectMsgToSenderOnDiscardBehavior(RejectMsgToSenderOnDiscardBehaviorEnum rejectMsgToSenderOnDiscardBehavior) { - - this.rejectMsgToSenderOnDiscardBehavior = rejectMsgToSenderOnDiscardBehavior; - return this; - } - - /** - * Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-queue-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> Available since 2.1. - * @return rejectMsgToSenderOnDiscardBehavior - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public RejectMsgToSenderOnDiscardBehaviorEnum getRejectMsgToSenderOnDiscardBehavior() { - return rejectMsgToSenderOnDiscardBehavior; - } - - - @JsonProperty(JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRejectMsgToSenderOnDiscardBehavior(RejectMsgToSenderOnDiscardBehaviorEnum rejectMsgToSenderOnDiscardBehavior) { - this.rejectMsgToSenderOnDiscardBehavior = rejectMsgToSenderOnDiscardBehavior; - } - - - public MsgVpnQueue respectMsgPriorityEnabled(Boolean respectMsgPriorityEnabled) { - - this.respectMsgPriorityEnabled = respectMsgPriorityEnabled; - return this; - } - - /** - * Enable or disable the respecting of message priority. When enabled, messages contained in the Queue are delivered in priority order, from 9 (highest) to 0 (lowest). MQTT queues do not support enabling message priority. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.8. - * @return respectMsgPriorityEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESPECT_MSG_PRIORITY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRespectMsgPriorityEnabled() { - return respectMsgPriorityEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESPECT_MSG_PRIORITY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRespectMsgPriorityEnabled(Boolean respectMsgPriorityEnabled) { - this.respectMsgPriorityEnabled = respectMsgPriorityEnabled; - } - - - public MsgVpnQueue respectTtlEnabled(Boolean respectTtlEnabled) { - - this.respectTtlEnabled = respectTtlEnabled; - return this; - } - - /** - * Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return respectTtlEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESPECT_TTL_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRespectTtlEnabled() { - return respectTtlEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESPECT_TTL_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRespectTtlEnabled(Boolean respectTtlEnabled) { - this.respectTtlEnabled = respectTtlEnabled; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnQueue msgVpnQueue = (MsgVpnQueue) o; - return Objects.equals(this.accessType, msgVpnQueue.accessType) && - Objects.equals(this.consumerAckPropagationEnabled, msgVpnQueue.consumerAckPropagationEnabled) && - Objects.equals(this.deadMsgQueue, msgVpnQueue.deadMsgQueue) && - Objects.equals(this.deliveryCountEnabled, msgVpnQueue.deliveryCountEnabled) && - Objects.equals(this.deliveryDelay, msgVpnQueue.deliveryDelay) && - Objects.equals(this.egressEnabled, msgVpnQueue.egressEnabled) && - Objects.equals(this.eventBindCountThreshold, msgVpnQueue.eventBindCountThreshold) && - Objects.equals(this.eventMsgSpoolUsageThreshold, msgVpnQueue.eventMsgSpoolUsageThreshold) && - Objects.equals(this.eventRejectLowPriorityMsgLimitThreshold, msgVpnQueue.eventRejectLowPriorityMsgLimitThreshold) && - Objects.equals(this.ingressEnabled, msgVpnQueue.ingressEnabled) && - Objects.equals(this.maxBindCount, msgVpnQueue.maxBindCount) && - Objects.equals(this.maxDeliveredUnackedMsgsPerFlow, msgVpnQueue.maxDeliveredUnackedMsgsPerFlow) && - Objects.equals(this.maxMsgSize, msgVpnQueue.maxMsgSize) && - Objects.equals(this.maxMsgSpoolUsage, msgVpnQueue.maxMsgSpoolUsage) && - Objects.equals(this.maxRedeliveryCount, msgVpnQueue.maxRedeliveryCount) && - Objects.equals(this.maxTtl, msgVpnQueue.maxTtl) && - Objects.equals(this.msgVpnName, msgVpnQueue.msgVpnName) && - Objects.equals(this.owner, msgVpnQueue.owner) && - Objects.equals(this.permission, msgVpnQueue.permission) && - Objects.equals(this.queueName, msgVpnQueue.queueName) && - Objects.equals(this.redeliveryEnabled, msgVpnQueue.redeliveryEnabled) && - Objects.equals(this.rejectLowPriorityMsgEnabled, msgVpnQueue.rejectLowPriorityMsgEnabled) && - Objects.equals(this.rejectLowPriorityMsgLimit, msgVpnQueue.rejectLowPriorityMsgLimit) && - Objects.equals(this.rejectMsgToSenderOnDiscardBehavior, msgVpnQueue.rejectMsgToSenderOnDiscardBehavior) && - Objects.equals(this.respectMsgPriorityEnabled, msgVpnQueue.respectMsgPriorityEnabled) && - Objects.equals(this.respectTtlEnabled, msgVpnQueue.respectTtlEnabled); - } - - @Override - public int hashCode() { - return Objects.hash(accessType, consumerAckPropagationEnabled, deadMsgQueue, deliveryCountEnabled, deliveryDelay, egressEnabled, eventBindCountThreshold, eventMsgSpoolUsageThreshold, eventRejectLowPriorityMsgLimitThreshold, ingressEnabled, maxBindCount, maxDeliveredUnackedMsgsPerFlow, maxMsgSize, maxMsgSpoolUsage, maxRedeliveryCount, maxTtl, msgVpnName, owner, permission, queueName, redeliveryEnabled, rejectLowPriorityMsgEnabled, rejectLowPriorityMsgLimit, rejectMsgToSenderOnDiscardBehavior, respectMsgPriorityEnabled, respectTtlEnabled); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnQueue {\n"); - sb.append(" accessType: ").append(toIndentedString(accessType)).append("\n"); - sb.append(" consumerAckPropagationEnabled: ").append(toIndentedString(consumerAckPropagationEnabled)).append("\n"); - sb.append(" deadMsgQueue: ").append(toIndentedString(deadMsgQueue)).append("\n"); - sb.append(" deliveryCountEnabled: ").append(toIndentedString(deliveryCountEnabled)).append("\n"); - sb.append(" deliveryDelay: ").append(toIndentedString(deliveryDelay)).append("\n"); - sb.append(" egressEnabled: ").append(toIndentedString(egressEnabled)).append("\n"); - sb.append(" eventBindCountThreshold: ").append(toIndentedString(eventBindCountThreshold)).append("\n"); - sb.append(" eventMsgSpoolUsageThreshold: ").append(toIndentedString(eventMsgSpoolUsageThreshold)).append("\n"); - sb.append(" eventRejectLowPriorityMsgLimitThreshold: ").append(toIndentedString(eventRejectLowPriorityMsgLimitThreshold)).append("\n"); - sb.append(" ingressEnabled: ").append(toIndentedString(ingressEnabled)).append("\n"); - sb.append(" maxBindCount: ").append(toIndentedString(maxBindCount)).append("\n"); - sb.append(" maxDeliveredUnackedMsgsPerFlow: ").append(toIndentedString(maxDeliveredUnackedMsgsPerFlow)).append("\n"); - sb.append(" maxMsgSize: ").append(toIndentedString(maxMsgSize)).append("\n"); - sb.append(" maxMsgSpoolUsage: ").append(toIndentedString(maxMsgSpoolUsage)).append("\n"); - sb.append(" maxRedeliveryCount: ").append(toIndentedString(maxRedeliveryCount)).append("\n"); - sb.append(" maxTtl: ").append(toIndentedString(maxTtl)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" owner: ").append(toIndentedString(owner)).append("\n"); - sb.append(" permission: ").append(toIndentedString(permission)).append("\n"); - sb.append(" queueName: ").append(toIndentedString(queueName)).append("\n"); - sb.append(" redeliveryEnabled: ").append(toIndentedString(redeliveryEnabled)).append("\n"); - sb.append(" rejectLowPriorityMsgEnabled: ").append(toIndentedString(rejectLowPriorityMsgEnabled)).append("\n"); - sb.append(" rejectLowPriorityMsgLimit: ").append(toIndentedString(rejectLowPriorityMsgLimit)).append("\n"); - sb.append(" rejectMsgToSenderOnDiscardBehavior: ").append(toIndentedString(rejectMsgToSenderOnDiscardBehavior)).append("\n"); - sb.append(" respectMsgPriorityEnabled: ").append(toIndentedString(respectMsgPriorityEnabled)).append("\n"); - sb.append(" respectTtlEnabled: ").append(toIndentedString(respectTtlEnabled)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueLinks.java deleted file mode 100644 index 1267d8645..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueLinks.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnQueueLinks - */ -@JsonPropertyOrder({ - MsgVpnQueueLinks.JSON_PROPERTY_SUBSCRIPTIONS_URI, - MsgVpnQueueLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnQueueLinks { - public static final String JSON_PROPERTY_SUBSCRIPTIONS_URI = "subscriptionsUri"; - private String subscriptionsUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnQueueLinks() { - } - - public MsgVpnQueueLinks subscriptionsUri(String subscriptionsUri) { - - this.subscriptionsUri = subscriptionsUri; - return this; - } - - /** - * The URI of this Queue's collection of Queue Subscription objects. - * @return subscriptionsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SUBSCRIPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSubscriptionsUri() { - return subscriptionsUri; - } - - - @JsonProperty(JSON_PROPERTY_SUBSCRIPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubscriptionsUri(String subscriptionsUri) { - this.subscriptionsUri = subscriptionsUri; - } - - - public MsgVpnQueueLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Queue object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnQueueLinks msgVpnQueueLinks = (MsgVpnQueueLinks) o; - return Objects.equals(this.subscriptionsUri, msgVpnQueueLinks.subscriptionsUri) && - Objects.equals(this.uri, msgVpnQueueLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(subscriptionsUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnQueueLinks {\n"); - sb.append(" subscriptionsUri: ").append(toIndentedString(subscriptionsUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueResponse.java deleted file mode 100644 index 8dfc01b56..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnQueueResponse - */ -@JsonPropertyOrder({ - MsgVpnQueueResponse.JSON_PROPERTY_DATA, - MsgVpnQueueResponse.JSON_PROPERTY_LINKS, - MsgVpnQueueResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnQueueResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnQueue data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnQueueLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnQueueResponse() { - } - - public MsgVpnQueueResponse data(MsgVpnQueue data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnQueue getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnQueue data) { - this.data = data; - } - - - public MsgVpnQueueResponse links(MsgVpnQueueLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnQueueLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnQueueLinks links) { - this.links = links; - } - - - public MsgVpnQueueResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnQueueResponse msgVpnQueueResponse = (MsgVpnQueueResponse) o; - return Objects.equals(this.data, msgVpnQueueResponse.data) && - Objects.equals(this.links, msgVpnQueueResponse.links) && - Objects.equals(this.meta, msgVpnQueueResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnQueueResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscription.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscription.java deleted file mode 100644 index 884d5d03b..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscription.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnQueueSubscription - */ -@JsonPropertyOrder({ - MsgVpnQueueSubscription.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnQueueSubscription.JSON_PROPERTY_QUEUE_NAME, - MsgVpnQueueSubscription.JSON_PROPERTY_SUBSCRIPTION_TOPIC -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnQueueSubscription { - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_QUEUE_NAME = "queueName"; - private String queueName; - - public static final String JSON_PROPERTY_SUBSCRIPTION_TOPIC = "subscriptionTopic"; - private String subscriptionTopic; - - public MsgVpnQueueSubscription() { - } - - public MsgVpnQueueSubscription msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnQueueSubscription queueName(String queueName) { - - this.queueName = queueName; - return this; - } - - /** - * The name of the Queue. - * @return queueName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getQueueName() { - return queueName; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueName(String queueName) { - this.queueName = queueName; - } - - - public MsgVpnQueueSubscription subscriptionTopic(String subscriptionTopic) { - - this.subscriptionTopic = subscriptionTopic; - return this; - } - - /** - * The topic of the Subscription. - * @return subscriptionTopic - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SUBSCRIPTION_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSubscriptionTopic() { - return subscriptionTopic; - } - - - @JsonProperty(JSON_PROPERTY_SUBSCRIPTION_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubscriptionTopic(String subscriptionTopic) { - this.subscriptionTopic = subscriptionTopic; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnQueueSubscription msgVpnQueueSubscription = (MsgVpnQueueSubscription) o; - return Objects.equals(this.msgVpnName, msgVpnQueueSubscription.msgVpnName) && - Objects.equals(this.queueName, msgVpnQueueSubscription.queueName) && - Objects.equals(this.subscriptionTopic, msgVpnQueueSubscription.subscriptionTopic); - } - - @Override - public int hashCode() { - return Objects.hash(msgVpnName, queueName, subscriptionTopic); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnQueueSubscription {\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" queueName: ").append(toIndentedString(queueName)).append("\n"); - sb.append(" subscriptionTopic: ").append(toIndentedString(subscriptionTopic)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionLinks.java deleted file mode 100644 index 36e7ca502..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnQueueSubscriptionLinks - */ -@JsonPropertyOrder({ - MsgVpnQueueSubscriptionLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnQueueSubscriptionLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnQueueSubscriptionLinks() { - } - - public MsgVpnQueueSubscriptionLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Queue Subscription object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnQueueSubscriptionLinks msgVpnQueueSubscriptionLinks = (MsgVpnQueueSubscriptionLinks) o; - return Objects.equals(this.uri, msgVpnQueueSubscriptionLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnQueueSubscriptionLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionResponse.java deleted file mode 100644 index 1937e3fd8..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscriptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnQueueSubscriptionResponse - */ -@JsonPropertyOrder({ - MsgVpnQueueSubscriptionResponse.JSON_PROPERTY_DATA, - MsgVpnQueueSubscriptionResponse.JSON_PROPERTY_LINKS, - MsgVpnQueueSubscriptionResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnQueueSubscriptionResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnQueueSubscription data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnQueueSubscriptionLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnQueueSubscriptionResponse() { - } - - public MsgVpnQueueSubscriptionResponse data(MsgVpnQueueSubscription data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnQueueSubscription getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnQueueSubscription data) { - this.data = data; - } - - - public MsgVpnQueueSubscriptionResponse links(MsgVpnQueueSubscriptionLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnQueueSubscriptionLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnQueueSubscriptionLinks links) { - this.links = links; - } - - - public MsgVpnQueueSubscriptionResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnQueueSubscriptionResponse msgVpnQueueSubscriptionResponse = (MsgVpnQueueSubscriptionResponse) o; - return Objects.equals(this.data, msgVpnQueueSubscriptionResponse.data) && - Objects.equals(this.links, msgVpnQueueSubscriptionResponse.links) && - Objects.equals(this.meta, msgVpnQueueSubscriptionResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnQueueSubscriptionResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionsResponse.java deleted file mode 100644 index 07aef4515..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscriptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnQueueSubscriptionsResponse - */ -@JsonPropertyOrder({ - MsgVpnQueueSubscriptionsResponse.JSON_PROPERTY_DATA, - MsgVpnQueueSubscriptionsResponse.JSON_PROPERTY_LINKS, - MsgVpnQueueSubscriptionsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnQueueSubscriptionsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnQueueSubscriptionsResponse() { - } - - public MsgVpnQueueSubscriptionsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnQueueSubscriptionsResponse addDataItem(MsgVpnQueueSubscription dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnQueueSubscriptionsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnQueueSubscriptionsResponse addLinksItem(MsgVpnQueueSubscriptionLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnQueueSubscriptionsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnQueueSubscriptionsResponse msgVpnQueueSubscriptionsResponse = (MsgVpnQueueSubscriptionsResponse) o; - return Objects.equals(this.data, msgVpnQueueSubscriptionsResponse.data) && - Objects.equals(this.links, msgVpnQueueSubscriptionsResponse.links) && - Objects.equals(this.meta, msgVpnQueueSubscriptionsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnQueueSubscriptionsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplate.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplate.java deleted file mode 100644 index bc1f07123..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplate.java +++ /dev/null @@ -1,989 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnQueueTemplate - */ -@JsonPropertyOrder({ - MsgVpnQueueTemplate.JSON_PROPERTY_ACCESS_TYPE, - MsgVpnQueueTemplate.JSON_PROPERTY_CONSUMER_ACK_PROPAGATION_ENABLED, - MsgVpnQueueTemplate.JSON_PROPERTY_DEAD_MSG_QUEUE, - MsgVpnQueueTemplate.JSON_PROPERTY_DELIVERY_DELAY, - MsgVpnQueueTemplate.JSON_PROPERTY_DURABILITY_OVERRIDE, - MsgVpnQueueTemplate.JSON_PROPERTY_EVENT_BIND_COUNT_THRESHOLD, - MsgVpnQueueTemplate.JSON_PROPERTY_EVENT_MSG_SPOOL_USAGE_THRESHOLD, - MsgVpnQueueTemplate.JSON_PROPERTY_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD, - MsgVpnQueueTemplate.JSON_PROPERTY_MAX_BIND_COUNT, - MsgVpnQueueTemplate.JSON_PROPERTY_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW, - MsgVpnQueueTemplate.JSON_PROPERTY_MAX_MSG_SIZE, - MsgVpnQueueTemplate.JSON_PROPERTY_MAX_MSG_SPOOL_USAGE, - MsgVpnQueueTemplate.JSON_PROPERTY_MAX_REDELIVERY_COUNT, - MsgVpnQueueTemplate.JSON_PROPERTY_MAX_TTL, - MsgVpnQueueTemplate.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnQueueTemplate.JSON_PROPERTY_PERMISSION, - MsgVpnQueueTemplate.JSON_PROPERTY_QUEUE_NAME_FILTER, - MsgVpnQueueTemplate.JSON_PROPERTY_QUEUE_TEMPLATE_NAME, - MsgVpnQueueTemplate.JSON_PROPERTY_REDELIVERY_ENABLED, - MsgVpnQueueTemplate.JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_ENABLED, - MsgVpnQueueTemplate.JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_LIMIT, - MsgVpnQueueTemplate.JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR, - MsgVpnQueueTemplate.JSON_PROPERTY_RESPECT_MSG_PRIORITY_ENABLED, - MsgVpnQueueTemplate.JSON_PROPERTY_RESPECT_TTL_ENABLED -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnQueueTemplate { - /** - * The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are: <pre> \"exclusive\" - Exclusive delivery of messages to the first bound consumer flow. \"non-exclusive\" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion. </pre> - */ - public enum AccessTypeEnum { - EXCLUSIVE("exclusive"), - - NON_EXCLUSIVE("non-exclusive"); - - private String value; - - AccessTypeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AccessTypeEnum fromValue(String value) { - for (AccessTypeEnum b : AccessTypeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_ACCESS_TYPE = "accessType"; - private AccessTypeEnum accessType; - - public static final String JSON_PROPERTY_CONSUMER_ACK_PROPAGATION_ENABLED = "consumerAckPropagationEnabled"; - private Boolean consumerAckPropagationEnabled; - - public static final String JSON_PROPERTY_DEAD_MSG_QUEUE = "deadMsgQueue"; - private String deadMsgQueue; - - public static final String JSON_PROPERTY_DELIVERY_DELAY = "deliveryDelay"; - private Long deliveryDelay; - - /** - * Controls the durability of queues created from this template. If non-durable, the created queue will be non-durable, regardless of the specified durability. If none, the created queue will have the requested durability. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - The durability of the endpoint will be as requested on create. \"non-durable\" - The durability of the created queue will be non-durable, regardless of what was requested. </pre> - */ - public enum DurabilityOverrideEnum { - NONE("none"), - - NON_DURABLE("non-durable"); - - private String value; - - DurabilityOverrideEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static DurabilityOverrideEnum fromValue(String value) { - for (DurabilityOverrideEnum b : DurabilityOverrideEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_DURABILITY_OVERRIDE = "durabilityOverride"; - private DurabilityOverrideEnum durabilityOverride; - - public static final String JSON_PROPERTY_EVENT_BIND_COUNT_THRESHOLD = "eventBindCountThreshold"; - private EventThreshold eventBindCountThreshold; - - public static final String JSON_PROPERTY_EVENT_MSG_SPOOL_USAGE_THRESHOLD = "eventMsgSpoolUsageThreshold"; - private EventThreshold eventMsgSpoolUsageThreshold; - - public static final String JSON_PROPERTY_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD = "eventRejectLowPriorityMsgLimitThreshold"; - private EventThreshold eventRejectLowPriorityMsgLimitThreshold; - - public static final String JSON_PROPERTY_MAX_BIND_COUNT = "maxBindCount"; - private Long maxBindCount; - - public static final String JSON_PROPERTY_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW = "maxDeliveredUnackedMsgsPerFlow"; - private Long maxDeliveredUnackedMsgsPerFlow; - - public static final String JSON_PROPERTY_MAX_MSG_SIZE = "maxMsgSize"; - private Integer maxMsgSize; - - public static final String JSON_PROPERTY_MAX_MSG_SPOOL_USAGE = "maxMsgSpoolUsage"; - private Long maxMsgSpoolUsage; - - public static final String JSON_PROPERTY_MAX_REDELIVERY_COUNT = "maxRedeliveryCount"; - private Long maxRedeliveryCount; - - public static final String JSON_PROPERTY_MAX_TTL = "maxTtl"; - private Long maxTtl; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - /** - * The permission level for all consumers, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are: <pre> \"no-access\" - Disallows all access. \"read-only\" - Read-only access to the messages. \"consume\" - Consume (read and remove) messages. \"modify-topic\" - Consume messages or modify the topic/selector. \"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. </pre> - */ - public enum PermissionEnum { - NO_ACCESS("no-access"), - - READ_ONLY("read-only"), - - CONSUME("consume"), - - MODIFY_TOPIC("modify-topic"), - - DELETE("delete"); - - private String value; - - PermissionEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static PermissionEnum fromValue(String value) { - for (PermissionEnum b : PermissionEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_PERMISSION = "permission"; - private PermissionEnum permission; - - public static final String JSON_PROPERTY_QUEUE_NAME_FILTER = "queueNameFilter"; - private String queueNameFilter; - - public static final String JSON_PROPERTY_QUEUE_TEMPLATE_NAME = "queueTemplateName"; - private String queueTemplateName; - - public static final String JSON_PROPERTY_REDELIVERY_ENABLED = "redeliveryEnabled"; - private Boolean redeliveryEnabled; - - public static final String JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_ENABLED = "rejectLowPriorityMsgEnabled"; - private Boolean rejectLowPriorityMsgEnabled; - - public static final String JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_LIMIT = "rejectLowPriorityMsgLimit"; - private Long rejectLowPriorityMsgLimit; - - /** - * Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs prevent the message from being delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-queue-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> - */ - public enum RejectMsgToSenderOnDiscardBehaviorEnum { - ALWAYS("always"), - - WHEN_QUEUE_ENABLED("when-queue-enabled"), - - NEVER("never"); - - private String value; - - RejectMsgToSenderOnDiscardBehaviorEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static RejectMsgToSenderOnDiscardBehaviorEnum fromValue(String value) { - for (RejectMsgToSenderOnDiscardBehaviorEnum b : RejectMsgToSenderOnDiscardBehaviorEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR = "rejectMsgToSenderOnDiscardBehavior"; - private RejectMsgToSenderOnDiscardBehaviorEnum rejectMsgToSenderOnDiscardBehavior; - - public static final String JSON_PROPERTY_RESPECT_MSG_PRIORITY_ENABLED = "respectMsgPriorityEnabled"; - private Boolean respectMsgPriorityEnabled; - - public static final String JSON_PROPERTY_RESPECT_TTL_ENABLED = "respectTtlEnabled"; - private Boolean respectTtlEnabled; - - public MsgVpnQueueTemplate() { - } - - public MsgVpnQueueTemplate accessType(AccessTypeEnum accessType) { - - this.accessType = accessType; - return this; - } - - /** - * The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are: <pre> \"exclusive\" - Exclusive delivery of messages to the first bound consumer flow. \"non-exclusive\" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion. </pre> - * @return accessType - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACCESS_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AccessTypeEnum getAccessType() { - return accessType; - } - - - @JsonProperty(JSON_PROPERTY_ACCESS_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccessType(AccessTypeEnum accessType) { - this.accessType = accessType; - } - - - public MsgVpnQueueTemplate consumerAckPropagationEnabled(Boolean consumerAckPropagationEnabled) { - - this.consumerAckPropagationEnabled = consumerAckPropagationEnabled; - return this; - } - - /** - * Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return consumerAckPropagationEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONSUMER_ACK_PROPAGATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getConsumerAckPropagationEnabled() { - return consumerAckPropagationEnabled; - } - - - @JsonProperty(JSON_PROPERTY_CONSUMER_ACK_PROPAGATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConsumerAckPropagationEnabled(Boolean consumerAckPropagationEnabled) { - this.consumerAckPropagationEnabled = consumerAckPropagationEnabled; - } - - - public MsgVpnQueueTemplate deadMsgQueue(String deadMsgQueue) { - - this.deadMsgQueue = deadMsgQueue; - return this; - } - - /** - * The name of the Dead Message Queue (DMQ). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. - * @return deadMsgQueue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DEAD_MSG_QUEUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDeadMsgQueue() { - return deadMsgQueue; - } - - - @JsonProperty(JSON_PROPERTY_DEAD_MSG_QUEUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDeadMsgQueue(String deadMsgQueue) { - this.deadMsgQueue = deadMsgQueue; - } - - - public MsgVpnQueueTemplate deliveryDelay(Long deliveryDelay) { - - this.deliveryDelay = deliveryDelay; - return this; - } - - /** - * The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. This attribute does not apply to MQTT queues created from this template, but it may apply in future releases. Therefore, to maintain forward compatibility, do not set this value on templates that might be used for MQTT queues. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22. - * @return deliveryDelay - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DELIVERY_DELAY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getDeliveryDelay() { - return deliveryDelay; - } - - - @JsonProperty(JSON_PROPERTY_DELIVERY_DELAY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDeliveryDelay(Long deliveryDelay) { - this.deliveryDelay = deliveryDelay; - } - - - public MsgVpnQueueTemplate durabilityOverride(DurabilityOverrideEnum durabilityOverride) { - - this.durabilityOverride = durabilityOverride; - return this; - } - - /** - * Controls the durability of queues created from this template. If non-durable, the created queue will be non-durable, regardless of the specified durability. If none, the created queue will have the requested durability. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - The durability of the endpoint will be as requested on create. \"non-durable\" - The durability of the created queue will be non-durable, regardless of what was requested. </pre> - * @return durabilityOverride - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DURABILITY_OVERRIDE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DurabilityOverrideEnum getDurabilityOverride() { - return durabilityOverride; - } - - - @JsonProperty(JSON_PROPERTY_DURABILITY_OVERRIDE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDurabilityOverride(DurabilityOverrideEnum durabilityOverride) { - this.durabilityOverride = durabilityOverride; - } - - - public MsgVpnQueueTemplate eventBindCountThreshold(EventThreshold eventBindCountThreshold) { - - this.eventBindCountThreshold = eventBindCountThreshold; - return this; - } - - /** - * Get eventBindCountThreshold - * @return eventBindCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_BIND_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventBindCountThreshold() { - return eventBindCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_BIND_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventBindCountThreshold(EventThreshold eventBindCountThreshold) { - this.eventBindCountThreshold = eventBindCountThreshold; - } - - - public MsgVpnQueueTemplate eventMsgSpoolUsageThreshold(EventThreshold eventMsgSpoolUsageThreshold) { - - this.eventMsgSpoolUsageThreshold = eventMsgSpoolUsageThreshold; - return this; - } - - /** - * Get eventMsgSpoolUsageThreshold - * @return eventMsgSpoolUsageThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_MSG_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventMsgSpoolUsageThreshold() { - return eventMsgSpoolUsageThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_MSG_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventMsgSpoolUsageThreshold(EventThreshold eventMsgSpoolUsageThreshold) { - this.eventMsgSpoolUsageThreshold = eventMsgSpoolUsageThreshold; - } - - - public MsgVpnQueueTemplate eventRejectLowPriorityMsgLimitThreshold(EventThreshold eventRejectLowPriorityMsgLimitThreshold) { - - this.eventRejectLowPriorityMsgLimitThreshold = eventRejectLowPriorityMsgLimitThreshold; - return this; - } - - /** - * Get eventRejectLowPriorityMsgLimitThreshold - * @return eventRejectLowPriorityMsgLimitThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventRejectLowPriorityMsgLimitThreshold() { - return eventRejectLowPriorityMsgLimitThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventRejectLowPriorityMsgLimitThreshold(EventThreshold eventRejectLowPriorityMsgLimitThreshold) { - this.eventRejectLowPriorityMsgLimitThreshold = eventRejectLowPriorityMsgLimitThreshold; - } - - - public MsgVpnQueueTemplate maxBindCount(Long maxBindCount) { - - this.maxBindCount = maxBindCount; - return this; - } - - /** - * The maximum number of consumer flows that can bind. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. - * @return maxBindCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_BIND_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxBindCount() { - return maxBindCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_BIND_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxBindCount(Long maxBindCount) { - this.maxBindCount = maxBindCount; - } - - - public MsgVpnQueueTemplate maxDeliveredUnackedMsgsPerFlow(Long maxDeliveredUnackedMsgsPerFlow) { - - this.maxDeliveredUnackedMsgsPerFlow = maxDeliveredUnackedMsgsPerFlow; - return this; - } - - /** - * The maximum number of messages delivered but not acknowledged per flow. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. - * @return maxDeliveredUnackedMsgsPerFlow - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxDeliveredUnackedMsgsPerFlow() { - return maxDeliveredUnackedMsgsPerFlow; - } - - - @JsonProperty(JSON_PROPERTY_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxDeliveredUnackedMsgsPerFlow(Long maxDeliveredUnackedMsgsPerFlow) { - this.maxDeliveredUnackedMsgsPerFlow = maxDeliveredUnackedMsgsPerFlow; - } - - - public MsgVpnQueueTemplate maxMsgSize(Integer maxMsgSize) { - - this.maxMsgSize = maxMsgSize; - return this; - } - - /** - * The maximum message size allowed, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. - * @return maxMsgSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_MSG_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getMaxMsgSize() { - return maxMsgSize; - } - - - @JsonProperty(JSON_PROPERTY_MAX_MSG_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxMsgSize(Integer maxMsgSize) { - this.maxMsgSize = maxMsgSize; - } - - - public MsgVpnQueueTemplate maxMsgSpoolUsage(Long maxMsgSpoolUsage) { - - this.maxMsgSpoolUsage = maxMsgSpoolUsage; - return this; - } - - /** - * The maximum message spool usage allowed, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`. - * @return maxMsgSpoolUsage - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_MSG_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxMsgSpoolUsage() { - return maxMsgSpoolUsage; - } - - - @JsonProperty(JSON_PROPERTY_MAX_MSG_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxMsgSpoolUsage(Long maxMsgSpoolUsage) { - this.maxMsgSpoolUsage = maxMsgSpoolUsage; - } - - - public MsgVpnQueueTemplate maxRedeliveryCount(Long maxRedeliveryCount) { - - this.maxRedeliveryCount = maxRedeliveryCount; - return this; - } - - /** - * The maximum number of message redelivery attempts that will occur prior to the message being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return maxRedeliveryCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_REDELIVERY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxRedeliveryCount() { - return maxRedeliveryCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_REDELIVERY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxRedeliveryCount(Long maxRedeliveryCount) { - this.maxRedeliveryCount = maxRedeliveryCount; - } - - - public MsgVpnQueueTemplate maxTtl(Long maxTtl) { - - this.maxTtl = maxTtl; - return this; - } - - /** - * The maximum time in seconds a message can stay in a Queue when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return maxTtl - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_TTL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxTtl() { - return maxTtl; - } - - - @JsonProperty(JSON_PROPERTY_MAX_TTL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxTtl(Long maxTtl) { - this.maxTtl = maxTtl; - } - - - public MsgVpnQueueTemplate msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnQueueTemplate permission(PermissionEnum permission) { - - this.permission = permission; - return this; - } - - /** - * The permission level for all consumers, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are: <pre> \"no-access\" - Disallows all access. \"read-only\" - Read-only access to the messages. \"consume\" - Consume (read and remove) messages. \"modify-topic\" - Consume messages or modify the topic/selector. \"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. </pre> - * @return permission - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PERMISSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PermissionEnum getPermission() { - return permission; - } - - - @JsonProperty(JSON_PROPERTY_PERMISSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPermission(PermissionEnum permission) { - this.permission = permission; - } - - - public MsgVpnQueueTemplate queueNameFilter(String queueNameFilter) { - - this.queueNameFilter = queueNameFilter; - return this; - } - - /** - * A wildcardable pattern used to determine which Queues use settings from this Template. Two different wildcards are supported: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return queueNameFilter - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_NAME_FILTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getQueueNameFilter() { - return queueNameFilter; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_NAME_FILTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueNameFilter(String queueNameFilter) { - this.queueNameFilter = queueNameFilter; - } - - - public MsgVpnQueueTemplate queueTemplateName(String queueTemplateName) { - - this.queueTemplateName = queueTemplateName; - return this; - } - - /** - * The name of the Queue Template. - * @return queueTemplateName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_TEMPLATE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getQueueTemplateName() { - return queueTemplateName; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_TEMPLATE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueTemplateName(String queueTemplateName) { - this.queueTemplateName = queueTemplateName; - } - - - public MsgVpnQueueTemplate redeliveryEnabled(Boolean redeliveryEnabled) { - - this.redeliveryEnabled = redeliveryEnabled; - return this; - } - - /** - * Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the queue more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18. - * @return redeliveryEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REDELIVERY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRedeliveryEnabled() { - return redeliveryEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REDELIVERY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRedeliveryEnabled(Boolean redeliveryEnabled) { - this.redeliveryEnabled = redeliveryEnabled; - } - - - public MsgVpnQueueTemplate rejectLowPriorityMsgEnabled(Boolean rejectLowPriorityMsgEnabled) { - - this.rejectLowPriorityMsgEnabled = rejectLowPriorityMsgEnabled; - return this; - } - - /** - * Enable or disable the checking of low priority messages against the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return rejectLowPriorityMsgEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRejectLowPriorityMsgEnabled() { - return rejectLowPriorityMsgEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRejectLowPriorityMsgEnabled(Boolean rejectLowPriorityMsgEnabled) { - this.rejectLowPriorityMsgEnabled = rejectLowPriorityMsgEnabled; - } - - - public MsgVpnQueueTemplate rejectLowPriorityMsgLimit(Long rejectLowPriorityMsgLimit) { - - this.rejectLowPriorityMsgLimit = rejectLowPriorityMsgLimit; - return this; - } - - /** - * The number of messages of any priority above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return rejectLowPriorityMsgLimit - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_LIMIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getRejectLowPriorityMsgLimit() { - return rejectLowPriorityMsgLimit; - } - - - @JsonProperty(JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_LIMIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRejectLowPriorityMsgLimit(Long rejectLowPriorityMsgLimit) { - this.rejectLowPriorityMsgLimit = rejectLowPriorityMsgLimit; - } - - - public MsgVpnQueueTemplate rejectMsgToSenderOnDiscardBehavior(RejectMsgToSenderOnDiscardBehaviorEnum rejectMsgToSenderOnDiscardBehavior) { - - this.rejectMsgToSenderOnDiscardBehavior = rejectMsgToSenderOnDiscardBehavior; - return this; - } - - /** - * Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs prevent the message from being delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-queue-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> - * @return rejectMsgToSenderOnDiscardBehavior - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public RejectMsgToSenderOnDiscardBehaviorEnum getRejectMsgToSenderOnDiscardBehavior() { - return rejectMsgToSenderOnDiscardBehavior; - } - - - @JsonProperty(JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRejectMsgToSenderOnDiscardBehavior(RejectMsgToSenderOnDiscardBehaviorEnum rejectMsgToSenderOnDiscardBehavior) { - this.rejectMsgToSenderOnDiscardBehavior = rejectMsgToSenderOnDiscardBehavior; - } - - - public MsgVpnQueueTemplate respectMsgPriorityEnabled(Boolean respectMsgPriorityEnabled) { - - this.respectMsgPriorityEnabled = respectMsgPriorityEnabled; - return this; - } - - /** - * Enable or disable the respecting of message priority. When enabled, messages are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return respectMsgPriorityEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESPECT_MSG_PRIORITY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRespectMsgPriorityEnabled() { - return respectMsgPriorityEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESPECT_MSG_PRIORITY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRespectMsgPriorityEnabled(Boolean respectMsgPriorityEnabled) { - this.respectMsgPriorityEnabled = respectMsgPriorityEnabled; - } - - - public MsgVpnQueueTemplate respectTtlEnabled(Boolean respectTtlEnabled) { - - this.respectTtlEnabled = respectTtlEnabled; - return this; - } - - /** - * Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return respectTtlEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESPECT_TTL_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRespectTtlEnabled() { - return respectTtlEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESPECT_TTL_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRespectTtlEnabled(Boolean respectTtlEnabled) { - this.respectTtlEnabled = respectTtlEnabled; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnQueueTemplate msgVpnQueueTemplate = (MsgVpnQueueTemplate) o; - return Objects.equals(this.accessType, msgVpnQueueTemplate.accessType) && - Objects.equals(this.consumerAckPropagationEnabled, msgVpnQueueTemplate.consumerAckPropagationEnabled) && - Objects.equals(this.deadMsgQueue, msgVpnQueueTemplate.deadMsgQueue) && - Objects.equals(this.deliveryDelay, msgVpnQueueTemplate.deliveryDelay) && - Objects.equals(this.durabilityOverride, msgVpnQueueTemplate.durabilityOverride) && - Objects.equals(this.eventBindCountThreshold, msgVpnQueueTemplate.eventBindCountThreshold) && - Objects.equals(this.eventMsgSpoolUsageThreshold, msgVpnQueueTemplate.eventMsgSpoolUsageThreshold) && - Objects.equals(this.eventRejectLowPriorityMsgLimitThreshold, msgVpnQueueTemplate.eventRejectLowPriorityMsgLimitThreshold) && - Objects.equals(this.maxBindCount, msgVpnQueueTemplate.maxBindCount) && - Objects.equals(this.maxDeliveredUnackedMsgsPerFlow, msgVpnQueueTemplate.maxDeliveredUnackedMsgsPerFlow) && - Objects.equals(this.maxMsgSize, msgVpnQueueTemplate.maxMsgSize) && - Objects.equals(this.maxMsgSpoolUsage, msgVpnQueueTemplate.maxMsgSpoolUsage) && - Objects.equals(this.maxRedeliveryCount, msgVpnQueueTemplate.maxRedeliveryCount) && - Objects.equals(this.maxTtl, msgVpnQueueTemplate.maxTtl) && - Objects.equals(this.msgVpnName, msgVpnQueueTemplate.msgVpnName) && - Objects.equals(this.permission, msgVpnQueueTemplate.permission) && - Objects.equals(this.queueNameFilter, msgVpnQueueTemplate.queueNameFilter) && - Objects.equals(this.queueTemplateName, msgVpnQueueTemplate.queueTemplateName) && - Objects.equals(this.redeliveryEnabled, msgVpnQueueTemplate.redeliveryEnabled) && - Objects.equals(this.rejectLowPriorityMsgEnabled, msgVpnQueueTemplate.rejectLowPriorityMsgEnabled) && - Objects.equals(this.rejectLowPriorityMsgLimit, msgVpnQueueTemplate.rejectLowPriorityMsgLimit) && - Objects.equals(this.rejectMsgToSenderOnDiscardBehavior, msgVpnQueueTemplate.rejectMsgToSenderOnDiscardBehavior) && - Objects.equals(this.respectMsgPriorityEnabled, msgVpnQueueTemplate.respectMsgPriorityEnabled) && - Objects.equals(this.respectTtlEnabled, msgVpnQueueTemplate.respectTtlEnabled); - } - - @Override - public int hashCode() { - return Objects.hash(accessType, consumerAckPropagationEnabled, deadMsgQueue, deliveryDelay, durabilityOverride, eventBindCountThreshold, eventMsgSpoolUsageThreshold, eventRejectLowPriorityMsgLimitThreshold, maxBindCount, maxDeliveredUnackedMsgsPerFlow, maxMsgSize, maxMsgSpoolUsage, maxRedeliveryCount, maxTtl, msgVpnName, permission, queueNameFilter, queueTemplateName, redeliveryEnabled, rejectLowPriorityMsgEnabled, rejectLowPriorityMsgLimit, rejectMsgToSenderOnDiscardBehavior, respectMsgPriorityEnabled, respectTtlEnabled); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnQueueTemplate {\n"); - sb.append(" accessType: ").append(toIndentedString(accessType)).append("\n"); - sb.append(" consumerAckPropagationEnabled: ").append(toIndentedString(consumerAckPropagationEnabled)).append("\n"); - sb.append(" deadMsgQueue: ").append(toIndentedString(deadMsgQueue)).append("\n"); - sb.append(" deliveryDelay: ").append(toIndentedString(deliveryDelay)).append("\n"); - sb.append(" durabilityOverride: ").append(toIndentedString(durabilityOverride)).append("\n"); - sb.append(" eventBindCountThreshold: ").append(toIndentedString(eventBindCountThreshold)).append("\n"); - sb.append(" eventMsgSpoolUsageThreshold: ").append(toIndentedString(eventMsgSpoolUsageThreshold)).append("\n"); - sb.append(" eventRejectLowPriorityMsgLimitThreshold: ").append(toIndentedString(eventRejectLowPriorityMsgLimitThreshold)).append("\n"); - sb.append(" maxBindCount: ").append(toIndentedString(maxBindCount)).append("\n"); - sb.append(" maxDeliveredUnackedMsgsPerFlow: ").append(toIndentedString(maxDeliveredUnackedMsgsPerFlow)).append("\n"); - sb.append(" maxMsgSize: ").append(toIndentedString(maxMsgSize)).append("\n"); - sb.append(" maxMsgSpoolUsage: ").append(toIndentedString(maxMsgSpoolUsage)).append("\n"); - sb.append(" maxRedeliveryCount: ").append(toIndentedString(maxRedeliveryCount)).append("\n"); - sb.append(" maxTtl: ").append(toIndentedString(maxTtl)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" permission: ").append(toIndentedString(permission)).append("\n"); - sb.append(" queueNameFilter: ").append(toIndentedString(queueNameFilter)).append("\n"); - sb.append(" queueTemplateName: ").append(toIndentedString(queueTemplateName)).append("\n"); - sb.append(" redeliveryEnabled: ").append(toIndentedString(redeliveryEnabled)).append("\n"); - sb.append(" rejectLowPriorityMsgEnabled: ").append(toIndentedString(rejectLowPriorityMsgEnabled)).append("\n"); - sb.append(" rejectLowPriorityMsgLimit: ").append(toIndentedString(rejectLowPriorityMsgLimit)).append("\n"); - sb.append(" rejectMsgToSenderOnDiscardBehavior: ").append(toIndentedString(rejectMsgToSenderOnDiscardBehavior)).append("\n"); - sb.append(" respectMsgPriorityEnabled: ").append(toIndentedString(respectMsgPriorityEnabled)).append("\n"); - sb.append(" respectTtlEnabled: ").append(toIndentedString(respectTtlEnabled)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateLinks.java deleted file mode 100644 index e11b21020..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnQueueTemplateLinks - */ -@JsonPropertyOrder({ - MsgVpnQueueTemplateLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnQueueTemplateLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnQueueTemplateLinks() { - } - - public MsgVpnQueueTemplateLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Queue Template object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnQueueTemplateLinks msgVpnQueueTemplateLinks = (MsgVpnQueueTemplateLinks) o; - return Objects.equals(this.uri, msgVpnQueueTemplateLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnQueueTemplateLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateResponse.java deleted file mode 100644 index 970c1a648..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplateLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnQueueTemplateResponse - */ -@JsonPropertyOrder({ - MsgVpnQueueTemplateResponse.JSON_PROPERTY_DATA, - MsgVpnQueueTemplateResponse.JSON_PROPERTY_LINKS, - MsgVpnQueueTemplateResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnQueueTemplateResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnQueueTemplate data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnQueueTemplateLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnQueueTemplateResponse() { - } - - public MsgVpnQueueTemplateResponse data(MsgVpnQueueTemplate data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnQueueTemplate getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnQueueTemplate data) { - this.data = data; - } - - - public MsgVpnQueueTemplateResponse links(MsgVpnQueueTemplateLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnQueueTemplateLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnQueueTemplateLinks links) { - this.links = links; - } - - - public MsgVpnQueueTemplateResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnQueueTemplateResponse msgVpnQueueTemplateResponse = (MsgVpnQueueTemplateResponse) o; - return Objects.equals(this.data, msgVpnQueueTemplateResponse.data) && - Objects.equals(this.links, msgVpnQueueTemplateResponse.links) && - Objects.equals(this.meta, msgVpnQueueTemplateResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnQueueTemplateResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplatesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplatesResponse.java deleted file mode 100644 index 8d6337fde..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplatesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplateLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnQueueTemplatesResponse - */ -@JsonPropertyOrder({ - MsgVpnQueueTemplatesResponse.JSON_PROPERTY_DATA, - MsgVpnQueueTemplatesResponse.JSON_PROPERTY_LINKS, - MsgVpnQueueTemplatesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnQueueTemplatesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnQueueTemplatesResponse() { - } - - public MsgVpnQueueTemplatesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnQueueTemplatesResponse addDataItem(MsgVpnQueueTemplate dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnQueueTemplatesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnQueueTemplatesResponse addLinksItem(MsgVpnQueueTemplateLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnQueueTemplatesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnQueueTemplatesResponse msgVpnQueueTemplatesResponse = (MsgVpnQueueTemplatesResponse) o; - return Objects.equals(this.data, msgVpnQueueTemplatesResponse.data) && - Objects.equals(this.links, msgVpnQueueTemplatesResponse.links) && - Objects.equals(this.meta, msgVpnQueueTemplatesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnQueueTemplatesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueuesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueuesResponse.java deleted file mode 100644 index e511eef36..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueuesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnQueuesResponse - */ -@JsonPropertyOrder({ - MsgVpnQueuesResponse.JSON_PROPERTY_DATA, - MsgVpnQueuesResponse.JSON_PROPERTY_LINKS, - MsgVpnQueuesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnQueuesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnQueuesResponse() { - } - - public MsgVpnQueuesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnQueuesResponse addDataItem(MsgVpnQueue dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnQueuesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnQueuesResponse addLinksItem(MsgVpnQueueLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnQueuesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnQueuesResponse msgVpnQueuesResponse = (MsgVpnQueuesResponse) o; - return Objects.equals(this.data, msgVpnQueuesResponse.data) && - Objects.equals(this.links, msgVpnQueuesResponse.links) && - Objects.equals(this.meta, msgVpnQueuesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnQueuesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLog.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLog.java deleted file mode 100644 index 679a7df0c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLog.java +++ /dev/null @@ -1,264 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnReplayLog - */ -@JsonPropertyOrder({ - MsgVpnReplayLog.JSON_PROPERTY_EGRESS_ENABLED, - MsgVpnReplayLog.JSON_PROPERTY_INGRESS_ENABLED, - MsgVpnReplayLog.JSON_PROPERTY_MAX_SPOOL_USAGE, - MsgVpnReplayLog.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnReplayLog.JSON_PROPERTY_REPLAY_LOG_NAME, - MsgVpnReplayLog.JSON_PROPERTY_TOPIC_FILTER_ENABLED -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnReplayLog { - public static final String JSON_PROPERTY_EGRESS_ENABLED = "egressEnabled"; - private Boolean egressEnabled; - - public static final String JSON_PROPERTY_INGRESS_ENABLED = "ingressEnabled"; - private Boolean ingressEnabled; - - public static final String JSON_PROPERTY_MAX_SPOOL_USAGE = "maxSpoolUsage"; - private Long maxSpoolUsage; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_REPLAY_LOG_NAME = "replayLogName"; - private String replayLogName; - - public static final String JSON_PROPERTY_TOPIC_FILTER_ENABLED = "topicFilterEnabled"; - private Boolean topicFilterEnabled; - - public MsgVpnReplayLog() { - } - - public MsgVpnReplayLog egressEnabled(Boolean egressEnabled) { - - this.egressEnabled = egressEnabled; - return this; - } - - /** - * Enable or disable the transmission of messages from the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return egressEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EGRESS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEgressEnabled() { - return egressEnabled; - } - - - @JsonProperty(JSON_PROPERTY_EGRESS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEgressEnabled(Boolean egressEnabled) { - this.egressEnabled = egressEnabled; - } - - - public MsgVpnReplayLog ingressEnabled(Boolean ingressEnabled) { - - this.ingressEnabled = ingressEnabled; - return this; - } - - /** - * Enable or disable the reception of messages to the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return ingressEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_INGRESS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getIngressEnabled() { - return ingressEnabled; - } - - - @JsonProperty(JSON_PROPERTY_INGRESS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIngressEnabled(Boolean ingressEnabled) { - this.ingressEnabled = ingressEnabled; - } - - - public MsgVpnReplayLog maxSpoolUsage(Long maxSpoolUsage) { - - this.maxSpoolUsage = maxSpoolUsage; - return this; - } - - /** - * The maximum spool usage allowed by the Replay Log, in megabytes (MB). If this limit is exceeded, old messages will be trimmed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return maxSpoolUsage - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxSpoolUsage() { - return maxSpoolUsage; - } - - - @JsonProperty(JSON_PROPERTY_MAX_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxSpoolUsage(Long maxSpoolUsage) { - this.maxSpoolUsage = maxSpoolUsage; - } - - - public MsgVpnReplayLog msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnReplayLog replayLogName(String replayLogName) { - - this.replayLogName = replayLogName; - return this; - } - - /** - * The name of the Replay Log. - * @return replayLogName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLAY_LOG_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getReplayLogName() { - return replayLogName; - } - - - @JsonProperty(JSON_PROPERTY_REPLAY_LOG_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplayLogName(String replayLogName) { - this.replayLogName = replayLogName; - } - - - public MsgVpnReplayLog topicFilterEnabled(Boolean topicFilterEnabled) { - - this.topicFilterEnabled = topicFilterEnabled; - return this; - } - - /** - * Enable or disable topic filtering for the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.27. - * @return topicFilterEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOPIC_FILTER_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTopicFilterEnabled() { - return topicFilterEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TOPIC_FILTER_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTopicFilterEnabled(Boolean topicFilterEnabled) { - this.topicFilterEnabled = topicFilterEnabled; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnReplayLog msgVpnReplayLog = (MsgVpnReplayLog) o; - return Objects.equals(this.egressEnabled, msgVpnReplayLog.egressEnabled) && - Objects.equals(this.ingressEnabled, msgVpnReplayLog.ingressEnabled) && - Objects.equals(this.maxSpoolUsage, msgVpnReplayLog.maxSpoolUsage) && - Objects.equals(this.msgVpnName, msgVpnReplayLog.msgVpnName) && - Objects.equals(this.replayLogName, msgVpnReplayLog.replayLogName) && - Objects.equals(this.topicFilterEnabled, msgVpnReplayLog.topicFilterEnabled); - } - - @Override - public int hashCode() { - return Objects.hash(egressEnabled, ingressEnabled, maxSpoolUsage, msgVpnName, replayLogName, topicFilterEnabled); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnReplayLog {\n"); - sb.append(" egressEnabled: ").append(toIndentedString(egressEnabled)).append("\n"); - sb.append(" ingressEnabled: ").append(toIndentedString(ingressEnabled)).append("\n"); - sb.append(" maxSpoolUsage: ").append(toIndentedString(maxSpoolUsage)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" replayLogName: ").append(toIndentedString(replayLogName)).append("\n"); - sb.append(" topicFilterEnabled: ").append(toIndentedString(topicFilterEnabled)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogLinks.java deleted file mode 100644 index 3918ba590..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogLinks.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnReplayLogLinks - */ -@JsonPropertyOrder({ - MsgVpnReplayLogLinks.JSON_PROPERTY_TOPIC_FILTER_SUBSCRIPTIONS_URI, - MsgVpnReplayLogLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnReplayLogLinks { - public static final String JSON_PROPERTY_TOPIC_FILTER_SUBSCRIPTIONS_URI = "topicFilterSubscriptionsUri"; - private String topicFilterSubscriptionsUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnReplayLogLinks() { - } - - public MsgVpnReplayLogLinks topicFilterSubscriptionsUri(String topicFilterSubscriptionsUri) { - - this.topicFilterSubscriptionsUri = topicFilterSubscriptionsUri; - return this; - } - - /** - * The URI of this Replay Log's collection of Topic Filter Subscription objects. Available since 2.27. - * @return topicFilterSubscriptionsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOPIC_FILTER_SUBSCRIPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTopicFilterSubscriptionsUri() { - return topicFilterSubscriptionsUri; - } - - - @JsonProperty(JSON_PROPERTY_TOPIC_FILTER_SUBSCRIPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTopicFilterSubscriptionsUri(String topicFilterSubscriptionsUri) { - this.topicFilterSubscriptionsUri = topicFilterSubscriptionsUri; - } - - - public MsgVpnReplayLogLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Replay Log object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnReplayLogLinks msgVpnReplayLogLinks = (MsgVpnReplayLogLinks) o; - return Objects.equals(this.topicFilterSubscriptionsUri, msgVpnReplayLogLinks.topicFilterSubscriptionsUri) && - Objects.equals(this.uri, msgVpnReplayLogLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(topicFilterSubscriptionsUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnReplayLogLinks {\n"); - sb.append(" topicFilterSubscriptionsUri: ").append(toIndentedString(topicFilterSubscriptionsUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogResponse.java deleted file mode 100644 index 1b5a370f7..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLog; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnReplayLogResponse - */ -@JsonPropertyOrder({ - MsgVpnReplayLogResponse.JSON_PROPERTY_DATA, - MsgVpnReplayLogResponse.JSON_PROPERTY_LINKS, - MsgVpnReplayLogResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnReplayLogResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnReplayLog data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnReplayLogLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnReplayLogResponse() { - } - - public MsgVpnReplayLogResponse data(MsgVpnReplayLog data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnReplayLog getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnReplayLog data) { - this.data = data; - } - - - public MsgVpnReplayLogResponse links(MsgVpnReplayLogLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnReplayLogLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnReplayLogLinks links) { - this.links = links; - } - - - public MsgVpnReplayLogResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnReplayLogResponse msgVpnReplayLogResponse = (MsgVpnReplayLogResponse) o; - return Objects.equals(this.data, msgVpnReplayLogResponse.data) && - Objects.equals(this.links, msgVpnReplayLogResponse.links) && - Objects.equals(this.meta, msgVpnReplayLogResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnReplayLogResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscription.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscription.java deleted file mode 100644 index ab4c169f5..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscription.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnReplayLogTopicFilterSubscription - */ -@JsonPropertyOrder({ - MsgVpnReplayLogTopicFilterSubscription.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnReplayLogTopicFilterSubscription.JSON_PROPERTY_REPLAY_LOG_NAME, - MsgVpnReplayLogTopicFilterSubscription.JSON_PROPERTY_TOPIC_FILTER_SUBSCRIPTION -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnReplayLogTopicFilterSubscription { - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_REPLAY_LOG_NAME = "replayLogName"; - private String replayLogName; - - public static final String JSON_PROPERTY_TOPIC_FILTER_SUBSCRIPTION = "topicFilterSubscription"; - private String topicFilterSubscription; - - public MsgVpnReplayLogTopicFilterSubscription() { - } - - public MsgVpnReplayLogTopicFilterSubscription msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnReplayLogTopicFilterSubscription replayLogName(String replayLogName) { - - this.replayLogName = replayLogName; - return this; - } - - /** - * The name of the Replay Log. - * @return replayLogName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLAY_LOG_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getReplayLogName() { - return replayLogName; - } - - - @JsonProperty(JSON_PROPERTY_REPLAY_LOG_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplayLogName(String replayLogName) { - this.replayLogName = replayLogName; - } - - - public MsgVpnReplayLogTopicFilterSubscription topicFilterSubscription(String topicFilterSubscription) { - - this.topicFilterSubscription = topicFilterSubscription; - return this; - } - - /** - * The topic of the Subscription. - * @return topicFilterSubscription - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOPIC_FILTER_SUBSCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTopicFilterSubscription() { - return topicFilterSubscription; - } - - - @JsonProperty(JSON_PROPERTY_TOPIC_FILTER_SUBSCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTopicFilterSubscription(String topicFilterSubscription) { - this.topicFilterSubscription = topicFilterSubscription; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnReplayLogTopicFilterSubscription msgVpnReplayLogTopicFilterSubscription = (MsgVpnReplayLogTopicFilterSubscription) o; - return Objects.equals(this.msgVpnName, msgVpnReplayLogTopicFilterSubscription.msgVpnName) && - Objects.equals(this.replayLogName, msgVpnReplayLogTopicFilterSubscription.replayLogName) && - Objects.equals(this.topicFilterSubscription, msgVpnReplayLogTopicFilterSubscription.topicFilterSubscription); - } - - @Override - public int hashCode() { - return Objects.hash(msgVpnName, replayLogName, topicFilterSubscription); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnReplayLogTopicFilterSubscription {\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" replayLogName: ").append(toIndentedString(replayLogName)).append("\n"); - sb.append(" topicFilterSubscription: ").append(toIndentedString(topicFilterSubscription)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionLinks.java deleted file mode 100644 index 1684fb35a..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnReplayLogTopicFilterSubscriptionLinks - */ -@JsonPropertyOrder({ - MsgVpnReplayLogTopicFilterSubscriptionLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnReplayLogTopicFilterSubscriptionLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnReplayLogTopicFilterSubscriptionLinks() { - } - - public MsgVpnReplayLogTopicFilterSubscriptionLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Topic Filter Subscription object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnReplayLogTopicFilterSubscriptionLinks msgVpnReplayLogTopicFilterSubscriptionLinks = (MsgVpnReplayLogTopicFilterSubscriptionLinks) o; - return Objects.equals(this.uri, msgVpnReplayLogTopicFilterSubscriptionLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnReplayLogTopicFilterSubscriptionLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionResponse.java deleted file mode 100644 index de1522d37..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscriptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnReplayLogTopicFilterSubscriptionResponse - */ -@JsonPropertyOrder({ - MsgVpnReplayLogTopicFilterSubscriptionResponse.JSON_PROPERTY_DATA, - MsgVpnReplayLogTopicFilterSubscriptionResponse.JSON_PROPERTY_LINKS, - MsgVpnReplayLogTopicFilterSubscriptionResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnReplayLogTopicFilterSubscriptionResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnReplayLogTopicFilterSubscription data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnReplayLogTopicFilterSubscriptionLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnReplayLogTopicFilterSubscriptionResponse() { - } - - public MsgVpnReplayLogTopicFilterSubscriptionResponse data(MsgVpnReplayLogTopicFilterSubscription data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnReplayLogTopicFilterSubscription getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnReplayLogTopicFilterSubscription data) { - this.data = data; - } - - - public MsgVpnReplayLogTopicFilterSubscriptionResponse links(MsgVpnReplayLogTopicFilterSubscriptionLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnReplayLogTopicFilterSubscriptionLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnReplayLogTopicFilterSubscriptionLinks links) { - this.links = links; - } - - - public MsgVpnReplayLogTopicFilterSubscriptionResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnReplayLogTopicFilterSubscriptionResponse msgVpnReplayLogTopicFilterSubscriptionResponse = (MsgVpnReplayLogTopicFilterSubscriptionResponse) o; - return Objects.equals(this.data, msgVpnReplayLogTopicFilterSubscriptionResponse.data) && - Objects.equals(this.links, msgVpnReplayLogTopicFilterSubscriptionResponse.links) && - Objects.equals(this.meta, msgVpnReplayLogTopicFilterSubscriptionResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnReplayLogTopicFilterSubscriptionResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionsResponse.java deleted file mode 100644 index 32c01ee75..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscriptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnReplayLogTopicFilterSubscriptionsResponse - */ -@JsonPropertyOrder({ - MsgVpnReplayLogTopicFilterSubscriptionsResponse.JSON_PROPERTY_DATA, - MsgVpnReplayLogTopicFilterSubscriptionsResponse.JSON_PROPERTY_LINKS, - MsgVpnReplayLogTopicFilterSubscriptionsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnReplayLogTopicFilterSubscriptionsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnReplayLogTopicFilterSubscriptionsResponse() { - } - - public MsgVpnReplayLogTopicFilterSubscriptionsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnReplayLogTopicFilterSubscriptionsResponse addDataItem(MsgVpnReplayLogTopicFilterSubscription dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnReplayLogTopicFilterSubscriptionsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnReplayLogTopicFilterSubscriptionsResponse addLinksItem(MsgVpnReplayLogTopicFilterSubscriptionLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnReplayLogTopicFilterSubscriptionsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnReplayLogTopicFilterSubscriptionsResponse msgVpnReplayLogTopicFilterSubscriptionsResponse = (MsgVpnReplayLogTopicFilterSubscriptionsResponse) o; - return Objects.equals(this.data, msgVpnReplayLogTopicFilterSubscriptionsResponse.data) && - Objects.equals(this.links, msgVpnReplayLogTopicFilterSubscriptionsResponse.links) && - Objects.equals(this.meta, msgVpnReplayLogTopicFilterSubscriptionsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnReplayLogTopicFilterSubscriptionsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogsResponse.java deleted file mode 100644 index 78d865beb..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLog; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnReplayLogsResponse - */ -@JsonPropertyOrder({ - MsgVpnReplayLogsResponse.JSON_PROPERTY_DATA, - MsgVpnReplayLogsResponse.JSON_PROPERTY_LINKS, - MsgVpnReplayLogsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnReplayLogsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnReplayLogsResponse() { - } - - public MsgVpnReplayLogsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnReplayLogsResponse addDataItem(MsgVpnReplayLog dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnReplayLogsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnReplayLogsResponse addLinksItem(MsgVpnReplayLogLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnReplayLogsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnReplayLogsResponse msgVpnReplayLogsResponse = (MsgVpnReplayLogsResponse) o; - return Objects.equals(this.data, msgVpnReplayLogsResponse.data) && - Objects.equals(this.links, msgVpnReplayLogsResponse.links) && - Objects.equals(this.meta, msgVpnReplayLogsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnReplayLogsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopic.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopic.java deleted file mode 100644 index 66a789d75..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopic.java +++ /dev/null @@ -1,203 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnReplicatedTopic - */ -@JsonPropertyOrder({ - MsgVpnReplicatedTopic.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnReplicatedTopic.JSON_PROPERTY_REPLICATED_TOPIC, - MsgVpnReplicatedTopic.JSON_PROPERTY_REPLICATION_MODE -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnReplicatedTopic { - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_REPLICATED_TOPIC = "replicatedTopic"; - private String replicatedTopic; - - /** - * The replication mode for the Replicated Topic. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"async\"`. The allowed values and their meaning are: <pre> \"sync\" - Messages are acknowledged when replicated (spooled remotely). \"async\" - Messages are acknowledged when pending replication (spooled locally). </pre> - */ - public enum ReplicationModeEnum { - SYNC("sync"), - - ASYNC("async"); - - private String value; - - ReplicationModeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static ReplicationModeEnum fromValue(String value) { - for (ReplicationModeEnum b : ReplicationModeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_REPLICATION_MODE = "replicationMode"; - private ReplicationModeEnum replicationMode; - - public MsgVpnReplicatedTopic() { - } - - public MsgVpnReplicatedTopic msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnReplicatedTopic replicatedTopic(String replicatedTopic) { - - this.replicatedTopic = replicatedTopic; - return this; - } - - /** - * The topic for applying replication. Published messages matching this topic will be replicated to the standby site. - * @return replicatedTopic - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATED_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getReplicatedTopic() { - return replicatedTopic; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATED_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicatedTopic(String replicatedTopic) { - this.replicatedTopic = replicatedTopic; - } - - - public MsgVpnReplicatedTopic replicationMode(ReplicationModeEnum replicationMode) { - - this.replicationMode = replicationMode; - return this; - } - - /** - * The replication mode for the Replicated Topic. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"async\"`. The allowed values and their meaning are: <pre> \"sync\" - Messages are acknowledged when replicated (spooled remotely). \"async\" - Messages are acknowledged when pending replication (spooled locally). </pre> - * @return replicationMode - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REPLICATION_MODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ReplicationModeEnum getReplicationMode() { - return replicationMode; - } - - - @JsonProperty(JSON_PROPERTY_REPLICATION_MODE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReplicationMode(ReplicationModeEnum replicationMode) { - this.replicationMode = replicationMode; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnReplicatedTopic msgVpnReplicatedTopic = (MsgVpnReplicatedTopic) o; - return Objects.equals(this.msgVpnName, msgVpnReplicatedTopic.msgVpnName) && - Objects.equals(this.replicatedTopic, msgVpnReplicatedTopic.replicatedTopic) && - Objects.equals(this.replicationMode, msgVpnReplicatedTopic.replicationMode); - } - - @Override - public int hashCode() { - return Objects.hash(msgVpnName, replicatedTopic, replicationMode); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnReplicatedTopic {\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" replicatedTopic: ").append(toIndentedString(replicatedTopic)).append("\n"); - sb.append(" replicationMode: ").append(toIndentedString(replicationMode)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicLinks.java deleted file mode 100644 index 37cd33b4a..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnReplicatedTopicLinks - */ -@JsonPropertyOrder({ - MsgVpnReplicatedTopicLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnReplicatedTopicLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnReplicatedTopicLinks() { - } - - public MsgVpnReplicatedTopicLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Replicated Topic object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnReplicatedTopicLinks msgVpnReplicatedTopicLinks = (MsgVpnReplicatedTopicLinks) o; - return Objects.equals(this.uri, msgVpnReplicatedTopicLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnReplicatedTopicLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicResponse.java deleted file mode 100644 index f25501302..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopicLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnReplicatedTopicResponse - */ -@JsonPropertyOrder({ - MsgVpnReplicatedTopicResponse.JSON_PROPERTY_DATA, - MsgVpnReplicatedTopicResponse.JSON_PROPERTY_LINKS, - MsgVpnReplicatedTopicResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnReplicatedTopicResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnReplicatedTopic data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnReplicatedTopicLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnReplicatedTopicResponse() { - } - - public MsgVpnReplicatedTopicResponse data(MsgVpnReplicatedTopic data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnReplicatedTopic getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnReplicatedTopic data) { - this.data = data; - } - - - public MsgVpnReplicatedTopicResponse links(MsgVpnReplicatedTopicLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnReplicatedTopicLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnReplicatedTopicLinks links) { - this.links = links; - } - - - public MsgVpnReplicatedTopicResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnReplicatedTopicResponse msgVpnReplicatedTopicResponse = (MsgVpnReplicatedTopicResponse) o; - return Objects.equals(this.data, msgVpnReplicatedTopicResponse.data) && - Objects.equals(this.links, msgVpnReplicatedTopicResponse.links) && - Objects.equals(this.meta, msgVpnReplicatedTopicResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnReplicatedTopicResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicsResponse.java deleted file mode 100644 index 155eafda6..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopicLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnReplicatedTopicsResponse - */ -@JsonPropertyOrder({ - MsgVpnReplicatedTopicsResponse.JSON_PROPERTY_DATA, - MsgVpnReplicatedTopicsResponse.JSON_PROPERTY_LINKS, - MsgVpnReplicatedTopicsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnReplicatedTopicsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnReplicatedTopicsResponse() { - } - - public MsgVpnReplicatedTopicsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnReplicatedTopicsResponse addDataItem(MsgVpnReplicatedTopic dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnReplicatedTopicsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnReplicatedTopicsResponse addLinksItem(MsgVpnReplicatedTopicLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnReplicatedTopicsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnReplicatedTopicsResponse msgVpnReplicatedTopicsResponse = (MsgVpnReplicatedTopicsResponse) o; - return Objects.equals(this.data, msgVpnReplicatedTopicsResponse.data) && - Objects.equals(this.links, msgVpnReplicatedTopicsResponse.links) && - Objects.equals(this.meta, msgVpnReplicatedTopicsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnReplicatedTopicsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnResponse.java deleted file mode 100644 index 1aa1216fa..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnResponse - */ -@JsonPropertyOrder({ - MsgVpnResponse.JSON_PROPERTY_DATA, - MsgVpnResponse.JSON_PROPERTY_LINKS, - MsgVpnResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpn data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnResponse() { - } - - public MsgVpnResponse data(MsgVpn data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpn getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpn data) { - this.data = data; - } - - - public MsgVpnResponse links(MsgVpnLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnLinks links) { - this.links = links; - } - - - public MsgVpnResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnResponse msgVpnResponse = (MsgVpnResponse) o; - return Objects.equals(this.data, msgVpnResponse.data) && - Objects.equals(this.links, msgVpnResponse.links) && - Objects.equals(this.meta, msgVpnResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPoint.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPoint.java deleted file mode 100644 index 6c2702cc6..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPoint.java +++ /dev/null @@ -1,264 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPoint - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPoint.JSON_PROPERTY_CLIENT_PROFILE_NAME, - MsgVpnRestDeliveryPoint.JSON_PROPERTY_ENABLED, - MsgVpnRestDeliveryPoint.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnRestDeliveryPoint.JSON_PROPERTY_REST_DELIVERY_POINT_NAME, - MsgVpnRestDeliveryPoint.JSON_PROPERTY_SERVICE, - MsgVpnRestDeliveryPoint.JSON_PROPERTY_VENDOR -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPoint { - public static final String JSON_PROPERTY_CLIENT_PROFILE_NAME = "clientProfileName"; - private String clientProfileName; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_REST_DELIVERY_POINT_NAME = "restDeliveryPointName"; - private String restDeliveryPointName; - - public static final String JSON_PROPERTY_SERVICE = "service"; - private String service; - - public static final String JSON_PROPERTY_VENDOR = "vendor"; - private String vendor; - - public MsgVpnRestDeliveryPoint() { - } - - public MsgVpnRestDeliveryPoint clientProfileName(String clientProfileName) { - - this.clientProfileName = clientProfileName; - return this; - } - - /** - * The Client Profile of the REST Delivery Point. It must exist in the local Message VPN. Its TCP parameters are used for all REST Consumers in this RDP. Its queue properties are used by the RDP client. The Client Profile is used inside the auto-generated Client Username for this RDP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`. - * @return clientProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientProfileName() { - return clientProfileName; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientProfileName(String clientProfileName) { - this.clientProfileName = clientProfileName; - } - - - public MsgVpnRestDeliveryPoint enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the REST Delivery Point. When disabled, no connections are initiated or messages delivered to any of the contained REST Consumers. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public MsgVpnRestDeliveryPoint msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnRestDeliveryPoint restDeliveryPointName(String restDeliveryPointName) { - - this.restDeliveryPointName = restDeliveryPointName; - return this; - } - - /** - * The name of the REST Delivery Point. - * @return restDeliveryPointName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REST_DELIVERY_POINT_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRestDeliveryPointName() { - return restDeliveryPointName; - } - - - @JsonProperty(JSON_PROPERTY_REST_DELIVERY_POINT_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRestDeliveryPointName(String restDeliveryPointName) { - this.restDeliveryPointName = restDeliveryPointName; - } - - - public MsgVpnRestDeliveryPoint service(String service) { - - this.service = service; - return this; - } - - /** - * The name of the service that this REST Delivery Point connects to. Internally the broker does not use this value; it is informational only. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19. - * @return service - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SERVICE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getService() { - return service; - } - - - @JsonProperty(JSON_PROPERTY_SERVICE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setService(String service) { - this.service = service; - } - - - public MsgVpnRestDeliveryPoint vendor(String vendor) { - - this.vendor = vendor; - return this; - } - - /** - * The name of the vendor that this REST Delivery Point connects to. Internally the broker does not use this value; it is informational only. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19. - * @return vendor - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_VENDOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getVendor() { - return vendor; - } - - - @JsonProperty(JSON_PROPERTY_VENDOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setVendor(String vendor) { - this.vendor = vendor; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPoint msgVpnRestDeliveryPoint = (MsgVpnRestDeliveryPoint) o; - return Objects.equals(this.clientProfileName, msgVpnRestDeliveryPoint.clientProfileName) && - Objects.equals(this.enabled, msgVpnRestDeliveryPoint.enabled) && - Objects.equals(this.msgVpnName, msgVpnRestDeliveryPoint.msgVpnName) && - Objects.equals(this.restDeliveryPointName, msgVpnRestDeliveryPoint.restDeliveryPointName) && - Objects.equals(this.service, msgVpnRestDeliveryPoint.service) && - Objects.equals(this.vendor, msgVpnRestDeliveryPoint.vendor); - } - - @Override - public int hashCode() { - return Objects.hash(clientProfileName, enabled, msgVpnName, restDeliveryPointName, service, vendor); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPoint {\n"); - sb.append(" clientProfileName: ").append(toIndentedString(clientProfileName)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" restDeliveryPointName: ").append(toIndentedString(restDeliveryPointName)).append("\n"); - sb.append(" service: ").append(toIndentedString(service)).append("\n"); - sb.append(" vendor: ").append(toIndentedString(vendor)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointLinks.java deleted file mode 100644 index 0bb0689e1..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointLinks.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointLinks - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointLinks.JSON_PROPERTY_QUEUE_BINDINGS_URI, - MsgVpnRestDeliveryPointLinks.JSON_PROPERTY_REST_CONSUMERS_URI, - MsgVpnRestDeliveryPointLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointLinks { - public static final String JSON_PROPERTY_QUEUE_BINDINGS_URI = "queueBindingsUri"; - private String queueBindingsUri; - - public static final String JSON_PROPERTY_REST_CONSUMERS_URI = "restConsumersUri"; - private String restConsumersUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnRestDeliveryPointLinks() { - } - - public MsgVpnRestDeliveryPointLinks queueBindingsUri(String queueBindingsUri) { - - this.queueBindingsUri = queueBindingsUri; - return this; - } - - /** - * The URI of this REST Delivery Point's collection of Queue Binding objects. - * @return queueBindingsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_BINDINGS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getQueueBindingsUri() { - return queueBindingsUri; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_BINDINGS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueBindingsUri(String queueBindingsUri) { - this.queueBindingsUri = queueBindingsUri; - } - - - public MsgVpnRestDeliveryPointLinks restConsumersUri(String restConsumersUri) { - - this.restConsumersUri = restConsumersUri; - return this; - } - - /** - * The URI of this REST Delivery Point's collection of REST Consumer objects. - * @return restConsumersUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REST_CONSUMERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRestConsumersUri() { - return restConsumersUri; - } - - - @JsonProperty(JSON_PROPERTY_REST_CONSUMERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRestConsumersUri(String restConsumersUri) { - this.restConsumersUri = restConsumersUri; - } - - - public MsgVpnRestDeliveryPointLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this REST Delivery Point object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointLinks msgVpnRestDeliveryPointLinks = (MsgVpnRestDeliveryPointLinks) o; - return Objects.equals(this.queueBindingsUri, msgVpnRestDeliveryPointLinks.queueBindingsUri) && - Objects.equals(this.restConsumersUri, msgVpnRestDeliveryPointLinks.restConsumersUri) && - Objects.equals(this.uri, msgVpnRestDeliveryPointLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(queueBindingsUri, restConsumersUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointLinks {\n"); - sb.append(" queueBindingsUri: ").append(toIndentedString(queueBindingsUri)).append("\n"); - sb.append(" restConsumersUri: ").append(toIndentedString(restConsumersUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBinding.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBinding.java deleted file mode 100644 index bc7b9a5d6..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBinding.java +++ /dev/null @@ -1,299 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointQueueBinding - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointQueueBinding.JSON_PROPERTY_GATEWAY_REPLACE_TARGET_AUTHORITY_ENABLED, - MsgVpnRestDeliveryPointQueueBinding.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnRestDeliveryPointQueueBinding.JSON_PROPERTY_POST_REQUEST_TARGET, - MsgVpnRestDeliveryPointQueueBinding.JSON_PROPERTY_QUEUE_BINDING_NAME, - MsgVpnRestDeliveryPointQueueBinding.JSON_PROPERTY_REQUEST_TARGET_EVALUATION, - MsgVpnRestDeliveryPointQueueBinding.JSON_PROPERTY_REST_DELIVERY_POINT_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointQueueBinding { - public static final String JSON_PROPERTY_GATEWAY_REPLACE_TARGET_AUTHORITY_ENABLED = "gatewayReplaceTargetAuthorityEnabled"; - private Boolean gatewayReplaceTargetAuthorityEnabled; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_POST_REQUEST_TARGET = "postRequestTarget"; - private String postRequestTarget; - - public static final String JSON_PROPERTY_QUEUE_BINDING_NAME = "queueBindingName"; - private String queueBindingName; - - /** - * The type of evaluation to perform on the request target. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - Do not evaluate substitution expressions on the request target. \"substitution-expressions\" - Evaluate substitution expressions on the request target. </pre> Available since 2.23. - */ - public enum RequestTargetEvaluationEnum { - NONE("none"), - - SUBSTITUTION_EXPRESSIONS("substitution-expressions"); - - private String value; - - RequestTargetEvaluationEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static RequestTargetEvaluationEnum fromValue(String value) { - for (RequestTargetEvaluationEnum b : RequestTargetEvaluationEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_REQUEST_TARGET_EVALUATION = "requestTargetEvaluation"; - private RequestTargetEvaluationEnum requestTargetEvaluation; - - public static final String JSON_PROPERTY_REST_DELIVERY_POINT_NAME = "restDeliveryPointName"; - private String restDeliveryPointName; - - public MsgVpnRestDeliveryPointQueueBinding() { - } - - public MsgVpnRestDeliveryPointQueueBinding gatewayReplaceTargetAuthorityEnabled(Boolean gatewayReplaceTargetAuthorityEnabled) { - - this.gatewayReplaceTargetAuthorityEnabled = gatewayReplaceTargetAuthorityEnabled; - return this; - } - - /** - * Enable or disable whether the authority for the request-target is replaced with that configured for the REST Consumer remote. When enabled, the broker sends HTTP requests in absolute-form, with the request-target's authority taken from the REST Consumer's remote host and port configuration. When disabled, the broker sends HTTP requests whose request-target matches that of the original request message, including whether to use absolute-form or origin-form. This configuration is applicable only when the Message VPN is in REST gateway mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.6. - * @return gatewayReplaceTargetAuthorityEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GATEWAY_REPLACE_TARGET_AUTHORITY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getGatewayReplaceTargetAuthorityEnabled() { - return gatewayReplaceTargetAuthorityEnabled; - } - - - @JsonProperty(JSON_PROPERTY_GATEWAY_REPLACE_TARGET_AUTHORITY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGatewayReplaceTargetAuthorityEnabled(Boolean gatewayReplaceTargetAuthorityEnabled) { - this.gatewayReplaceTargetAuthorityEnabled = gatewayReplaceTargetAuthorityEnabled; - } - - - public MsgVpnRestDeliveryPointQueueBinding msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnRestDeliveryPointQueueBinding postRequestTarget(String postRequestTarget) { - - this.postRequestTarget = postRequestTarget; - return this; - } - - /** - * The request-target string to use when sending requests. It identifies the target resource on the far-end REST Consumer upon which to apply the request. There are generally two common forms for the request-target. The origin-form is most often used in practice and contains the path and query components of the target URI. If the path component is empty then the client must generally send a \"/\" as the path. When making a request to a proxy, most often the absolute-form is required. This configuration is only applicable when the Message VPN is in REST messaging mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return postRequestTarget - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_POST_REQUEST_TARGET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getPostRequestTarget() { - return postRequestTarget; - } - - - @JsonProperty(JSON_PROPERTY_POST_REQUEST_TARGET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPostRequestTarget(String postRequestTarget) { - this.postRequestTarget = postRequestTarget; - } - - - public MsgVpnRestDeliveryPointQueueBinding queueBindingName(String queueBindingName) { - - this.queueBindingName = queueBindingName; - return this; - } - - /** - * The name of a queue in the Message VPN. - * @return queueBindingName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_BINDING_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getQueueBindingName() { - return queueBindingName; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_BINDING_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueBindingName(String queueBindingName) { - this.queueBindingName = queueBindingName; - } - - - public MsgVpnRestDeliveryPointQueueBinding requestTargetEvaluation(RequestTargetEvaluationEnum requestTargetEvaluation) { - - this.requestTargetEvaluation = requestTargetEvaluation; - return this; - } - - /** - * The type of evaluation to perform on the request target. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - Do not evaluate substitution expressions on the request target. \"substitution-expressions\" - Evaluate substitution expressions on the request target. </pre> Available since 2.23. - * @return requestTargetEvaluation - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REQUEST_TARGET_EVALUATION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public RequestTargetEvaluationEnum getRequestTargetEvaluation() { - return requestTargetEvaluation; - } - - - @JsonProperty(JSON_PROPERTY_REQUEST_TARGET_EVALUATION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequestTargetEvaluation(RequestTargetEvaluationEnum requestTargetEvaluation) { - this.requestTargetEvaluation = requestTargetEvaluation; - } - - - public MsgVpnRestDeliveryPointQueueBinding restDeliveryPointName(String restDeliveryPointName) { - - this.restDeliveryPointName = restDeliveryPointName; - return this; - } - - /** - * The name of the REST Delivery Point. - * @return restDeliveryPointName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REST_DELIVERY_POINT_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRestDeliveryPointName() { - return restDeliveryPointName; - } - - - @JsonProperty(JSON_PROPERTY_REST_DELIVERY_POINT_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRestDeliveryPointName(String restDeliveryPointName) { - this.restDeliveryPointName = restDeliveryPointName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointQueueBinding msgVpnRestDeliveryPointQueueBinding = (MsgVpnRestDeliveryPointQueueBinding) o; - return Objects.equals(this.gatewayReplaceTargetAuthorityEnabled, msgVpnRestDeliveryPointQueueBinding.gatewayReplaceTargetAuthorityEnabled) && - Objects.equals(this.msgVpnName, msgVpnRestDeliveryPointQueueBinding.msgVpnName) && - Objects.equals(this.postRequestTarget, msgVpnRestDeliveryPointQueueBinding.postRequestTarget) && - Objects.equals(this.queueBindingName, msgVpnRestDeliveryPointQueueBinding.queueBindingName) && - Objects.equals(this.requestTargetEvaluation, msgVpnRestDeliveryPointQueueBinding.requestTargetEvaluation) && - Objects.equals(this.restDeliveryPointName, msgVpnRestDeliveryPointQueueBinding.restDeliveryPointName); - } - - @Override - public int hashCode() { - return Objects.hash(gatewayReplaceTargetAuthorityEnabled, msgVpnName, postRequestTarget, queueBindingName, requestTargetEvaluation, restDeliveryPointName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointQueueBinding {\n"); - sb.append(" gatewayReplaceTargetAuthorityEnabled: ").append(toIndentedString(gatewayReplaceTargetAuthorityEnabled)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" postRequestTarget: ").append(toIndentedString(postRequestTarget)).append("\n"); - sb.append(" queueBindingName: ").append(toIndentedString(queueBindingName)).append("\n"); - sb.append(" requestTargetEvaluation: ").append(toIndentedString(requestTargetEvaluation)).append("\n"); - sb.append(" restDeliveryPointName: ").append(toIndentedString(restDeliveryPointName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingLinks.java deleted file mode 100644 index 6145a7ee0..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingLinks.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointQueueBindingLinks - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointQueueBindingLinks.JSON_PROPERTY_REQUEST_HEADERS_URI, - MsgVpnRestDeliveryPointQueueBindingLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointQueueBindingLinks { - public static final String JSON_PROPERTY_REQUEST_HEADERS_URI = "requestHeadersUri"; - private String requestHeadersUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnRestDeliveryPointQueueBindingLinks() { - } - - public MsgVpnRestDeliveryPointQueueBindingLinks requestHeadersUri(String requestHeadersUri) { - - this.requestHeadersUri = requestHeadersUri; - return this; - } - - /** - * The URI of this Queue Binding's collection of Request Header objects. Available since 2.23. - * @return requestHeadersUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REQUEST_HEADERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRequestHeadersUri() { - return requestHeadersUri; - } - - - @JsonProperty(JSON_PROPERTY_REQUEST_HEADERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequestHeadersUri(String requestHeadersUri) { - this.requestHeadersUri = requestHeadersUri; - } - - - public MsgVpnRestDeliveryPointQueueBindingLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Queue Binding object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointQueueBindingLinks msgVpnRestDeliveryPointQueueBindingLinks = (MsgVpnRestDeliveryPointQueueBindingLinks) o; - return Objects.equals(this.requestHeadersUri, msgVpnRestDeliveryPointQueueBindingLinks.requestHeadersUri) && - Objects.equals(this.uri, msgVpnRestDeliveryPointQueueBindingLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(requestHeadersUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointQueueBindingLinks {\n"); - sb.append(" requestHeadersUri: ").append(toIndentedString(requestHeadersUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeader.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeader.java deleted file mode 100644 index fbdd501ae..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeader.java +++ /dev/null @@ -1,232 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointQueueBindingRequestHeader - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointQueueBindingRequestHeader.JSON_PROPERTY_HEADER_NAME, - MsgVpnRestDeliveryPointQueueBindingRequestHeader.JSON_PROPERTY_HEADER_VALUE, - MsgVpnRestDeliveryPointQueueBindingRequestHeader.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnRestDeliveryPointQueueBindingRequestHeader.JSON_PROPERTY_QUEUE_BINDING_NAME, - MsgVpnRestDeliveryPointQueueBindingRequestHeader.JSON_PROPERTY_REST_DELIVERY_POINT_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointQueueBindingRequestHeader { - public static final String JSON_PROPERTY_HEADER_NAME = "headerName"; - private String headerName; - - public static final String JSON_PROPERTY_HEADER_VALUE = "headerValue"; - private String headerValue; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_QUEUE_BINDING_NAME = "queueBindingName"; - private String queueBindingName; - - public static final String JSON_PROPERTY_REST_DELIVERY_POINT_NAME = "restDeliveryPointName"; - private String restDeliveryPointName; - - public MsgVpnRestDeliveryPointQueueBindingRequestHeader() { - } - - public MsgVpnRestDeliveryPointQueueBindingRequestHeader headerName(String headerName) { - - this.headerName = headerName; - return this; - } - - /** - * The name of the HTTP request header. - * @return headerName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_HEADER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getHeaderName() { - return headerName; - } - - - @JsonProperty(JSON_PROPERTY_HEADER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHeaderName(String headerName) { - this.headerName = headerName; - } - - - public MsgVpnRestDeliveryPointQueueBindingRequestHeader headerValue(String headerValue) { - - this.headerValue = headerValue; - return this; - } - - /** - * A substitution expression for the value of the HTTP request header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return headerValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_HEADER_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getHeaderValue() { - return headerValue; - } - - - @JsonProperty(JSON_PROPERTY_HEADER_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHeaderValue(String headerValue) { - this.headerValue = headerValue; - } - - - public MsgVpnRestDeliveryPointQueueBindingRequestHeader msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnRestDeliveryPointQueueBindingRequestHeader queueBindingName(String queueBindingName) { - - this.queueBindingName = queueBindingName; - return this; - } - - /** - * The name of a queue in the Message VPN. - * @return queueBindingName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_QUEUE_BINDING_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getQueueBindingName() { - return queueBindingName; - } - - - @JsonProperty(JSON_PROPERTY_QUEUE_BINDING_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQueueBindingName(String queueBindingName) { - this.queueBindingName = queueBindingName; - } - - - public MsgVpnRestDeliveryPointQueueBindingRequestHeader restDeliveryPointName(String restDeliveryPointName) { - - this.restDeliveryPointName = restDeliveryPointName; - return this; - } - - /** - * The name of the REST Delivery Point. - * @return restDeliveryPointName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REST_DELIVERY_POINT_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRestDeliveryPointName() { - return restDeliveryPointName; - } - - - @JsonProperty(JSON_PROPERTY_REST_DELIVERY_POINT_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRestDeliveryPointName(String restDeliveryPointName) { - this.restDeliveryPointName = restDeliveryPointName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointQueueBindingRequestHeader msgVpnRestDeliveryPointQueueBindingRequestHeader = (MsgVpnRestDeliveryPointQueueBindingRequestHeader) o; - return Objects.equals(this.headerName, msgVpnRestDeliveryPointQueueBindingRequestHeader.headerName) && - Objects.equals(this.headerValue, msgVpnRestDeliveryPointQueueBindingRequestHeader.headerValue) && - Objects.equals(this.msgVpnName, msgVpnRestDeliveryPointQueueBindingRequestHeader.msgVpnName) && - Objects.equals(this.queueBindingName, msgVpnRestDeliveryPointQueueBindingRequestHeader.queueBindingName) && - Objects.equals(this.restDeliveryPointName, msgVpnRestDeliveryPointQueueBindingRequestHeader.restDeliveryPointName); - } - - @Override - public int hashCode() { - return Objects.hash(headerName, headerValue, msgVpnName, queueBindingName, restDeliveryPointName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointQueueBindingRequestHeader {\n"); - sb.append(" headerName: ").append(toIndentedString(headerName)).append("\n"); - sb.append(" headerValue: ").append(toIndentedString(headerValue)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" queueBindingName: ").append(toIndentedString(queueBindingName)).append("\n"); - sb.append(" restDeliveryPointName: ").append(toIndentedString(restDeliveryPointName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks.java deleted file mode 100644 index 7df87d392..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks() { - } - - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Request Header object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks msgVpnRestDeliveryPointQueueBindingRequestHeaderLinks = (MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks) o; - return Objects.equals(this.uri, msgVpnRestDeliveryPointQueueBindingRequestHeaderLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.java deleted file mode 100644 index ef8726357..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeader; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.JSON_PROPERTY_DATA, - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.JSON_PROPERTY_LINKS, - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnRestDeliveryPointQueueBindingRequestHeader data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse() { - } - - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse data(MsgVpnRestDeliveryPointQueueBindingRequestHeader data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnRestDeliveryPointQueueBindingRequestHeader getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnRestDeliveryPointQueueBindingRequestHeader data) { - this.data = data; - } - - - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse links(MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks links) { - this.links = links; - } - - - public MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse msgVpnRestDeliveryPointQueueBindingRequestHeaderResponse = (MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse) o; - return Objects.equals(this.data, msgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.data) && - Objects.equals(this.links, msgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.links) && - Objects.equals(this.meta, msgVpnRestDeliveryPointQueueBindingRequestHeaderResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.java deleted file mode 100644 index 4bc548f99..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeader; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.JSON_PROPERTY_DATA, - MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.JSON_PROPERTY_LINKS, - MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse() { - } - - public MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse addDataItem(MsgVpnRestDeliveryPointQueueBindingRequestHeader dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse addLinksItem(MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse msgVpnRestDeliveryPointQueueBindingRequestHeadersResponse = (MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse) o; - return Objects.equals(this.data, msgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.data) && - Objects.equals(this.links, msgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.links) && - Objects.equals(this.meta, msgVpnRestDeliveryPointQueueBindingRequestHeadersResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingResponse.java deleted file mode 100644 index c0a7b1c90..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBinding; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointQueueBindingResponse - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointQueueBindingResponse.JSON_PROPERTY_DATA, - MsgVpnRestDeliveryPointQueueBindingResponse.JSON_PROPERTY_LINKS, - MsgVpnRestDeliveryPointQueueBindingResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointQueueBindingResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnRestDeliveryPointQueueBinding data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnRestDeliveryPointQueueBindingLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnRestDeliveryPointQueueBindingResponse() { - } - - public MsgVpnRestDeliveryPointQueueBindingResponse data(MsgVpnRestDeliveryPointQueueBinding data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnRestDeliveryPointQueueBinding getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnRestDeliveryPointQueueBinding data) { - this.data = data; - } - - - public MsgVpnRestDeliveryPointQueueBindingResponse links(MsgVpnRestDeliveryPointQueueBindingLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnRestDeliveryPointQueueBindingLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnRestDeliveryPointQueueBindingLinks links) { - this.links = links; - } - - - public MsgVpnRestDeliveryPointQueueBindingResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointQueueBindingResponse msgVpnRestDeliveryPointQueueBindingResponse = (MsgVpnRestDeliveryPointQueueBindingResponse) o; - return Objects.equals(this.data, msgVpnRestDeliveryPointQueueBindingResponse.data) && - Objects.equals(this.links, msgVpnRestDeliveryPointQueueBindingResponse.links) && - Objects.equals(this.meta, msgVpnRestDeliveryPointQueueBindingResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointQueueBindingResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingsResponse.java deleted file mode 100644 index 0c573ad62..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBinding; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointQueueBindingsResponse - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointQueueBindingsResponse.JSON_PROPERTY_DATA, - MsgVpnRestDeliveryPointQueueBindingsResponse.JSON_PROPERTY_LINKS, - MsgVpnRestDeliveryPointQueueBindingsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointQueueBindingsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnRestDeliveryPointQueueBindingsResponse() { - } - - public MsgVpnRestDeliveryPointQueueBindingsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnRestDeliveryPointQueueBindingsResponse addDataItem(MsgVpnRestDeliveryPointQueueBinding dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnRestDeliveryPointQueueBindingsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnRestDeliveryPointQueueBindingsResponse addLinksItem(MsgVpnRestDeliveryPointQueueBindingLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnRestDeliveryPointQueueBindingsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointQueueBindingsResponse msgVpnRestDeliveryPointQueueBindingsResponse = (MsgVpnRestDeliveryPointQueueBindingsResponse) o; - return Objects.equals(this.data, msgVpnRestDeliveryPointQueueBindingsResponse.data) && - Objects.equals(this.links, msgVpnRestDeliveryPointQueueBindingsResponse.links) && - Objects.equals(this.meta, msgVpnRestDeliveryPointQueueBindingsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointQueueBindingsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointResponse.java deleted file mode 100644 index a0ca8454e..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointResponse - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointResponse.JSON_PROPERTY_DATA, - MsgVpnRestDeliveryPointResponse.JSON_PROPERTY_LINKS, - MsgVpnRestDeliveryPointResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnRestDeliveryPoint data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnRestDeliveryPointLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnRestDeliveryPointResponse() { - } - - public MsgVpnRestDeliveryPointResponse data(MsgVpnRestDeliveryPoint data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnRestDeliveryPoint getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnRestDeliveryPoint data) { - this.data = data; - } - - - public MsgVpnRestDeliveryPointResponse links(MsgVpnRestDeliveryPointLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnRestDeliveryPointLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnRestDeliveryPointLinks links) { - this.links = links; - } - - - public MsgVpnRestDeliveryPointResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointResponse msgVpnRestDeliveryPointResponse = (MsgVpnRestDeliveryPointResponse) o; - return Objects.equals(this.data, msgVpnRestDeliveryPointResponse.data) && - Objects.equals(this.links, msgVpnRestDeliveryPointResponse.links) && - Objects.equals(this.meta, msgVpnRestDeliveryPointResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumer.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumer.java deleted file mode 100644 index 07890c179..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumer.java +++ /dev/null @@ -1,1114 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointRestConsumer - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_AWS_ACCESS_KEY_ID, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_AWS_REGION, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_AWS_SECRET_ACCESS_KEY, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_AWS_SERVICE, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_CONTENT, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_PASSWORD, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_HTTP_BASIC_PASSWORD, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_HTTP_BASIC_USERNAME, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_HTTP_HEADER_NAME, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_HTTP_HEADER_VALUE, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_OAUTH_CLIENT_ID, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_OAUTH_CLIENT_SCOPE, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_OAUTH_CLIENT_SECRET, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_OAUTH_CLIENT_TOKEN_ENDPOINT, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_OAUTH_JWT_SECRET_KEY, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_OAUTH_JWT_TOKEN_ENDPOINT, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_AUTHENTICATION_SCHEME, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_ENABLED, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_HTTP_METHOD, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_LOCAL_INTERFACE, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_MAX_POST_WAIT_TIME, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_OUTGOING_CONNECTION_COUNT, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_REMOTE_HOST, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_REMOTE_PORT, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_REST_CONSUMER_NAME, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_REST_DELIVERY_POINT_NAME, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_RETRY_DELAY, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_TLS_CIPHER_SUITE_LIST, - MsgVpnRestDeliveryPointRestConsumer.JSON_PROPERTY_TLS_ENABLED -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointRestConsumer { - public static final String JSON_PROPERTY_AUTHENTICATION_AWS_ACCESS_KEY_ID = "authenticationAwsAccessKeyId"; - private String authenticationAwsAccessKeyId; - - public static final String JSON_PROPERTY_AUTHENTICATION_AWS_REGION = "authenticationAwsRegion"; - private String authenticationAwsRegion; - - public static final String JSON_PROPERTY_AUTHENTICATION_AWS_SECRET_ACCESS_KEY = "authenticationAwsSecretAccessKey"; - private String authenticationAwsSecretAccessKey; - - public static final String JSON_PROPERTY_AUTHENTICATION_AWS_SERVICE = "authenticationAwsService"; - private String authenticationAwsService; - - public static final String JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_CONTENT = "authenticationClientCertContent"; - private String authenticationClientCertContent; - - public static final String JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_PASSWORD = "authenticationClientCertPassword"; - private String authenticationClientCertPassword; - - public static final String JSON_PROPERTY_AUTHENTICATION_HTTP_BASIC_PASSWORD = "authenticationHttpBasicPassword"; - private String authenticationHttpBasicPassword; - - public static final String JSON_PROPERTY_AUTHENTICATION_HTTP_BASIC_USERNAME = "authenticationHttpBasicUsername"; - private String authenticationHttpBasicUsername; - - public static final String JSON_PROPERTY_AUTHENTICATION_HTTP_HEADER_NAME = "authenticationHttpHeaderName"; - private String authenticationHttpHeaderName; - - public static final String JSON_PROPERTY_AUTHENTICATION_HTTP_HEADER_VALUE = "authenticationHttpHeaderValue"; - private String authenticationHttpHeaderValue; - - public static final String JSON_PROPERTY_AUTHENTICATION_OAUTH_CLIENT_ID = "authenticationOauthClientId"; - private String authenticationOauthClientId; - - public static final String JSON_PROPERTY_AUTHENTICATION_OAUTH_CLIENT_SCOPE = "authenticationOauthClientScope"; - private String authenticationOauthClientScope; - - public static final String JSON_PROPERTY_AUTHENTICATION_OAUTH_CLIENT_SECRET = "authenticationOauthClientSecret"; - private String authenticationOauthClientSecret; - - public static final String JSON_PROPERTY_AUTHENTICATION_OAUTH_CLIENT_TOKEN_ENDPOINT = "authenticationOauthClientTokenEndpoint"; - private String authenticationOauthClientTokenEndpoint; - - public static final String JSON_PROPERTY_AUTHENTICATION_OAUTH_JWT_SECRET_KEY = "authenticationOauthJwtSecretKey"; - private String authenticationOauthJwtSecretKey; - - public static final String JSON_PROPERTY_AUTHENTICATION_OAUTH_JWT_TOKEN_ENDPOINT = "authenticationOauthJwtTokenEndpoint"; - private String authenticationOauthJwtTokenEndpoint; - - /** - * The authentication scheme used by the REST Consumer to login to the REST host. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - Login with no authentication. This may be useful for anonymous connections or when a REST Consumer does not require authentication. \"http-basic\" - Login with a username and optional password according to HTTP Basic authentication as per RFC2616. \"client-certificate\" - Login with a client TLS certificate as per RFC5246. Client certificate authentication is only available on TLS connections. \"http-header\" - Login with a specified HTTP header. \"oauth-client\" - Login with OAuth 2.0 client credentials. \"oauth-jwt\" - Login with OAuth (RFC 7523 JWT Profile). \"transparent\" - Login using the Authorization header from the message properties, if present. Transparent authentication passes along existing Authorization header metadata instead of discarding it. Note that if the message is coming from a REST producer, the REST service must be configured to forward the Authorization header. \"aws\" - Login using AWS Signature Version 4 authentication (AWS4-HMAC-SHA256). </pre> - */ - public enum AuthenticationSchemeEnum { - NONE("none"), - - HTTP_BASIC("http-basic"), - - CLIENT_CERTIFICATE("client-certificate"), - - HTTP_HEADER("http-header"), - - OAUTH_CLIENT("oauth-client"), - - OAUTH_JWT("oauth-jwt"), - - TRANSPARENT("transparent"), - - AWS("aws"); - - private String value; - - AuthenticationSchemeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AuthenticationSchemeEnum fromValue(String value) { - for (AuthenticationSchemeEnum b : AuthenticationSchemeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_AUTHENTICATION_SCHEME = "authenticationScheme"; - private AuthenticationSchemeEnum authenticationScheme; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - /** - * The HTTP method to use (POST or PUT). This is used only when operating in the REST service \"messaging\" mode and is ignored in \"gateway\" mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"post\"`. The allowed values and their meaning are: <pre> \"post\" - Use the POST HTTP method. \"put\" - Use the PUT HTTP method. </pre> Available since 2.17. - */ - public enum HttpMethodEnum { - POST("post"), - - PUT("put"); - - private String value; - - HttpMethodEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static HttpMethodEnum fromValue(String value) { - for (HttpMethodEnum b : HttpMethodEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_HTTP_METHOD = "httpMethod"; - private HttpMethodEnum httpMethod; - - public static final String JSON_PROPERTY_LOCAL_INTERFACE = "localInterface"; - private String localInterface; - - public static final String JSON_PROPERTY_MAX_POST_WAIT_TIME = "maxPostWaitTime"; - private Integer maxPostWaitTime; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_OUTGOING_CONNECTION_COUNT = "outgoingConnectionCount"; - private Integer outgoingConnectionCount; - - public static final String JSON_PROPERTY_REMOTE_HOST = "remoteHost"; - private String remoteHost; - - public static final String JSON_PROPERTY_REMOTE_PORT = "remotePort"; - private Long remotePort; - - public static final String JSON_PROPERTY_REST_CONSUMER_NAME = "restConsumerName"; - private String restConsumerName; - - public static final String JSON_PROPERTY_REST_DELIVERY_POINT_NAME = "restDeliveryPointName"; - private String restDeliveryPointName; - - public static final String JSON_PROPERTY_RETRY_DELAY = "retryDelay"; - private Integer retryDelay; - - public static final String JSON_PROPERTY_TLS_CIPHER_SUITE_LIST = "tlsCipherSuiteList"; - private String tlsCipherSuiteList; - - public static final String JSON_PROPERTY_TLS_ENABLED = "tlsEnabled"; - private Boolean tlsEnabled; - - public MsgVpnRestDeliveryPointRestConsumer() { - } - - public MsgVpnRestDeliveryPointRestConsumer authenticationAwsAccessKeyId(String authenticationAwsAccessKeyId) { - - this.authenticationAwsAccessKeyId = authenticationAwsAccessKeyId; - return this; - } - - /** - * The AWS access key id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26. - * @return authenticationAwsAccessKeyId - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_AWS_ACCESS_KEY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationAwsAccessKeyId() { - return authenticationAwsAccessKeyId; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_AWS_ACCESS_KEY_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationAwsAccessKeyId(String authenticationAwsAccessKeyId) { - this.authenticationAwsAccessKeyId = authenticationAwsAccessKeyId; - } - - - public MsgVpnRestDeliveryPointRestConsumer authenticationAwsRegion(String authenticationAwsRegion) { - - this.authenticationAwsRegion = authenticationAwsRegion; - return this; - } - - /** - * The AWS region id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26. - * @return authenticationAwsRegion - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_AWS_REGION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationAwsRegion() { - return authenticationAwsRegion; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_AWS_REGION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationAwsRegion(String authenticationAwsRegion) { - this.authenticationAwsRegion = authenticationAwsRegion; - } - - - public MsgVpnRestDeliveryPointRestConsumer authenticationAwsSecretAccessKey(String authenticationAwsSecretAccessKey) { - - this.authenticationAwsSecretAccessKey = authenticationAwsSecretAccessKey; - return this; - } - - /** - * The AWS secret access key. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26. - * @return authenticationAwsSecretAccessKey - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_AWS_SECRET_ACCESS_KEY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationAwsSecretAccessKey() { - return authenticationAwsSecretAccessKey; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_AWS_SECRET_ACCESS_KEY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationAwsSecretAccessKey(String authenticationAwsSecretAccessKey) { - this.authenticationAwsSecretAccessKey = authenticationAwsSecretAccessKey; - } - - - public MsgVpnRestDeliveryPointRestConsumer authenticationAwsService(String authenticationAwsService) { - - this.authenticationAwsService = authenticationAwsService; - return this; - } - - /** - * The AWS service id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26. - * @return authenticationAwsService - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_AWS_SERVICE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationAwsService() { - return authenticationAwsService; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_AWS_SERVICE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationAwsService(String authenticationAwsService) { - this.authenticationAwsService = authenticationAwsService; - } - - - public MsgVpnRestDeliveryPointRestConsumer authenticationClientCertContent(String authenticationClientCertContent) { - - this.authenticationClientCertContent = authenticationClientCertContent; - return this; - } - - /** - * The PEM formatted content for the client certificate that the REST Consumer will present to the REST host. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9. - * @return authenticationClientCertContent - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationClientCertContent() { - return authenticationClientCertContent; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_CONTENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationClientCertContent(String authenticationClientCertContent) { - this.authenticationClientCertContent = authenticationClientCertContent; - } - - - public MsgVpnRestDeliveryPointRestConsumer authenticationClientCertPassword(String authenticationClientCertPassword) { - - this.authenticationClientCertPassword = authenticationClientCertPassword; - return this; - } - - /** - * The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9. - * @return authenticationClientCertPassword - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationClientCertPassword() { - return authenticationClientCertPassword; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_CLIENT_CERT_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationClientCertPassword(String authenticationClientCertPassword) { - this.authenticationClientCertPassword = authenticationClientCertPassword; - } - - - public MsgVpnRestDeliveryPointRestConsumer authenticationHttpBasicPassword(String authenticationHttpBasicPassword) { - - this.authenticationHttpBasicPassword = authenticationHttpBasicPassword; - return this; - } - - /** - * The password for the username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return authenticationHttpBasicPassword - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_HTTP_BASIC_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationHttpBasicPassword() { - return authenticationHttpBasicPassword; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_HTTP_BASIC_PASSWORD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationHttpBasicPassword(String authenticationHttpBasicPassword) { - this.authenticationHttpBasicPassword = authenticationHttpBasicPassword; - } - - - public MsgVpnRestDeliveryPointRestConsumer authenticationHttpBasicUsername(String authenticationHttpBasicUsername) { - - this.authenticationHttpBasicUsername = authenticationHttpBasicUsername; - return this; - } - - /** - * The username that the REST Consumer will use to login to the REST host. Normally a username is only configured when basic authentication is selected for the REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return authenticationHttpBasicUsername - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_HTTP_BASIC_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationHttpBasicUsername() { - return authenticationHttpBasicUsername; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_HTTP_BASIC_USERNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationHttpBasicUsername(String authenticationHttpBasicUsername) { - this.authenticationHttpBasicUsername = authenticationHttpBasicUsername; - } - - - public MsgVpnRestDeliveryPointRestConsumer authenticationHttpHeaderName(String authenticationHttpHeaderName) { - - this.authenticationHttpHeaderName = authenticationHttpHeaderName; - return this; - } - - /** - * The authentication header name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.15. - * @return authenticationHttpHeaderName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_HTTP_HEADER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationHttpHeaderName() { - return authenticationHttpHeaderName; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_HTTP_HEADER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationHttpHeaderName(String authenticationHttpHeaderName) { - this.authenticationHttpHeaderName = authenticationHttpHeaderName; - } - - - public MsgVpnRestDeliveryPointRestConsumer authenticationHttpHeaderValue(String authenticationHttpHeaderValue) { - - this.authenticationHttpHeaderValue = authenticationHttpHeaderValue; - return this; - } - - /** - * The authentication header value. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.15. - * @return authenticationHttpHeaderValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_HTTP_HEADER_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationHttpHeaderValue() { - return authenticationHttpHeaderValue; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_HTTP_HEADER_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationHttpHeaderValue(String authenticationHttpHeaderValue) { - this.authenticationHttpHeaderValue = authenticationHttpHeaderValue; - } - - - public MsgVpnRestDeliveryPointRestConsumer authenticationOauthClientId(String authenticationOauthClientId) { - - this.authenticationOauthClientId = authenticationOauthClientId; - return this; - } - - /** - * The OAuth client ID. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19. - * @return authenticationOauthClientId - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationOauthClientId() { - return authenticationOauthClientId; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationOauthClientId(String authenticationOauthClientId) { - this.authenticationOauthClientId = authenticationOauthClientId; - } - - - public MsgVpnRestDeliveryPointRestConsumer authenticationOauthClientScope(String authenticationOauthClientScope) { - - this.authenticationOauthClientScope = authenticationOauthClientScope; - return this; - } - - /** - * The OAuth scope. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19. - * @return authenticationOauthClientScope - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_CLIENT_SCOPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationOauthClientScope() { - return authenticationOauthClientScope; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_CLIENT_SCOPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationOauthClientScope(String authenticationOauthClientScope) { - this.authenticationOauthClientScope = authenticationOauthClientScope; - } - - - public MsgVpnRestDeliveryPointRestConsumer authenticationOauthClientSecret(String authenticationOauthClientSecret) { - - this.authenticationOauthClientSecret = authenticationOauthClientSecret; - return this; - } - - /** - * The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19. - * @return authenticationOauthClientSecret - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_CLIENT_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationOauthClientSecret() { - return authenticationOauthClientSecret; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_CLIENT_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationOauthClientSecret(String authenticationOauthClientSecret) { - this.authenticationOauthClientSecret = authenticationOauthClientSecret; - } - - - public MsgVpnRestDeliveryPointRestConsumer authenticationOauthClientTokenEndpoint(String authenticationOauthClientTokenEndpoint) { - - this.authenticationOauthClientTokenEndpoint = authenticationOauthClientTokenEndpoint; - return this; - } - - /** - * The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. Must begin with \"https\". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19. - * @return authenticationOauthClientTokenEndpoint - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_CLIENT_TOKEN_ENDPOINT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationOauthClientTokenEndpoint() { - return authenticationOauthClientTokenEndpoint; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_CLIENT_TOKEN_ENDPOINT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationOauthClientTokenEndpoint(String authenticationOauthClientTokenEndpoint) { - this.authenticationOauthClientTokenEndpoint = authenticationOauthClientTokenEndpoint; - } - - - public MsgVpnRestDeliveryPointRestConsumer authenticationOauthJwtSecretKey(String authenticationOauthJwtSecretKey) { - - this.authenticationOauthJwtSecretKey = authenticationOauthJwtSecretKey; - return this; - } - - /** - * The OAuth secret key used to sign the token request JWT. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.21. - * @return authenticationOauthJwtSecretKey - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_JWT_SECRET_KEY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationOauthJwtSecretKey() { - return authenticationOauthJwtSecretKey; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_JWT_SECRET_KEY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationOauthJwtSecretKey(String authenticationOauthJwtSecretKey) { - this.authenticationOauthJwtSecretKey = authenticationOauthJwtSecretKey; - } - - - public MsgVpnRestDeliveryPointRestConsumer authenticationOauthJwtTokenEndpoint(String authenticationOauthJwtTokenEndpoint) { - - this.authenticationOauthJwtTokenEndpoint = authenticationOauthJwtTokenEndpoint; - return this; - } - - /** - * The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.21. - * @return authenticationOauthJwtTokenEndpoint - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_JWT_TOKEN_ENDPOINT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthenticationOauthJwtTokenEndpoint() { - return authenticationOauthJwtTokenEndpoint; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_OAUTH_JWT_TOKEN_ENDPOINT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationOauthJwtTokenEndpoint(String authenticationOauthJwtTokenEndpoint) { - this.authenticationOauthJwtTokenEndpoint = authenticationOauthJwtTokenEndpoint; - } - - - public MsgVpnRestDeliveryPointRestConsumer authenticationScheme(AuthenticationSchemeEnum authenticationScheme) { - - this.authenticationScheme = authenticationScheme; - return this; - } - - /** - * The authentication scheme used by the REST Consumer to login to the REST host. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - Login with no authentication. This may be useful for anonymous connections or when a REST Consumer does not require authentication. \"http-basic\" - Login with a username and optional password according to HTTP Basic authentication as per RFC2616. \"client-certificate\" - Login with a client TLS certificate as per RFC5246. Client certificate authentication is only available on TLS connections. \"http-header\" - Login with a specified HTTP header. \"oauth-client\" - Login with OAuth 2.0 client credentials. \"oauth-jwt\" - Login with OAuth (RFC 7523 JWT Profile). \"transparent\" - Login using the Authorization header from the message properties, if present. Transparent authentication passes along existing Authorization header metadata instead of discarding it. Note that if the message is coming from a REST producer, the REST service must be configured to forward the Authorization header. \"aws\" - Login using AWS Signature Version 4 authentication (AWS4-HMAC-SHA256). </pre> - * @return authenticationScheme - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_SCHEME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AuthenticationSchemeEnum getAuthenticationScheme() { - return authenticationScheme; - } - - - @JsonProperty(JSON_PROPERTY_AUTHENTICATION_SCHEME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthenticationScheme(AuthenticationSchemeEnum authenticationScheme) { - this.authenticationScheme = authenticationScheme; - } - - - public MsgVpnRestDeliveryPointRestConsumer enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the REST Consumer. When disabled, no connections are initiated or messages delivered to this particular REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public MsgVpnRestDeliveryPointRestConsumer httpMethod(HttpMethodEnum httpMethod) { - - this.httpMethod = httpMethod; - return this; - } - - /** - * The HTTP method to use (POST or PUT). This is used only when operating in the REST service \"messaging\" mode and is ignored in \"gateway\" mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"post\"`. The allowed values and their meaning are: <pre> \"post\" - Use the POST HTTP method. \"put\" - Use the PUT HTTP method. </pre> Available since 2.17. - * @return httpMethod - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_HTTP_METHOD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public HttpMethodEnum getHttpMethod() { - return httpMethod; - } - - - @JsonProperty(JSON_PROPERTY_HTTP_METHOD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHttpMethod(HttpMethodEnum httpMethod) { - this.httpMethod = httpMethod; - } - - - public MsgVpnRestDeliveryPointRestConsumer localInterface(String localInterface) { - - this.localInterface = localInterface; - return this; - } - - /** - * The interface that will be used for all outgoing connections associated with the REST Consumer. When unspecified, an interface is automatically chosen. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return localInterface - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LOCAL_INTERFACE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getLocalInterface() { - return localInterface; - } - - - @JsonProperty(JSON_PROPERTY_LOCAL_INTERFACE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLocalInterface(String localInterface) { - this.localInterface = localInterface; - } - - - public MsgVpnRestDeliveryPointRestConsumer maxPostWaitTime(Integer maxPostWaitTime) { - - this.maxPostWaitTime = maxPostWaitTime; - return this; - } - - /** - * The maximum amount of time (in seconds) to wait for an HTTP POST response from the REST Consumer. Once this time is exceeded, the TCP connection is reset. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30`. - * @return maxPostWaitTime - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_POST_WAIT_TIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getMaxPostWaitTime() { - return maxPostWaitTime; - } - - - @JsonProperty(JSON_PROPERTY_MAX_POST_WAIT_TIME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxPostWaitTime(Integer maxPostWaitTime) { - this.maxPostWaitTime = maxPostWaitTime; - } - - - public MsgVpnRestDeliveryPointRestConsumer msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnRestDeliveryPointRestConsumer outgoingConnectionCount(Integer outgoingConnectionCount) { - - this.outgoingConnectionCount = outgoingConnectionCount; - return this; - } - - /** - * The number of concurrent TCP connections open to the REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. - * @return outgoingConnectionCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OUTGOING_CONNECTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getOutgoingConnectionCount() { - return outgoingConnectionCount; - } - - - @JsonProperty(JSON_PROPERTY_OUTGOING_CONNECTION_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOutgoingConnectionCount(Integer outgoingConnectionCount) { - this.outgoingConnectionCount = outgoingConnectionCount; - } - - - public MsgVpnRestDeliveryPointRestConsumer remoteHost(String remoteHost) { - - this.remoteHost = remoteHost; - return this; - } - - /** - * The IP address or DNS name to which the broker is to connect to deliver messages for the REST Consumer. A host value must be configured for the REST Consumer to be operationally up. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return remoteHost - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_HOST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRemoteHost() { - return remoteHost; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_HOST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemoteHost(String remoteHost) { - this.remoteHost = remoteHost; - } - - - public MsgVpnRestDeliveryPointRestConsumer remotePort(Long remotePort) { - - this.remotePort = remotePort; - return this; - } - - /** - * The port associated with the host of the REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `8080`. - * @return remotePort - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REMOTE_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getRemotePort() { - return remotePort; - } - - - @JsonProperty(JSON_PROPERTY_REMOTE_PORT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRemotePort(Long remotePort) { - this.remotePort = remotePort; - } - - - public MsgVpnRestDeliveryPointRestConsumer restConsumerName(String restConsumerName) { - - this.restConsumerName = restConsumerName; - return this; - } - - /** - * The name of the REST Consumer. - * @return restConsumerName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REST_CONSUMER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRestConsumerName() { - return restConsumerName; - } - - - @JsonProperty(JSON_PROPERTY_REST_CONSUMER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRestConsumerName(String restConsumerName) { - this.restConsumerName = restConsumerName; - } - - - public MsgVpnRestDeliveryPointRestConsumer restDeliveryPointName(String restDeliveryPointName) { - - this.restDeliveryPointName = restDeliveryPointName; - return this; - } - - /** - * The name of the REST Delivery Point. - * @return restDeliveryPointName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REST_DELIVERY_POINT_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRestDeliveryPointName() { - return restDeliveryPointName; - } - - - @JsonProperty(JSON_PROPERTY_REST_DELIVERY_POINT_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRestDeliveryPointName(String restDeliveryPointName) { - this.restDeliveryPointName = restDeliveryPointName; - } - - - public MsgVpnRestDeliveryPointRestConsumer retryDelay(Integer retryDelay) { - - this.retryDelay = retryDelay; - return this; - } - - /** - * The number of seconds that must pass before retrying the remote REST Consumer connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. - * @return retryDelay - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RETRY_DELAY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getRetryDelay() { - return retryDelay; - } - - - @JsonProperty(JSON_PROPERTY_RETRY_DELAY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRetryDelay(Integer retryDelay) { - this.retryDelay = retryDelay; - } - - - public MsgVpnRestDeliveryPointRestConsumer tlsCipherSuiteList(String tlsCipherSuiteList) { - - this.tlsCipherSuiteList = tlsCipherSuiteList; - return this; - } - - /** - * The colon-separated list of cipher suites the REST Consumer uses in its encrypted connection. The value `\"default\"` implies all supported suites ordered from most secure to least secure. The list of default cipher suites is available in the `tlsCipherSuiteMsgBackboneDefaultList` attribute of the Broker object in the Monitoring API. The REST Consumer should choose the first suite from this list that it supports. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`. - * @return tlsCipherSuiteList - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_CIPHER_SUITE_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTlsCipherSuiteList() { - return tlsCipherSuiteList; - } - - - @JsonProperty(JSON_PROPERTY_TLS_CIPHER_SUITE_LIST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsCipherSuiteList(String tlsCipherSuiteList) { - this.tlsCipherSuiteList = tlsCipherSuiteList; - } - - - public MsgVpnRestDeliveryPointRestConsumer tlsEnabled(Boolean tlsEnabled) { - - this.tlsEnabled = tlsEnabled; - return this; - } - - /** - * Enable or disable encryption (TLS) for the REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return tlsEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getTlsEnabled() { - return tlsEnabled; - } - - - @JsonProperty(JSON_PROPERTY_TLS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsEnabled(Boolean tlsEnabled) { - this.tlsEnabled = tlsEnabled; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointRestConsumer msgVpnRestDeliveryPointRestConsumer = (MsgVpnRestDeliveryPointRestConsumer) o; - return Objects.equals(this.authenticationAwsAccessKeyId, msgVpnRestDeliveryPointRestConsumer.authenticationAwsAccessKeyId) && - Objects.equals(this.authenticationAwsRegion, msgVpnRestDeliveryPointRestConsumer.authenticationAwsRegion) && - Objects.equals(this.authenticationAwsSecretAccessKey, msgVpnRestDeliveryPointRestConsumer.authenticationAwsSecretAccessKey) && - Objects.equals(this.authenticationAwsService, msgVpnRestDeliveryPointRestConsumer.authenticationAwsService) && - Objects.equals(this.authenticationClientCertContent, msgVpnRestDeliveryPointRestConsumer.authenticationClientCertContent) && - Objects.equals(this.authenticationClientCertPassword, msgVpnRestDeliveryPointRestConsumer.authenticationClientCertPassword) && - Objects.equals(this.authenticationHttpBasicPassword, msgVpnRestDeliveryPointRestConsumer.authenticationHttpBasicPassword) && - Objects.equals(this.authenticationHttpBasicUsername, msgVpnRestDeliveryPointRestConsumer.authenticationHttpBasicUsername) && - Objects.equals(this.authenticationHttpHeaderName, msgVpnRestDeliveryPointRestConsumer.authenticationHttpHeaderName) && - Objects.equals(this.authenticationHttpHeaderValue, msgVpnRestDeliveryPointRestConsumer.authenticationHttpHeaderValue) && - Objects.equals(this.authenticationOauthClientId, msgVpnRestDeliveryPointRestConsumer.authenticationOauthClientId) && - Objects.equals(this.authenticationOauthClientScope, msgVpnRestDeliveryPointRestConsumer.authenticationOauthClientScope) && - Objects.equals(this.authenticationOauthClientSecret, msgVpnRestDeliveryPointRestConsumer.authenticationOauthClientSecret) && - Objects.equals(this.authenticationOauthClientTokenEndpoint, msgVpnRestDeliveryPointRestConsumer.authenticationOauthClientTokenEndpoint) && - Objects.equals(this.authenticationOauthJwtSecretKey, msgVpnRestDeliveryPointRestConsumer.authenticationOauthJwtSecretKey) && - Objects.equals(this.authenticationOauthJwtTokenEndpoint, msgVpnRestDeliveryPointRestConsumer.authenticationOauthJwtTokenEndpoint) && - Objects.equals(this.authenticationScheme, msgVpnRestDeliveryPointRestConsumer.authenticationScheme) && - Objects.equals(this.enabled, msgVpnRestDeliveryPointRestConsumer.enabled) && - Objects.equals(this.httpMethod, msgVpnRestDeliveryPointRestConsumer.httpMethod) && - Objects.equals(this.localInterface, msgVpnRestDeliveryPointRestConsumer.localInterface) && - Objects.equals(this.maxPostWaitTime, msgVpnRestDeliveryPointRestConsumer.maxPostWaitTime) && - Objects.equals(this.msgVpnName, msgVpnRestDeliveryPointRestConsumer.msgVpnName) && - Objects.equals(this.outgoingConnectionCount, msgVpnRestDeliveryPointRestConsumer.outgoingConnectionCount) && - Objects.equals(this.remoteHost, msgVpnRestDeliveryPointRestConsumer.remoteHost) && - Objects.equals(this.remotePort, msgVpnRestDeliveryPointRestConsumer.remotePort) && - Objects.equals(this.restConsumerName, msgVpnRestDeliveryPointRestConsumer.restConsumerName) && - Objects.equals(this.restDeliveryPointName, msgVpnRestDeliveryPointRestConsumer.restDeliveryPointName) && - Objects.equals(this.retryDelay, msgVpnRestDeliveryPointRestConsumer.retryDelay) && - Objects.equals(this.tlsCipherSuiteList, msgVpnRestDeliveryPointRestConsumer.tlsCipherSuiteList) && - Objects.equals(this.tlsEnabled, msgVpnRestDeliveryPointRestConsumer.tlsEnabled); - } - - @Override - public int hashCode() { - return Objects.hash(authenticationAwsAccessKeyId, authenticationAwsRegion, authenticationAwsSecretAccessKey, authenticationAwsService, authenticationClientCertContent, authenticationClientCertPassword, authenticationHttpBasicPassword, authenticationHttpBasicUsername, authenticationHttpHeaderName, authenticationHttpHeaderValue, authenticationOauthClientId, authenticationOauthClientScope, authenticationOauthClientSecret, authenticationOauthClientTokenEndpoint, authenticationOauthJwtSecretKey, authenticationOauthJwtTokenEndpoint, authenticationScheme, enabled, httpMethod, localInterface, maxPostWaitTime, msgVpnName, outgoingConnectionCount, remoteHost, remotePort, restConsumerName, restDeliveryPointName, retryDelay, tlsCipherSuiteList, tlsEnabled); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointRestConsumer {\n"); - sb.append(" authenticationAwsAccessKeyId: ").append(toIndentedString(authenticationAwsAccessKeyId)).append("\n"); - sb.append(" authenticationAwsRegion: ").append(toIndentedString(authenticationAwsRegion)).append("\n"); - sb.append(" authenticationAwsSecretAccessKey: ").append(toIndentedString(authenticationAwsSecretAccessKey)).append("\n"); - sb.append(" authenticationAwsService: ").append(toIndentedString(authenticationAwsService)).append("\n"); - sb.append(" authenticationClientCertContent: ").append(toIndentedString(authenticationClientCertContent)).append("\n"); - sb.append(" authenticationClientCertPassword: ").append(toIndentedString(authenticationClientCertPassword)).append("\n"); - sb.append(" authenticationHttpBasicPassword: ").append(toIndentedString(authenticationHttpBasicPassword)).append("\n"); - sb.append(" authenticationHttpBasicUsername: ").append(toIndentedString(authenticationHttpBasicUsername)).append("\n"); - sb.append(" authenticationHttpHeaderName: ").append(toIndentedString(authenticationHttpHeaderName)).append("\n"); - sb.append(" authenticationHttpHeaderValue: ").append(toIndentedString(authenticationHttpHeaderValue)).append("\n"); - sb.append(" authenticationOauthClientId: ").append(toIndentedString(authenticationOauthClientId)).append("\n"); - sb.append(" authenticationOauthClientScope: ").append(toIndentedString(authenticationOauthClientScope)).append("\n"); - sb.append(" authenticationOauthClientSecret: ").append(toIndentedString(authenticationOauthClientSecret)).append("\n"); - sb.append(" authenticationOauthClientTokenEndpoint: ").append(toIndentedString(authenticationOauthClientTokenEndpoint)).append("\n"); - sb.append(" authenticationOauthJwtSecretKey: ").append(toIndentedString(authenticationOauthJwtSecretKey)).append("\n"); - sb.append(" authenticationOauthJwtTokenEndpoint: ").append(toIndentedString(authenticationOauthJwtTokenEndpoint)).append("\n"); - sb.append(" authenticationScheme: ").append(toIndentedString(authenticationScheme)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" httpMethod: ").append(toIndentedString(httpMethod)).append("\n"); - sb.append(" localInterface: ").append(toIndentedString(localInterface)).append("\n"); - sb.append(" maxPostWaitTime: ").append(toIndentedString(maxPostWaitTime)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" outgoingConnectionCount: ").append(toIndentedString(outgoingConnectionCount)).append("\n"); - sb.append(" remoteHost: ").append(toIndentedString(remoteHost)).append("\n"); - sb.append(" remotePort: ").append(toIndentedString(remotePort)).append("\n"); - sb.append(" restConsumerName: ").append(toIndentedString(restConsumerName)).append("\n"); - sb.append(" restDeliveryPointName: ").append(toIndentedString(restDeliveryPointName)).append("\n"); - sb.append(" retryDelay: ").append(toIndentedString(retryDelay)).append("\n"); - sb.append(" tlsCipherSuiteList: ").append(toIndentedString(tlsCipherSuiteList)).append("\n"); - sb.append(" tlsEnabled: ").append(toIndentedString(tlsEnabled)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerLinks.java deleted file mode 100644 index 3f61fb8e3..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerLinks.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointRestConsumerLinks - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointRestConsumerLinks.JSON_PROPERTY_OAUTH_JWT_CLAIMS_URI, - MsgVpnRestDeliveryPointRestConsumerLinks.JSON_PROPERTY_TLS_TRUSTED_COMMON_NAMES_URI, - MsgVpnRestDeliveryPointRestConsumerLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointRestConsumerLinks { - public static final String JSON_PROPERTY_OAUTH_JWT_CLAIMS_URI = "oauthJwtClaimsUri"; - private String oauthJwtClaimsUri; - - public static final String JSON_PROPERTY_TLS_TRUSTED_COMMON_NAMES_URI = "tlsTrustedCommonNamesUri"; - private String tlsTrustedCommonNamesUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnRestDeliveryPointRestConsumerLinks() { - } - - public MsgVpnRestDeliveryPointRestConsumerLinks oauthJwtClaimsUri(String oauthJwtClaimsUri) { - - this.oauthJwtClaimsUri = oauthJwtClaimsUri; - return this; - } - - /** - * The URI of this REST Consumer's collection of Claim objects. Available since 2.21. - * @return oauthJwtClaimsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_JWT_CLAIMS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthJwtClaimsUri() { - return oauthJwtClaimsUri; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_JWT_CLAIMS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthJwtClaimsUri(String oauthJwtClaimsUri) { - this.oauthJwtClaimsUri = oauthJwtClaimsUri; - } - - - public MsgVpnRestDeliveryPointRestConsumerLinks tlsTrustedCommonNamesUri(String tlsTrustedCommonNamesUri) { - - this.tlsTrustedCommonNamesUri = tlsTrustedCommonNamesUri; - return this; - } - - /** - * The URI of this REST Consumer's collection of Trusted Common Name objects. Deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * @return tlsTrustedCommonNamesUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_TRUSTED_COMMON_NAMES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTlsTrustedCommonNamesUri() { - return tlsTrustedCommonNamesUri; - } - - - @JsonProperty(JSON_PROPERTY_TLS_TRUSTED_COMMON_NAMES_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsTrustedCommonNamesUri(String tlsTrustedCommonNamesUri) { - this.tlsTrustedCommonNamesUri = tlsTrustedCommonNamesUri; - } - - - public MsgVpnRestDeliveryPointRestConsumerLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this REST Consumer object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointRestConsumerLinks msgVpnRestDeliveryPointRestConsumerLinks = (MsgVpnRestDeliveryPointRestConsumerLinks) o; - return Objects.equals(this.oauthJwtClaimsUri, msgVpnRestDeliveryPointRestConsumerLinks.oauthJwtClaimsUri) && - Objects.equals(this.tlsTrustedCommonNamesUri, msgVpnRestDeliveryPointRestConsumerLinks.tlsTrustedCommonNamesUri) && - Objects.equals(this.uri, msgVpnRestDeliveryPointRestConsumerLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(oauthJwtClaimsUri, tlsTrustedCommonNamesUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointRestConsumerLinks {\n"); - sb.append(" oauthJwtClaimsUri: ").append(toIndentedString(oauthJwtClaimsUri)).append("\n"); - sb.append(" tlsTrustedCommonNamesUri: ").append(toIndentedString(tlsTrustedCommonNamesUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.java deleted file mode 100644 index cd406e7dd..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.java +++ /dev/null @@ -1,232 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.JSON_PROPERTY_OAUTH_JWT_CLAIM_NAME, - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.JSON_PROPERTY_OAUTH_JWT_CLAIM_VALUE, - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.JSON_PROPERTY_REST_CONSUMER_NAME, - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.JSON_PROPERTY_REST_DELIVERY_POINT_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim { - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_OAUTH_JWT_CLAIM_NAME = "oauthJwtClaimName"; - private String oauthJwtClaimName; - - public static final String JSON_PROPERTY_OAUTH_JWT_CLAIM_VALUE = "oauthJwtClaimValue"; - private String oauthJwtClaimValue; - - public static final String JSON_PROPERTY_REST_CONSUMER_NAME = "restConsumerName"; - private String restConsumerName; - - public static final String JSON_PROPERTY_REST_DELIVERY_POINT_NAME = "restDeliveryPointName"; - private String restDeliveryPointName; - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim() { - } - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim oauthJwtClaimName(String oauthJwtClaimName) { - - this.oauthJwtClaimName = oauthJwtClaimName; - return this; - } - - /** - * The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\". - * @return oauthJwtClaimName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_JWT_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthJwtClaimName() { - return oauthJwtClaimName; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_JWT_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthJwtClaimName(String oauthJwtClaimName) { - this.oauthJwtClaimName = oauthJwtClaimName; - } - - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim oauthJwtClaimValue(String oauthJwtClaimValue) { - - this.oauthJwtClaimValue = oauthJwtClaimValue; - return this; - } - - /** - * The value of the additional claim, which must be a string containing a valid JSON value. - * @return oauthJwtClaimValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_JWT_CLAIM_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthJwtClaimValue() { - return oauthJwtClaimValue; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_JWT_CLAIM_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthJwtClaimValue(String oauthJwtClaimValue) { - this.oauthJwtClaimValue = oauthJwtClaimValue; - } - - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim restConsumerName(String restConsumerName) { - - this.restConsumerName = restConsumerName; - return this; - } - - /** - * The name of the REST Consumer. - * @return restConsumerName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REST_CONSUMER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRestConsumerName() { - return restConsumerName; - } - - - @JsonProperty(JSON_PROPERTY_REST_CONSUMER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRestConsumerName(String restConsumerName) { - this.restConsumerName = restConsumerName; - } - - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim restDeliveryPointName(String restDeliveryPointName) { - - this.restDeliveryPointName = restDeliveryPointName; - return this; - } - - /** - * The name of the REST Delivery Point. - * @return restDeliveryPointName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REST_DELIVERY_POINT_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRestDeliveryPointName() { - return restDeliveryPointName; - } - - - @JsonProperty(JSON_PROPERTY_REST_DELIVERY_POINT_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRestDeliveryPointName(String restDeliveryPointName) { - this.restDeliveryPointName = restDeliveryPointName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim msgVpnRestDeliveryPointRestConsumerOauthJwtClaim = (MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim) o; - return Objects.equals(this.msgVpnName, msgVpnRestDeliveryPointRestConsumerOauthJwtClaim.msgVpnName) && - Objects.equals(this.oauthJwtClaimName, msgVpnRestDeliveryPointRestConsumerOauthJwtClaim.oauthJwtClaimName) && - Objects.equals(this.oauthJwtClaimValue, msgVpnRestDeliveryPointRestConsumerOauthJwtClaim.oauthJwtClaimValue) && - Objects.equals(this.restConsumerName, msgVpnRestDeliveryPointRestConsumerOauthJwtClaim.restConsumerName) && - Objects.equals(this.restDeliveryPointName, msgVpnRestDeliveryPointRestConsumerOauthJwtClaim.restDeliveryPointName); - } - - @Override - public int hashCode() { - return Objects.hash(msgVpnName, oauthJwtClaimName, oauthJwtClaimValue, restConsumerName, restDeliveryPointName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim {\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" oauthJwtClaimName: ").append(toIndentedString(oauthJwtClaimName)).append("\n"); - sb.append(" oauthJwtClaimValue: ").append(toIndentedString(oauthJwtClaimValue)).append("\n"); - sb.append(" restConsumerName: ").append(toIndentedString(restConsumerName)).append("\n"); - sb.append(" restDeliveryPointName: ").append(toIndentedString(restDeliveryPointName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks.java deleted file mode 100644 index 91044b81e..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks() { - } - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Claim object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks msgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks = (MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks) o; - return Objects.equals(this.uri, msgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.java deleted file mode 100644 index fb7c1e41a..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.JSON_PROPERTY_DATA, - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.JSON_PROPERTY_LINKS, - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse() { - } - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse data(MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim data) { - this.data = data; - } - - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse links(MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks links) { - this.links = links; - } - - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse msgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse = (MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse) o; - return Objects.equals(this.data, msgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.data) && - Objects.equals(this.links, msgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.links) && - Objects.equals(this.meta, msgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.java deleted file mode 100644 index 4bee891c8..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.JSON_PROPERTY_DATA, - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.JSON_PROPERTY_LINKS, - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse() { - } - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse addDataItem(MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse addLinksItem(MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse msgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse = (MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse) o; - return Objects.equals(this.data, msgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.data) && - Objects.equals(this.links, msgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.links) && - Objects.equals(this.meta, msgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerResponse.java deleted file mode 100644 index 86d253f92..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumer; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointRestConsumerResponse - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointRestConsumerResponse.JSON_PROPERTY_DATA, - MsgVpnRestDeliveryPointRestConsumerResponse.JSON_PROPERTY_LINKS, - MsgVpnRestDeliveryPointRestConsumerResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointRestConsumerResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnRestDeliveryPointRestConsumer data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnRestDeliveryPointRestConsumerLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnRestDeliveryPointRestConsumerResponse() { - } - - public MsgVpnRestDeliveryPointRestConsumerResponse data(MsgVpnRestDeliveryPointRestConsumer data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnRestDeliveryPointRestConsumer getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnRestDeliveryPointRestConsumer data) { - this.data = data; - } - - - public MsgVpnRestDeliveryPointRestConsumerResponse links(MsgVpnRestDeliveryPointRestConsumerLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnRestDeliveryPointRestConsumerLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnRestDeliveryPointRestConsumerLinks links) { - this.links = links; - } - - - public MsgVpnRestDeliveryPointRestConsumerResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointRestConsumerResponse msgVpnRestDeliveryPointRestConsumerResponse = (MsgVpnRestDeliveryPointRestConsumerResponse) o; - return Objects.equals(this.data, msgVpnRestDeliveryPointRestConsumerResponse.data) && - Objects.equals(this.links, msgVpnRestDeliveryPointRestConsumerResponse.links) && - Objects.equals(this.meta, msgVpnRestDeliveryPointRestConsumerResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointRestConsumerResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.java deleted file mode 100644 index 4ea1c7aab..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.java +++ /dev/null @@ -1,200 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.JSON_PROPERTY_REST_CONSUMER_NAME, - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.JSON_PROPERTY_REST_DELIVERY_POINT_NAME, - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.JSON_PROPERTY_TLS_TRUSTED_COMMON_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName { - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_REST_CONSUMER_NAME = "restConsumerName"; - private String restConsumerName; - - public static final String JSON_PROPERTY_REST_DELIVERY_POINT_NAME = "restDeliveryPointName"; - private String restDeliveryPointName; - - public static final String JSON_PROPERTY_TLS_TRUSTED_COMMON_NAME = "tlsTrustedCommonName"; - private String tlsTrustedCommonName; - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName() { - } - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. Deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName restConsumerName(String restConsumerName) { - - this.restConsumerName = restConsumerName; - return this; - } - - /** - * The name of the REST Consumer. Deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * @return restConsumerName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REST_CONSUMER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRestConsumerName() { - return restConsumerName; - } - - - @JsonProperty(JSON_PROPERTY_REST_CONSUMER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRestConsumerName(String restConsumerName) { - this.restConsumerName = restConsumerName; - } - - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName restDeliveryPointName(String restDeliveryPointName) { - - this.restDeliveryPointName = restDeliveryPointName; - return this; - } - - /** - * The name of the REST Delivery Point. Deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * @return restDeliveryPointName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REST_DELIVERY_POINT_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getRestDeliveryPointName() { - return restDeliveryPointName; - } - - - @JsonProperty(JSON_PROPERTY_REST_DELIVERY_POINT_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRestDeliveryPointName(String restDeliveryPointName) { - this.restDeliveryPointName = restDeliveryPointName; - } - - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName tlsTrustedCommonName(String tlsTrustedCommonName) { - - this.tlsTrustedCommonName = tlsTrustedCommonName; - return this; - } - - /** - * The expected trusted common name of the remote certificate. Deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * @return tlsTrustedCommonName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TLS_TRUSTED_COMMON_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTlsTrustedCommonName() { - return tlsTrustedCommonName; - } - - - @JsonProperty(JSON_PROPERTY_TLS_TRUSTED_COMMON_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTlsTrustedCommonName(String tlsTrustedCommonName) { - this.tlsTrustedCommonName = tlsTrustedCommonName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName msgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName = (MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName) o; - return Objects.equals(this.msgVpnName, msgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.msgVpnName) && - Objects.equals(this.restConsumerName, msgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.restConsumerName) && - Objects.equals(this.restDeliveryPointName, msgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.restDeliveryPointName) && - Objects.equals(this.tlsTrustedCommonName, msgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName.tlsTrustedCommonName); - } - - @Override - public int hashCode() { - return Objects.hash(msgVpnName, restConsumerName, restDeliveryPointName, tlsTrustedCommonName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName {\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" restConsumerName: ").append(toIndentedString(restConsumerName)).append("\n"); - sb.append(" restDeliveryPointName: ").append(toIndentedString(restDeliveryPointName)).append("\n"); - sb.append(" tlsTrustedCommonName: ").append(toIndentedString(tlsTrustedCommonName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks.java deleted file mode 100644 index ba03fa172..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks() { - } - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Trusted Common Name object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks msgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks = (MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks) o; - return Objects.equals(this.uri, msgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.java deleted file mode 100644 index 06aaa5b7d..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.JSON_PROPERTY_DATA, - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.JSON_PROPERTY_LINKS, - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse() { - } - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse data(MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName data) { - this.data = data; - } - - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse links(MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks links) { - this.links = links; - } - - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse msgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse = (MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse) o; - return Objects.equals(this.data, msgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.data) && - Objects.equals(this.links, msgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.links) && - Objects.equals(this.meta, msgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.java deleted file mode 100644 index 6697c93d6..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.JSON_PROPERTY_DATA, - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.JSON_PROPERTY_LINKS, - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse() { - } - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse addDataItem(MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse addLinksItem(MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse msgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse = (MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse) o; - return Objects.equals(this.data, msgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.data) && - Objects.equals(this.links, msgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.links) && - Objects.equals(this.meta, msgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumersResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumersResponse.java deleted file mode 100644 index 025a8389a..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumersResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumer; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointRestConsumersResponse - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointRestConsumersResponse.JSON_PROPERTY_DATA, - MsgVpnRestDeliveryPointRestConsumersResponse.JSON_PROPERTY_LINKS, - MsgVpnRestDeliveryPointRestConsumersResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointRestConsumersResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnRestDeliveryPointRestConsumersResponse() { - } - - public MsgVpnRestDeliveryPointRestConsumersResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnRestDeliveryPointRestConsumersResponse addDataItem(MsgVpnRestDeliveryPointRestConsumer dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnRestDeliveryPointRestConsumersResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnRestDeliveryPointRestConsumersResponse addLinksItem(MsgVpnRestDeliveryPointRestConsumerLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnRestDeliveryPointRestConsumersResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointRestConsumersResponse msgVpnRestDeliveryPointRestConsumersResponse = (MsgVpnRestDeliveryPointRestConsumersResponse) o; - return Objects.equals(this.data, msgVpnRestDeliveryPointRestConsumersResponse.data) && - Objects.equals(this.links, msgVpnRestDeliveryPointRestConsumersResponse.links) && - Objects.equals(this.meta, msgVpnRestDeliveryPointRestConsumersResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointRestConsumersResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointsResponse.java deleted file mode 100644 index b13085069..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnRestDeliveryPointsResponse - */ -@JsonPropertyOrder({ - MsgVpnRestDeliveryPointsResponse.JSON_PROPERTY_DATA, - MsgVpnRestDeliveryPointsResponse.JSON_PROPERTY_LINKS, - MsgVpnRestDeliveryPointsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnRestDeliveryPointsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnRestDeliveryPointsResponse() { - } - - public MsgVpnRestDeliveryPointsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnRestDeliveryPointsResponse addDataItem(MsgVpnRestDeliveryPoint dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnRestDeliveryPointsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnRestDeliveryPointsResponse addLinksItem(MsgVpnRestDeliveryPointLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnRestDeliveryPointsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnRestDeliveryPointsResponse msgVpnRestDeliveryPointsResponse = (MsgVpnRestDeliveryPointsResponse) o; - return Objects.equals(this.data, msgVpnRestDeliveryPointsResponse.data) && - Objects.equals(this.links, msgVpnRestDeliveryPointsResponse.links) && - Objects.equals(this.meta, msgVpnRestDeliveryPointsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnRestDeliveryPointsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopic.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopic.java deleted file mode 100644 index 595421d9f..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopic.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnSequencedTopic - */ -@JsonPropertyOrder({ - MsgVpnSequencedTopic.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnSequencedTopic.JSON_PROPERTY_SEQUENCED_TOPIC -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnSequencedTopic { - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_SEQUENCED_TOPIC = "sequencedTopic"; - private String sequencedTopic; - - public MsgVpnSequencedTopic() { - } - - public MsgVpnSequencedTopic msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnSequencedTopic sequencedTopic(String sequencedTopic) { - - this.sequencedTopic = sequencedTopic; - return this; - } - - /** - * Topic for applying sequence numbers. - * @return sequencedTopic - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SEQUENCED_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSequencedTopic() { - return sequencedTopic; - } - - - @JsonProperty(JSON_PROPERTY_SEQUENCED_TOPIC) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSequencedTopic(String sequencedTopic) { - this.sequencedTopic = sequencedTopic; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnSequencedTopic msgVpnSequencedTopic = (MsgVpnSequencedTopic) o; - return Objects.equals(this.msgVpnName, msgVpnSequencedTopic.msgVpnName) && - Objects.equals(this.sequencedTopic, msgVpnSequencedTopic.sequencedTopic); - } - - @Override - public int hashCode() { - return Objects.hash(msgVpnName, sequencedTopic); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnSequencedTopic {\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" sequencedTopic: ").append(toIndentedString(sequencedTopic)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicLinks.java deleted file mode 100644 index 68c780c54..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnSequencedTopicLinks - */ -@JsonPropertyOrder({ - MsgVpnSequencedTopicLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnSequencedTopicLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnSequencedTopicLinks() { - } - - public MsgVpnSequencedTopicLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Sequenced Topic object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnSequencedTopicLinks msgVpnSequencedTopicLinks = (MsgVpnSequencedTopicLinks) o; - return Objects.equals(this.uri, msgVpnSequencedTopicLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnSequencedTopicLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicResponse.java deleted file mode 100644 index 46a38c9a2..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopicLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnSequencedTopicResponse - */ -@JsonPropertyOrder({ - MsgVpnSequencedTopicResponse.JSON_PROPERTY_DATA, - MsgVpnSequencedTopicResponse.JSON_PROPERTY_LINKS, - MsgVpnSequencedTopicResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnSequencedTopicResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnSequencedTopic data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnSequencedTopicLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnSequencedTopicResponse() { - } - - public MsgVpnSequencedTopicResponse data(MsgVpnSequencedTopic data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnSequencedTopic getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnSequencedTopic data) { - this.data = data; - } - - - public MsgVpnSequencedTopicResponse links(MsgVpnSequencedTopicLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnSequencedTopicLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnSequencedTopicLinks links) { - this.links = links; - } - - - public MsgVpnSequencedTopicResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnSequencedTopicResponse msgVpnSequencedTopicResponse = (MsgVpnSequencedTopicResponse) o; - return Objects.equals(this.data, msgVpnSequencedTopicResponse.data) && - Objects.equals(this.links, msgVpnSequencedTopicResponse.links) && - Objects.equals(this.meta, msgVpnSequencedTopicResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnSequencedTopicResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicsResponse.java deleted file mode 100644 index 03d201425..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopicLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnSequencedTopicsResponse - */ -@JsonPropertyOrder({ - MsgVpnSequencedTopicsResponse.JSON_PROPERTY_DATA, - MsgVpnSequencedTopicsResponse.JSON_PROPERTY_LINKS, - MsgVpnSequencedTopicsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnSequencedTopicsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnSequencedTopicsResponse() { - } - - public MsgVpnSequencedTopicsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnSequencedTopicsResponse addDataItem(MsgVpnSequencedTopic dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnSequencedTopicsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnSequencedTopicsResponse addLinksItem(MsgVpnSequencedTopicLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnSequencedTopicsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnSequencedTopicsResponse msgVpnSequencedTopicsResponse = (MsgVpnSequencedTopicsResponse) o; - return Objects.equals(this.data, msgVpnSequencedTopicsResponse.data) && - Objects.equals(this.links, msgVpnSequencedTopicsResponse.links) && - Objects.equals(this.meta, msgVpnSequencedTopicsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnSequencedTopicsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpoint.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpoint.java deleted file mode 100644 index 6c312d920..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpoint.java +++ /dev/null @@ -1,1018 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnTopicEndpoint - */ -@JsonPropertyOrder({ - MsgVpnTopicEndpoint.JSON_PROPERTY_ACCESS_TYPE, - MsgVpnTopicEndpoint.JSON_PROPERTY_CONSUMER_ACK_PROPAGATION_ENABLED, - MsgVpnTopicEndpoint.JSON_PROPERTY_DEAD_MSG_QUEUE, - MsgVpnTopicEndpoint.JSON_PROPERTY_DELIVERY_COUNT_ENABLED, - MsgVpnTopicEndpoint.JSON_PROPERTY_DELIVERY_DELAY, - MsgVpnTopicEndpoint.JSON_PROPERTY_EGRESS_ENABLED, - MsgVpnTopicEndpoint.JSON_PROPERTY_EVENT_BIND_COUNT_THRESHOLD, - MsgVpnTopicEndpoint.JSON_PROPERTY_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD, - MsgVpnTopicEndpoint.JSON_PROPERTY_EVENT_SPOOL_USAGE_THRESHOLD, - MsgVpnTopicEndpoint.JSON_PROPERTY_INGRESS_ENABLED, - MsgVpnTopicEndpoint.JSON_PROPERTY_MAX_BIND_COUNT, - MsgVpnTopicEndpoint.JSON_PROPERTY_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW, - MsgVpnTopicEndpoint.JSON_PROPERTY_MAX_MSG_SIZE, - MsgVpnTopicEndpoint.JSON_PROPERTY_MAX_REDELIVERY_COUNT, - MsgVpnTopicEndpoint.JSON_PROPERTY_MAX_SPOOL_USAGE, - MsgVpnTopicEndpoint.JSON_PROPERTY_MAX_TTL, - MsgVpnTopicEndpoint.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnTopicEndpoint.JSON_PROPERTY_OWNER, - MsgVpnTopicEndpoint.JSON_PROPERTY_PERMISSION, - MsgVpnTopicEndpoint.JSON_PROPERTY_REDELIVERY_ENABLED, - MsgVpnTopicEndpoint.JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_ENABLED, - MsgVpnTopicEndpoint.JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_LIMIT, - MsgVpnTopicEndpoint.JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR, - MsgVpnTopicEndpoint.JSON_PROPERTY_RESPECT_MSG_PRIORITY_ENABLED, - MsgVpnTopicEndpoint.JSON_PROPERTY_RESPECT_TTL_ENABLED, - MsgVpnTopicEndpoint.JSON_PROPERTY_TOPIC_ENDPOINT_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnTopicEndpoint { - /** - * The access type for delivering messages to consumer flows bound to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are: <pre> \"exclusive\" - Exclusive delivery of messages to the first bound consumer flow. \"non-exclusive\" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion. </pre> Available since 2.4. - */ - public enum AccessTypeEnum { - EXCLUSIVE("exclusive"), - - NON_EXCLUSIVE("non-exclusive"); - - private String value; - - AccessTypeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AccessTypeEnum fromValue(String value) { - for (AccessTypeEnum b : AccessTypeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_ACCESS_TYPE = "accessType"; - private AccessTypeEnum accessType; - - public static final String JSON_PROPERTY_CONSUMER_ACK_PROPAGATION_ENABLED = "consumerAckPropagationEnabled"; - private Boolean consumerAckPropagationEnabled; - - public static final String JSON_PROPERTY_DEAD_MSG_QUEUE = "deadMsgQueue"; - private String deadMsgQueue; - - public static final String JSON_PROPERTY_DELIVERY_COUNT_ENABLED = "deliveryCountEnabled"; - private Boolean deliveryCountEnabled; - - public static final String JSON_PROPERTY_DELIVERY_DELAY = "deliveryDelay"; - private Long deliveryDelay; - - public static final String JSON_PROPERTY_EGRESS_ENABLED = "egressEnabled"; - private Boolean egressEnabled; - - public static final String JSON_PROPERTY_EVENT_BIND_COUNT_THRESHOLD = "eventBindCountThreshold"; - private EventThreshold eventBindCountThreshold; - - public static final String JSON_PROPERTY_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD = "eventRejectLowPriorityMsgLimitThreshold"; - private EventThreshold eventRejectLowPriorityMsgLimitThreshold; - - public static final String JSON_PROPERTY_EVENT_SPOOL_USAGE_THRESHOLD = "eventSpoolUsageThreshold"; - private EventThreshold eventSpoolUsageThreshold; - - public static final String JSON_PROPERTY_INGRESS_ENABLED = "ingressEnabled"; - private Boolean ingressEnabled; - - public static final String JSON_PROPERTY_MAX_BIND_COUNT = "maxBindCount"; - private Long maxBindCount; - - public static final String JSON_PROPERTY_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW = "maxDeliveredUnackedMsgsPerFlow"; - private Long maxDeliveredUnackedMsgsPerFlow; - - public static final String JSON_PROPERTY_MAX_MSG_SIZE = "maxMsgSize"; - private Integer maxMsgSize; - - public static final String JSON_PROPERTY_MAX_REDELIVERY_COUNT = "maxRedeliveryCount"; - private Long maxRedeliveryCount; - - public static final String JSON_PROPERTY_MAX_SPOOL_USAGE = "maxSpoolUsage"; - private Long maxSpoolUsage; - - public static final String JSON_PROPERTY_MAX_TTL = "maxTtl"; - private Long maxTtl; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_OWNER = "owner"; - private String owner; - - /** - * The permission level for all consumers of the Topic Endpoint, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are: <pre> \"no-access\" - Disallows all access. \"read-only\" - Read-only access to the messages. \"consume\" - Consume (read and remove) messages. \"modify-topic\" - Consume messages or modify the topic/selector. \"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. </pre> - */ - public enum PermissionEnum { - NO_ACCESS("no-access"), - - READ_ONLY("read-only"), - - CONSUME("consume"), - - MODIFY_TOPIC("modify-topic"), - - DELETE("delete"); - - private String value; - - PermissionEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static PermissionEnum fromValue(String value) { - for (PermissionEnum b : PermissionEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_PERMISSION = "permission"; - private PermissionEnum permission; - - public static final String JSON_PROPERTY_REDELIVERY_ENABLED = "redeliveryEnabled"; - private Boolean redeliveryEnabled; - - public static final String JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_ENABLED = "rejectLowPriorityMsgEnabled"; - private Boolean rejectLowPriorityMsgEnabled; - - public static final String JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_LIMIT = "rejectLowPriorityMsgLimit"; - private Long rejectLowPriorityMsgLimit; - - /** - * Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"never\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-topic-endpoint-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Topic Endpoint is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> - */ - public enum RejectMsgToSenderOnDiscardBehaviorEnum { - ALWAYS("always"), - - WHEN_TOPIC_ENDPOINT_ENABLED("when-topic-endpoint-enabled"), - - NEVER("never"); - - private String value; - - RejectMsgToSenderOnDiscardBehaviorEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static RejectMsgToSenderOnDiscardBehaviorEnum fromValue(String value) { - for (RejectMsgToSenderOnDiscardBehaviorEnum b : RejectMsgToSenderOnDiscardBehaviorEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR = "rejectMsgToSenderOnDiscardBehavior"; - private RejectMsgToSenderOnDiscardBehaviorEnum rejectMsgToSenderOnDiscardBehavior; - - public static final String JSON_PROPERTY_RESPECT_MSG_PRIORITY_ENABLED = "respectMsgPriorityEnabled"; - private Boolean respectMsgPriorityEnabled; - - public static final String JSON_PROPERTY_RESPECT_TTL_ENABLED = "respectTtlEnabled"; - private Boolean respectTtlEnabled; - - public static final String JSON_PROPERTY_TOPIC_ENDPOINT_NAME = "topicEndpointName"; - private String topicEndpointName; - - public MsgVpnTopicEndpoint() { - } - - public MsgVpnTopicEndpoint accessType(AccessTypeEnum accessType) { - - this.accessType = accessType; - return this; - } - - /** - * The access type for delivering messages to consumer flows bound to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are: <pre> \"exclusive\" - Exclusive delivery of messages to the first bound consumer flow. \"non-exclusive\" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion. </pre> Available since 2.4. - * @return accessType - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACCESS_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AccessTypeEnum getAccessType() { - return accessType; - } - - - @JsonProperty(JSON_PROPERTY_ACCESS_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccessType(AccessTypeEnum accessType) { - this.accessType = accessType; - } - - - public MsgVpnTopicEndpoint consumerAckPropagationEnabled(Boolean consumerAckPropagationEnabled) { - - this.consumerAckPropagationEnabled = consumerAckPropagationEnabled; - return this; - } - - /** - * Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return consumerAckPropagationEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONSUMER_ACK_PROPAGATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getConsumerAckPropagationEnabled() { - return consumerAckPropagationEnabled; - } - - - @JsonProperty(JSON_PROPERTY_CONSUMER_ACK_PROPAGATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConsumerAckPropagationEnabled(Boolean consumerAckPropagationEnabled) { - this.consumerAckPropagationEnabled = consumerAckPropagationEnabled; - } - - - public MsgVpnTopicEndpoint deadMsgQueue(String deadMsgQueue) { - - this.deadMsgQueue = deadMsgQueue; - return this; - } - - /** - * The name of the Dead Message Queue (DMQ) used by the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.2. - * @return deadMsgQueue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DEAD_MSG_QUEUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDeadMsgQueue() { - return deadMsgQueue; - } - - - @JsonProperty(JSON_PROPERTY_DEAD_MSG_QUEUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDeadMsgQueue(String deadMsgQueue) { - this.deadMsgQueue = deadMsgQueue; - } - - - public MsgVpnTopicEndpoint deliveryCountEnabled(Boolean deliveryCountEnabled) { - - this.deliveryCountEnabled = deliveryCountEnabled; - return this; - } - - /** - * Enable or disable the ability for client applications to query the message delivery count of messages received from the Topic Endpoint. This is a controlled availability feature. Please contact support to find out if this feature is supported for your use case. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.19. - * @return deliveryCountEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DELIVERY_COUNT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getDeliveryCountEnabled() { - return deliveryCountEnabled; - } - - - @JsonProperty(JSON_PROPERTY_DELIVERY_COUNT_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDeliveryCountEnabled(Boolean deliveryCountEnabled) { - this.deliveryCountEnabled = deliveryCountEnabled; - } - - - public MsgVpnTopicEndpoint deliveryDelay(Long deliveryDelay) { - - this.deliveryDelay = deliveryDelay; - return this; - } - - /** - * The delay, in seconds, to apply to messages arriving on the Topic Endpoint before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22. - * @return deliveryDelay - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DELIVERY_DELAY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getDeliveryDelay() { - return deliveryDelay; - } - - - @JsonProperty(JSON_PROPERTY_DELIVERY_DELAY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDeliveryDelay(Long deliveryDelay) { - this.deliveryDelay = deliveryDelay; - } - - - public MsgVpnTopicEndpoint egressEnabled(Boolean egressEnabled) { - - this.egressEnabled = egressEnabled; - return this; - } - - /** - * Enable or disable the transmission of messages from the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return egressEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EGRESS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEgressEnabled() { - return egressEnabled; - } - - - @JsonProperty(JSON_PROPERTY_EGRESS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEgressEnabled(Boolean egressEnabled) { - this.egressEnabled = egressEnabled; - } - - - public MsgVpnTopicEndpoint eventBindCountThreshold(EventThreshold eventBindCountThreshold) { - - this.eventBindCountThreshold = eventBindCountThreshold; - return this; - } - - /** - * Get eventBindCountThreshold - * @return eventBindCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_BIND_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventBindCountThreshold() { - return eventBindCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_BIND_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventBindCountThreshold(EventThreshold eventBindCountThreshold) { - this.eventBindCountThreshold = eventBindCountThreshold; - } - - - public MsgVpnTopicEndpoint eventRejectLowPriorityMsgLimitThreshold(EventThreshold eventRejectLowPriorityMsgLimitThreshold) { - - this.eventRejectLowPriorityMsgLimitThreshold = eventRejectLowPriorityMsgLimitThreshold; - return this; - } - - /** - * Get eventRejectLowPriorityMsgLimitThreshold - * @return eventRejectLowPriorityMsgLimitThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventRejectLowPriorityMsgLimitThreshold() { - return eventRejectLowPriorityMsgLimitThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventRejectLowPriorityMsgLimitThreshold(EventThreshold eventRejectLowPriorityMsgLimitThreshold) { - this.eventRejectLowPriorityMsgLimitThreshold = eventRejectLowPriorityMsgLimitThreshold; - } - - - public MsgVpnTopicEndpoint eventSpoolUsageThreshold(EventThreshold eventSpoolUsageThreshold) { - - this.eventSpoolUsageThreshold = eventSpoolUsageThreshold; - return this; - } - - /** - * Get eventSpoolUsageThreshold - * @return eventSpoolUsageThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventSpoolUsageThreshold() { - return eventSpoolUsageThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventSpoolUsageThreshold(EventThreshold eventSpoolUsageThreshold) { - this.eventSpoolUsageThreshold = eventSpoolUsageThreshold; - } - - - public MsgVpnTopicEndpoint ingressEnabled(Boolean ingressEnabled) { - - this.ingressEnabled = ingressEnabled; - return this; - } - - /** - * Enable or disable the reception of messages to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return ingressEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_INGRESS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getIngressEnabled() { - return ingressEnabled; - } - - - @JsonProperty(JSON_PROPERTY_INGRESS_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIngressEnabled(Boolean ingressEnabled) { - this.ingressEnabled = ingressEnabled; - } - - - public MsgVpnTopicEndpoint maxBindCount(Long maxBindCount) { - - this.maxBindCount = maxBindCount; - return this; - } - - /** - * The maximum number of consumer flows that can bind to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. Available since 2.4. - * @return maxBindCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_BIND_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxBindCount() { - return maxBindCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_BIND_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxBindCount(Long maxBindCount) { - this.maxBindCount = maxBindCount; - } - - - public MsgVpnTopicEndpoint maxDeliveredUnackedMsgsPerFlow(Long maxDeliveredUnackedMsgsPerFlow) { - - this.maxDeliveredUnackedMsgsPerFlow = maxDeliveredUnackedMsgsPerFlow; - return this; - } - - /** - * The maximum number of messages delivered but not acknowledged per flow for the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. - * @return maxDeliveredUnackedMsgsPerFlow - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxDeliveredUnackedMsgsPerFlow() { - return maxDeliveredUnackedMsgsPerFlow; - } - - - @JsonProperty(JSON_PROPERTY_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxDeliveredUnackedMsgsPerFlow(Long maxDeliveredUnackedMsgsPerFlow) { - this.maxDeliveredUnackedMsgsPerFlow = maxDeliveredUnackedMsgsPerFlow; - } - - - public MsgVpnTopicEndpoint maxMsgSize(Integer maxMsgSize) { - - this.maxMsgSize = maxMsgSize; - return this; - } - - /** - * The maximum message size allowed in the Topic Endpoint, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. - * @return maxMsgSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_MSG_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getMaxMsgSize() { - return maxMsgSize; - } - - - @JsonProperty(JSON_PROPERTY_MAX_MSG_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxMsgSize(Integer maxMsgSize) { - this.maxMsgSize = maxMsgSize; - } - - - public MsgVpnTopicEndpoint maxRedeliveryCount(Long maxRedeliveryCount) { - - this.maxRedeliveryCount = maxRedeliveryCount; - return this; - } - - /** - * The maximum number of times the Topic Endpoint will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return maxRedeliveryCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_REDELIVERY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxRedeliveryCount() { - return maxRedeliveryCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_REDELIVERY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxRedeliveryCount(Long maxRedeliveryCount) { - this.maxRedeliveryCount = maxRedeliveryCount; - } - - - public MsgVpnTopicEndpoint maxSpoolUsage(Long maxSpoolUsage) { - - this.maxSpoolUsage = maxSpoolUsage; - return this; - } - - /** - * The maximum message spool usage allowed by the Topic Endpoint, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`. - * @return maxSpoolUsage - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxSpoolUsage() { - return maxSpoolUsage; - } - - - @JsonProperty(JSON_PROPERTY_MAX_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxSpoolUsage(Long maxSpoolUsage) { - this.maxSpoolUsage = maxSpoolUsage; - } - - - public MsgVpnTopicEndpoint maxTtl(Long maxTtl) { - - this.maxTtl = maxTtl; - return this; - } - - /** - * The maximum time in seconds a message can stay in the Topic Endpoint when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Topic Endpoint, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return maxTtl - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_TTL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxTtl() { - return maxTtl; - } - - - @JsonProperty(JSON_PROPERTY_MAX_TTL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxTtl(Long maxTtl) { - this.maxTtl = maxTtl; - } - - - public MsgVpnTopicEndpoint msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnTopicEndpoint owner(String owner) { - - this.owner = owner; - return this; - } - - /** - * The Client Username that owns the Topic Endpoint and has permission equivalent to `\"delete\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return owner - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OWNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOwner() { - return owner; - } - - - @JsonProperty(JSON_PROPERTY_OWNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOwner(String owner) { - this.owner = owner; - } - - - public MsgVpnTopicEndpoint permission(PermissionEnum permission) { - - this.permission = permission; - return this; - } - - /** - * The permission level for all consumers of the Topic Endpoint, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are: <pre> \"no-access\" - Disallows all access. \"read-only\" - Read-only access to the messages. \"consume\" - Consume (read and remove) messages. \"modify-topic\" - Consume messages or modify the topic/selector. \"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. </pre> - * @return permission - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PERMISSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PermissionEnum getPermission() { - return permission; - } - - - @JsonProperty(JSON_PROPERTY_PERMISSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPermission(PermissionEnum permission) { - this.permission = permission; - } - - - public MsgVpnTopicEndpoint redeliveryEnabled(Boolean redeliveryEnabled) { - - this.redeliveryEnabled = redeliveryEnabled; - return this; - } - - /** - * Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the topic-endpoint more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18. - * @return redeliveryEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REDELIVERY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRedeliveryEnabled() { - return redeliveryEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REDELIVERY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRedeliveryEnabled(Boolean redeliveryEnabled) { - this.redeliveryEnabled = redeliveryEnabled; - } - - - public MsgVpnTopicEndpoint rejectLowPriorityMsgEnabled(Boolean rejectLowPriorityMsgEnabled) { - - this.rejectLowPriorityMsgEnabled = rejectLowPriorityMsgEnabled; - return this; - } - - /** - * Enable or disable the checking of low priority messages against the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return rejectLowPriorityMsgEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRejectLowPriorityMsgEnabled() { - return rejectLowPriorityMsgEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRejectLowPriorityMsgEnabled(Boolean rejectLowPriorityMsgEnabled) { - this.rejectLowPriorityMsgEnabled = rejectLowPriorityMsgEnabled; - } - - - public MsgVpnTopicEndpoint rejectLowPriorityMsgLimit(Long rejectLowPriorityMsgLimit) { - - this.rejectLowPriorityMsgLimit = rejectLowPriorityMsgLimit; - return this; - } - - /** - * The number of messages of any priority in the Topic Endpoint above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return rejectLowPriorityMsgLimit - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_LIMIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getRejectLowPriorityMsgLimit() { - return rejectLowPriorityMsgLimit; - } - - - @JsonProperty(JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_LIMIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRejectLowPriorityMsgLimit(Long rejectLowPriorityMsgLimit) { - this.rejectLowPriorityMsgLimit = rejectLowPriorityMsgLimit; - } - - - public MsgVpnTopicEndpoint rejectMsgToSenderOnDiscardBehavior(RejectMsgToSenderOnDiscardBehaviorEnum rejectMsgToSenderOnDiscardBehavior) { - - this.rejectMsgToSenderOnDiscardBehavior = rejectMsgToSenderOnDiscardBehavior; - return this; - } - - /** - * Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"never\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-topic-endpoint-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Topic Endpoint is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> - * @return rejectMsgToSenderOnDiscardBehavior - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public RejectMsgToSenderOnDiscardBehaviorEnum getRejectMsgToSenderOnDiscardBehavior() { - return rejectMsgToSenderOnDiscardBehavior; - } - - - @JsonProperty(JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRejectMsgToSenderOnDiscardBehavior(RejectMsgToSenderOnDiscardBehaviorEnum rejectMsgToSenderOnDiscardBehavior) { - this.rejectMsgToSenderOnDiscardBehavior = rejectMsgToSenderOnDiscardBehavior; - } - - - public MsgVpnTopicEndpoint respectMsgPriorityEnabled(Boolean respectMsgPriorityEnabled) { - - this.respectMsgPriorityEnabled = respectMsgPriorityEnabled; - return this; - } - - /** - * Enable or disable the respecting of message priority. When enabled, messages contained in the Topic Endpoint are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.8. - * @return respectMsgPriorityEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESPECT_MSG_PRIORITY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRespectMsgPriorityEnabled() { - return respectMsgPriorityEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESPECT_MSG_PRIORITY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRespectMsgPriorityEnabled(Boolean respectMsgPriorityEnabled) { - this.respectMsgPriorityEnabled = respectMsgPriorityEnabled; - } - - - public MsgVpnTopicEndpoint respectTtlEnabled(Boolean respectTtlEnabled) { - - this.respectTtlEnabled = respectTtlEnabled; - return this; - } - - /** - * Enable or disable the respecting of the time-to-live (TTL) for messages in the Topic Endpoint. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return respectTtlEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESPECT_TTL_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRespectTtlEnabled() { - return respectTtlEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESPECT_TTL_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRespectTtlEnabled(Boolean respectTtlEnabled) { - this.respectTtlEnabled = respectTtlEnabled; - } - - - public MsgVpnTopicEndpoint topicEndpointName(String topicEndpointName) { - - this.topicEndpointName = topicEndpointName; - return this; - } - - /** - * The name of the Topic Endpoint. - * @return topicEndpointName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOPIC_ENDPOINT_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTopicEndpointName() { - return topicEndpointName; - } - - - @JsonProperty(JSON_PROPERTY_TOPIC_ENDPOINT_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTopicEndpointName(String topicEndpointName) { - this.topicEndpointName = topicEndpointName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnTopicEndpoint msgVpnTopicEndpoint = (MsgVpnTopicEndpoint) o; - return Objects.equals(this.accessType, msgVpnTopicEndpoint.accessType) && - Objects.equals(this.consumerAckPropagationEnabled, msgVpnTopicEndpoint.consumerAckPropagationEnabled) && - Objects.equals(this.deadMsgQueue, msgVpnTopicEndpoint.deadMsgQueue) && - Objects.equals(this.deliveryCountEnabled, msgVpnTopicEndpoint.deliveryCountEnabled) && - Objects.equals(this.deliveryDelay, msgVpnTopicEndpoint.deliveryDelay) && - Objects.equals(this.egressEnabled, msgVpnTopicEndpoint.egressEnabled) && - Objects.equals(this.eventBindCountThreshold, msgVpnTopicEndpoint.eventBindCountThreshold) && - Objects.equals(this.eventRejectLowPriorityMsgLimitThreshold, msgVpnTopicEndpoint.eventRejectLowPriorityMsgLimitThreshold) && - Objects.equals(this.eventSpoolUsageThreshold, msgVpnTopicEndpoint.eventSpoolUsageThreshold) && - Objects.equals(this.ingressEnabled, msgVpnTopicEndpoint.ingressEnabled) && - Objects.equals(this.maxBindCount, msgVpnTopicEndpoint.maxBindCount) && - Objects.equals(this.maxDeliveredUnackedMsgsPerFlow, msgVpnTopicEndpoint.maxDeliveredUnackedMsgsPerFlow) && - Objects.equals(this.maxMsgSize, msgVpnTopicEndpoint.maxMsgSize) && - Objects.equals(this.maxRedeliveryCount, msgVpnTopicEndpoint.maxRedeliveryCount) && - Objects.equals(this.maxSpoolUsage, msgVpnTopicEndpoint.maxSpoolUsage) && - Objects.equals(this.maxTtl, msgVpnTopicEndpoint.maxTtl) && - Objects.equals(this.msgVpnName, msgVpnTopicEndpoint.msgVpnName) && - Objects.equals(this.owner, msgVpnTopicEndpoint.owner) && - Objects.equals(this.permission, msgVpnTopicEndpoint.permission) && - Objects.equals(this.redeliveryEnabled, msgVpnTopicEndpoint.redeliveryEnabled) && - Objects.equals(this.rejectLowPriorityMsgEnabled, msgVpnTopicEndpoint.rejectLowPriorityMsgEnabled) && - Objects.equals(this.rejectLowPriorityMsgLimit, msgVpnTopicEndpoint.rejectLowPriorityMsgLimit) && - Objects.equals(this.rejectMsgToSenderOnDiscardBehavior, msgVpnTopicEndpoint.rejectMsgToSenderOnDiscardBehavior) && - Objects.equals(this.respectMsgPriorityEnabled, msgVpnTopicEndpoint.respectMsgPriorityEnabled) && - Objects.equals(this.respectTtlEnabled, msgVpnTopicEndpoint.respectTtlEnabled) && - Objects.equals(this.topicEndpointName, msgVpnTopicEndpoint.topicEndpointName); - } - - @Override - public int hashCode() { - return Objects.hash(accessType, consumerAckPropagationEnabled, deadMsgQueue, deliveryCountEnabled, deliveryDelay, egressEnabled, eventBindCountThreshold, eventRejectLowPriorityMsgLimitThreshold, eventSpoolUsageThreshold, ingressEnabled, maxBindCount, maxDeliveredUnackedMsgsPerFlow, maxMsgSize, maxRedeliveryCount, maxSpoolUsage, maxTtl, msgVpnName, owner, permission, redeliveryEnabled, rejectLowPriorityMsgEnabled, rejectLowPriorityMsgLimit, rejectMsgToSenderOnDiscardBehavior, respectMsgPriorityEnabled, respectTtlEnabled, topicEndpointName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnTopicEndpoint {\n"); - sb.append(" accessType: ").append(toIndentedString(accessType)).append("\n"); - sb.append(" consumerAckPropagationEnabled: ").append(toIndentedString(consumerAckPropagationEnabled)).append("\n"); - sb.append(" deadMsgQueue: ").append(toIndentedString(deadMsgQueue)).append("\n"); - sb.append(" deliveryCountEnabled: ").append(toIndentedString(deliveryCountEnabled)).append("\n"); - sb.append(" deliveryDelay: ").append(toIndentedString(deliveryDelay)).append("\n"); - sb.append(" egressEnabled: ").append(toIndentedString(egressEnabled)).append("\n"); - sb.append(" eventBindCountThreshold: ").append(toIndentedString(eventBindCountThreshold)).append("\n"); - sb.append(" eventRejectLowPriorityMsgLimitThreshold: ").append(toIndentedString(eventRejectLowPriorityMsgLimitThreshold)).append("\n"); - sb.append(" eventSpoolUsageThreshold: ").append(toIndentedString(eventSpoolUsageThreshold)).append("\n"); - sb.append(" ingressEnabled: ").append(toIndentedString(ingressEnabled)).append("\n"); - sb.append(" maxBindCount: ").append(toIndentedString(maxBindCount)).append("\n"); - sb.append(" maxDeliveredUnackedMsgsPerFlow: ").append(toIndentedString(maxDeliveredUnackedMsgsPerFlow)).append("\n"); - sb.append(" maxMsgSize: ").append(toIndentedString(maxMsgSize)).append("\n"); - sb.append(" maxRedeliveryCount: ").append(toIndentedString(maxRedeliveryCount)).append("\n"); - sb.append(" maxSpoolUsage: ").append(toIndentedString(maxSpoolUsage)).append("\n"); - sb.append(" maxTtl: ").append(toIndentedString(maxTtl)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" owner: ").append(toIndentedString(owner)).append("\n"); - sb.append(" permission: ").append(toIndentedString(permission)).append("\n"); - sb.append(" redeliveryEnabled: ").append(toIndentedString(redeliveryEnabled)).append("\n"); - sb.append(" rejectLowPriorityMsgEnabled: ").append(toIndentedString(rejectLowPriorityMsgEnabled)).append("\n"); - sb.append(" rejectLowPriorityMsgLimit: ").append(toIndentedString(rejectLowPriorityMsgLimit)).append("\n"); - sb.append(" rejectMsgToSenderOnDiscardBehavior: ").append(toIndentedString(rejectMsgToSenderOnDiscardBehavior)).append("\n"); - sb.append(" respectMsgPriorityEnabled: ").append(toIndentedString(respectMsgPriorityEnabled)).append("\n"); - sb.append(" respectTtlEnabled: ").append(toIndentedString(respectTtlEnabled)).append("\n"); - sb.append(" topicEndpointName: ").append(toIndentedString(topicEndpointName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointLinks.java deleted file mode 100644 index 995a1e8d5..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnTopicEndpointLinks - */ -@JsonPropertyOrder({ - MsgVpnTopicEndpointLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnTopicEndpointLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnTopicEndpointLinks() { - } - - public MsgVpnTopicEndpointLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Topic Endpoint object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnTopicEndpointLinks msgVpnTopicEndpointLinks = (MsgVpnTopicEndpointLinks) o; - return Objects.equals(this.uri, msgVpnTopicEndpointLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnTopicEndpointLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointResponse.java deleted file mode 100644 index 2c7ceea0c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnTopicEndpointResponse - */ -@JsonPropertyOrder({ - MsgVpnTopicEndpointResponse.JSON_PROPERTY_DATA, - MsgVpnTopicEndpointResponse.JSON_PROPERTY_LINKS, - MsgVpnTopicEndpointResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnTopicEndpointResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnTopicEndpoint data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnTopicEndpointLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnTopicEndpointResponse() { - } - - public MsgVpnTopicEndpointResponse data(MsgVpnTopicEndpoint data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnTopicEndpoint getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnTopicEndpoint data) { - this.data = data; - } - - - public MsgVpnTopicEndpointResponse links(MsgVpnTopicEndpointLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnTopicEndpointLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnTopicEndpointLinks links) { - this.links = links; - } - - - public MsgVpnTopicEndpointResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnTopicEndpointResponse msgVpnTopicEndpointResponse = (MsgVpnTopicEndpointResponse) o; - return Objects.equals(this.data, msgVpnTopicEndpointResponse.data) && - Objects.equals(this.links, msgVpnTopicEndpointResponse.links) && - Objects.equals(this.meta, msgVpnTopicEndpointResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnTopicEndpointResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplate.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplate.java deleted file mode 100644 index de522155c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplate.java +++ /dev/null @@ -1,922 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnTopicEndpointTemplate - */ -@JsonPropertyOrder({ - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_ACCESS_TYPE, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_CONSUMER_ACK_PROPAGATION_ENABLED, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_DEAD_MSG_QUEUE, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_DELIVERY_DELAY, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_EVENT_BIND_COUNT_THRESHOLD, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_EVENT_MSG_SPOOL_USAGE_THRESHOLD, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_MAX_BIND_COUNT, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_MAX_MSG_SIZE, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_MAX_MSG_SPOOL_USAGE, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_MAX_REDELIVERY_COUNT, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_MAX_TTL, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_MSG_VPN_NAME, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_PERMISSION, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_REDELIVERY_ENABLED, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_ENABLED, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_LIMIT, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_RESPECT_MSG_PRIORITY_ENABLED, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_RESPECT_TTL_ENABLED, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_TOPIC_ENDPOINT_NAME_FILTER, - MsgVpnTopicEndpointTemplate.JSON_PROPERTY_TOPIC_ENDPOINT_TEMPLATE_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnTopicEndpointTemplate { - /** - * The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are: <pre> \"exclusive\" - Exclusive delivery of messages to the first bound consumer flow. \"non-exclusive\" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion. </pre> - */ - public enum AccessTypeEnum { - EXCLUSIVE("exclusive"), - - NON_EXCLUSIVE("non-exclusive"); - - private String value; - - AccessTypeEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AccessTypeEnum fromValue(String value) { - for (AccessTypeEnum b : AccessTypeEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_ACCESS_TYPE = "accessType"; - private AccessTypeEnum accessType; - - public static final String JSON_PROPERTY_CONSUMER_ACK_PROPAGATION_ENABLED = "consumerAckPropagationEnabled"; - private Boolean consumerAckPropagationEnabled; - - public static final String JSON_PROPERTY_DEAD_MSG_QUEUE = "deadMsgQueue"; - private String deadMsgQueue; - - public static final String JSON_PROPERTY_DELIVERY_DELAY = "deliveryDelay"; - private Long deliveryDelay; - - public static final String JSON_PROPERTY_EVENT_BIND_COUNT_THRESHOLD = "eventBindCountThreshold"; - private EventThreshold eventBindCountThreshold; - - public static final String JSON_PROPERTY_EVENT_MSG_SPOOL_USAGE_THRESHOLD = "eventMsgSpoolUsageThreshold"; - private EventThreshold eventMsgSpoolUsageThreshold; - - public static final String JSON_PROPERTY_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD = "eventRejectLowPriorityMsgLimitThreshold"; - private EventThreshold eventRejectLowPriorityMsgLimitThreshold; - - public static final String JSON_PROPERTY_MAX_BIND_COUNT = "maxBindCount"; - private Long maxBindCount; - - public static final String JSON_PROPERTY_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW = "maxDeliveredUnackedMsgsPerFlow"; - private Long maxDeliveredUnackedMsgsPerFlow; - - public static final String JSON_PROPERTY_MAX_MSG_SIZE = "maxMsgSize"; - private Integer maxMsgSize; - - public static final String JSON_PROPERTY_MAX_MSG_SPOOL_USAGE = "maxMsgSpoolUsage"; - private Long maxMsgSpoolUsage; - - public static final String JSON_PROPERTY_MAX_REDELIVERY_COUNT = "maxRedeliveryCount"; - private Long maxRedeliveryCount; - - public static final String JSON_PROPERTY_MAX_TTL = "maxTtl"; - private Long maxTtl; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - /** - * The permission level for all consumers, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are: <pre> \"no-access\" - Disallows all access. \"read-only\" - Read-only access to the messages. \"consume\" - Consume (read and remove) messages. \"modify-topic\" - Consume messages or modify the topic/selector. \"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. </pre> - */ - public enum PermissionEnum { - NO_ACCESS("no-access"), - - READ_ONLY("read-only"), - - CONSUME("consume"), - - MODIFY_TOPIC("modify-topic"), - - DELETE("delete"); - - private String value; - - PermissionEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static PermissionEnum fromValue(String value) { - for (PermissionEnum b : PermissionEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_PERMISSION = "permission"; - private PermissionEnum permission; - - public static final String JSON_PROPERTY_REDELIVERY_ENABLED = "redeliveryEnabled"; - private Boolean redeliveryEnabled; - - public static final String JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_ENABLED = "rejectLowPriorityMsgEnabled"; - private Boolean rejectLowPriorityMsgEnabled; - - public static final String JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_LIMIT = "rejectLowPriorityMsgLimit"; - private Long rejectLowPriorityMsgLimit; - - /** - * Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"never\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-topic-endpoint-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Topic Endpoint is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> - */ - public enum RejectMsgToSenderOnDiscardBehaviorEnum { - ALWAYS("always"), - - WHEN_TOPIC_ENDPOINT_ENABLED("when-topic-endpoint-enabled"), - - NEVER("never"); - - private String value; - - RejectMsgToSenderOnDiscardBehaviorEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static RejectMsgToSenderOnDiscardBehaviorEnum fromValue(String value) { - for (RejectMsgToSenderOnDiscardBehaviorEnum b : RejectMsgToSenderOnDiscardBehaviorEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR = "rejectMsgToSenderOnDiscardBehavior"; - private RejectMsgToSenderOnDiscardBehaviorEnum rejectMsgToSenderOnDiscardBehavior; - - public static final String JSON_PROPERTY_RESPECT_MSG_PRIORITY_ENABLED = "respectMsgPriorityEnabled"; - private Boolean respectMsgPriorityEnabled; - - public static final String JSON_PROPERTY_RESPECT_TTL_ENABLED = "respectTtlEnabled"; - private Boolean respectTtlEnabled; - - public static final String JSON_PROPERTY_TOPIC_ENDPOINT_NAME_FILTER = "topicEndpointNameFilter"; - private String topicEndpointNameFilter; - - public static final String JSON_PROPERTY_TOPIC_ENDPOINT_TEMPLATE_NAME = "topicEndpointTemplateName"; - private String topicEndpointTemplateName; - - public MsgVpnTopicEndpointTemplate() { - } - - public MsgVpnTopicEndpointTemplate accessType(AccessTypeEnum accessType) { - - this.accessType = accessType; - return this; - } - - /** - * The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are: <pre> \"exclusive\" - Exclusive delivery of messages to the first bound consumer flow. \"non-exclusive\" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion. </pre> - * @return accessType - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACCESS_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AccessTypeEnum getAccessType() { - return accessType; - } - - - @JsonProperty(JSON_PROPERTY_ACCESS_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccessType(AccessTypeEnum accessType) { - this.accessType = accessType; - } - - - public MsgVpnTopicEndpointTemplate consumerAckPropagationEnabled(Boolean consumerAckPropagationEnabled) { - - this.consumerAckPropagationEnabled = consumerAckPropagationEnabled; - return this; - } - - /** - * Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - * @return consumerAckPropagationEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CONSUMER_ACK_PROPAGATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getConsumerAckPropagationEnabled() { - return consumerAckPropagationEnabled; - } - - - @JsonProperty(JSON_PROPERTY_CONSUMER_ACK_PROPAGATION_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setConsumerAckPropagationEnabled(Boolean consumerAckPropagationEnabled) { - this.consumerAckPropagationEnabled = consumerAckPropagationEnabled; - } - - - public MsgVpnTopicEndpointTemplate deadMsgQueue(String deadMsgQueue) { - - this.deadMsgQueue = deadMsgQueue; - return this; - } - - /** - * The name of the Dead Message Queue (DMQ). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. - * @return deadMsgQueue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DEAD_MSG_QUEUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDeadMsgQueue() { - return deadMsgQueue; - } - - - @JsonProperty(JSON_PROPERTY_DEAD_MSG_QUEUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDeadMsgQueue(String deadMsgQueue) { - this.deadMsgQueue = deadMsgQueue; - } - - - public MsgVpnTopicEndpointTemplate deliveryDelay(Long deliveryDelay) { - - this.deliveryDelay = deliveryDelay; - return this; - } - - /** - * The delay, in seconds, to apply to messages arriving on the Topic Endpoint before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22. - * @return deliveryDelay - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DELIVERY_DELAY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getDeliveryDelay() { - return deliveryDelay; - } - - - @JsonProperty(JSON_PROPERTY_DELIVERY_DELAY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDeliveryDelay(Long deliveryDelay) { - this.deliveryDelay = deliveryDelay; - } - - - public MsgVpnTopicEndpointTemplate eventBindCountThreshold(EventThreshold eventBindCountThreshold) { - - this.eventBindCountThreshold = eventBindCountThreshold; - return this; - } - - /** - * Get eventBindCountThreshold - * @return eventBindCountThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_BIND_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventBindCountThreshold() { - return eventBindCountThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_BIND_COUNT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventBindCountThreshold(EventThreshold eventBindCountThreshold) { - this.eventBindCountThreshold = eventBindCountThreshold; - } - - - public MsgVpnTopicEndpointTemplate eventMsgSpoolUsageThreshold(EventThreshold eventMsgSpoolUsageThreshold) { - - this.eventMsgSpoolUsageThreshold = eventMsgSpoolUsageThreshold; - return this; - } - - /** - * Get eventMsgSpoolUsageThreshold - * @return eventMsgSpoolUsageThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_MSG_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventMsgSpoolUsageThreshold() { - return eventMsgSpoolUsageThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_MSG_SPOOL_USAGE_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventMsgSpoolUsageThreshold(EventThreshold eventMsgSpoolUsageThreshold) { - this.eventMsgSpoolUsageThreshold = eventMsgSpoolUsageThreshold; - } - - - public MsgVpnTopicEndpointTemplate eventRejectLowPriorityMsgLimitThreshold(EventThreshold eventRejectLowPriorityMsgLimitThreshold) { - - this.eventRejectLowPriorityMsgLimitThreshold = eventRejectLowPriorityMsgLimitThreshold; - return this; - } - - /** - * Get eventRejectLowPriorityMsgLimitThreshold - * @return eventRejectLowPriorityMsgLimitThreshold - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public EventThreshold getEventRejectLowPriorityMsgLimitThreshold() { - return eventRejectLowPriorityMsgLimitThreshold; - } - - - @JsonProperty(JSON_PROPERTY_EVENT_REJECT_LOW_PRIORITY_MSG_LIMIT_THRESHOLD) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventRejectLowPriorityMsgLimitThreshold(EventThreshold eventRejectLowPriorityMsgLimitThreshold) { - this.eventRejectLowPriorityMsgLimitThreshold = eventRejectLowPriorityMsgLimitThreshold; - } - - - public MsgVpnTopicEndpointTemplate maxBindCount(Long maxBindCount) { - - this.maxBindCount = maxBindCount; - return this; - } - - /** - * The maximum number of consumer flows that can bind. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. - * @return maxBindCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_BIND_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxBindCount() { - return maxBindCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_BIND_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxBindCount(Long maxBindCount) { - this.maxBindCount = maxBindCount; - } - - - public MsgVpnTopicEndpointTemplate maxDeliveredUnackedMsgsPerFlow(Long maxDeliveredUnackedMsgsPerFlow) { - - this.maxDeliveredUnackedMsgsPerFlow = maxDeliveredUnackedMsgsPerFlow; - return this; - } - - /** - * The maximum number of messages delivered but not acknowledged per flow. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. - * @return maxDeliveredUnackedMsgsPerFlow - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxDeliveredUnackedMsgsPerFlow() { - return maxDeliveredUnackedMsgsPerFlow; - } - - - @JsonProperty(JSON_PROPERTY_MAX_DELIVERED_UNACKED_MSGS_PER_FLOW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxDeliveredUnackedMsgsPerFlow(Long maxDeliveredUnackedMsgsPerFlow) { - this.maxDeliveredUnackedMsgsPerFlow = maxDeliveredUnackedMsgsPerFlow; - } - - - public MsgVpnTopicEndpointTemplate maxMsgSize(Integer maxMsgSize) { - - this.maxMsgSize = maxMsgSize; - return this; - } - - /** - * The maximum message size allowed, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. - * @return maxMsgSize - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_MSG_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getMaxMsgSize() { - return maxMsgSize; - } - - - @JsonProperty(JSON_PROPERTY_MAX_MSG_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxMsgSize(Integer maxMsgSize) { - this.maxMsgSize = maxMsgSize; - } - - - public MsgVpnTopicEndpointTemplate maxMsgSpoolUsage(Long maxMsgSpoolUsage) { - - this.maxMsgSpoolUsage = maxMsgSpoolUsage; - return this; - } - - /** - * The maximum message spool usage allowed, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`. - * @return maxMsgSpoolUsage - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_MSG_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxMsgSpoolUsage() { - return maxMsgSpoolUsage; - } - - - @JsonProperty(JSON_PROPERTY_MAX_MSG_SPOOL_USAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxMsgSpoolUsage(Long maxMsgSpoolUsage) { - this.maxMsgSpoolUsage = maxMsgSpoolUsage; - } - - - public MsgVpnTopicEndpointTemplate maxRedeliveryCount(Long maxRedeliveryCount) { - - this.maxRedeliveryCount = maxRedeliveryCount; - return this; - } - - /** - * The maximum number of message redelivery attempts that will occur prior to the message being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return maxRedeliveryCount - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_REDELIVERY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxRedeliveryCount() { - return maxRedeliveryCount; - } - - - @JsonProperty(JSON_PROPERTY_MAX_REDELIVERY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxRedeliveryCount(Long maxRedeliveryCount) { - this.maxRedeliveryCount = maxRedeliveryCount; - } - - - public MsgVpnTopicEndpointTemplate maxTtl(Long maxTtl) { - - this.maxTtl = maxTtl; - return this; - } - - /** - * The maximum time in seconds a message can stay in the Topic Endpoint when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Topic Endpoint, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return maxTtl - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MAX_TTL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getMaxTtl() { - return maxTtl; - } - - - @JsonProperty(JSON_PROPERTY_MAX_TTL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMaxTtl(Long maxTtl) { - this.maxTtl = maxTtl; - } - - - public MsgVpnTopicEndpointTemplate msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the Message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public MsgVpnTopicEndpointTemplate permission(PermissionEnum permission) { - - this.permission = permission; - return this; - } - - /** - * The permission level for all consumers, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are: <pre> \"no-access\" - Disallows all access. \"read-only\" - Read-only access to the messages. \"consume\" - Consume (read and remove) messages. \"modify-topic\" - Consume messages or modify the topic/selector. \"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. </pre> - * @return permission - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PERMISSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public PermissionEnum getPermission() { - return permission; - } - - - @JsonProperty(JSON_PROPERTY_PERMISSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPermission(PermissionEnum permission) { - this.permission = permission; - } - - - public MsgVpnTopicEndpointTemplate redeliveryEnabled(Boolean redeliveryEnabled) { - - this.redeliveryEnabled = redeliveryEnabled; - return this; - } - - /** - * Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the topic-endpoint more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18. - * @return redeliveryEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REDELIVERY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRedeliveryEnabled() { - return redeliveryEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REDELIVERY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRedeliveryEnabled(Boolean redeliveryEnabled) { - this.redeliveryEnabled = redeliveryEnabled; - } - - - public MsgVpnTopicEndpointTemplate rejectLowPriorityMsgEnabled(Boolean rejectLowPriorityMsgEnabled) { - - this.rejectLowPriorityMsgEnabled = rejectLowPriorityMsgEnabled; - return this; - } - - /** - * Enable or disable the checking of low priority messages against the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return rejectLowPriorityMsgEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRejectLowPriorityMsgEnabled() { - return rejectLowPriorityMsgEnabled; - } - - - @JsonProperty(JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRejectLowPriorityMsgEnabled(Boolean rejectLowPriorityMsgEnabled) { - this.rejectLowPriorityMsgEnabled = rejectLowPriorityMsgEnabled; - } - - - public MsgVpnTopicEndpointTemplate rejectLowPriorityMsgLimit(Long rejectLowPriorityMsgLimit) { - - this.rejectLowPriorityMsgLimit = rejectLowPriorityMsgLimit; - return this; - } - - /** - * The number of messages that are permitted before low priority messages are rejected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - * @return rejectLowPriorityMsgLimit - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_LIMIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getRejectLowPriorityMsgLimit() { - return rejectLowPriorityMsgLimit; - } - - - @JsonProperty(JSON_PROPERTY_REJECT_LOW_PRIORITY_MSG_LIMIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRejectLowPriorityMsgLimit(Long rejectLowPriorityMsgLimit) { - this.rejectLowPriorityMsgLimit = rejectLowPriorityMsgLimit; - } - - - public MsgVpnTopicEndpointTemplate rejectMsgToSenderOnDiscardBehavior(RejectMsgToSenderOnDiscardBehaviorEnum rejectMsgToSenderOnDiscardBehavior) { - - this.rejectMsgToSenderOnDiscardBehavior = rejectMsgToSenderOnDiscardBehavior; - return this; - } - - /** - * Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"never\"`. The allowed values and their meaning are: <pre> \"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard. \"when-topic-endpoint-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Topic Endpoint is enabled. \"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard. </pre> - * @return rejectMsgToSenderOnDiscardBehavior - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public RejectMsgToSenderOnDiscardBehaviorEnum getRejectMsgToSenderOnDiscardBehavior() { - return rejectMsgToSenderOnDiscardBehavior; - } - - - @JsonProperty(JSON_PROPERTY_REJECT_MSG_TO_SENDER_ON_DISCARD_BEHAVIOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRejectMsgToSenderOnDiscardBehavior(RejectMsgToSenderOnDiscardBehaviorEnum rejectMsgToSenderOnDiscardBehavior) { - this.rejectMsgToSenderOnDiscardBehavior = rejectMsgToSenderOnDiscardBehavior; - } - - - public MsgVpnTopicEndpointTemplate respectMsgPriorityEnabled(Boolean respectMsgPriorityEnabled) { - - this.respectMsgPriorityEnabled = respectMsgPriorityEnabled; - return this; - } - - /** - * Enable or disable the respecting of message priority. When enabled, messages are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return respectMsgPriorityEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESPECT_MSG_PRIORITY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRespectMsgPriorityEnabled() { - return respectMsgPriorityEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESPECT_MSG_PRIORITY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRespectMsgPriorityEnabled(Boolean respectMsgPriorityEnabled) { - this.respectMsgPriorityEnabled = respectMsgPriorityEnabled; - } - - - public MsgVpnTopicEndpointTemplate respectTtlEnabled(Boolean respectTtlEnabled) { - - this.respectTtlEnabled = respectTtlEnabled; - return this; - } - - /** - * Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - * @return respectTtlEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESPECT_TTL_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getRespectTtlEnabled() { - return respectTtlEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESPECT_TTL_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRespectTtlEnabled(Boolean respectTtlEnabled) { - this.respectTtlEnabled = respectTtlEnabled; - } - - - public MsgVpnTopicEndpointTemplate topicEndpointNameFilter(String topicEndpointNameFilter) { - - this.topicEndpointNameFilter = topicEndpointNameFilter; - return this; - } - - /** - * A wildcardable pattern used to determine which Topic Endpoints use settings from this Template. Two different wildcards are supported: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. - * @return topicEndpointNameFilter - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOPIC_ENDPOINT_NAME_FILTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTopicEndpointNameFilter() { - return topicEndpointNameFilter; - } - - - @JsonProperty(JSON_PROPERTY_TOPIC_ENDPOINT_NAME_FILTER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTopicEndpointNameFilter(String topicEndpointNameFilter) { - this.topicEndpointNameFilter = topicEndpointNameFilter; - } - - - public MsgVpnTopicEndpointTemplate topicEndpointTemplateName(String topicEndpointTemplateName) { - - this.topicEndpointTemplateName = topicEndpointTemplateName; - return this; - } - - /** - * The name of the Topic Endpoint Template. - * @return topicEndpointTemplateName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_TOPIC_ENDPOINT_TEMPLATE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getTopicEndpointTemplateName() { - return topicEndpointTemplateName; - } - - - @JsonProperty(JSON_PROPERTY_TOPIC_ENDPOINT_TEMPLATE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTopicEndpointTemplateName(String topicEndpointTemplateName) { - this.topicEndpointTemplateName = topicEndpointTemplateName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnTopicEndpointTemplate msgVpnTopicEndpointTemplate = (MsgVpnTopicEndpointTemplate) o; - return Objects.equals(this.accessType, msgVpnTopicEndpointTemplate.accessType) && - Objects.equals(this.consumerAckPropagationEnabled, msgVpnTopicEndpointTemplate.consumerAckPropagationEnabled) && - Objects.equals(this.deadMsgQueue, msgVpnTopicEndpointTemplate.deadMsgQueue) && - Objects.equals(this.deliveryDelay, msgVpnTopicEndpointTemplate.deliveryDelay) && - Objects.equals(this.eventBindCountThreshold, msgVpnTopicEndpointTemplate.eventBindCountThreshold) && - Objects.equals(this.eventMsgSpoolUsageThreshold, msgVpnTopicEndpointTemplate.eventMsgSpoolUsageThreshold) && - Objects.equals(this.eventRejectLowPriorityMsgLimitThreshold, msgVpnTopicEndpointTemplate.eventRejectLowPriorityMsgLimitThreshold) && - Objects.equals(this.maxBindCount, msgVpnTopicEndpointTemplate.maxBindCount) && - Objects.equals(this.maxDeliveredUnackedMsgsPerFlow, msgVpnTopicEndpointTemplate.maxDeliveredUnackedMsgsPerFlow) && - Objects.equals(this.maxMsgSize, msgVpnTopicEndpointTemplate.maxMsgSize) && - Objects.equals(this.maxMsgSpoolUsage, msgVpnTopicEndpointTemplate.maxMsgSpoolUsage) && - Objects.equals(this.maxRedeliveryCount, msgVpnTopicEndpointTemplate.maxRedeliveryCount) && - Objects.equals(this.maxTtl, msgVpnTopicEndpointTemplate.maxTtl) && - Objects.equals(this.msgVpnName, msgVpnTopicEndpointTemplate.msgVpnName) && - Objects.equals(this.permission, msgVpnTopicEndpointTemplate.permission) && - Objects.equals(this.redeliveryEnabled, msgVpnTopicEndpointTemplate.redeliveryEnabled) && - Objects.equals(this.rejectLowPriorityMsgEnabled, msgVpnTopicEndpointTemplate.rejectLowPriorityMsgEnabled) && - Objects.equals(this.rejectLowPriorityMsgLimit, msgVpnTopicEndpointTemplate.rejectLowPriorityMsgLimit) && - Objects.equals(this.rejectMsgToSenderOnDiscardBehavior, msgVpnTopicEndpointTemplate.rejectMsgToSenderOnDiscardBehavior) && - Objects.equals(this.respectMsgPriorityEnabled, msgVpnTopicEndpointTemplate.respectMsgPriorityEnabled) && - Objects.equals(this.respectTtlEnabled, msgVpnTopicEndpointTemplate.respectTtlEnabled) && - Objects.equals(this.topicEndpointNameFilter, msgVpnTopicEndpointTemplate.topicEndpointNameFilter) && - Objects.equals(this.topicEndpointTemplateName, msgVpnTopicEndpointTemplate.topicEndpointTemplateName); - } - - @Override - public int hashCode() { - return Objects.hash(accessType, consumerAckPropagationEnabled, deadMsgQueue, deliveryDelay, eventBindCountThreshold, eventMsgSpoolUsageThreshold, eventRejectLowPriorityMsgLimitThreshold, maxBindCount, maxDeliveredUnackedMsgsPerFlow, maxMsgSize, maxMsgSpoolUsage, maxRedeliveryCount, maxTtl, msgVpnName, permission, redeliveryEnabled, rejectLowPriorityMsgEnabled, rejectLowPriorityMsgLimit, rejectMsgToSenderOnDiscardBehavior, respectMsgPriorityEnabled, respectTtlEnabled, topicEndpointNameFilter, topicEndpointTemplateName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnTopicEndpointTemplate {\n"); - sb.append(" accessType: ").append(toIndentedString(accessType)).append("\n"); - sb.append(" consumerAckPropagationEnabled: ").append(toIndentedString(consumerAckPropagationEnabled)).append("\n"); - sb.append(" deadMsgQueue: ").append(toIndentedString(deadMsgQueue)).append("\n"); - sb.append(" deliveryDelay: ").append(toIndentedString(deliveryDelay)).append("\n"); - sb.append(" eventBindCountThreshold: ").append(toIndentedString(eventBindCountThreshold)).append("\n"); - sb.append(" eventMsgSpoolUsageThreshold: ").append(toIndentedString(eventMsgSpoolUsageThreshold)).append("\n"); - sb.append(" eventRejectLowPriorityMsgLimitThreshold: ").append(toIndentedString(eventRejectLowPriorityMsgLimitThreshold)).append("\n"); - sb.append(" maxBindCount: ").append(toIndentedString(maxBindCount)).append("\n"); - sb.append(" maxDeliveredUnackedMsgsPerFlow: ").append(toIndentedString(maxDeliveredUnackedMsgsPerFlow)).append("\n"); - sb.append(" maxMsgSize: ").append(toIndentedString(maxMsgSize)).append("\n"); - sb.append(" maxMsgSpoolUsage: ").append(toIndentedString(maxMsgSpoolUsage)).append("\n"); - sb.append(" maxRedeliveryCount: ").append(toIndentedString(maxRedeliveryCount)).append("\n"); - sb.append(" maxTtl: ").append(toIndentedString(maxTtl)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" permission: ").append(toIndentedString(permission)).append("\n"); - sb.append(" redeliveryEnabled: ").append(toIndentedString(redeliveryEnabled)).append("\n"); - sb.append(" rejectLowPriorityMsgEnabled: ").append(toIndentedString(rejectLowPriorityMsgEnabled)).append("\n"); - sb.append(" rejectLowPriorityMsgLimit: ").append(toIndentedString(rejectLowPriorityMsgLimit)).append("\n"); - sb.append(" rejectMsgToSenderOnDiscardBehavior: ").append(toIndentedString(rejectMsgToSenderOnDiscardBehavior)).append("\n"); - sb.append(" respectMsgPriorityEnabled: ").append(toIndentedString(respectMsgPriorityEnabled)).append("\n"); - sb.append(" respectTtlEnabled: ").append(toIndentedString(respectTtlEnabled)).append("\n"); - sb.append(" topicEndpointNameFilter: ").append(toIndentedString(topicEndpointNameFilter)).append("\n"); - sb.append(" topicEndpointTemplateName: ").append(toIndentedString(topicEndpointTemplateName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateLinks.java deleted file mode 100644 index 4d2290623..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnTopicEndpointTemplateLinks - */ -@JsonPropertyOrder({ - MsgVpnTopicEndpointTemplateLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnTopicEndpointTemplateLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public MsgVpnTopicEndpointTemplateLinks() { - } - - public MsgVpnTopicEndpointTemplateLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Topic Endpoint Template object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnTopicEndpointTemplateLinks msgVpnTopicEndpointTemplateLinks = (MsgVpnTopicEndpointTemplateLinks) o; - return Objects.equals(this.uri, msgVpnTopicEndpointTemplateLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnTopicEndpointTemplateLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateResponse.java deleted file mode 100644 index ed56a1d90..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplateLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnTopicEndpointTemplateResponse - */ -@JsonPropertyOrder({ - MsgVpnTopicEndpointTemplateResponse.JSON_PROPERTY_DATA, - MsgVpnTopicEndpointTemplateResponse.JSON_PROPERTY_LINKS, - MsgVpnTopicEndpointTemplateResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnTopicEndpointTemplateResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private MsgVpnTopicEndpointTemplate data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private MsgVpnTopicEndpointTemplateLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnTopicEndpointTemplateResponse() { - } - - public MsgVpnTopicEndpointTemplateResponse data(MsgVpnTopicEndpointTemplate data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnTopicEndpointTemplate getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(MsgVpnTopicEndpointTemplate data) { - this.data = data; - } - - - public MsgVpnTopicEndpointTemplateResponse links(MsgVpnTopicEndpointTemplateLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnTopicEndpointTemplateLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(MsgVpnTopicEndpointTemplateLinks links) { - this.links = links; - } - - - public MsgVpnTopicEndpointTemplateResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnTopicEndpointTemplateResponse msgVpnTopicEndpointTemplateResponse = (MsgVpnTopicEndpointTemplateResponse) o; - return Objects.equals(this.data, msgVpnTopicEndpointTemplateResponse.data) && - Objects.equals(this.links, msgVpnTopicEndpointTemplateResponse.links) && - Objects.equals(this.meta, msgVpnTopicEndpointTemplateResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnTopicEndpointTemplateResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplatesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplatesResponse.java deleted file mode 100644 index 899a2ff8b..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplatesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplateLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnTopicEndpointTemplatesResponse - */ -@JsonPropertyOrder({ - MsgVpnTopicEndpointTemplatesResponse.JSON_PROPERTY_DATA, - MsgVpnTopicEndpointTemplatesResponse.JSON_PROPERTY_LINKS, - MsgVpnTopicEndpointTemplatesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnTopicEndpointTemplatesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnTopicEndpointTemplatesResponse() { - } - - public MsgVpnTopicEndpointTemplatesResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnTopicEndpointTemplatesResponse addDataItem(MsgVpnTopicEndpointTemplate dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnTopicEndpointTemplatesResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnTopicEndpointTemplatesResponse addLinksItem(MsgVpnTopicEndpointTemplateLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnTopicEndpointTemplatesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnTopicEndpointTemplatesResponse msgVpnTopicEndpointTemplatesResponse = (MsgVpnTopicEndpointTemplatesResponse) o; - return Objects.equals(this.data, msgVpnTopicEndpointTemplatesResponse.data) && - Objects.equals(this.links, msgVpnTopicEndpointTemplatesResponse.links) && - Objects.equals(this.meta, msgVpnTopicEndpointTemplatesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnTopicEndpointTemplatesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointsResponse.java deleted file mode 100644 index d1a22f4c0..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnTopicEndpointsResponse - */ -@JsonPropertyOrder({ - MsgVpnTopicEndpointsResponse.JSON_PROPERTY_DATA, - MsgVpnTopicEndpointsResponse.JSON_PROPERTY_LINKS, - MsgVpnTopicEndpointsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnTopicEndpointsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnTopicEndpointsResponse() { - } - - public MsgVpnTopicEndpointsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnTopicEndpointsResponse addDataItem(MsgVpnTopicEndpoint dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnTopicEndpointsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnTopicEndpointsResponse addLinksItem(MsgVpnTopicEndpointLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnTopicEndpointsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnTopicEndpointsResponse msgVpnTopicEndpointsResponse = (MsgVpnTopicEndpointsResponse) o; - return Objects.equals(this.data, msgVpnTopicEndpointsResponse.data) && - Objects.equals(this.links, msgVpnTopicEndpointsResponse.links) && - Objects.equals(this.meta, msgVpnTopicEndpointsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnTopicEndpointsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnsResponse.java deleted file mode 100644 index 84b80dec0..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * MsgVpnsResponse - */ -@JsonPropertyOrder({ - MsgVpnsResponse.JSON_PROPERTY_DATA, - MsgVpnsResponse.JSON_PROPERTY_LINKS, - MsgVpnsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class MsgVpnsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public MsgVpnsResponse() { - } - - public MsgVpnsResponse data(List data) { - - this.data = data; - return this; - } - - public MsgVpnsResponse addDataItem(MsgVpn dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public MsgVpnsResponse links(List links) { - - this.links = links; - return this; - } - - public MsgVpnsResponse addLinksItem(MsgVpnLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public MsgVpnsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - MsgVpnsResponse msgVpnsResponse = (MsgVpnsResponse) o; - return Objects.equals(this.data, msgVpnsResponse.data) && - Objects.equals(this.links, msgVpnsResponse.links) && - Objects.equals(this.meta, msgVpnsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class MsgVpnsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfile.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfile.java deleted file mode 100644 index 4540b827a..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfile.java +++ /dev/null @@ -1,1431 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfile - */ -@JsonPropertyOrder({ - OauthProfile.JSON_PROPERTY_ACCESS_LEVEL_GROUPS_CLAIM_NAME, - OauthProfile.JSON_PROPERTY_CLIENT_ID, - OauthProfile.JSON_PROPERTY_CLIENT_REDIRECT_URI, - OauthProfile.JSON_PROPERTY_CLIENT_REQUIRED_TYPE, - OauthProfile.JSON_PROPERTY_CLIENT_SCOPE, - OauthProfile.JSON_PROPERTY_CLIENT_SECRET, - OauthProfile.JSON_PROPERTY_CLIENT_VALIDATE_TYPE_ENABLED, - OauthProfile.JSON_PROPERTY_DEFAULT_GLOBAL_ACCESS_LEVEL, - OauthProfile.JSON_PROPERTY_DEFAULT_MSG_VPN_ACCESS_LEVEL, - OauthProfile.JSON_PROPERTY_DISPLAY_NAME, - OauthProfile.JSON_PROPERTY_ENABLED, - OauthProfile.JSON_PROPERTY_ENDPOINT_AUTHORIZATION, - OauthProfile.JSON_PROPERTY_ENDPOINT_DISCOVERY, - OauthProfile.JSON_PROPERTY_ENDPOINT_DISCOVERY_REFRESH_INTERVAL, - OauthProfile.JSON_PROPERTY_ENDPOINT_INTROSPECTION, - OauthProfile.JSON_PROPERTY_ENDPOINT_INTROSPECTION_TIMEOUT, - OauthProfile.JSON_PROPERTY_ENDPOINT_JWKS, - OauthProfile.JSON_PROPERTY_ENDPOINT_JWKS_REFRESH_INTERVAL, - OauthProfile.JSON_PROPERTY_ENDPOINT_TOKEN, - OauthProfile.JSON_PROPERTY_ENDPOINT_TOKEN_TIMEOUT, - OauthProfile.JSON_PROPERTY_ENDPOINT_USERINFO, - OauthProfile.JSON_PROPERTY_ENDPOINT_USERINFO_TIMEOUT, - OauthProfile.JSON_PROPERTY_INTERACTIVE_ENABLED, - OauthProfile.JSON_PROPERTY_INTERACTIVE_PROMPT_FOR_EXPIRED_SESSION, - OauthProfile.JSON_PROPERTY_INTERACTIVE_PROMPT_FOR_NEW_SESSION, - OauthProfile.JSON_PROPERTY_ISSUER, - OauthProfile.JSON_PROPERTY_OAUTH_PROFILE_NAME, - OauthProfile.JSON_PROPERTY_OAUTH_ROLE, - OauthProfile.JSON_PROPERTY_RESOURCE_SERVER_PARSE_ACCESS_TOKEN_ENABLED, - OauthProfile.JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_AUDIENCE, - OauthProfile.JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_ISSUER, - OauthProfile.JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_SCOPE, - OauthProfile.JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_TYPE, - OauthProfile.JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_AUDIENCE_ENABLED, - OauthProfile.JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_ISSUER_ENABLED, - OauthProfile.JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_SCOPE_ENABLED, - OauthProfile.JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_TYPE_ENABLED, - OauthProfile.JSON_PROPERTY_SEMP_ENABLED, - OauthProfile.JSON_PROPERTY_USERNAME_CLAIM_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfile { - public static final String JSON_PROPERTY_ACCESS_LEVEL_GROUPS_CLAIM_NAME = "accessLevelGroupsClaimName"; - private String accessLevelGroupsClaimName; - - public static final String JSON_PROPERTY_CLIENT_ID = "clientId"; - private String clientId; - - public static final String JSON_PROPERTY_CLIENT_REDIRECT_URI = "clientRedirectUri"; - private String clientRedirectUri; - - public static final String JSON_PROPERTY_CLIENT_REQUIRED_TYPE = "clientRequiredType"; - private String clientRequiredType; - - public static final String JSON_PROPERTY_CLIENT_SCOPE = "clientScope"; - private String clientScope; - - public static final String JSON_PROPERTY_CLIENT_SECRET = "clientSecret"; - private String clientSecret; - - public static final String JSON_PROPERTY_CLIENT_VALIDATE_TYPE_ENABLED = "clientValidateTypeEnabled"; - private Boolean clientValidateTypeEnabled; - - /** - * The default global access level for this OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to global data. \"read-only\" - User has read-only access to global data. \"read-write\" - User has read-write access to most global data. \"admin\" - User has read-write access to all global data. </pre> - */ - public enum DefaultGlobalAccessLevelEnum { - NONE("none"), - - READ_ONLY("read-only"), - - READ_WRITE("read-write"), - - ADMIN("admin"); - - private String value; - - DefaultGlobalAccessLevelEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static DefaultGlobalAccessLevelEnum fromValue(String value) { - for (DefaultGlobalAccessLevelEnum b : DefaultGlobalAccessLevelEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_DEFAULT_GLOBAL_ACCESS_LEVEL = "defaultGlobalAccessLevel"; - private DefaultGlobalAccessLevelEnum defaultGlobalAccessLevel; - - /** - * The default message VPN access level for the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to a Message VPN. \"read-only\" - User has read-only access to a Message VPN. \"read-write\" - User has read-write access to most Message VPN settings. </pre> - */ - public enum DefaultMsgVpnAccessLevelEnum { - NONE("none"), - - READ_ONLY("read-only"), - - READ_WRITE("read-write"); - - private String value; - - DefaultMsgVpnAccessLevelEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static DefaultMsgVpnAccessLevelEnum fromValue(String value) { - for (DefaultMsgVpnAccessLevelEnum b : DefaultMsgVpnAccessLevelEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_DEFAULT_MSG_VPN_ACCESS_LEVEL = "defaultMsgVpnAccessLevel"; - private DefaultMsgVpnAccessLevelEnum defaultMsgVpnAccessLevel; - - public static final String JSON_PROPERTY_DISPLAY_NAME = "displayName"; - private String displayName; - - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_ENDPOINT_AUTHORIZATION = "endpointAuthorization"; - private String endpointAuthorization; - - public static final String JSON_PROPERTY_ENDPOINT_DISCOVERY = "endpointDiscovery"; - private String endpointDiscovery; - - public static final String JSON_PROPERTY_ENDPOINT_DISCOVERY_REFRESH_INTERVAL = "endpointDiscoveryRefreshInterval"; - private Integer endpointDiscoveryRefreshInterval; - - public static final String JSON_PROPERTY_ENDPOINT_INTROSPECTION = "endpointIntrospection"; - private String endpointIntrospection; - - public static final String JSON_PROPERTY_ENDPOINT_INTROSPECTION_TIMEOUT = "endpointIntrospectionTimeout"; - private Integer endpointIntrospectionTimeout; - - public static final String JSON_PROPERTY_ENDPOINT_JWKS = "endpointJwks"; - private String endpointJwks; - - public static final String JSON_PROPERTY_ENDPOINT_JWKS_REFRESH_INTERVAL = "endpointJwksRefreshInterval"; - private Integer endpointJwksRefreshInterval; - - public static final String JSON_PROPERTY_ENDPOINT_TOKEN = "endpointToken"; - private String endpointToken; - - public static final String JSON_PROPERTY_ENDPOINT_TOKEN_TIMEOUT = "endpointTokenTimeout"; - private Integer endpointTokenTimeout; - - public static final String JSON_PROPERTY_ENDPOINT_USERINFO = "endpointUserinfo"; - private String endpointUserinfo; - - public static final String JSON_PROPERTY_ENDPOINT_USERINFO_TIMEOUT = "endpointUserinfoTimeout"; - private Integer endpointUserinfoTimeout; - - public static final String JSON_PROPERTY_INTERACTIVE_ENABLED = "interactiveEnabled"; - private Boolean interactiveEnabled; - - public static final String JSON_PROPERTY_INTERACTIVE_PROMPT_FOR_EXPIRED_SESSION = "interactivePromptForExpiredSession"; - private String interactivePromptForExpiredSession; - - public static final String JSON_PROPERTY_INTERACTIVE_PROMPT_FOR_NEW_SESSION = "interactivePromptForNewSession"; - private String interactivePromptForNewSession; - - public static final String JSON_PROPERTY_ISSUER = "issuer"; - private String issuer; - - public static final String JSON_PROPERTY_OAUTH_PROFILE_NAME = "oauthProfileName"; - private String oauthProfileName; - - /** - * The OAuth role of the broker. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"client\"`. The allowed values and their meaning are: <pre> \"client\" - The broker is in the OAuth client role. \"resource-server\" - The broker is in the OAuth resource server role. </pre> - */ - public enum OauthRoleEnum { - CLIENT("client"), - - RESOURCE_SERVER("resource-server"); - - private String value; - - OauthRoleEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static OauthRoleEnum fromValue(String value) { - for (OauthRoleEnum b : OauthRoleEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_OAUTH_ROLE = "oauthRole"; - private OauthRoleEnum oauthRole; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_PARSE_ACCESS_TOKEN_ENABLED = "resourceServerParseAccessTokenEnabled"; - private Boolean resourceServerParseAccessTokenEnabled; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_AUDIENCE = "resourceServerRequiredAudience"; - private String resourceServerRequiredAudience; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_ISSUER = "resourceServerRequiredIssuer"; - private String resourceServerRequiredIssuer; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_SCOPE = "resourceServerRequiredScope"; - private String resourceServerRequiredScope; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_TYPE = "resourceServerRequiredType"; - private String resourceServerRequiredType; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_AUDIENCE_ENABLED = "resourceServerValidateAudienceEnabled"; - private Boolean resourceServerValidateAudienceEnabled; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_ISSUER_ENABLED = "resourceServerValidateIssuerEnabled"; - private Boolean resourceServerValidateIssuerEnabled; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_SCOPE_ENABLED = "resourceServerValidateScopeEnabled"; - private Boolean resourceServerValidateScopeEnabled; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_TYPE_ENABLED = "resourceServerValidateTypeEnabled"; - private Boolean resourceServerValidateTypeEnabled; - - public static final String JSON_PROPERTY_SEMP_ENABLED = "sempEnabled"; - private Boolean sempEnabled; - - public static final String JSON_PROPERTY_USERNAME_CLAIM_NAME = "usernameClaimName"; - private String usernameClaimName; - - public OauthProfile() { - } - - public OauthProfile accessLevelGroupsClaimName(String accessLevelGroupsClaimName) { - - this.accessLevelGroupsClaimName = accessLevelGroupsClaimName; - return this; - } - - /** - * The name of the groups claim. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"groups\"`. - * @return accessLevelGroupsClaimName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACCESS_LEVEL_GROUPS_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAccessLevelGroupsClaimName() { - return accessLevelGroupsClaimName; - } - - - @JsonProperty(JSON_PROPERTY_ACCESS_LEVEL_GROUPS_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccessLevelGroupsClaimName(String accessLevelGroupsClaimName) { - this.accessLevelGroupsClaimName = accessLevelGroupsClaimName; - } - - - public OauthProfile clientId(String clientId) { - - this.clientId = clientId; - return this; - } - - /** - * The OAuth client id. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return clientId - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientId() { - return clientId; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientId(String clientId) { - this.clientId = clientId; - } - - - public OauthProfile clientRedirectUri(String clientRedirectUri) { - - this.clientRedirectUri = clientRedirectUri; - return this; - } - - /** - * The OAuth redirect URI. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return clientRedirectUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_REDIRECT_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientRedirectUri() { - return clientRedirectUri; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_REDIRECT_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientRedirectUri(String clientRedirectUri) { - this.clientRedirectUri = clientRedirectUri; - } - - - public OauthProfile clientRequiredType(String clientRequiredType) { - - this.clientRequiredType = clientRequiredType; - return this; - } - - /** - * The required value for the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"JWT\"`. - * @return clientRequiredType - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_REQUIRED_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientRequiredType() { - return clientRequiredType; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_REQUIRED_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientRequiredType(String clientRequiredType) { - this.clientRequiredType = clientRequiredType; - } - - - public OauthProfile clientScope(String clientScope) { - - this.clientScope = clientScope; - return this; - } - - /** - * The OAuth scope. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"openid email\"`. - * @return clientScope - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_SCOPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientScope() { - return clientScope; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_SCOPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientScope(String clientScope) { - this.clientScope = clientScope; - } - - - public OauthProfile clientSecret(String clientSecret) { - - this.clientSecret = clientSecret; - return this; - } - - /** - * The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return clientSecret - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientSecret() { - return clientSecret; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientSecret(String clientSecret) { - this.clientSecret = clientSecret; - } - - - public OauthProfile clientValidateTypeEnabled(Boolean clientValidateTypeEnabled) { - - this.clientValidateTypeEnabled = clientValidateTypeEnabled; - return this; - } - - /** - * Enable or disable verification of the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - * @return clientValidateTypeEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_VALIDATE_TYPE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getClientValidateTypeEnabled() { - return clientValidateTypeEnabled; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_VALIDATE_TYPE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientValidateTypeEnabled(Boolean clientValidateTypeEnabled) { - this.clientValidateTypeEnabled = clientValidateTypeEnabled; - } - - - public OauthProfile defaultGlobalAccessLevel(DefaultGlobalAccessLevelEnum defaultGlobalAccessLevel) { - - this.defaultGlobalAccessLevel = defaultGlobalAccessLevel; - return this; - } - - /** - * The default global access level for this OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to global data. \"read-only\" - User has read-only access to global data. \"read-write\" - User has read-write access to most global data. \"admin\" - User has read-write access to all global data. </pre> - * @return defaultGlobalAccessLevel - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DEFAULT_GLOBAL_ACCESS_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DefaultGlobalAccessLevelEnum getDefaultGlobalAccessLevel() { - return defaultGlobalAccessLevel; - } - - - @JsonProperty(JSON_PROPERTY_DEFAULT_GLOBAL_ACCESS_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDefaultGlobalAccessLevel(DefaultGlobalAccessLevelEnum defaultGlobalAccessLevel) { - this.defaultGlobalAccessLevel = defaultGlobalAccessLevel; - } - - - public OauthProfile defaultMsgVpnAccessLevel(DefaultMsgVpnAccessLevelEnum defaultMsgVpnAccessLevel) { - - this.defaultMsgVpnAccessLevel = defaultMsgVpnAccessLevel; - return this; - } - - /** - * The default message VPN access level for the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to a Message VPN. \"read-only\" - User has read-only access to a Message VPN. \"read-write\" - User has read-write access to most Message VPN settings. </pre> - * @return defaultMsgVpnAccessLevel - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DEFAULT_MSG_VPN_ACCESS_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public DefaultMsgVpnAccessLevelEnum getDefaultMsgVpnAccessLevel() { - return defaultMsgVpnAccessLevel; - } - - - @JsonProperty(JSON_PROPERTY_DEFAULT_MSG_VPN_ACCESS_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDefaultMsgVpnAccessLevel(DefaultMsgVpnAccessLevelEnum defaultMsgVpnAccessLevel) { - this.defaultMsgVpnAccessLevel = defaultMsgVpnAccessLevel; - } - - - public OauthProfile displayName(String displayName) { - - this.displayName = displayName; - return this; - } - - /** - * The user friendly name for the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return displayName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DISPLAY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDisplayName() { - return displayName; - } - - - @JsonProperty(JSON_PROPERTY_DISPLAY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDisplayName(String displayName) { - this.displayName = displayName; - } - - - public OauthProfile enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public OauthProfile endpointAuthorization(String endpointAuthorization) { - - this.endpointAuthorization = endpointAuthorization; - return this; - } - - /** - * The OAuth authorization endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return endpointAuthorization - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_AUTHORIZATION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getEndpointAuthorization() { - return endpointAuthorization; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_AUTHORIZATION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointAuthorization(String endpointAuthorization) { - this.endpointAuthorization = endpointAuthorization; - } - - - public OauthProfile endpointDiscovery(String endpointDiscovery) { - - this.endpointDiscovery = endpointDiscovery; - return this; - } - - /** - * The OpenID Connect discovery endpoint or OAuth Authorization Server Metadata endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return endpointDiscovery - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_DISCOVERY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getEndpointDiscovery() { - return endpointDiscovery; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_DISCOVERY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointDiscovery(String endpointDiscovery) { - this.endpointDiscovery = endpointDiscovery; - } - - - public OauthProfile endpointDiscoveryRefreshInterval(Integer endpointDiscoveryRefreshInterval) { - - this.endpointDiscoveryRefreshInterval = endpointDiscoveryRefreshInterval; - return this; - } - - /** - * The number of seconds between discovery endpoint requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`. - * @return endpointDiscoveryRefreshInterval - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_DISCOVERY_REFRESH_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getEndpointDiscoveryRefreshInterval() { - return endpointDiscoveryRefreshInterval; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_DISCOVERY_REFRESH_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointDiscoveryRefreshInterval(Integer endpointDiscoveryRefreshInterval) { - this.endpointDiscoveryRefreshInterval = endpointDiscoveryRefreshInterval; - } - - - public OauthProfile endpointIntrospection(String endpointIntrospection) { - - this.endpointIntrospection = endpointIntrospection; - return this; - } - - /** - * The OAuth introspection endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return endpointIntrospection - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_INTROSPECTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getEndpointIntrospection() { - return endpointIntrospection; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_INTROSPECTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointIntrospection(String endpointIntrospection) { - this.endpointIntrospection = endpointIntrospection; - } - - - public OauthProfile endpointIntrospectionTimeout(Integer endpointIntrospectionTimeout) { - - this.endpointIntrospectionTimeout = endpointIntrospectionTimeout; - return this; - } - - /** - * The maximum time in seconds a token introspection request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`. - * @return endpointIntrospectionTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_INTROSPECTION_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getEndpointIntrospectionTimeout() { - return endpointIntrospectionTimeout; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_INTROSPECTION_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointIntrospectionTimeout(Integer endpointIntrospectionTimeout) { - this.endpointIntrospectionTimeout = endpointIntrospectionTimeout; - } - - - public OauthProfile endpointJwks(String endpointJwks) { - - this.endpointJwks = endpointJwks; - return this; - } - - /** - * The OAuth JWKS endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return endpointJwks - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_JWKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getEndpointJwks() { - return endpointJwks; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_JWKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointJwks(String endpointJwks) { - this.endpointJwks = endpointJwks; - } - - - public OauthProfile endpointJwksRefreshInterval(Integer endpointJwksRefreshInterval) { - - this.endpointJwksRefreshInterval = endpointJwksRefreshInterval; - return this; - } - - /** - * The number of seconds between JWKS endpoint requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`. - * @return endpointJwksRefreshInterval - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_JWKS_REFRESH_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getEndpointJwksRefreshInterval() { - return endpointJwksRefreshInterval; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_JWKS_REFRESH_INTERVAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointJwksRefreshInterval(Integer endpointJwksRefreshInterval) { - this.endpointJwksRefreshInterval = endpointJwksRefreshInterval; - } - - - public OauthProfile endpointToken(String endpointToken) { - - this.endpointToken = endpointToken; - return this; - } - - /** - * The OAuth token endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return endpointToken - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_TOKEN) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getEndpointToken() { - return endpointToken; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_TOKEN) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointToken(String endpointToken) { - this.endpointToken = endpointToken; - } - - - public OauthProfile endpointTokenTimeout(Integer endpointTokenTimeout) { - - this.endpointTokenTimeout = endpointTokenTimeout; - return this; - } - - /** - * The maximum time in seconds a token request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`. - * @return endpointTokenTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_TOKEN_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getEndpointTokenTimeout() { - return endpointTokenTimeout; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_TOKEN_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointTokenTimeout(Integer endpointTokenTimeout) { - this.endpointTokenTimeout = endpointTokenTimeout; - } - - - public OauthProfile endpointUserinfo(String endpointUserinfo) { - - this.endpointUserinfo = endpointUserinfo; - return this; - } - - /** - * The OpenID Connect Userinfo endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return endpointUserinfo - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_USERINFO) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getEndpointUserinfo() { - return endpointUserinfo; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_USERINFO) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointUserinfo(String endpointUserinfo) { - this.endpointUserinfo = endpointUserinfo; - } - - - public OauthProfile endpointUserinfoTimeout(Integer endpointUserinfoTimeout) { - - this.endpointUserinfoTimeout = endpointUserinfoTimeout; - return this; - } - - /** - * The maximum time in seconds a userinfo request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`. - * @return endpointUserinfoTimeout - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENDPOINT_USERINFO_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getEndpointUserinfoTimeout() { - return endpointUserinfoTimeout; - } - - - @JsonProperty(JSON_PROPERTY_ENDPOINT_USERINFO_TIMEOUT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndpointUserinfoTimeout(Integer endpointUserinfoTimeout) { - this.endpointUserinfoTimeout = endpointUserinfoTimeout; - } - - - public OauthProfile interactiveEnabled(Boolean interactiveEnabled) { - - this.interactiveEnabled = interactiveEnabled; - return this; - } - - /** - * Enable or disable interactive logins via this OAuth provider. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - * @return interactiveEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_INTERACTIVE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getInteractiveEnabled() { - return interactiveEnabled; - } - - - @JsonProperty(JSON_PROPERTY_INTERACTIVE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setInteractiveEnabled(Boolean interactiveEnabled) { - this.interactiveEnabled = interactiveEnabled; - } - - - public OauthProfile interactivePromptForExpiredSession(String interactivePromptForExpiredSession) { - - this.interactivePromptForExpiredSession = interactivePromptForExpiredSession; - return this; - } - - /** - * The value of the prompt parameter provided to the OAuth authorization server for login requests where the session has expired. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return interactivePromptForExpiredSession - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_INTERACTIVE_PROMPT_FOR_EXPIRED_SESSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getInteractivePromptForExpiredSession() { - return interactivePromptForExpiredSession; - } - - - @JsonProperty(JSON_PROPERTY_INTERACTIVE_PROMPT_FOR_EXPIRED_SESSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setInteractivePromptForExpiredSession(String interactivePromptForExpiredSession) { - this.interactivePromptForExpiredSession = interactivePromptForExpiredSession; - } - - - public OauthProfile interactivePromptForNewSession(String interactivePromptForNewSession) { - - this.interactivePromptForNewSession = interactivePromptForNewSession; - return this; - } - - /** - * The value of the prompt parameter provided to the OAuth authorization server for login requests where the session is new or the user has explicitly logged out. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"select_account\"`. - * @return interactivePromptForNewSession - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_INTERACTIVE_PROMPT_FOR_NEW_SESSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getInteractivePromptForNewSession() { - return interactivePromptForNewSession; - } - - - @JsonProperty(JSON_PROPERTY_INTERACTIVE_PROMPT_FOR_NEW_SESSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setInteractivePromptForNewSession(String interactivePromptForNewSession) { - this.interactivePromptForNewSession = interactivePromptForNewSession; - } - - - public OauthProfile issuer(String issuer) { - - this.issuer = issuer; - return this; - } - - /** - * The Issuer Identifier for the OAuth provider. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return issuer - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ISSUER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getIssuer() { - return issuer; - } - - - @JsonProperty(JSON_PROPERTY_ISSUER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIssuer(String issuer) { - this.issuer = issuer; - } - - - public OauthProfile oauthProfileName(String oauthProfileName) { - - this.oauthProfileName = oauthProfileName; - return this; - } - - /** - * The name of the OAuth profile. - * @return oauthProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthProfileName() { - return oauthProfileName; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthProfileName(String oauthProfileName) { - this.oauthProfileName = oauthProfileName; - } - - - public OauthProfile oauthRole(OauthRoleEnum oauthRole) { - - this.oauthRole = oauthRole; - return this; - } - - /** - * The OAuth role of the broker. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"client\"`. The allowed values and their meaning are: <pre> \"client\" - The broker is in the OAuth client role. \"resource-server\" - The broker is in the OAuth resource server role. </pre> - * @return oauthRole - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_ROLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthRoleEnum getOauthRole() { - return oauthRole; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_ROLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthRole(OauthRoleEnum oauthRole) { - this.oauthRole = oauthRole; - } - - - public OauthProfile resourceServerParseAccessTokenEnabled(Boolean resourceServerParseAccessTokenEnabled) { - - this.resourceServerParseAccessTokenEnabled = resourceServerParseAccessTokenEnabled; - return this; - } - - /** - * Enable or disable parsing of the access token as a JWT. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - * @return resourceServerParseAccessTokenEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_PARSE_ACCESS_TOKEN_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getResourceServerParseAccessTokenEnabled() { - return resourceServerParseAccessTokenEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_PARSE_ACCESS_TOKEN_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerParseAccessTokenEnabled(Boolean resourceServerParseAccessTokenEnabled) { - this.resourceServerParseAccessTokenEnabled = resourceServerParseAccessTokenEnabled; - } - - - public OauthProfile resourceServerRequiredAudience(String resourceServerRequiredAudience) { - - this.resourceServerRequiredAudience = resourceServerRequiredAudience; - return this; - } - - /** - * The required audience value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return resourceServerRequiredAudience - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_AUDIENCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getResourceServerRequiredAudience() { - return resourceServerRequiredAudience; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_AUDIENCE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerRequiredAudience(String resourceServerRequiredAudience) { - this.resourceServerRequiredAudience = resourceServerRequiredAudience; - } - - - public OauthProfile resourceServerRequiredIssuer(String resourceServerRequiredIssuer) { - - this.resourceServerRequiredIssuer = resourceServerRequiredIssuer; - return this; - } - - /** - * The required issuer value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return resourceServerRequiredIssuer - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_ISSUER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getResourceServerRequiredIssuer() { - return resourceServerRequiredIssuer; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_ISSUER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerRequiredIssuer(String resourceServerRequiredIssuer) { - this.resourceServerRequiredIssuer = resourceServerRequiredIssuer; - } - - - public OauthProfile resourceServerRequiredScope(String resourceServerRequiredScope) { - - this.resourceServerRequiredScope = resourceServerRequiredScope; - return this; - } - - /** - * A space-separated list of scopes that must be present in the scope claim. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return resourceServerRequiredScope - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_SCOPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getResourceServerRequiredScope() { - return resourceServerRequiredScope; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_SCOPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerRequiredScope(String resourceServerRequiredScope) { - this.resourceServerRequiredScope = resourceServerRequiredScope; - } - - - public OauthProfile resourceServerRequiredType(String resourceServerRequiredType) { - - this.resourceServerRequiredType = resourceServerRequiredType; - return this; - } - - /** - * The required TYP value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"at+jwt\"`. - * @return resourceServerRequiredType - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getResourceServerRequiredType() { - return resourceServerRequiredType; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_TYPE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerRequiredType(String resourceServerRequiredType) { - this.resourceServerRequiredType = resourceServerRequiredType; - } - - - public OauthProfile resourceServerValidateAudienceEnabled(Boolean resourceServerValidateAudienceEnabled) { - - this.resourceServerValidateAudienceEnabled = resourceServerValidateAudienceEnabled; - return this; - } - - /** - * Enable or disable verification of the audience claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - * @return resourceServerValidateAudienceEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_AUDIENCE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getResourceServerValidateAudienceEnabled() { - return resourceServerValidateAudienceEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_AUDIENCE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerValidateAudienceEnabled(Boolean resourceServerValidateAudienceEnabled) { - this.resourceServerValidateAudienceEnabled = resourceServerValidateAudienceEnabled; - } - - - public OauthProfile resourceServerValidateIssuerEnabled(Boolean resourceServerValidateIssuerEnabled) { - - this.resourceServerValidateIssuerEnabled = resourceServerValidateIssuerEnabled; - return this; - } - - /** - * Enable or disable verification of the issuer claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - * @return resourceServerValidateIssuerEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_ISSUER_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getResourceServerValidateIssuerEnabled() { - return resourceServerValidateIssuerEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_ISSUER_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerValidateIssuerEnabled(Boolean resourceServerValidateIssuerEnabled) { - this.resourceServerValidateIssuerEnabled = resourceServerValidateIssuerEnabled; - } - - - public OauthProfile resourceServerValidateScopeEnabled(Boolean resourceServerValidateScopeEnabled) { - - this.resourceServerValidateScopeEnabled = resourceServerValidateScopeEnabled; - return this; - } - - /** - * Enable or disable verification of the scope claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - * @return resourceServerValidateScopeEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_SCOPE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getResourceServerValidateScopeEnabled() { - return resourceServerValidateScopeEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_SCOPE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerValidateScopeEnabled(Boolean resourceServerValidateScopeEnabled) { - this.resourceServerValidateScopeEnabled = resourceServerValidateScopeEnabled; - } - - - public OauthProfile resourceServerValidateTypeEnabled(Boolean resourceServerValidateTypeEnabled) { - - this.resourceServerValidateTypeEnabled = resourceServerValidateTypeEnabled; - return this; - } - - /** - * Enable or disable verification of the TYP field in the access token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - * @return resourceServerValidateTypeEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_TYPE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getResourceServerValidateTypeEnabled() { - return resourceServerValidateTypeEnabled; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_VALIDATE_TYPE_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerValidateTypeEnabled(Boolean resourceServerValidateTypeEnabled) { - this.resourceServerValidateTypeEnabled = resourceServerValidateTypeEnabled; - } - - - public OauthProfile sempEnabled(Boolean sempEnabled) { - - this.sempEnabled = sempEnabled; - return this; - } - - /** - * Enable or disable authentication of SEMP requests with OAuth tokens. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - * @return sempEnabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SEMP_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getSempEnabled() { - return sempEnabled; - } - - - @JsonProperty(JSON_PROPERTY_SEMP_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSempEnabled(Boolean sempEnabled) { - this.sempEnabled = sempEnabled; - } - - - public OauthProfile usernameClaimName(String usernameClaimName) { - - this.usernameClaimName = usernameClaimName; - return this; - } - - /** - * The name of the username claim. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"sub\"`. - * @return usernameClaimName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_USERNAME_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUsernameClaimName() { - return usernameClaimName; - } - - - @JsonProperty(JSON_PROPERTY_USERNAME_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUsernameClaimName(String usernameClaimName) { - this.usernameClaimName = usernameClaimName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfile oauthProfile = (OauthProfile) o; - return Objects.equals(this.accessLevelGroupsClaimName, oauthProfile.accessLevelGroupsClaimName) && - Objects.equals(this.clientId, oauthProfile.clientId) && - Objects.equals(this.clientRedirectUri, oauthProfile.clientRedirectUri) && - Objects.equals(this.clientRequiredType, oauthProfile.clientRequiredType) && - Objects.equals(this.clientScope, oauthProfile.clientScope) && - Objects.equals(this.clientSecret, oauthProfile.clientSecret) && - Objects.equals(this.clientValidateTypeEnabled, oauthProfile.clientValidateTypeEnabled) && - Objects.equals(this.defaultGlobalAccessLevel, oauthProfile.defaultGlobalAccessLevel) && - Objects.equals(this.defaultMsgVpnAccessLevel, oauthProfile.defaultMsgVpnAccessLevel) && - Objects.equals(this.displayName, oauthProfile.displayName) && - Objects.equals(this.enabled, oauthProfile.enabled) && - Objects.equals(this.endpointAuthorization, oauthProfile.endpointAuthorization) && - Objects.equals(this.endpointDiscovery, oauthProfile.endpointDiscovery) && - Objects.equals(this.endpointDiscoveryRefreshInterval, oauthProfile.endpointDiscoveryRefreshInterval) && - Objects.equals(this.endpointIntrospection, oauthProfile.endpointIntrospection) && - Objects.equals(this.endpointIntrospectionTimeout, oauthProfile.endpointIntrospectionTimeout) && - Objects.equals(this.endpointJwks, oauthProfile.endpointJwks) && - Objects.equals(this.endpointJwksRefreshInterval, oauthProfile.endpointJwksRefreshInterval) && - Objects.equals(this.endpointToken, oauthProfile.endpointToken) && - Objects.equals(this.endpointTokenTimeout, oauthProfile.endpointTokenTimeout) && - Objects.equals(this.endpointUserinfo, oauthProfile.endpointUserinfo) && - Objects.equals(this.endpointUserinfoTimeout, oauthProfile.endpointUserinfoTimeout) && - Objects.equals(this.interactiveEnabled, oauthProfile.interactiveEnabled) && - Objects.equals(this.interactivePromptForExpiredSession, oauthProfile.interactivePromptForExpiredSession) && - Objects.equals(this.interactivePromptForNewSession, oauthProfile.interactivePromptForNewSession) && - Objects.equals(this.issuer, oauthProfile.issuer) && - Objects.equals(this.oauthProfileName, oauthProfile.oauthProfileName) && - Objects.equals(this.oauthRole, oauthProfile.oauthRole) && - Objects.equals(this.resourceServerParseAccessTokenEnabled, oauthProfile.resourceServerParseAccessTokenEnabled) && - Objects.equals(this.resourceServerRequiredAudience, oauthProfile.resourceServerRequiredAudience) && - Objects.equals(this.resourceServerRequiredIssuer, oauthProfile.resourceServerRequiredIssuer) && - Objects.equals(this.resourceServerRequiredScope, oauthProfile.resourceServerRequiredScope) && - Objects.equals(this.resourceServerRequiredType, oauthProfile.resourceServerRequiredType) && - Objects.equals(this.resourceServerValidateAudienceEnabled, oauthProfile.resourceServerValidateAudienceEnabled) && - Objects.equals(this.resourceServerValidateIssuerEnabled, oauthProfile.resourceServerValidateIssuerEnabled) && - Objects.equals(this.resourceServerValidateScopeEnabled, oauthProfile.resourceServerValidateScopeEnabled) && - Objects.equals(this.resourceServerValidateTypeEnabled, oauthProfile.resourceServerValidateTypeEnabled) && - Objects.equals(this.sempEnabled, oauthProfile.sempEnabled) && - Objects.equals(this.usernameClaimName, oauthProfile.usernameClaimName); - } - - @Override - public int hashCode() { - return Objects.hash(accessLevelGroupsClaimName, clientId, clientRedirectUri, clientRequiredType, clientScope, clientSecret, clientValidateTypeEnabled, defaultGlobalAccessLevel, defaultMsgVpnAccessLevel, displayName, enabled, endpointAuthorization, endpointDiscovery, endpointDiscoveryRefreshInterval, endpointIntrospection, endpointIntrospectionTimeout, endpointJwks, endpointJwksRefreshInterval, endpointToken, endpointTokenTimeout, endpointUserinfo, endpointUserinfoTimeout, interactiveEnabled, interactivePromptForExpiredSession, interactivePromptForNewSession, issuer, oauthProfileName, oauthRole, resourceServerParseAccessTokenEnabled, resourceServerRequiredAudience, resourceServerRequiredIssuer, resourceServerRequiredScope, resourceServerRequiredType, resourceServerValidateAudienceEnabled, resourceServerValidateIssuerEnabled, resourceServerValidateScopeEnabled, resourceServerValidateTypeEnabled, sempEnabled, usernameClaimName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfile {\n"); - sb.append(" accessLevelGroupsClaimName: ").append(toIndentedString(accessLevelGroupsClaimName)).append("\n"); - sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); - sb.append(" clientRedirectUri: ").append(toIndentedString(clientRedirectUri)).append("\n"); - sb.append(" clientRequiredType: ").append(toIndentedString(clientRequiredType)).append("\n"); - sb.append(" clientScope: ").append(toIndentedString(clientScope)).append("\n"); - sb.append(" clientSecret: ").append(toIndentedString(clientSecret)).append("\n"); - sb.append(" clientValidateTypeEnabled: ").append(toIndentedString(clientValidateTypeEnabled)).append("\n"); - sb.append(" defaultGlobalAccessLevel: ").append(toIndentedString(defaultGlobalAccessLevel)).append("\n"); - sb.append(" defaultMsgVpnAccessLevel: ").append(toIndentedString(defaultMsgVpnAccessLevel)).append("\n"); - sb.append(" displayName: ").append(toIndentedString(displayName)).append("\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" endpointAuthorization: ").append(toIndentedString(endpointAuthorization)).append("\n"); - sb.append(" endpointDiscovery: ").append(toIndentedString(endpointDiscovery)).append("\n"); - sb.append(" endpointDiscoveryRefreshInterval: ").append(toIndentedString(endpointDiscoveryRefreshInterval)).append("\n"); - sb.append(" endpointIntrospection: ").append(toIndentedString(endpointIntrospection)).append("\n"); - sb.append(" endpointIntrospectionTimeout: ").append(toIndentedString(endpointIntrospectionTimeout)).append("\n"); - sb.append(" endpointJwks: ").append(toIndentedString(endpointJwks)).append("\n"); - sb.append(" endpointJwksRefreshInterval: ").append(toIndentedString(endpointJwksRefreshInterval)).append("\n"); - sb.append(" endpointToken: ").append(toIndentedString(endpointToken)).append("\n"); - sb.append(" endpointTokenTimeout: ").append(toIndentedString(endpointTokenTimeout)).append("\n"); - sb.append(" endpointUserinfo: ").append(toIndentedString(endpointUserinfo)).append("\n"); - sb.append(" endpointUserinfoTimeout: ").append(toIndentedString(endpointUserinfoTimeout)).append("\n"); - sb.append(" interactiveEnabled: ").append(toIndentedString(interactiveEnabled)).append("\n"); - sb.append(" interactivePromptForExpiredSession: ").append(toIndentedString(interactivePromptForExpiredSession)).append("\n"); - sb.append(" interactivePromptForNewSession: ").append(toIndentedString(interactivePromptForNewSession)).append("\n"); - sb.append(" issuer: ").append(toIndentedString(issuer)).append("\n"); - sb.append(" oauthProfileName: ").append(toIndentedString(oauthProfileName)).append("\n"); - sb.append(" oauthRole: ").append(toIndentedString(oauthRole)).append("\n"); - sb.append(" resourceServerParseAccessTokenEnabled: ").append(toIndentedString(resourceServerParseAccessTokenEnabled)).append("\n"); - sb.append(" resourceServerRequiredAudience: ").append(toIndentedString(resourceServerRequiredAudience)).append("\n"); - sb.append(" resourceServerRequiredIssuer: ").append(toIndentedString(resourceServerRequiredIssuer)).append("\n"); - sb.append(" resourceServerRequiredScope: ").append(toIndentedString(resourceServerRequiredScope)).append("\n"); - sb.append(" resourceServerRequiredType: ").append(toIndentedString(resourceServerRequiredType)).append("\n"); - sb.append(" resourceServerValidateAudienceEnabled: ").append(toIndentedString(resourceServerValidateAudienceEnabled)).append("\n"); - sb.append(" resourceServerValidateIssuerEnabled: ").append(toIndentedString(resourceServerValidateIssuerEnabled)).append("\n"); - sb.append(" resourceServerValidateScopeEnabled: ").append(toIndentedString(resourceServerValidateScopeEnabled)).append("\n"); - sb.append(" resourceServerValidateTypeEnabled: ").append(toIndentedString(resourceServerValidateTypeEnabled)).append("\n"); - sb.append(" sempEnabled: ").append(toIndentedString(sempEnabled)).append("\n"); - sb.append(" usernameClaimName: ").append(toIndentedString(usernameClaimName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroup.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroup.java deleted file mode 100644 index 5538a77ec..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroup.java +++ /dev/null @@ -1,308 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileAccessLevelGroup - */ -@JsonPropertyOrder({ - OauthProfileAccessLevelGroup.JSON_PROPERTY_DESCRIPTION, - OauthProfileAccessLevelGroup.JSON_PROPERTY_GLOBAL_ACCESS_LEVEL, - OauthProfileAccessLevelGroup.JSON_PROPERTY_GROUP_NAME, - OauthProfileAccessLevelGroup.JSON_PROPERTY_MSG_VPN_ACCESS_LEVEL, - OauthProfileAccessLevelGroup.JSON_PROPERTY_OAUTH_PROFILE_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileAccessLevelGroup { - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - /** - * The global access level for this group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to global data. \"read-only\" - User has read-only access to global data. \"read-write\" - User has read-write access to most global data. \"admin\" - User has read-write access to all global data. </pre> - */ - public enum GlobalAccessLevelEnum { - NONE("none"), - - READ_ONLY("read-only"), - - READ_WRITE("read-write"), - - ADMIN("admin"); - - private String value; - - GlobalAccessLevelEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static GlobalAccessLevelEnum fromValue(String value) { - for (GlobalAccessLevelEnum b : GlobalAccessLevelEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_GLOBAL_ACCESS_LEVEL = "globalAccessLevel"; - private GlobalAccessLevelEnum globalAccessLevel; - - public static final String JSON_PROPERTY_GROUP_NAME = "groupName"; - private String groupName; - - /** - * The default message VPN access level for this group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to a Message VPN. \"read-only\" - User has read-only access to a Message VPN. \"read-write\" - User has read-write access to most Message VPN settings. </pre> - */ - public enum MsgVpnAccessLevelEnum { - NONE("none"), - - READ_ONLY("read-only"), - - READ_WRITE("read-write"); - - private String value; - - MsgVpnAccessLevelEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static MsgVpnAccessLevelEnum fromValue(String value) { - for (MsgVpnAccessLevelEnum b : MsgVpnAccessLevelEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_MSG_VPN_ACCESS_LEVEL = "msgVpnAccessLevel"; - private MsgVpnAccessLevelEnum msgVpnAccessLevel; - - public static final String JSON_PROPERTY_OAUTH_PROFILE_NAME = "oauthProfileName"; - private String oauthProfileName; - - public OauthProfileAccessLevelGroup() { - } - - public OauthProfileAccessLevelGroup description(String description) { - - this.description = description; - return this; - } - - /** - * A description for the group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return description - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDescription() { - return description; - } - - - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDescription(String description) { - this.description = description; - } - - - public OauthProfileAccessLevelGroup globalAccessLevel(GlobalAccessLevelEnum globalAccessLevel) { - - this.globalAccessLevel = globalAccessLevel; - return this; - } - - /** - * The global access level for this group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to global data. \"read-only\" - User has read-only access to global data. \"read-write\" - User has read-write access to most global data. \"admin\" - User has read-write access to all global data. </pre> - * @return globalAccessLevel - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GLOBAL_ACCESS_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public GlobalAccessLevelEnum getGlobalAccessLevel() { - return globalAccessLevel; - } - - - @JsonProperty(JSON_PROPERTY_GLOBAL_ACCESS_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGlobalAccessLevel(GlobalAccessLevelEnum globalAccessLevel) { - this.globalAccessLevel = globalAccessLevel; - } - - - public OauthProfileAccessLevelGroup groupName(String groupName) { - - this.groupName = groupName; - return this; - } - - /** - * The name of the group. - * @return groupName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GROUP_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getGroupName() { - return groupName; - } - - - @JsonProperty(JSON_PROPERTY_GROUP_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroupName(String groupName) { - this.groupName = groupName; - } - - - public OauthProfileAccessLevelGroup msgVpnAccessLevel(MsgVpnAccessLevelEnum msgVpnAccessLevel) { - - this.msgVpnAccessLevel = msgVpnAccessLevel; - return this; - } - - /** - * The default message VPN access level for this group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to a Message VPN. \"read-only\" - User has read-only access to a Message VPN. \"read-write\" - User has read-write access to most Message VPN settings. </pre> - * @return msgVpnAccessLevel - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_ACCESS_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public MsgVpnAccessLevelEnum getMsgVpnAccessLevel() { - return msgVpnAccessLevel; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_ACCESS_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnAccessLevel(MsgVpnAccessLevelEnum msgVpnAccessLevel) { - this.msgVpnAccessLevel = msgVpnAccessLevel; - } - - - public OauthProfileAccessLevelGroup oauthProfileName(String oauthProfileName) { - - this.oauthProfileName = oauthProfileName; - return this; - } - - /** - * The name of the OAuth profile. - * @return oauthProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthProfileName() { - return oauthProfileName; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthProfileName(String oauthProfileName) { - this.oauthProfileName = oauthProfileName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileAccessLevelGroup oauthProfileAccessLevelGroup = (OauthProfileAccessLevelGroup) o; - return Objects.equals(this.description, oauthProfileAccessLevelGroup.description) && - Objects.equals(this.globalAccessLevel, oauthProfileAccessLevelGroup.globalAccessLevel) && - Objects.equals(this.groupName, oauthProfileAccessLevelGroup.groupName) && - Objects.equals(this.msgVpnAccessLevel, oauthProfileAccessLevelGroup.msgVpnAccessLevel) && - Objects.equals(this.oauthProfileName, oauthProfileAccessLevelGroup.oauthProfileName); - } - - @Override - public int hashCode() { - return Objects.hash(description, globalAccessLevel, groupName, msgVpnAccessLevel, oauthProfileName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileAccessLevelGroup {\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" globalAccessLevel: ").append(toIndentedString(globalAccessLevel)).append("\n"); - sb.append(" groupName: ").append(toIndentedString(groupName)).append("\n"); - sb.append(" msgVpnAccessLevel: ").append(toIndentedString(msgVpnAccessLevel)).append("\n"); - sb.append(" oauthProfileName: ").append(toIndentedString(oauthProfileName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupLinks.java deleted file mode 100644 index 274abf396..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupLinks.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileAccessLevelGroupLinks - */ -@JsonPropertyOrder({ - OauthProfileAccessLevelGroupLinks.JSON_PROPERTY_MSG_VPN_ACCESS_LEVEL_EXCEPTIONS_URI, - OauthProfileAccessLevelGroupLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileAccessLevelGroupLinks { - public static final String JSON_PROPERTY_MSG_VPN_ACCESS_LEVEL_EXCEPTIONS_URI = "msgVpnAccessLevelExceptionsUri"; - private String msgVpnAccessLevelExceptionsUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public OauthProfileAccessLevelGroupLinks() { - } - - public OauthProfileAccessLevelGroupLinks msgVpnAccessLevelExceptionsUri(String msgVpnAccessLevelExceptionsUri) { - - this.msgVpnAccessLevelExceptionsUri = msgVpnAccessLevelExceptionsUri; - return this; - } - - /** - * The URI of this Group Access Level's collection of Message VPN Access-Level Exception objects. - * @return msgVpnAccessLevelExceptionsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_ACCESS_LEVEL_EXCEPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnAccessLevelExceptionsUri() { - return msgVpnAccessLevelExceptionsUri; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_ACCESS_LEVEL_EXCEPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnAccessLevelExceptionsUri(String msgVpnAccessLevelExceptionsUri) { - this.msgVpnAccessLevelExceptionsUri = msgVpnAccessLevelExceptionsUri; - } - - - public OauthProfileAccessLevelGroupLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Group Access Level object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileAccessLevelGroupLinks oauthProfileAccessLevelGroupLinks = (OauthProfileAccessLevelGroupLinks) o; - return Objects.equals(this.msgVpnAccessLevelExceptionsUri, oauthProfileAccessLevelGroupLinks.msgVpnAccessLevelExceptionsUri) && - Objects.equals(this.uri, oauthProfileAccessLevelGroupLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(msgVpnAccessLevelExceptionsUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileAccessLevelGroupLinks {\n"); - sb.append(" msgVpnAccessLevelExceptionsUri: ").append(toIndentedString(msgVpnAccessLevelExceptionsUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.java deleted file mode 100644 index 140213ea8..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.java +++ /dev/null @@ -1,237 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileAccessLevelGroupMsgVpnAccessLevelException - */ -@JsonPropertyOrder({ - OauthProfileAccessLevelGroupMsgVpnAccessLevelException.JSON_PROPERTY_ACCESS_LEVEL, - OauthProfileAccessLevelGroupMsgVpnAccessLevelException.JSON_PROPERTY_GROUP_NAME, - OauthProfileAccessLevelGroupMsgVpnAccessLevelException.JSON_PROPERTY_MSG_VPN_NAME, - OauthProfileAccessLevelGroupMsgVpnAccessLevelException.JSON_PROPERTY_OAUTH_PROFILE_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileAccessLevelGroupMsgVpnAccessLevelException { - /** - * The message VPN access level. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to a Message VPN. \"read-only\" - User has read-only access to a Message VPN. \"read-write\" - User has read-write access to most Message VPN settings. </pre> - */ - public enum AccessLevelEnum { - NONE("none"), - - READ_ONLY("read-only"), - - READ_WRITE("read-write"); - - private String value; - - AccessLevelEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AccessLevelEnum fromValue(String value) { - for (AccessLevelEnum b : AccessLevelEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_ACCESS_LEVEL = "accessLevel"; - private AccessLevelEnum accessLevel; - - public static final String JSON_PROPERTY_GROUP_NAME = "groupName"; - private String groupName; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_OAUTH_PROFILE_NAME = "oauthProfileName"; - private String oauthProfileName; - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelException() { - } - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelException accessLevel(AccessLevelEnum accessLevel) { - - this.accessLevel = accessLevel; - return this; - } - - /** - * The message VPN access level. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to a Message VPN. \"read-only\" - User has read-only access to a Message VPN. \"read-write\" - User has read-write access to most Message VPN settings. </pre> - * @return accessLevel - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACCESS_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AccessLevelEnum getAccessLevel() { - return accessLevel; - } - - - @JsonProperty(JSON_PROPERTY_ACCESS_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccessLevel(AccessLevelEnum accessLevel) { - this.accessLevel = accessLevel; - } - - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelException groupName(String groupName) { - - this.groupName = groupName; - return this; - } - - /** - * The name of the group. - * @return groupName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GROUP_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getGroupName() { - return groupName; - } - - - @JsonProperty(JSON_PROPERTY_GROUP_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroupName(String groupName) { - this.groupName = groupName; - } - - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelException msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelException oauthProfileName(String oauthProfileName) { - - this.oauthProfileName = oauthProfileName; - return this; - } - - /** - * The name of the OAuth profile. - * @return oauthProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthProfileName() { - return oauthProfileName; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthProfileName(String oauthProfileName) { - this.oauthProfileName = oauthProfileName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileAccessLevelGroupMsgVpnAccessLevelException oauthProfileAccessLevelGroupMsgVpnAccessLevelException = (OauthProfileAccessLevelGroupMsgVpnAccessLevelException) o; - return Objects.equals(this.accessLevel, oauthProfileAccessLevelGroupMsgVpnAccessLevelException.accessLevel) && - Objects.equals(this.groupName, oauthProfileAccessLevelGroupMsgVpnAccessLevelException.groupName) && - Objects.equals(this.msgVpnName, oauthProfileAccessLevelGroupMsgVpnAccessLevelException.msgVpnName) && - Objects.equals(this.oauthProfileName, oauthProfileAccessLevelGroupMsgVpnAccessLevelException.oauthProfileName); - } - - @Override - public int hashCode() { - return Objects.hash(accessLevel, groupName, msgVpnName, oauthProfileName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileAccessLevelGroupMsgVpnAccessLevelException {\n"); - sb.append(" accessLevel: ").append(toIndentedString(accessLevel)).append("\n"); - sb.append(" groupName: ").append(toIndentedString(groupName)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" oauthProfileName: ").append(toIndentedString(oauthProfileName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks.java deleted file mode 100644 index 2ca59efce..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks - */ -@JsonPropertyOrder({ - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks() { - } - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Message VPN Access-Level Exception object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks oauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks = (OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks) o; - return Objects.equals(this.uri, oauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.java deleted file mode 100644 index b25cea7c2..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse - */ -@JsonPropertyOrder({ - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.JSON_PROPERTY_DATA, - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.JSON_PROPERTY_LINKS, - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private OauthProfileAccessLevelGroupMsgVpnAccessLevelException data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse() { - } - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse data(OauthProfileAccessLevelGroupMsgVpnAccessLevelException data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelException getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(OauthProfileAccessLevelGroupMsgVpnAccessLevelException data) { - this.data = data; - } - - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse links(OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks links) { - this.links = links; - } - - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse oauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse = (OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse) o; - return Objects.equals(this.data, oauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.data) && - Objects.equals(this.links, oauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.links) && - Objects.equals(this.meta, oauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.java deleted file mode 100644 index bde6079f5..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse - */ -@JsonPropertyOrder({ - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.JSON_PROPERTY_DATA, - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.JSON_PROPERTY_LINKS, - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse() { - } - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse data(List data) { - - this.data = data; - return this; - } - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse addDataItem(OauthProfileAccessLevelGroupMsgVpnAccessLevelException dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse links(List links) { - - this.links = links; - return this; - } - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse addLinksItem(OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse oauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse = (OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse) o; - return Objects.equals(this.data, oauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.data) && - Objects.equals(this.links, oauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.links) && - Objects.equals(this.meta, oauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupResponse.java deleted file mode 100644 index bbab6a39f..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileAccessLevelGroupResponse - */ -@JsonPropertyOrder({ - OauthProfileAccessLevelGroupResponse.JSON_PROPERTY_DATA, - OauthProfileAccessLevelGroupResponse.JSON_PROPERTY_LINKS, - OauthProfileAccessLevelGroupResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileAccessLevelGroupResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private OauthProfileAccessLevelGroup data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private OauthProfileAccessLevelGroupLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public OauthProfileAccessLevelGroupResponse() { - } - - public OauthProfileAccessLevelGroupResponse data(OauthProfileAccessLevelGroup data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthProfileAccessLevelGroup getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(OauthProfileAccessLevelGroup data) { - this.data = data; - } - - - public OauthProfileAccessLevelGroupResponse links(OauthProfileAccessLevelGroupLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthProfileAccessLevelGroupLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(OauthProfileAccessLevelGroupLinks links) { - this.links = links; - } - - - public OauthProfileAccessLevelGroupResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileAccessLevelGroupResponse oauthProfileAccessLevelGroupResponse = (OauthProfileAccessLevelGroupResponse) o; - return Objects.equals(this.data, oauthProfileAccessLevelGroupResponse.data) && - Objects.equals(this.links, oauthProfileAccessLevelGroupResponse.links) && - Objects.equals(this.meta, oauthProfileAccessLevelGroupResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileAccessLevelGroupResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupsResponse.java deleted file mode 100644 index 9e7bb6faa..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileAccessLevelGroupsResponse - */ -@JsonPropertyOrder({ - OauthProfileAccessLevelGroupsResponse.JSON_PROPERTY_DATA, - OauthProfileAccessLevelGroupsResponse.JSON_PROPERTY_LINKS, - OauthProfileAccessLevelGroupsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileAccessLevelGroupsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public OauthProfileAccessLevelGroupsResponse() { - } - - public OauthProfileAccessLevelGroupsResponse data(List data) { - - this.data = data; - return this; - } - - public OauthProfileAccessLevelGroupsResponse addDataItem(OauthProfileAccessLevelGroup dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public OauthProfileAccessLevelGroupsResponse links(List links) { - - this.links = links; - return this; - } - - public OauthProfileAccessLevelGroupsResponse addLinksItem(OauthProfileAccessLevelGroupLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public OauthProfileAccessLevelGroupsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileAccessLevelGroupsResponse oauthProfileAccessLevelGroupsResponse = (OauthProfileAccessLevelGroupsResponse) o; - return Objects.equals(this.data, oauthProfileAccessLevelGroupsResponse.data) && - Objects.equals(this.links, oauthProfileAccessLevelGroupsResponse.links) && - Objects.equals(this.meta, oauthProfileAccessLevelGroupsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileAccessLevelGroupsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHost.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHost.java deleted file mode 100644 index bf42976b5..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHost.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileClientAllowedHost - */ -@JsonPropertyOrder({ - OauthProfileClientAllowedHost.JSON_PROPERTY_ALLOWED_HOST, - OauthProfileClientAllowedHost.JSON_PROPERTY_OAUTH_PROFILE_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileClientAllowedHost { - public static final String JSON_PROPERTY_ALLOWED_HOST = "allowedHost"; - private String allowedHost; - - public static final String JSON_PROPERTY_OAUTH_PROFILE_NAME = "oauthProfileName"; - private String oauthProfileName; - - public OauthProfileClientAllowedHost() { - } - - public OauthProfileClientAllowedHost allowedHost(String allowedHost) { - - this.allowedHost = allowedHost; - return this; - } - - /** - * An allowed value for the Host header. - * @return allowedHost - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOWED_HOST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAllowedHost() { - return allowedHost; - } - - - @JsonProperty(JSON_PROPERTY_ALLOWED_HOST) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowedHost(String allowedHost) { - this.allowedHost = allowedHost; - } - - - public OauthProfileClientAllowedHost oauthProfileName(String oauthProfileName) { - - this.oauthProfileName = oauthProfileName; - return this; - } - - /** - * The name of the OAuth profile. - * @return oauthProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthProfileName() { - return oauthProfileName; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthProfileName(String oauthProfileName) { - this.oauthProfileName = oauthProfileName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileClientAllowedHost oauthProfileClientAllowedHost = (OauthProfileClientAllowedHost) o; - return Objects.equals(this.allowedHost, oauthProfileClientAllowedHost.allowedHost) && - Objects.equals(this.oauthProfileName, oauthProfileClientAllowedHost.oauthProfileName); - } - - @Override - public int hashCode() { - return Objects.hash(allowedHost, oauthProfileName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileClientAllowedHost {\n"); - sb.append(" allowedHost: ").append(toIndentedString(allowedHost)).append("\n"); - sb.append(" oauthProfileName: ").append(toIndentedString(oauthProfileName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostLinks.java deleted file mode 100644 index 53170f131..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileClientAllowedHostLinks - */ -@JsonPropertyOrder({ - OauthProfileClientAllowedHostLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileClientAllowedHostLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public OauthProfileClientAllowedHostLinks() { - } - - public OauthProfileClientAllowedHostLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Allowed Host Value object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileClientAllowedHostLinks oauthProfileClientAllowedHostLinks = (OauthProfileClientAllowedHostLinks) o; - return Objects.equals(this.uri, oauthProfileClientAllowedHostLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileClientAllowedHostLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostResponse.java deleted file mode 100644 index 68f697e44..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHost; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHostLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileClientAllowedHostResponse - */ -@JsonPropertyOrder({ - OauthProfileClientAllowedHostResponse.JSON_PROPERTY_DATA, - OauthProfileClientAllowedHostResponse.JSON_PROPERTY_LINKS, - OauthProfileClientAllowedHostResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileClientAllowedHostResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private OauthProfileClientAllowedHost data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private OauthProfileClientAllowedHostLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public OauthProfileClientAllowedHostResponse() { - } - - public OauthProfileClientAllowedHostResponse data(OauthProfileClientAllowedHost data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthProfileClientAllowedHost getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(OauthProfileClientAllowedHost data) { - this.data = data; - } - - - public OauthProfileClientAllowedHostResponse links(OauthProfileClientAllowedHostLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthProfileClientAllowedHostLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(OauthProfileClientAllowedHostLinks links) { - this.links = links; - } - - - public OauthProfileClientAllowedHostResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileClientAllowedHostResponse oauthProfileClientAllowedHostResponse = (OauthProfileClientAllowedHostResponse) o; - return Objects.equals(this.data, oauthProfileClientAllowedHostResponse.data) && - Objects.equals(this.links, oauthProfileClientAllowedHostResponse.links) && - Objects.equals(this.meta, oauthProfileClientAllowedHostResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileClientAllowedHostResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostsResponse.java deleted file mode 100644 index 8a8fd61af..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHost; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHostLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileClientAllowedHostsResponse - */ -@JsonPropertyOrder({ - OauthProfileClientAllowedHostsResponse.JSON_PROPERTY_DATA, - OauthProfileClientAllowedHostsResponse.JSON_PROPERTY_LINKS, - OauthProfileClientAllowedHostsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileClientAllowedHostsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public OauthProfileClientAllowedHostsResponse() { - } - - public OauthProfileClientAllowedHostsResponse data(List data) { - - this.data = data; - return this; - } - - public OauthProfileClientAllowedHostsResponse addDataItem(OauthProfileClientAllowedHost dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public OauthProfileClientAllowedHostsResponse links(List links) { - - this.links = links; - return this; - } - - public OauthProfileClientAllowedHostsResponse addLinksItem(OauthProfileClientAllowedHostLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public OauthProfileClientAllowedHostsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileClientAllowedHostsResponse oauthProfileClientAllowedHostsResponse = (OauthProfileClientAllowedHostsResponse) o; - return Objects.equals(this.data, oauthProfileClientAllowedHostsResponse.data) && - Objects.equals(this.links, oauthProfileClientAllowedHostsResponse.links) && - Objects.equals(this.meta, oauthProfileClientAllowedHostsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileClientAllowedHostsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameter.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameter.java deleted file mode 100644 index 4873111ac..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameter.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileClientAuthorizationParameter - */ -@JsonPropertyOrder({ - OauthProfileClientAuthorizationParameter.JSON_PROPERTY_AUTHORIZATION_PARAMETER_NAME, - OauthProfileClientAuthorizationParameter.JSON_PROPERTY_AUTHORIZATION_PARAMETER_VALUE, - OauthProfileClientAuthorizationParameter.JSON_PROPERTY_OAUTH_PROFILE_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileClientAuthorizationParameter { - public static final String JSON_PROPERTY_AUTHORIZATION_PARAMETER_NAME = "authorizationParameterName"; - private String authorizationParameterName; - - public static final String JSON_PROPERTY_AUTHORIZATION_PARAMETER_VALUE = "authorizationParameterValue"; - private String authorizationParameterValue; - - public static final String JSON_PROPERTY_OAUTH_PROFILE_NAME = "oauthProfileName"; - private String oauthProfileName; - - public OauthProfileClientAuthorizationParameter() { - } - - public OauthProfileClientAuthorizationParameter authorizationParameterName(String authorizationParameterName) { - - this.authorizationParameterName = authorizationParameterName; - return this; - } - - /** - * The name of the authorization parameter. - * @return authorizationParameterName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_PARAMETER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthorizationParameterName() { - return authorizationParameterName; - } - - - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_PARAMETER_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthorizationParameterName(String authorizationParameterName) { - this.authorizationParameterName = authorizationParameterName; - } - - - public OauthProfileClientAuthorizationParameter authorizationParameterValue(String authorizationParameterValue) { - - this.authorizationParameterValue = authorizationParameterValue; - return this; - } - - /** - * The authorization parameter value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return authorizationParameterValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_PARAMETER_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAuthorizationParameterValue() { - return authorizationParameterValue; - } - - - @JsonProperty(JSON_PROPERTY_AUTHORIZATION_PARAMETER_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAuthorizationParameterValue(String authorizationParameterValue) { - this.authorizationParameterValue = authorizationParameterValue; - } - - - public OauthProfileClientAuthorizationParameter oauthProfileName(String oauthProfileName) { - - this.oauthProfileName = oauthProfileName; - return this; - } - - /** - * The name of the OAuth profile. - * @return oauthProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthProfileName() { - return oauthProfileName; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthProfileName(String oauthProfileName) { - this.oauthProfileName = oauthProfileName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileClientAuthorizationParameter oauthProfileClientAuthorizationParameter = (OauthProfileClientAuthorizationParameter) o; - return Objects.equals(this.authorizationParameterName, oauthProfileClientAuthorizationParameter.authorizationParameterName) && - Objects.equals(this.authorizationParameterValue, oauthProfileClientAuthorizationParameter.authorizationParameterValue) && - Objects.equals(this.oauthProfileName, oauthProfileClientAuthorizationParameter.oauthProfileName); - } - - @Override - public int hashCode() { - return Objects.hash(authorizationParameterName, authorizationParameterValue, oauthProfileName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileClientAuthorizationParameter {\n"); - sb.append(" authorizationParameterName: ").append(toIndentedString(authorizationParameterName)).append("\n"); - sb.append(" authorizationParameterValue: ").append(toIndentedString(authorizationParameterValue)).append("\n"); - sb.append(" oauthProfileName: ").append(toIndentedString(oauthProfileName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterLinks.java deleted file mode 100644 index 771e5ca47..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileClientAuthorizationParameterLinks - */ -@JsonPropertyOrder({ - OauthProfileClientAuthorizationParameterLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileClientAuthorizationParameterLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public OauthProfileClientAuthorizationParameterLinks() { - } - - public OauthProfileClientAuthorizationParameterLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Authorization Parameter object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileClientAuthorizationParameterLinks oauthProfileClientAuthorizationParameterLinks = (OauthProfileClientAuthorizationParameterLinks) o; - return Objects.equals(this.uri, oauthProfileClientAuthorizationParameterLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileClientAuthorizationParameterLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterResponse.java deleted file mode 100644 index 1d9fb2ebd..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParameter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParameterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileClientAuthorizationParameterResponse - */ -@JsonPropertyOrder({ - OauthProfileClientAuthorizationParameterResponse.JSON_PROPERTY_DATA, - OauthProfileClientAuthorizationParameterResponse.JSON_PROPERTY_LINKS, - OauthProfileClientAuthorizationParameterResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileClientAuthorizationParameterResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private OauthProfileClientAuthorizationParameter data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private OauthProfileClientAuthorizationParameterLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public OauthProfileClientAuthorizationParameterResponse() { - } - - public OauthProfileClientAuthorizationParameterResponse data(OauthProfileClientAuthorizationParameter data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthProfileClientAuthorizationParameter getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(OauthProfileClientAuthorizationParameter data) { - this.data = data; - } - - - public OauthProfileClientAuthorizationParameterResponse links(OauthProfileClientAuthorizationParameterLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthProfileClientAuthorizationParameterLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(OauthProfileClientAuthorizationParameterLinks links) { - this.links = links; - } - - - public OauthProfileClientAuthorizationParameterResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileClientAuthorizationParameterResponse oauthProfileClientAuthorizationParameterResponse = (OauthProfileClientAuthorizationParameterResponse) o; - return Objects.equals(this.data, oauthProfileClientAuthorizationParameterResponse.data) && - Objects.equals(this.links, oauthProfileClientAuthorizationParameterResponse.links) && - Objects.equals(this.meta, oauthProfileClientAuthorizationParameterResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileClientAuthorizationParameterResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParametersResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParametersResponse.java deleted file mode 100644 index 8a9e873d4..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParametersResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParameter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParameterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileClientAuthorizationParametersResponse - */ -@JsonPropertyOrder({ - OauthProfileClientAuthorizationParametersResponse.JSON_PROPERTY_DATA, - OauthProfileClientAuthorizationParametersResponse.JSON_PROPERTY_LINKS, - OauthProfileClientAuthorizationParametersResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileClientAuthorizationParametersResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public OauthProfileClientAuthorizationParametersResponse() { - } - - public OauthProfileClientAuthorizationParametersResponse data(List data) { - - this.data = data; - return this; - } - - public OauthProfileClientAuthorizationParametersResponse addDataItem(OauthProfileClientAuthorizationParameter dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public OauthProfileClientAuthorizationParametersResponse links(List links) { - - this.links = links; - return this; - } - - public OauthProfileClientAuthorizationParametersResponse addLinksItem(OauthProfileClientAuthorizationParameterLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public OauthProfileClientAuthorizationParametersResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileClientAuthorizationParametersResponse oauthProfileClientAuthorizationParametersResponse = (OauthProfileClientAuthorizationParametersResponse) o; - return Objects.equals(this.data, oauthProfileClientAuthorizationParametersResponse.data) && - Objects.equals(this.links, oauthProfileClientAuthorizationParametersResponse.links) && - Objects.equals(this.meta, oauthProfileClientAuthorizationParametersResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileClientAuthorizationParametersResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaim.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaim.java deleted file mode 100644 index 848d30c54..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaim.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileClientRequiredClaim - */ -@JsonPropertyOrder({ - OauthProfileClientRequiredClaim.JSON_PROPERTY_CLIENT_REQUIRED_CLAIM_NAME, - OauthProfileClientRequiredClaim.JSON_PROPERTY_CLIENT_REQUIRED_CLAIM_VALUE, - OauthProfileClientRequiredClaim.JSON_PROPERTY_OAUTH_PROFILE_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileClientRequiredClaim { - public static final String JSON_PROPERTY_CLIENT_REQUIRED_CLAIM_NAME = "clientRequiredClaimName"; - private String clientRequiredClaimName; - - public static final String JSON_PROPERTY_CLIENT_REQUIRED_CLAIM_VALUE = "clientRequiredClaimValue"; - private String clientRequiredClaimValue; - - public static final String JSON_PROPERTY_OAUTH_PROFILE_NAME = "oauthProfileName"; - private String oauthProfileName; - - public OauthProfileClientRequiredClaim() { - } - - public OauthProfileClientRequiredClaim clientRequiredClaimName(String clientRequiredClaimName) { - - this.clientRequiredClaimName = clientRequiredClaimName; - return this; - } - - /** - * The name of the ID token claim to verify. - * @return clientRequiredClaimName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_REQUIRED_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientRequiredClaimName() { - return clientRequiredClaimName; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_REQUIRED_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientRequiredClaimName(String clientRequiredClaimName) { - this.clientRequiredClaimName = clientRequiredClaimName; - } - - - public OauthProfileClientRequiredClaim clientRequiredClaimValue(String clientRequiredClaimValue) { - - this.clientRequiredClaimValue = clientRequiredClaimValue; - return this; - } - - /** - * The required claim value, which must be a string containing a valid JSON value. - * @return clientRequiredClaimValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_REQUIRED_CLAIM_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientRequiredClaimValue() { - return clientRequiredClaimValue; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_REQUIRED_CLAIM_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientRequiredClaimValue(String clientRequiredClaimValue) { - this.clientRequiredClaimValue = clientRequiredClaimValue; - } - - - public OauthProfileClientRequiredClaim oauthProfileName(String oauthProfileName) { - - this.oauthProfileName = oauthProfileName; - return this; - } - - /** - * The name of the OAuth profile. - * @return oauthProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthProfileName() { - return oauthProfileName; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthProfileName(String oauthProfileName) { - this.oauthProfileName = oauthProfileName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileClientRequiredClaim oauthProfileClientRequiredClaim = (OauthProfileClientRequiredClaim) o; - return Objects.equals(this.clientRequiredClaimName, oauthProfileClientRequiredClaim.clientRequiredClaimName) && - Objects.equals(this.clientRequiredClaimValue, oauthProfileClientRequiredClaim.clientRequiredClaimValue) && - Objects.equals(this.oauthProfileName, oauthProfileClientRequiredClaim.oauthProfileName); - } - - @Override - public int hashCode() { - return Objects.hash(clientRequiredClaimName, clientRequiredClaimValue, oauthProfileName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileClientRequiredClaim {\n"); - sb.append(" clientRequiredClaimName: ").append(toIndentedString(clientRequiredClaimName)).append("\n"); - sb.append(" clientRequiredClaimValue: ").append(toIndentedString(clientRequiredClaimValue)).append("\n"); - sb.append(" oauthProfileName: ").append(toIndentedString(oauthProfileName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimLinks.java deleted file mode 100644 index 6c3a8243c..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileClientRequiredClaimLinks - */ -@JsonPropertyOrder({ - OauthProfileClientRequiredClaimLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileClientRequiredClaimLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public OauthProfileClientRequiredClaimLinks() { - } - - public OauthProfileClientRequiredClaimLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Required Claim object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileClientRequiredClaimLinks oauthProfileClientRequiredClaimLinks = (OauthProfileClientRequiredClaimLinks) o; - return Objects.equals(this.uri, oauthProfileClientRequiredClaimLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileClientRequiredClaimLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimResponse.java deleted file mode 100644 index 1d9e3c077..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileClientRequiredClaimResponse - */ -@JsonPropertyOrder({ - OauthProfileClientRequiredClaimResponse.JSON_PROPERTY_DATA, - OauthProfileClientRequiredClaimResponse.JSON_PROPERTY_LINKS, - OauthProfileClientRequiredClaimResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileClientRequiredClaimResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private OauthProfileClientRequiredClaim data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private OauthProfileClientRequiredClaimLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public OauthProfileClientRequiredClaimResponse() { - } - - public OauthProfileClientRequiredClaimResponse data(OauthProfileClientRequiredClaim data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthProfileClientRequiredClaim getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(OauthProfileClientRequiredClaim data) { - this.data = data; - } - - - public OauthProfileClientRequiredClaimResponse links(OauthProfileClientRequiredClaimLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthProfileClientRequiredClaimLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(OauthProfileClientRequiredClaimLinks links) { - this.links = links; - } - - - public OauthProfileClientRequiredClaimResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileClientRequiredClaimResponse oauthProfileClientRequiredClaimResponse = (OauthProfileClientRequiredClaimResponse) o; - return Objects.equals(this.data, oauthProfileClientRequiredClaimResponse.data) && - Objects.equals(this.links, oauthProfileClientRequiredClaimResponse.links) && - Objects.equals(this.meta, oauthProfileClientRequiredClaimResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileClientRequiredClaimResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimsResponse.java deleted file mode 100644 index 129a6be70..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileClientRequiredClaimsResponse - */ -@JsonPropertyOrder({ - OauthProfileClientRequiredClaimsResponse.JSON_PROPERTY_DATA, - OauthProfileClientRequiredClaimsResponse.JSON_PROPERTY_LINKS, - OauthProfileClientRequiredClaimsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileClientRequiredClaimsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public OauthProfileClientRequiredClaimsResponse() { - } - - public OauthProfileClientRequiredClaimsResponse data(List data) { - - this.data = data; - return this; - } - - public OauthProfileClientRequiredClaimsResponse addDataItem(OauthProfileClientRequiredClaim dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public OauthProfileClientRequiredClaimsResponse links(List links) { - - this.links = links; - return this; - } - - public OauthProfileClientRequiredClaimsResponse addLinksItem(OauthProfileClientRequiredClaimLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public OauthProfileClientRequiredClaimsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileClientRequiredClaimsResponse oauthProfileClientRequiredClaimsResponse = (OauthProfileClientRequiredClaimsResponse) o; - return Objects.equals(this.data, oauthProfileClientRequiredClaimsResponse.data) && - Objects.equals(this.links, oauthProfileClientRequiredClaimsResponse.links) && - Objects.equals(this.meta, oauthProfileClientRequiredClaimsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileClientRequiredClaimsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelException.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelException.java deleted file mode 100644 index ac0ed829e..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelException.java +++ /dev/null @@ -1,205 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileDefaultMsgVpnAccessLevelException - */ -@JsonPropertyOrder({ - OauthProfileDefaultMsgVpnAccessLevelException.JSON_PROPERTY_ACCESS_LEVEL, - OauthProfileDefaultMsgVpnAccessLevelException.JSON_PROPERTY_MSG_VPN_NAME, - OauthProfileDefaultMsgVpnAccessLevelException.JSON_PROPERTY_OAUTH_PROFILE_NAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileDefaultMsgVpnAccessLevelException { - /** - * The message VPN access level. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to a Message VPN. \"read-only\" - User has read-only access to a Message VPN. \"read-write\" - User has read-write access to most Message VPN settings. </pre> - */ - public enum AccessLevelEnum { - NONE("none"), - - READ_ONLY("read-only"), - - READ_WRITE("read-write"); - - private String value; - - AccessLevelEnum(String value) { - this.value = value; - } - - @JsonValue - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - @JsonCreator - public static AccessLevelEnum fromValue(String value) { - for (AccessLevelEnum b : AccessLevelEnum.values()) { - if (b.value.equals(value)) { - return b; - } - } - throw new IllegalArgumentException("Unexpected value '" + value + "'"); - } - } - - public static final String JSON_PROPERTY_ACCESS_LEVEL = "accessLevel"; - private AccessLevelEnum accessLevel; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_OAUTH_PROFILE_NAME = "oauthProfileName"; - private String oauthProfileName; - - public OauthProfileDefaultMsgVpnAccessLevelException() { - } - - public OauthProfileDefaultMsgVpnAccessLevelException accessLevel(AccessLevelEnum accessLevel) { - - this.accessLevel = accessLevel; - return this; - } - - /** - * The message VPN access level. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are: <pre> \"none\" - User has no access to a Message VPN. \"read-only\" - User has read-only access to a Message VPN. \"read-write\" - User has read-write access to most Message VPN settings. </pre> - * @return accessLevel - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACCESS_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public AccessLevelEnum getAccessLevel() { - return accessLevel; - } - - - @JsonProperty(JSON_PROPERTY_ACCESS_LEVEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccessLevel(AccessLevelEnum accessLevel) { - this.accessLevel = accessLevel; - } - - - public OauthProfileDefaultMsgVpnAccessLevelException msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The name of the message VPN. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public OauthProfileDefaultMsgVpnAccessLevelException oauthProfileName(String oauthProfileName) { - - this.oauthProfileName = oauthProfileName; - return this; - } - - /** - * The name of the OAuth profile. - * @return oauthProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthProfileName() { - return oauthProfileName; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthProfileName(String oauthProfileName) { - this.oauthProfileName = oauthProfileName; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileDefaultMsgVpnAccessLevelException oauthProfileDefaultMsgVpnAccessLevelException = (OauthProfileDefaultMsgVpnAccessLevelException) o; - return Objects.equals(this.accessLevel, oauthProfileDefaultMsgVpnAccessLevelException.accessLevel) && - Objects.equals(this.msgVpnName, oauthProfileDefaultMsgVpnAccessLevelException.msgVpnName) && - Objects.equals(this.oauthProfileName, oauthProfileDefaultMsgVpnAccessLevelException.oauthProfileName); - } - - @Override - public int hashCode() { - return Objects.hash(accessLevel, msgVpnName, oauthProfileName); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileDefaultMsgVpnAccessLevelException {\n"); - sb.append(" accessLevel: ").append(toIndentedString(accessLevel)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" oauthProfileName: ").append(toIndentedString(oauthProfileName)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks.java deleted file mode 100644 index f3e97b049..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileDefaultMsgVpnAccessLevelExceptionLinks - */ -@JsonPropertyOrder({ - OauthProfileDefaultMsgVpnAccessLevelExceptionLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileDefaultMsgVpnAccessLevelExceptionLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public OauthProfileDefaultMsgVpnAccessLevelExceptionLinks() { - } - - public OauthProfileDefaultMsgVpnAccessLevelExceptionLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Message VPN Access-Level Exception object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileDefaultMsgVpnAccessLevelExceptionLinks oauthProfileDefaultMsgVpnAccessLevelExceptionLinks = (OauthProfileDefaultMsgVpnAccessLevelExceptionLinks) o; - return Objects.equals(this.uri, oauthProfileDefaultMsgVpnAccessLevelExceptionLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileDefaultMsgVpnAccessLevelExceptionLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.java deleted file mode 100644 index b30cc7924..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileDefaultMsgVpnAccessLevelExceptionResponse - */ -@JsonPropertyOrder({ - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.JSON_PROPERTY_DATA, - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.JSON_PROPERTY_LINKS, - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileDefaultMsgVpnAccessLevelExceptionResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private OauthProfileDefaultMsgVpnAccessLevelException data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private OauthProfileDefaultMsgVpnAccessLevelExceptionLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public OauthProfileDefaultMsgVpnAccessLevelExceptionResponse() { - } - - public OauthProfileDefaultMsgVpnAccessLevelExceptionResponse data(OauthProfileDefaultMsgVpnAccessLevelException data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthProfileDefaultMsgVpnAccessLevelException getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(OauthProfileDefaultMsgVpnAccessLevelException data) { - this.data = data; - } - - - public OauthProfileDefaultMsgVpnAccessLevelExceptionResponse links(OauthProfileDefaultMsgVpnAccessLevelExceptionLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthProfileDefaultMsgVpnAccessLevelExceptionLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(OauthProfileDefaultMsgVpnAccessLevelExceptionLinks links) { - this.links = links; - } - - - public OauthProfileDefaultMsgVpnAccessLevelExceptionResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse oauthProfileDefaultMsgVpnAccessLevelExceptionResponse = (OauthProfileDefaultMsgVpnAccessLevelExceptionResponse) o; - return Objects.equals(this.data, oauthProfileDefaultMsgVpnAccessLevelExceptionResponse.data) && - Objects.equals(this.links, oauthProfileDefaultMsgVpnAccessLevelExceptionResponse.links) && - Objects.equals(this.meta, oauthProfileDefaultMsgVpnAccessLevelExceptionResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileDefaultMsgVpnAccessLevelExceptionResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.java deleted file mode 100644 index 4a998c36f..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse - */ -@JsonPropertyOrder({ - OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.JSON_PROPERTY_DATA, - OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.JSON_PROPERTY_LINKS, - OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse() { - } - - public OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse data(List data) { - - this.data = data; - return this; - } - - public OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse addDataItem(OauthProfileDefaultMsgVpnAccessLevelException dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse links(List links) { - - this.links = links; - return this; - } - - public OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse addLinksItem(OauthProfileDefaultMsgVpnAccessLevelExceptionLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse oauthProfileDefaultMsgVpnAccessLevelExceptionsResponse = (OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse) o; - return Objects.equals(this.data, oauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.data) && - Objects.equals(this.links, oauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.links) && - Objects.equals(this.meta, oauthProfileDefaultMsgVpnAccessLevelExceptionsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileLinks.java deleted file mode 100644 index 84a36816f..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileLinks.java +++ /dev/null @@ -1,296 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileLinks - */ -@JsonPropertyOrder({ - OauthProfileLinks.JSON_PROPERTY_ACCESS_LEVEL_GROUPS_URI, - OauthProfileLinks.JSON_PROPERTY_CLIENT_ALLOWED_HOSTS_URI, - OauthProfileLinks.JSON_PROPERTY_CLIENT_AUTHORIZATION_PARAMETERS_URI, - OauthProfileLinks.JSON_PROPERTY_CLIENT_REQUIRED_CLAIMS_URI, - OauthProfileLinks.JSON_PROPERTY_DEFAULT_MSG_VPN_ACCESS_LEVEL_EXCEPTIONS_URI, - OauthProfileLinks.JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIMS_URI, - OauthProfileLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileLinks { - public static final String JSON_PROPERTY_ACCESS_LEVEL_GROUPS_URI = "accessLevelGroupsUri"; - private String accessLevelGroupsUri; - - public static final String JSON_PROPERTY_CLIENT_ALLOWED_HOSTS_URI = "clientAllowedHostsUri"; - private String clientAllowedHostsUri; - - public static final String JSON_PROPERTY_CLIENT_AUTHORIZATION_PARAMETERS_URI = "clientAuthorizationParametersUri"; - private String clientAuthorizationParametersUri; - - public static final String JSON_PROPERTY_CLIENT_REQUIRED_CLAIMS_URI = "clientRequiredClaimsUri"; - private String clientRequiredClaimsUri; - - public static final String JSON_PROPERTY_DEFAULT_MSG_VPN_ACCESS_LEVEL_EXCEPTIONS_URI = "defaultMsgVpnAccessLevelExceptionsUri"; - private String defaultMsgVpnAccessLevelExceptionsUri; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIMS_URI = "resourceServerRequiredClaimsUri"; - private String resourceServerRequiredClaimsUri; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public OauthProfileLinks() { - } - - public OauthProfileLinks accessLevelGroupsUri(String accessLevelGroupsUri) { - - this.accessLevelGroupsUri = accessLevelGroupsUri; - return this; - } - - /** - * The URI of this OAuth Profile's collection of Group Access Level objects. - * @return accessLevelGroupsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACCESS_LEVEL_GROUPS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getAccessLevelGroupsUri() { - return accessLevelGroupsUri; - } - - - @JsonProperty(JSON_PROPERTY_ACCESS_LEVEL_GROUPS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccessLevelGroupsUri(String accessLevelGroupsUri) { - this.accessLevelGroupsUri = accessLevelGroupsUri; - } - - - public OauthProfileLinks clientAllowedHostsUri(String clientAllowedHostsUri) { - - this.clientAllowedHostsUri = clientAllowedHostsUri; - return this; - } - - /** - * The URI of this OAuth Profile's collection of Allowed Host Value objects. - * @return clientAllowedHostsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_ALLOWED_HOSTS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientAllowedHostsUri() { - return clientAllowedHostsUri; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_ALLOWED_HOSTS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientAllowedHostsUri(String clientAllowedHostsUri) { - this.clientAllowedHostsUri = clientAllowedHostsUri; - } - - - public OauthProfileLinks clientAuthorizationParametersUri(String clientAuthorizationParametersUri) { - - this.clientAuthorizationParametersUri = clientAuthorizationParametersUri; - return this; - } - - /** - * The URI of this OAuth Profile's collection of Authorization Parameter objects. - * @return clientAuthorizationParametersUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_AUTHORIZATION_PARAMETERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientAuthorizationParametersUri() { - return clientAuthorizationParametersUri; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_AUTHORIZATION_PARAMETERS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientAuthorizationParametersUri(String clientAuthorizationParametersUri) { - this.clientAuthorizationParametersUri = clientAuthorizationParametersUri; - } - - - public OauthProfileLinks clientRequiredClaimsUri(String clientRequiredClaimsUri) { - - this.clientRequiredClaimsUri = clientRequiredClaimsUri; - return this; - } - - /** - * The URI of this OAuth Profile's collection of Required Claim objects. - * @return clientRequiredClaimsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_REQUIRED_CLAIMS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientRequiredClaimsUri() { - return clientRequiredClaimsUri; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_REQUIRED_CLAIMS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientRequiredClaimsUri(String clientRequiredClaimsUri) { - this.clientRequiredClaimsUri = clientRequiredClaimsUri; - } - - - public OauthProfileLinks defaultMsgVpnAccessLevelExceptionsUri(String defaultMsgVpnAccessLevelExceptionsUri) { - - this.defaultMsgVpnAccessLevelExceptionsUri = defaultMsgVpnAccessLevelExceptionsUri; - return this; - } - - /** - * The URI of this OAuth Profile's collection of Message VPN Access-Level Exception objects. - * @return defaultMsgVpnAccessLevelExceptionsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DEFAULT_MSG_VPN_ACCESS_LEVEL_EXCEPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getDefaultMsgVpnAccessLevelExceptionsUri() { - return defaultMsgVpnAccessLevelExceptionsUri; - } - - - @JsonProperty(JSON_PROPERTY_DEFAULT_MSG_VPN_ACCESS_LEVEL_EXCEPTIONS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDefaultMsgVpnAccessLevelExceptionsUri(String defaultMsgVpnAccessLevelExceptionsUri) { - this.defaultMsgVpnAccessLevelExceptionsUri = defaultMsgVpnAccessLevelExceptionsUri; - } - - - public OauthProfileLinks resourceServerRequiredClaimsUri(String resourceServerRequiredClaimsUri) { - - this.resourceServerRequiredClaimsUri = resourceServerRequiredClaimsUri; - return this; - } - - /** - * The URI of this OAuth Profile's collection of Required Claim objects. - * @return resourceServerRequiredClaimsUri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIMS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getResourceServerRequiredClaimsUri() { - return resourceServerRequiredClaimsUri; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIMS_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerRequiredClaimsUri(String resourceServerRequiredClaimsUri) { - this.resourceServerRequiredClaimsUri = resourceServerRequiredClaimsUri; - } - - - public OauthProfileLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this OAuth Profile object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileLinks oauthProfileLinks = (OauthProfileLinks) o; - return Objects.equals(this.accessLevelGroupsUri, oauthProfileLinks.accessLevelGroupsUri) && - Objects.equals(this.clientAllowedHostsUri, oauthProfileLinks.clientAllowedHostsUri) && - Objects.equals(this.clientAuthorizationParametersUri, oauthProfileLinks.clientAuthorizationParametersUri) && - Objects.equals(this.clientRequiredClaimsUri, oauthProfileLinks.clientRequiredClaimsUri) && - Objects.equals(this.defaultMsgVpnAccessLevelExceptionsUri, oauthProfileLinks.defaultMsgVpnAccessLevelExceptionsUri) && - Objects.equals(this.resourceServerRequiredClaimsUri, oauthProfileLinks.resourceServerRequiredClaimsUri) && - Objects.equals(this.uri, oauthProfileLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(accessLevelGroupsUri, clientAllowedHostsUri, clientAuthorizationParametersUri, clientRequiredClaimsUri, defaultMsgVpnAccessLevelExceptionsUri, resourceServerRequiredClaimsUri, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileLinks {\n"); - sb.append(" accessLevelGroupsUri: ").append(toIndentedString(accessLevelGroupsUri)).append("\n"); - sb.append(" clientAllowedHostsUri: ").append(toIndentedString(clientAllowedHostsUri)).append("\n"); - sb.append(" clientAuthorizationParametersUri: ").append(toIndentedString(clientAuthorizationParametersUri)).append("\n"); - sb.append(" clientRequiredClaimsUri: ").append(toIndentedString(clientRequiredClaimsUri)).append("\n"); - sb.append(" defaultMsgVpnAccessLevelExceptionsUri: ").append(toIndentedString(defaultMsgVpnAccessLevelExceptionsUri)).append("\n"); - sb.append(" resourceServerRequiredClaimsUri: ").append(toIndentedString(resourceServerRequiredClaimsUri)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaim.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaim.java deleted file mode 100644 index 38f17761d..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaim.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileResourceServerRequiredClaim - */ -@JsonPropertyOrder({ - OauthProfileResourceServerRequiredClaim.JSON_PROPERTY_OAUTH_PROFILE_NAME, - OauthProfileResourceServerRequiredClaim.JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIM_NAME, - OauthProfileResourceServerRequiredClaim.JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIM_VALUE -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileResourceServerRequiredClaim { - public static final String JSON_PROPERTY_OAUTH_PROFILE_NAME = "oauthProfileName"; - private String oauthProfileName; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIM_NAME = "resourceServerRequiredClaimName"; - private String resourceServerRequiredClaimName; - - public static final String JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIM_VALUE = "resourceServerRequiredClaimValue"; - private String resourceServerRequiredClaimValue; - - public OauthProfileResourceServerRequiredClaim() { - } - - public OauthProfileResourceServerRequiredClaim oauthProfileName(String oauthProfileName) { - - this.oauthProfileName = oauthProfileName; - return this; - } - - /** - * The name of the OAuth profile. - * @return oauthProfileName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getOauthProfileName() { - return oauthProfileName; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH_PROFILE_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthProfileName(String oauthProfileName) { - this.oauthProfileName = oauthProfileName; - } - - - public OauthProfileResourceServerRequiredClaim resourceServerRequiredClaimName(String resourceServerRequiredClaimName) { - - this.resourceServerRequiredClaimName = resourceServerRequiredClaimName; - return this; - } - - /** - * The name of the access token claim to verify. - * @return resourceServerRequiredClaimName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getResourceServerRequiredClaimName() { - return resourceServerRequiredClaimName; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIM_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerRequiredClaimName(String resourceServerRequiredClaimName) { - this.resourceServerRequiredClaimName = resourceServerRequiredClaimName; - } - - - public OauthProfileResourceServerRequiredClaim resourceServerRequiredClaimValue(String resourceServerRequiredClaimValue) { - - this.resourceServerRequiredClaimValue = resourceServerRequiredClaimValue; - return this; - } - - /** - * The required claim value, which must be a string containing a valid JSON value. - * @return resourceServerRequiredClaimValue - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIM_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getResourceServerRequiredClaimValue() { - return resourceServerRequiredClaimValue; - } - - - @JsonProperty(JSON_PROPERTY_RESOURCE_SERVER_REQUIRED_CLAIM_VALUE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResourceServerRequiredClaimValue(String resourceServerRequiredClaimValue) { - this.resourceServerRequiredClaimValue = resourceServerRequiredClaimValue; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileResourceServerRequiredClaim oauthProfileResourceServerRequiredClaim = (OauthProfileResourceServerRequiredClaim) o; - return Objects.equals(this.oauthProfileName, oauthProfileResourceServerRequiredClaim.oauthProfileName) && - Objects.equals(this.resourceServerRequiredClaimName, oauthProfileResourceServerRequiredClaim.resourceServerRequiredClaimName) && - Objects.equals(this.resourceServerRequiredClaimValue, oauthProfileResourceServerRequiredClaim.resourceServerRequiredClaimValue); - } - - @Override - public int hashCode() { - return Objects.hash(oauthProfileName, resourceServerRequiredClaimName, resourceServerRequiredClaimValue); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileResourceServerRequiredClaim {\n"); - sb.append(" oauthProfileName: ").append(toIndentedString(oauthProfileName)).append("\n"); - sb.append(" resourceServerRequiredClaimName: ").append(toIndentedString(resourceServerRequiredClaimName)).append("\n"); - sb.append(" resourceServerRequiredClaimValue: ").append(toIndentedString(resourceServerRequiredClaimValue)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimLinks.java deleted file mode 100644 index 93701c147..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileResourceServerRequiredClaimLinks - */ -@JsonPropertyOrder({ - OauthProfileResourceServerRequiredClaimLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileResourceServerRequiredClaimLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public OauthProfileResourceServerRequiredClaimLinks() { - } - - public OauthProfileResourceServerRequiredClaimLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Required Claim object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileResourceServerRequiredClaimLinks oauthProfileResourceServerRequiredClaimLinks = (OauthProfileResourceServerRequiredClaimLinks) o; - return Objects.equals(this.uri, oauthProfileResourceServerRequiredClaimLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileResourceServerRequiredClaimLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimResponse.java deleted file mode 100644 index cee8b6d36..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileResourceServerRequiredClaimResponse - */ -@JsonPropertyOrder({ - OauthProfileResourceServerRequiredClaimResponse.JSON_PROPERTY_DATA, - OauthProfileResourceServerRequiredClaimResponse.JSON_PROPERTY_LINKS, - OauthProfileResourceServerRequiredClaimResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileResourceServerRequiredClaimResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private OauthProfileResourceServerRequiredClaim data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private OauthProfileResourceServerRequiredClaimLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public OauthProfileResourceServerRequiredClaimResponse() { - } - - public OauthProfileResourceServerRequiredClaimResponse data(OauthProfileResourceServerRequiredClaim data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthProfileResourceServerRequiredClaim getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(OauthProfileResourceServerRequiredClaim data) { - this.data = data; - } - - - public OauthProfileResourceServerRequiredClaimResponse links(OauthProfileResourceServerRequiredClaimLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthProfileResourceServerRequiredClaimLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(OauthProfileResourceServerRequiredClaimLinks links) { - this.links = links; - } - - - public OauthProfileResourceServerRequiredClaimResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileResourceServerRequiredClaimResponse oauthProfileResourceServerRequiredClaimResponse = (OauthProfileResourceServerRequiredClaimResponse) o; - return Objects.equals(this.data, oauthProfileResourceServerRequiredClaimResponse.data) && - Objects.equals(this.links, oauthProfileResourceServerRequiredClaimResponse.links) && - Objects.equals(this.meta, oauthProfileResourceServerRequiredClaimResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileResourceServerRequiredClaimResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimsResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimsResponse.java deleted file mode 100644 index 1587aa183..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimsResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileResourceServerRequiredClaimsResponse - */ -@JsonPropertyOrder({ - OauthProfileResourceServerRequiredClaimsResponse.JSON_PROPERTY_DATA, - OauthProfileResourceServerRequiredClaimsResponse.JSON_PROPERTY_LINKS, - OauthProfileResourceServerRequiredClaimsResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileResourceServerRequiredClaimsResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public OauthProfileResourceServerRequiredClaimsResponse() { - } - - public OauthProfileResourceServerRequiredClaimsResponse data(List data) { - - this.data = data; - return this; - } - - public OauthProfileResourceServerRequiredClaimsResponse addDataItem(OauthProfileResourceServerRequiredClaim dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public OauthProfileResourceServerRequiredClaimsResponse links(List links) { - - this.links = links; - return this; - } - - public OauthProfileResourceServerRequiredClaimsResponse addLinksItem(OauthProfileResourceServerRequiredClaimLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public OauthProfileResourceServerRequiredClaimsResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileResourceServerRequiredClaimsResponse oauthProfileResourceServerRequiredClaimsResponse = (OauthProfileResourceServerRequiredClaimsResponse) o; - return Objects.equals(this.data, oauthProfileResourceServerRequiredClaimsResponse.data) && - Objects.equals(this.links, oauthProfileResourceServerRequiredClaimsResponse.links) && - Objects.equals(this.meta, oauthProfileResourceServerRequiredClaimsResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileResourceServerRequiredClaimsResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResponse.java deleted file mode 100644 index 4aba2ab7d..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfileResponse - */ -@JsonPropertyOrder({ - OauthProfileResponse.JSON_PROPERTY_DATA, - OauthProfileResponse.JSON_PROPERTY_LINKS, - OauthProfileResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfileResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private OauthProfile data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private OauthProfileLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public OauthProfileResponse() { - } - - public OauthProfileResponse data(OauthProfile data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthProfile getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(OauthProfile data) { - this.data = data; - } - - - public OauthProfileResponse links(OauthProfileLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public OauthProfileLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(OauthProfileLinks links) { - this.links = links; - } - - - public OauthProfileResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfileResponse oauthProfileResponse = (OauthProfileResponse) o; - return Objects.equals(this.data, oauthProfileResponse.data) && - Objects.equals(this.links, oauthProfileResponse.links) && - Objects.equals(this.meta, oauthProfileResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfileResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfilesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfilesResponse.java deleted file mode 100644 index 36834a429..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfilesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * OauthProfilesResponse - */ -@JsonPropertyOrder({ - OauthProfilesResponse.JSON_PROPERTY_DATA, - OauthProfilesResponse.JSON_PROPERTY_LINKS, - OauthProfilesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class OauthProfilesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public OauthProfilesResponse() { - } - - public OauthProfilesResponse data(List data) { - - this.data = data; - return this; - } - - public OauthProfilesResponse addDataItem(OauthProfile dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public OauthProfilesResponse links(List links) { - - this.links = links; - return this; - } - - public OauthProfilesResponse addLinksItem(OauthProfileLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public OauthProfilesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OauthProfilesResponse oauthProfilesResponse = (OauthProfilesResponse) o; - return Objects.equals(this.data, oauthProfilesResponse.data) && - Objects.equals(this.links, oauthProfilesResponse.links) && - Objects.equals(this.meta, oauthProfilesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OauthProfilesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempError.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempError.java deleted file mode 100644 index baec7a984..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempError.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * SempError - */ -@JsonPropertyOrder({ - SempError.JSON_PROPERTY_CODE, - SempError.JSON_PROPERTY_DESCRIPTION, - SempError.JSON_PROPERTY_STATUS -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class SempError { - public static final String JSON_PROPERTY_CODE = "code"; - private Integer code; - - public static final String JSON_PROPERTY_DESCRIPTION = "description"; - private String description; - - public static final String JSON_PROPERTY_STATUS = "status"; - private String status; - - public SempError() { - } - - public SempError code(Integer code) { - - this.code = code; - return this; - } - - /** - * The error code which uniquely identifies the error that has occurred. - * @return code - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_CODE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public Integer getCode() { - return code; - } - - - @JsonProperty(JSON_PROPERTY_CODE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setCode(Integer code) { - this.code = code; - } - - - public SempError description(String description) { - - this.description = description; - return this; - } - - /** - * The verbose description of the problem. - * @return description - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getDescription() { - return description; - } - - - @JsonProperty(JSON_PROPERTY_DESCRIPTION) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setDescription(String description) { - this.description = description; - } - - - public SempError status(String status) { - - this.status = status; - return this; - } - - /** - * The terse status string associated with `code`. - * @return status - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_STATUS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getStatus() { - return status; - } - - - @JsonProperty(JSON_PROPERTY_STATUS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setStatus(String status) { - this.status = status; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - SempError sempError = (SempError) o; - return Objects.equals(this.code, sempError.code) && - Objects.equals(this.description, sempError.description) && - Objects.equals(this.status, sempError.status); - } - - @Override - public int hashCode() { - return Objects.hash(code, description, status); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class SempError {\n"); - sb.append(" code: ").append(toIndentedString(code)).append("\n"); - sb.append(" description: ").append(toIndentedString(description)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempMeta.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempMeta.java deleted file mode 100644 index fabb55833..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempMeta.java +++ /dev/null @@ -1,235 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempError; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempPaging; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempRequest; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * SempMeta - */ -@JsonPropertyOrder({ - SempMeta.JSON_PROPERTY_COUNT, - SempMeta.JSON_PROPERTY_ERROR, - SempMeta.JSON_PROPERTY_PAGING, - SempMeta.JSON_PROPERTY_REQUEST, - SempMeta.JSON_PROPERTY_RESPONSE_CODE -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class SempMeta { - public static final String JSON_PROPERTY_COUNT = "count"; - private Long count; - - public static final String JSON_PROPERTY_ERROR = "error"; - private SempError error; - - public static final String JSON_PROPERTY_PAGING = "paging"; - private SempPaging paging; - - public static final String JSON_PROPERTY_REQUEST = "request"; - private SempRequest request; - - public static final String JSON_PROPERTY_RESPONSE_CODE = "responseCode"; - private Integer responseCode; - - public SempMeta() { - } - - public SempMeta count(Long count) { - - this.count = count; - return this; - } - - /** - * The total number of objects requested, irrespective of page size. This may be a count of all objects in a collection or a filtered subset. It represents a snapshot in time and may change when paging through results. - * @return count - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Long getCount() { - return count; - } - - - @JsonProperty(JSON_PROPERTY_COUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCount(Long count) { - this.count = count; - } - - - public SempMeta error(SempError error) { - - this.error = error; - return this; - } - - /** - * Get error - * @return error - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ERROR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public SempError getError() { - return error; - } - - - @JsonProperty(JSON_PROPERTY_ERROR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setError(SempError error) { - this.error = error; - } - - - public SempMeta paging(SempPaging paging) { - - this.paging = paging; - return this; - } - - /** - * Get paging - * @return paging - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PAGING) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public SempPaging getPaging() { - return paging; - } - - - @JsonProperty(JSON_PROPERTY_PAGING) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPaging(SempPaging paging) { - this.paging = paging; - } - - - public SempMeta request(SempRequest request) { - - this.request = request; - return this; - } - - /** - * Get request - * @return request - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_REQUEST) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempRequest getRequest() { - return request; - } - - - @JsonProperty(JSON_PROPERTY_REQUEST) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setRequest(SempRequest request) { - this.request = request; - } - - - public SempMeta responseCode(Integer responseCode) { - - this.responseCode = responseCode; - return this; - } - - /** - * The HTTP response code, one of 200 (success), 4xx (client error), or 5xx (server error). - * @return responseCode - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_RESPONSE_CODE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public Integer getResponseCode() { - return responseCode; - } - - - @JsonProperty(JSON_PROPERTY_RESPONSE_CODE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setResponseCode(Integer responseCode) { - this.responseCode = responseCode; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - SempMeta sempMeta = (SempMeta) o; - return Objects.equals(this.count, sempMeta.count) && - Objects.equals(this.error, sempMeta.error) && - Objects.equals(this.paging, sempMeta.paging) && - Objects.equals(this.request, sempMeta.request) && - Objects.equals(this.responseCode, sempMeta.responseCode); - } - - @Override - public int hashCode() { - return Objects.hash(count, error, paging, request, responseCode); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class SempMeta {\n"); - sb.append(" count: ").append(toIndentedString(count)).append("\n"); - sb.append(" error: ").append(toIndentedString(error)).append("\n"); - sb.append(" paging: ").append(toIndentedString(paging)).append("\n"); - sb.append(" request: ").append(toIndentedString(request)).append("\n"); - sb.append(" responseCode: ").append(toIndentedString(responseCode)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempMetaOnlyResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempMetaOnlyResponse.java deleted file mode 100644 index 4ad60ae88..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempMetaOnlyResponse.java +++ /dev/null @@ -1,105 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * SempMetaOnlyResponse - */ -@JsonPropertyOrder({ - SempMetaOnlyResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class SempMetaOnlyResponse { - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public SempMetaOnlyResponse() { - } - - public SempMetaOnlyResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - SempMetaOnlyResponse sempMetaOnlyResponse = (SempMetaOnlyResponse) o; - return Objects.equals(this.meta, sempMetaOnlyResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class SempMetaOnlyResponse {\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempPaging.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempPaging.java deleted file mode 100644 index a00a2b438..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempPaging.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * SempPaging - */ -@JsonPropertyOrder({ - SempPaging.JSON_PROPERTY_CURSOR_QUERY, - SempPaging.JSON_PROPERTY_NEXT_PAGE_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class SempPaging { - public static final String JSON_PROPERTY_CURSOR_QUERY = "cursorQuery"; - private String cursorQuery; - - public static final String JSON_PROPERTY_NEXT_PAGE_URI = "nextPageUri"; - private String nextPageUri; - - public SempPaging() { - } - - public SempPaging cursorQuery(String cursorQuery) { - - this.cursorQuery = cursorQuery; - return this; - } - - /** - * The cursor, or position, for the next page of objects. Use this as the `cursor` query parameter of the next request. - * @return cursorQuery - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_CURSOR_QUERY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getCursorQuery() { - return cursorQuery; - } - - - @JsonProperty(JSON_PROPERTY_CURSOR_QUERY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setCursorQuery(String cursorQuery) { - this.cursorQuery = cursorQuery; - } - - - public SempPaging nextPageUri(String nextPageUri) { - - this.nextPageUri = nextPageUri; - return this; - } - - /** - * The URI of the next page of objects. `cursorQuery` is already embedded within this URI. - * @return nextPageUri - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_NEXT_PAGE_URI) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getNextPageUri() { - return nextPageUri; - } - - - @JsonProperty(JSON_PROPERTY_NEXT_PAGE_URI) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setNextPageUri(String nextPageUri) { - this.nextPageUri = nextPageUri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - SempPaging sempPaging = (SempPaging) o; - return Objects.equals(this.cursorQuery, sempPaging.cursorQuery) && - Objects.equals(this.nextPageUri, sempPaging.nextPageUri); - } - - @Override - public int hashCode() { - return Objects.hash(cursorQuery, nextPageUri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class SempPaging {\n"); - sb.append(" cursorQuery: ").append(toIndentedString(cursorQuery)).append("\n"); - sb.append(" nextPageUri: ").append(toIndentedString(nextPageUri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempRequest.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempRequest.java deleted file mode 100644 index 60266545b..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempRequest.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * SempRequest - */ -@JsonPropertyOrder({ - SempRequest.JSON_PROPERTY_METHOD, - SempRequest.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class SempRequest { - public static final String JSON_PROPERTY_METHOD = "method"; - private String method; - - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public SempRequest() { - } - - public SempRequest method(String method) { - - this.method = method; - return this; - } - - /** - * The HTTP method of the request which resulted in this response. - * @return method - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_METHOD) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getMethod() { - return method; - } - - - @JsonProperty(JSON_PROPERTY_METHOD) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMethod(String method) { - this.method = method; - } - - - public SempRequest uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of the request which resulted in this response. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - SempRequest sempRequest = (SempRequest) o; - return Objects.equals(this.method, sempRequest.method) && - Objects.equals(this.uri, sempRequest.uri); - } - - @Override - public int hashCode() { - return Objects.hash(method, uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class SempRequest {\n"); - sb.append(" method: ").append(toIndentedString(method)).append("\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformation.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformation.java deleted file mode 100644 index 280e66f20..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformation.java +++ /dev/null @@ -1,136 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * SystemInformation - */ -@JsonPropertyOrder({ - SystemInformation.JSON_PROPERTY_PLATFORM, - SystemInformation.JSON_PROPERTY_SEMP_VERSION -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class SystemInformation { - public static final String JSON_PROPERTY_PLATFORM = "platform"; - private String platform; - - public static final String JSON_PROPERTY_SEMP_VERSION = "sempVersion"; - private String sempVersion; - - public SystemInformation() { - } - - public SystemInformation platform(String platform) { - - this.platform = platform; - return this; - } - - /** - * The platform running the SEMP API. Deprecated since 2.2. /systemInformation was replaced by /about/api. - * @return platform - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_PLATFORM) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getPlatform() { - return platform; - } - - - @JsonProperty(JSON_PROPERTY_PLATFORM) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPlatform(String platform) { - this.platform = platform; - } - - - public SystemInformation sempVersion(String sempVersion) { - - this.sempVersion = sempVersion; - return this; - } - - /** - * The version of the SEMP API. Deprecated since 2.2. /systemInformation was replaced by /about/api. - * @return sempVersion - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SEMP_VERSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSempVersion() { - return sempVersion; - } - - - @JsonProperty(JSON_PROPERTY_SEMP_VERSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSempVersion(String sempVersion) { - this.sempVersion = sempVersion; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - SystemInformation systemInformation = (SystemInformation) o; - return Objects.equals(this.platform, systemInformation.platform) && - Objects.equals(this.sempVersion, systemInformation.sempVersion); - } - - @Override - public int hashCode() { - return Objects.hash(platform, sempVersion); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class SystemInformation {\n"); - sb.append(" platform: ").append(toIndentedString(platform)).append("\n"); - sb.append(" sempVersion: ").append(toIndentedString(sempVersion)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationLinks.java deleted file mode 100644 index 396171b4a..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * SystemInformationLinks - */ -@JsonPropertyOrder({ - SystemInformationLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class SystemInformationLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public SystemInformationLinks() { - } - - public SystemInformationLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this System Information object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - SystemInformationLinks systemInformationLinks = (SystemInformationLinks) o; - return Objects.equals(this.uri, systemInformationLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class SystemInformationLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationResponse.java deleted file mode 100644 index 4f58e13b8..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SystemInformation; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SystemInformationLinks; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * SystemInformationResponse - */ -@JsonPropertyOrder({ - SystemInformationResponse.JSON_PROPERTY_DATA, - SystemInformationResponse.JSON_PROPERTY_LINKS, - SystemInformationResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class SystemInformationResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private SystemInformation data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private SystemInformationLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public SystemInformationResponse() { - } - - public SystemInformationResponse data(SystemInformation data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public SystemInformation getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(SystemInformation data) { - this.data = data; - } - - - public SystemInformationResponse links(SystemInformationLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public SystemInformationLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(SystemInformationLinks links) { - this.links = links; - } - - - public SystemInformationResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - SystemInformationResponse systemInformationResponse = (SystemInformationResponse) o; - return Objects.equals(this.data, systemInformationResponse.data) && - Objects.equals(this.links, systemInformationResponse.links) && - Objects.equals(this.meta, systemInformationResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class SystemInformationResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostname.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostname.java deleted file mode 100644 index 7166eda02..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostname.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * VirtualHostname - */ -@JsonPropertyOrder({ - VirtualHostname.JSON_PROPERTY_ENABLED, - VirtualHostname.JSON_PROPERTY_MSG_VPN_NAME, - VirtualHostname.JSON_PROPERTY_VIRTUAL_HOSTNAME -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class VirtualHostname { - public static final String JSON_PROPERTY_ENABLED = "enabled"; - private Boolean enabled; - - public static final String JSON_PROPERTY_MSG_VPN_NAME = "msgVpnName"; - private String msgVpnName; - - public static final String JSON_PROPERTY_VIRTUAL_HOSTNAME = "virtualHostname"; - private String virtualHostname; - - public VirtualHostname() { - } - - public VirtualHostname enabled(Boolean enabled) { - - this.enabled = enabled; - return this; - } - - /** - * Enable or disable Virtual Hostname to Message VPN mapping. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - * @return enabled - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getEnabled() { - return enabled; - } - - - @JsonProperty(JSON_PROPERTY_ENABLED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - - public VirtualHostname msgVpnName(String msgVpnName) { - - this.msgVpnName = msgVpnName; - return this; - } - - /** - * The message VPN to which this virtual hostname is mapped. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. - * @return msgVpnName - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getMsgVpnName() { - return msgVpnName; - } - - - @JsonProperty(JSON_PROPERTY_MSG_VPN_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMsgVpnName(String msgVpnName) { - this.msgVpnName = msgVpnName; - } - - - public VirtualHostname virtualHostname(String virtualHostname) { - - this.virtualHostname = virtualHostname; - return this; - } - - /** - * The virtual hostname. - * @return virtualHostname - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_VIRTUAL_HOSTNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getVirtualHostname() { - return virtualHostname; - } - - - @JsonProperty(JSON_PROPERTY_VIRTUAL_HOSTNAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setVirtualHostname(String virtualHostname) { - this.virtualHostname = virtualHostname; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - VirtualHostname virtualHostname = (VirtualHostname) o; - return Objects.equals(this.enabled, virtualHostname.enabled) && - Objects.equals(this.msgVpnName, virtualHostname.msgVpnName) && - Objects.equals(this.virtualHostname, virtualHostname.virtualHostname); - } - - @Override - public int hashCode() { - return Objects.hash(enabled, msgVpnName, virtualHostname); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class VirtualHostname {\n"); - sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" msgVpnName: ").append(toIndentedString(msgVpnName)).append("\n"); - sb.append(" virtualHostname: ").append(toIndentedString(virtualHostname)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameLinks.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameLinks.java deleted file mode 100644 index 15ec41b34..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameLinks.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * VirtualHostnameLinks - */ -@JsonPropertyOrder({ - VirtualHostnameLinks.JSON_PROPERTY_URI -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class VirtualHostnameLinks { - public static final String JSON_PROPERTY_URI = "uri"; - private String uri; - - public VirtualHostnameLinks() { - } - - public VirtualHostnameLinks uri(String uri) { - - this.uri = uri; - return this; - } - - /** - * The URI of this Virtual Hostname object. - * @return uri - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getUri() { - return uri; - } - - - @JsonProperty(JSON_PROPERTY_URI) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUri(String uri) { - this.uri = uri; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - VirtualHostnameLinks virtualHostnameLinks = (VirtualHostnameLinks) o; - return Objects.equals(this.uri, virtualHostnameLinks.uri); - } - - @Override - public int hashCode() { - return Objects.hash(uri); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class VirtualHostnameLinks {\n"); - sb.append(" uri: ").append(toIndentedString(uri)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameResponse.java deleted file mode 100644 index bed6385c6..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameResponse.java +++ /dev/null @@ -1,171 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostname; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostnameLinks; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * VirtualHostnameResponse - */ -@JsonPropertyOrder({ - VirtualHostnameResponse.JSON_PROPERTY_DATA, - VirtualHostnameResponse.JSON_PROPERTY_LINKS, - VirtualHostnameResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class VirtualHostnameResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private VirtualHostname data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private VirtualHostnameLinks links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public VirtualHostnameResponse() { - } - - public VirtualHostnameResponse data(VirtualHostname data) { - - this.data = data; - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public VirtualHostname getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(VirtualHostname data) { - this.data = data; - } - - - public VirtualHostnameResponse links(VirtualHostnameLinks links) { - - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public VirtualHostnameLinks getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(VirtualHostnameLinks links) { - this.links = links; - } - - - public VirtualHostnameResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - VirtualHostnameResponse virtualHostnameResponse = (VirtualHostnameResponse) o; - return Objects.equals(this.data, virtualHostnameResponse.data) && - Objects.equals(this.links, virtualHostnameResponse.links) && - Objects.equals(this.meta, virtualHostnameResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class VirtualHostnameResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnamesResponse.java b/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnamesResponse.java deleted file mode 100644 index d229c58ac..000000000 --- a/service/solace-config-client/src/main/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnamesResponse.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import java.util.Objects; -import java.util.Arrays; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostname; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostnameLinks; -import java.util.ArrayList; -import java.util.List; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonTypeName; - -/** - * VirtualHostnamesResponse - */ -@JsonPropertyOrder({ - VirtualHostnamesResponse.JSON_PROPERTY_DATA, - VirtualHostnamesResponse.JSON_PROPERTY_LINKS, - VirtualHostnamesResponse.JSON_PROPERTY_META -}) -@JsonInclude(JsonInclude.Include.NON_NULL) -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-05-17T23:49:01.929728+01:00[Europe/London]") -public class VirtualHostnamesResponse { - public static final String JSON_PROPERTY_DATA = "data"; - private List data; - - public static final String JSON_PROPERTY_LINKS = "links"; - private List links; - - public static final String JSON_PROPERTY_META = "meta"; - private SempMeta meta; - - public VirtualHostnamesResponse() { - } - - public VirtualHostnamesResponse data(List data) { - - this.data = data; - return this; - } - - public VirtualHostnamesResponse addDataItem(VirtualHostname dataItem) { - if (this.data == null) { - this.data = new ArrayList<>(); - } - this.data.add(dataItem); - return this; - } - - /** - * Get data - * @return data - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getData() { - return data; - } - - - @JsonProperty(JSON_PROPERTY_DATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setData(List data) { - this.data = data; - } - - - public VirtualHostnamesResponse links(List links) { - - this.links = links; - return this; - } - - public VirtualHostnamesResponse addLinksItem(VirtualHostnameLinks linksItem) { - if (this.links == null) { - this.links = new ArrayList<>(); - } - this.links.add(linksItem); - return this; - } - - /** - * Get links - * @return links - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getLinks() { - return links; - } - - - @JsonProperty(JSON_PROPERTY_LINKS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinks(List links) { - this.links = links; - } - - - public VirtualHostnamesResponse meta(SempMeta meta) { - - this.meta = meta; - return this; - } - - /** - * Get meta - * @return meta - **/ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public SempMeta getMeta() { - return meta; - } - - - @JsonProperty(JSON_PROPERTY_META) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setMeta(SempMeta meta) { - this.meta = meta; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - VirtualHostnamesResponse virtualHostnamesResponse = (VirtualHostnamesResponse) o; - return Objects.equals(this.data, virtualHostnamesResponse.data) && - Objects.equals(this.links, virtualHostnamesResponse.links) && - Objects.equals(this.meta, virtualHostnamesResponse.meta); - } - - @Override - public int hashCode() { - return Objects.hash(data, links, meta); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class VirtualHostnamesResponse {\n"); - sb.append(" data: ").append(toIndentedString(data)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" meta: ").append(toIndentedString(meta)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/service/solace-config-client/src/main/resources/sempv2_spec.json b/service/solace-config-client/src/main/resources/sempv2_spec.json new file mode 100644 index 000000000..47ef14cfc --- /dev/null +++ b/service/solace-config-client/src/main/resources/sempv2_spec.json @@ -0,0 +1,31877 @@ +{ + "basePath": "/SEMP/v2/config", + "consumes": [ + "application/json" + ], + "definitions": { + "About": { + "properties": {}, + "type": "object" + }, + "AboutApi": { + "properties": { + "platform": { + "description": "The platform running the SEMP API.", + "type": "string" + }, + "sempVersion": { + "description": "The version of the SEMP API.", + "type": "string" + } + }, + "type": "object" + }, + "AboutApiLinks": { + "properties": { + "uri": { + "description": "The URI of this API Description object.", + "type": "string" + } + }, + "type": "object" + }, + "AboutApiResponse": { + "properties": { + "data": { + "$ref": "#/definitions/AboutApi" + }, + "links": { + "$ref": "#/definitions/AboutApiLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "AboutLinks": { + "properties": { + "apiUri": { + "description": "The URI of this About's API Description object. Available since 2.2.", + "type": "string" + }, + "uri": { + "description": "The URI of this About object.", + "type": "string" + }, + "userUri": { + "description": "The URI of this About's User object. Available since 2.2.", + "type": "string" + } + }, + "type": "object" + }, + "AboutResponse": { + "properties": { + "data": { + "$ref": "#/definitions/About" + }, + "links": { + "$ref": "#/definitions/AboutLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "AboutUser": { + "properties": { + "globalAccessLevel": { + "description": "The global access level of the User. The allowed values and their meaning are:\n\n
\n\"admin\" - Full administrative access.\n\"none\" - No access.\n\"read-only\" - Read only access.\n\"read-write\" - Read and write access.\n
\n", + "enum": [ + "admin", + "none", + "read-only", + "read-write" + ], + "type": "string" + }, + "sessionActive": { + "description": "Indicates whether a session is active for this request. Available since 2.24.", + "type": "boolean" + }, + "sessionCreateTime": { + "description": "The timestamp of when the session was created. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21.", + "format": "int32", + "type": "integer" + }, + "sessionCurrentTime": { + "description": "The current server timestamp. This is provided as a reference point for the other timestamps provided. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21.", + "format": "int32", + "type": "integer" + }, + "sessionHardExpiryTime": { + "description": "The hard expiry time for the session. After this time the session will be invalid, regardless of activity. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21.", + "format": "int32", + "type": "integer" + }, + "sessionId": { + "description": "An identifier for the session to differentiate this session from other sessions for the same user. This value is not guaranteed to be unique between active sessions for different users. This attribute may not be returned in a GET. Available since 2.21.", + "type": "string" + }, + "sessionIdleExpiryTime": { + "description": "The session idle expiry time. After this time the session will be invalid if there has been no activity. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since 2.21.", + "format": "int32", + "type": "integer" + }, + "username": { + "description": "The username of the User. Available since 2.21.", + "type": "string" + } + }, + "type": "object" + }, + "AboutUserLinks": { + "properties": { + "msgVpnsUri": { + "description": "The URI of this User's collection of User Message VPN objects.", + "type": "string" + }, + "uri": { + "description": "The URI of this User object.", + "type": "string" + } + }, + "type": "object" + }, + "AboutUserMsgVpn": { + "properties": { + "accessLevel": { + "description": "The Message VPN access level of the User. The allowed values and their meaning are:\n\n
\n\"none\" - No access.\n\"read-only\" - Read only access.\n\"read-write\" - Read and write access.\n
\n", + "enum": [ + "none", + "read-only", + "read-write" + ], + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + } + }, + "type": "object" + }, + "AboutUserMsgVpnLinks": { + "properties": { + "uri": { + "description": "The URI of this User Message VPN object.", + "type": "string" + } + }, + "type": "object" + }, + "AboutUserMsgVpnResponse": { + "properties": { + "data": { + "$ref": "#/definitions/AboutUserMsgVpn" + }, + "links": { + "$ref": "#/definitions/AboutUserMsgVpnLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "AboutUserMsgVpnsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/AboutUserMsgVpn" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/AboutUserMsgVpnLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "AboutUserResponse": { + "properties": { + "data": { + "$ref": "#/definitions/AboutUser" + }, + "links": { + "$ref": "#/definitions/AboutUserLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "Broker": { + "properties": { + "authClientCertRevocationCheckMode": { + "description": "The client certificate revocation checking mode used when a client authenticates with a client certificate. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Do not perform any certificate revocation checking.\n\"ocsp\" - Use the Open Certificate Status Protcol (OCSP) for certificate revocation checking.\n\"crl\" - Use Certificate Revocation Lists (CRL) for certificate revocation checking.\n\"ocsp-crl\" - Use OCSP first, but if OCSP fails to return an unambiguous result, then check via CRL.\n
\n", + "enum": [ + "none", + "ocsp", + "crl", + "ocsp-crl" + ], + "type": "string" + }, + "configSyncAuthenticationClientCertMaxChainDepth": { + "description": "The maximum depth for a client certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. The default value is `3`. Available since 2.22.", + "format": "int64", + "type": "integer" + }, + "configSyncAuthenticationClientCertValidateDateEnabled": { + "description": "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the authentication certificate(s). The default value is `true`. Available since 2.22.", + "type": "boolean" + }, + "configSyncClientProfileTcpInitialCongestionWindow": { + "description": "The TCP initial congestion window size for Config Sync clients, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. The default value is `2`. Available since 2.22.", + "format": "int64", + "type": "integer" + }, + "configSyncClientProfileTcpKeepaliveCount": { + "description": "The number of TCP keepalive retransmissions to a client using the Client Profile before declaring that it is not available. The default value is `5`. Available since 2.22.", + "format": "int64", + "type": "integer" + }, + "configSyncClientProfileTcpKeepaliveIdle": { + "description": "The amount of time a client connection using the Client Profile must remain idle before TCP begins sending keepalive probes, in seconds. The default value is `3`. Available since 2.22.", + "format": "int64", + "type": "integer" + }, + "configSyncClientProfileTcpKeepaliveInterval": { + "description": "The amount of time between TCP keepalive retransmissions to a client using the Client Profile when no acknowledgement is received, in seconds. The default value is `1`. Available since 2.22.", + "format": "int64", + "type": "integer" + }, + "configSyncClientProfileTcpMaxWindow": { + "description": "The TCP maximum window size for clients using the Client Profile, in kilobytes. Changes are applied to all existing connections. The default value is `256`. Available since 2.22.", + "format": "int64", + "type": "integer" + }, + "configSyncClientProfileTcpMss": { + "description": "The TCP maximum segment size for clients using the Client Profile, in bytes. Changes are applied to all existing connections. The default value is `1460`. Available since 2.22.", + "format": "int64", + "type": "integer" + }, + "configSyncEnabled": { + "description": "Enable or disable configuration synchronization for High Availability or Disaster Recovery. The default value is `false`. Available since 2.22.", + "type": "boolean" + }, + "configSyncSynchronizeUsernameEnabled": { + "description": "Enable or disable the synchronizing of usernames within High Availability groups. The transition from not synchronizing to synchronizing will cause the High Availability mate to fall out of sync. Recommendation: leave this as enabled. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.22.", + "type": "boolean" + }, + "configSyncTlsEnabled": { + "description": "Enable or disable the use of TLS encryption of the configuration synchronization communications between brokers in High Availability groups and/or Disaster Recovery sites. The default value is `false`. Available since 2.22.", + "type": "boolean" + }, + "guaranteedMsgingDefragmentationScheduleDayList": { + "description": "The days of the week to schedule defragmentation runs, specified as \"daily\" or as a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri, or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. Please note \"Sun,Mon,Tue,Wed,Thu,Fri,Sat\" is not allowed, use \"daily\" instead. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"daily\"`. Available since 2.25.", + "type": "string" + }, + "guaranteedMsgingDefragmentationScheduleEnabled": { + "description": "Enable or disable schedule-based defragmentation of Guaranteed Messaging spool files. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.25.", + "type": "boolean" + }, + "guaranteedMsgingDefragmentationScheduleTimeList": { + "description": "The times of the day to schedule defragmentation runs, specified as \"hourly\" or as a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"0:00\"`. Available since 2.25.", + "type": "string" + }, + "guaranteedMsgingDefragmentationThresholdEnabled": { + "description": "Enable or disable threshold-based defragmentation of Guaranteed Messaging spool files. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.25.", + "type": "boolean" + }, + "guaranteedMsgingDefragmentationThresholdFragmentationPercentage": { + "description": "Percentage of spool fragmentation needed to trigger defragmentation run. The minimum value allowed is 30%. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `50`. Available since 2.25.", + "format": "int64", + "type": "integer" + }, + "guaranteedMsgingDefragmentationThresholdMinInterval": { + "description": "Minimum interval of time (in minutes) between defragmentation runs triggered by thresholds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `15`. Available since 2.25.", + "format": "int64", + "type": "integer" + }, + "guaranteedMsgingDefragmentationThresholdUsagePercentage": { + "description": "Percentage of spool usage needed to trigger defragmentation run. The minimum value allowed is 30%. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `50`. Available since 2.25.", + "format": "int64", + "type": "integer" + }, + "guaranteedMsgingEnabled": { + "description": "Enable or disable Guaranteed Messaging. The default value is `false`. Available since 2.18.", + "type": "boolean" + }, + "guaranteedMsgingEventCacheUsageThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "guaranteedMsgingEventDeliveredUnackedThreshold": { + "$ref": "#/definitions/EventThresholdByPercent" + }, + "guaranteedMsgingEventDiskUsageThreshold": { + "$ref": "#/definitions/EventThresholdByPercent" + }, + "guaranteedMsgingEventEgressFlowCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "guaranteedMsgingEventEndpointCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "guaranteedMsgingEventIngressFlowCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "guaranteedMsgingEventMsgCountThreshold": { + "$ref": "#/definitions/EventThresholdByPercent" + }, + "guaranteedMsgingEventMsgSpoolFileCountThreshold": { + "$ref": "#/definitions/EventThresholdByPercent" + }, + "guaranteedMsgingEventMsgSpoolUsageThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "guaranteedMsgingEventTransactedSessionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "guaranteedMsgingEventTransactedSessionResourceCountThreshold": { + "$ref": "#/definitions/EventThresholdByPercent" + }, + "guaranteedMsgingEventTransactionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "guaranteedMsgingMaxCacheUsage": { + "description": "Guaranteed messaging cache usage limit. Expressed as a maximum percentage of the NAB's egress queueing. resources that the guaranteed message cache is allowed to use. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `10`. Available since 2.18.", + "format": "int32", + "type": "integer" + }, + "guaranteedMsgingMaxMsgSpoolUsage": { + "description": "The maximum total message spool usage allowed across all VPNs on this broker, in megabytes. Recommendation: the maximum value should be less than 90% of the disk space allocated for the guaranteed message spool. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1500`. Available since 2.18.", + "format": "int64", + "type": "integer" + }, + "guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout": { + "description": "The maximum time, in milliseconds, that can be tolerated for remote acknowledgement of synchronization messages before which the remote system will be considered out of sync. The default value is `10000`. Available since 2.18.", + "format": "int64", + "type": "integer" + }, + "guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout": { + "description": "The maximum time, in milliseconds, that can be tolerated for remote disk writes before which the remote system will be considered out of sync. The default value is `10000`. Available since 2.18.", + "format": "int64", + "type": "integer" + }, + "guaranteedMsgingTransactionReplicationCompatibilityMode": { + "description": "The replication compatibility mode for the router. The default value is `\"legacy\"`. The allowed values and their meaning are:\"legacy\" - All transactions originated by clients are replicated to the standby site without using transactions.\"transacted\" - All transactions originated by clients are replicated to the standby site using transactions. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"legacy\"`. The allowed values and their meaning are:\n\n
\n\"legacy\" - All transactions originated by clients are replicated to the standby site without using transactions.\n\"transacted\" - All transactions originated by clients are replicated to the standby site using transactions.\n
\n Available since 2.18.", + "enum": [ + "legacy", + "transacted" + ], + "type": "string" + }, + "oauthProfileDefault": { + "description": "The default OAuth profile for OAuth authenticated SEMP requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Available since 2.24.", + "type": "string" + }, + "serviceAmqpEnabled": { + "description": "Enable or disable the AMQP service. When disabled new AMQP Clients may not connect through the global or per-VPN AMQP listen-ports, and all currently connected AMQP Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.", + "type": "boolean" + }, + "serviceAmqpTlsListenPort": { + "description": "TCP port number that AMQP clients can use to connect to the broker using raw TCP over TLS. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since 2.17.", + "format": "int64", + "type": "integer" + }, + "serviceEventConnectionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "serviceHealthCheckEnabled": { + "description": "Enable or disable the health-check service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.", + "type": "boolean" + }, + "serviceHealthCheckListenPort": { + "description": "The port number for the health-check service. The port must be unique across the message backbone. The health-check service must be disabled to change the port. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5550`. Available since 2.17.", + "format": "int64", + "type": "integer" + }, + "serviceMateLinkEnabled": { + "description": "Enable or disable the mate-link service. The default value is `true`. Available since 2.17.", + "type": "boolean" + }, + "serviceMateLinkListenPort": { + "description": "The port number for the mate-link service. The port must be unique across the message backbone. The mate-link service must be disabled to change the port. The default value is `8741`. Available since 2.17.", + "format": "int64", + "type": "integer" + }, + "serviceMqttEnabled": { + "description": "Enable or disable the MQTT service. When disabled new MQTT Clients may not connect through the per-VPN MQTT listen-ports, and all currently connected MQTT Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.", + "type": "boolean" + }, + "serviceMsgBackboneEnabled": { + "description": "Enable or disable the msg-backbone service. When disabled new Clients may not connect through global or per-VPN listen-ports, and all currently connected Clients are immediately disconnected. The default value is `true`. Available since 2.17.", + "type": "boolean" + }, + "serviceRedundancyEnabled": { + "description": "Enable or disable the redundancy service. The default value is `true`. Available since 2.17.", + "type": "boolean" + }, + "serviceRedundancyFirstListenPort": { + "description": "The first listen-port used for the redundancy service. Redundancy uses this port and the subsequent 2 ports. These port must be unique across the message backbone. The redundancy service must be disabled to change this port. The default value is `8300`. Available since 2.17.", + "format": "int64", + "type": "integer" + }, + "serviceRestEventOutgoingConnectionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "serviceRestIncomingEnabled": { + "description": "Enable or disable the REST service incoming connections on the router. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.", + "type": "boolean" + }, + "serviceRestOutgoingEnabled": { + "description": "Enable or disable the REST service outgoing connections on the router. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.", + "type": "boolean" + }, + "serviceSempCorsAllowAnyHostEnabled": { + "description": "Enable or disable cross origin resource requests for the SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.24.", + "type": "boolean" + }, + "serviceSempLegacyTimeoutEnabled": { + "description": "Enable or disable extended SEMP timeouts for paged GETs. When a request times out, it returns the current page of content, even if the page is not full. When enabled, the timeout is 60 seconds. When disabled, the timeout is 5 seconds. The recommended setting is disabled (no legacy-timeout). This parameter is intended as a temporary workaround to be used until SEMP clients can handle short pages. This setting will be removed in a future release. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.18.", + "type": "boolean" + }, + "serviceSempPlainTextEnabled": { + "description": "Enable or disable plain-text SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.17.", + "type": "boolean" + }, + "serviceSempPlainTextListenPort": { + "description": "The TCP port for plain-text SEMP client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `80`. Available since 2.17.", + "format": "int64", + "type": "integer" + }, + "serviceSempSessionIdleTimeout": { + "description": "The session idle timeout, in minutes. Sessions will be invalidated if there is no activity in this period of time. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `15`. Available since 2.21.", + "format": "int32", + "type": "integer" + }, + "serviceSempSessionMaxLifetime": { + "description": "The maximum lifetime of a session, in minutes. Sessions will be invalidated after this period of time, regardless of activity. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `43200`. Available since 2.21.", + "format": "int32", + "type": "integer" + }, + "serviceSempTlsEnabled": { + "description": "Enable or disable TLS SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.17.", + "type": "boolean" + }, + "serviceSempTlsListenPort": { + "description": "The TCP port for TLS SEMP client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1943`. Available since 2.17.", + "format": "int64", + "type": "integer" + }, + "serviceSmfCompressionListenPort": { + "description": "TCP port number that SMF clients can use to connect to the broker using raw compression TCP. The default value is `55003`. Available since 2.17.", + "format": "int64", + "type": "integer" + }, + "serviceSmfEnabled": { + "description": "Enable or disable the SMF service. When disabled new SMF Clients may not connect through the global listen-ports, and all currently connected SMF Clients are immediately disconnected. The default value is `true`. Available since 2.17.", + "type": "boolean" + }, + "serviceSmfEventConnectionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "serviceSmfPlainTextListenPort": { + "description": "TCP port number that SMF clients can use to connect to the broker using raw TCP. The default value is `55555`. Available since 2.17.", + "format": "int64", + "type": "integer" + }, + "serviceSmfRoutingControlListenPort": { + "description": "TCP port number that SMF clients can use to connect to the broker using raw routing control TCP. The default value is `55556`. Available since 2.17.", + "format": "int64", + "type": "integer" + }, + "serviceSmfTlsListenPort": { + "description": "TCP port number that SMF clients can use to connect to the broker using raw TCP over TLS. The default value is `55443`. Available since 2.17.", + "format": "int64", + "type": "integer" + }, + "serviceTlsEventConnectionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "serviceWebTransportEnabled": { + "description": "Enable or disable the web-transport service. When disabled new web-transport Clients may not connect through the global listen-ports, and all currently connected web-transport Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.", + "type": "boolean" + }, + "serviceWebTransportPlainTextListenPort": { + "description": "The TCP port for plain-text WEB client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `8008`. Available since 2.17.", + "format": "int64", + "type": "integer" + }, + "serviceWebTransportTlsListenPort": { + "description": "The TCP port for TLS WEB client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1443`. Available since 2.17.", + "format": "int64", + "type": "integer" + }, + "serviceWebTransportWebUrlSuffix": { + "description": "Used to specify the Web URL suffix that will be used by Web clients when communicating with the broker. The default value is `\"\"`. Available since 2.17.", + "type": "string" + }, + "tlsBlockVersion11Enabled": { + "description": "Enable or disable the blocking of TLS version 1.1 connections. When blocked, all existing incoming and outgoing TLS 1.1 connections with Clients, SEMP users, and LDAP servers remain connected while new connections are blocked. Note that support for TLS 1.1 will eventually be discontinued, at which time TLS 1.1 connections will be blocked regardless of this setting. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean" + }, + "tlsCipherSuiteManagementList": { + "description": "The colon-separated list of cipher suites used for TLS management connections (e.g. SEMP, LDAP). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`.", + "type": "string" + }, + "tlsCipherSuiteMsgBackboneList": { + "description": "The colon-separated list of cipher suites used for TLS data connections (e.g. client pub/sub). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`.", + "type": "string" + }, + "tlsCipherSuiteSecureShellList": { + "description": "The colon-separated list of cipher suites used for TLS secure shell connections (e.g. SSH, SFTP, SCP). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`.", + "type": "string" + }, + "tlsCrimeExploitProtectionEnabled": { + "description": "Enable or disable protection against the CRIME exploit. When enabled, TLS+compressed messaging performance is degraded. This protection should only be disabled if sufficient ACL and authentication features are being employed such that a potential attacker does not have sufficient access to trigger the exploit. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean" + }, + "tlsServerCertContent": { + "description": "The PEM formatted content for the server certificate used for TLS connections. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`.", + "type": "string", + "x-requires-https": true + }, + "tlsServerCertPassword": { + "description": "The password for the server certificate used for TLS connections. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`.", + "type": "string", + "x-requires-https": true + }, + "tlsStandardDomainCertificateAuthoritiesEnabled": { + "description": "Enable or disable the standard domain certificate authority list. The default value is `true`. Available since 2.19.", + "type": "boolean" + }, + "tlsTicketLifetime": { + "description": "The TLS ticket lifetime in seconds. When a client connects with TLS, a session with a session ticket is created using the TLS ticket lifetime which determines how long the client has to resume the session. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`.", + "format": "int32", + "type": "integer" + }, + "webManagerAllowUnencryptedWizardsEnabled": { + "description": "Enable or disable the use of unencrypted wizards in the Web-based Manager UI. This setting should be left at its default on all production systems or other systems that need to be secure. Enabling this option will permit the broker to forward plain-text data to other brokers, making important information or credentials available for snooping. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.28.", + "type": "boolean" + }, + "webManagerCustomization": { + "description": "Reserved for internal use by Solace. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Available since 2.25.", + "type": "string" + }, + "webManagerRedirectHttpEnabled": { + "description": "Enable or disable redirection of HTTP requests for the broker manager to HTTPS. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.24.", + "type": "boolean" + }, + "webManagerRedirectHttpOverrideTlsPort": { + "description": "The HTTPS port that HTTP requests will be redirected towards in a HTTP 301 redirect response. Zero is a special value that means use the value specified for the SEMP TLS port value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since 2.24.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "BrokerLinks": { + "properties": { + "aboutUri": { + "description": "The URI of this Broker's About object.", + "type": "string" + }, + "certAuthoritiesUri": { + "description": "The URI of this Broker's collection of Certificate Authority objects. Deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "type": "string" + }, + "clientCertAuthoritiesUri": { + "description": "The URI of this Broker's collection of Client Certificate Authority objects. Available since 2.19.", + "type": "string" + }, + "dmrClustersUri": { + "description": "The URI of this Broker's collection of Cluster objects. Available since 2.11.", + "type": "string" + }, + "domainCertAuthoritiesUri": { + "description": "The URI of this Broker's collection of Domain Certificate Authority objects. Available since 2.19.", + "type": "string" + }, + "msgVpnsUri": { + "description": "The URI of this Broker's collection of Message VPN objects. Available since 2.0.", + "type": "string" + }, + "oauthProfilesUri": { + "description": "The URI of this Broker's collection of OAuth Profile objects. Available since 2.24.", + "type": "string" + }, + "systemInformationUri": { + "description": "The URI of this Broker's System Information object. Deprecated since 2.2. /systemInformation was replaced by /about/api.", + "type": "string" + }, + "uri": { + "description": "The URI of this Broker object.", + "type": "string" + }, + "virtualHostnamesUri": { + "description": "The URI of this Broker's collection of Virtual Hostname objects. Available since 2.17.", + "type": "string" + } + }, + "type": "object" + }, + "BrokerResponse": { + "properties": { + "data": { + "$ref": "#/definitions/Broker" + }, + "links": { + "$ref": "#/definitions/BrokerLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "CertAuthoritiesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/CertAuthority" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/CertAuthorityLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "CertAuthority": { + "properties": { + "certAuthorityName": { + "description": "The name of the Certificate Authority. Deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "type": "string" + }, + "certContent": { + "description": "The PEM formatted content for the trusted root certificate of a Certificate Authority. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.", + "type": "string" + }, + "crlDayList": { + "description": "The scheduled CRL refresh day(s), specified as \"daily\" or a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"daily\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.", + "type": "string" + }, + "crlTimeList": { + "description": "The scheduled CRL refresh time(s), specified as \"hourly\" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times must be in sorted order from 0:00 to 23:59. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"3:00\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.", + "type": "string" + }, + "crlUrl": { + "description": "The URL for the CRL source. This is a required attribute for CRL to be operational and the URL must be complete with http:// included. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.", + "type": "string" + }, + "ocspNonResponderCertEnabled": { + "description": "Enable or disable allowing a non-responder certificate to sign an OCSP response. Typically used with an OCSP override URL in cases where a single certificate is used to sign client certificates and OCSP responses. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.", + "type": "boolean" + }, + "ocspOverrideUrl": { + "description": "The OCSP responder URL to use for overriding the one supplied in the client certificate. The URL must be complete with http:// included. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.", + "type": "string" + }, + "ocspTimeout": { + "description": "The timeout in seconds to receive a response from the OCSP responder after sending a request or making the initial connection attempt. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.", + "format": "int64", + "type": "integer" + }, + "revocationCheckEnabled": { + "description": "Enable or disable Certificate Authority revocation checking. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Deprecated since 2.19. certAuthorities replaced by clientCertAuthorities and domainCertAuthorities.", + "type": "boolean" + } + }, + "type": "object" + }, + "CertAuthorityLinks": { + "properties": { + "ocspTlsTrustedCommonNamesUri": { + "description": "The URI of this Certificate Authority's collection of OCSP Responder Trusted Common Name objects. Deprecated since 2.19. Replaced by clientCertAuthorities.", + "type": "string" + }, + "uri": { + "description": "The URI of this Certificate Authority object.", + "type": "string" + } + }, + "type": "object" + }, + "CertAuthorityOcspTlsTrustedCommonName": { + "properties": { + "certAuthorityName": { + "description": "The name of the Certificate Authority. Deprecated since 2.19. Replaced by clientCertAuthorities.", + "type": "string" + }, + "ocspTlsTrustedCommonName": { + "description": "The expected Trusted Common Name of the OCSP responder remote certificate. Deprecated since 2.19. Replaced by clientCertAuthorities.", + "type": "string" + } + }, + "type": "object" + }, + "CertAuthorityOcspTlsTrustedCommonNameLinks": { + "properties": { + "uri": { + "description": "The URI of this OCSP Responder Trusted Common Name object.", + "type": "string" + } + }, + "type": "object" + }, + "CertAuthorityOcspTlsTrustedCommonNameResponse": { + "properties": { + "data": { + "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonName" + }, + "links": { + "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonNameLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "CertAuthorityOcspTlsTrustedCommonNamesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonName" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonNameLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "CertAuthorityResponse": { + "properties": { + "data": { + "$ref": "#/definitions/CertAuthority" + }, + "links": { + "$ref": "#/definitions/CertAuthorityLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "ClientCertAuthoritiesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/ClientCertAuthority" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/ClientCertAuthorityLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "ClientCertAuthority": { + "properties": { + "certAuthorityName": { + "description": "The name of the Certificate Authority.", + "type": "string" + }, + "certContent": { + "description": "The PEM formatted content for the trusted root certificate of a client Certificate Authority. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "crlDayList": { + "description": "The scheduled CRL refresh day(s), specified as \"daily\" or a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. The empty-string (\"\") can also be specified, indicating no schedule is configured (\"crlTimeList\" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"daily\"`.", + "type": "string" + }, + "crlTimeList": { + "description": "The scheduled CRL refresh time(s), specified as \"hourly\" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. The empty-string (\"\") can also be specified, indicating no schedule is configured (\"crlDayList\" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"3:00\"`.", + "type": "string" + }, + "crlUrl": { + "description": "The URL for the CRL source. This is a required attribute for CRL to be operational and the URL must be complete with http:// included. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "ocspNonResponderCertEnabled": { + "description": "Enable or disable allowing a non-responder certificate to sign an OCSP response. Typically used with an OCSP override URL in cases where a single certificate is used to sign client certificates and OCSP responses. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean" + }, + "ocspOverrideUrl": { + "description": "The OCSP responder URL to use for overriding the one supplied in the client certificate. The URL must be complete with http:// included. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "ocspTimeout": { + "description": "The timeout in seconds to receive a response from the OCSP responder after sending a request or making the initial connection attempt. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`.", + "format": "int64", + "type": "integer" + }, + "revocationCheckEnabled": { + "description": "Enable or disable Certificate Authority revocation checking. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "ClientCertAuthorityLinks": { + "properties": { + "ocspTlsTrustedCommonNamesUri": { + "description": "The URI of this Client Certificate Authority's collection of OCSP Responder Trusted Common Name objects.", + "type": "string" + }, + "uri": { + "description": "The URI of this Client Certificate Authority object.", + "type": "string" + } + }, + "type": "object" + }, + "ClientCertAuthorityOcspTlsTrustedCommonName": { + "properties": { + "certAuthorityName": { + "description": "The name of the Certificate Authority.", + "type": "string" + }, + "ocspTlsTrustedCommonName": { + "description": "The expected Trusted Common Name of the OCSP responder remote certificate.", + "type": "string" + } + }, + "type": "object" + }, + "ClientCertAuthorityOcspTlsTrustedCommonNameLinks": { + "properties": { + "uri": { + "description": "The URI of this OCSP Responder Trusted Common Name object.", + "type": "string" + } + }, + "type": "object" + }, + "ClientCertAuthorityOcspTlsTrustedCommonNameResponse": { + "properties": { + "data": { + "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonName" + }, + "links": { + "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonNameLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "ClientCertAuthorityOcspTlsTrustedCommonNamesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonName" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonNameLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "ClientCertAuthorityResponse": { + "properties": { + "data": { + "$ref": "#/definitions/ClientCertAuthority" + }, + "links": { + "$ref": "#/definitions/ClientCertAuthorityLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DmrCluster": { + "properties": { + "authenticationBasicEnabled": { + "description": "Enable or disable basic authentication for Cluster Links. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean" + }, + "authenticationBasicPassword": { + "description": "The password used to authenticate incoming Cluster Links when using basic internal authentication. The same password is also used by outgoing Cluster Links if a per-Link password is not configured. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "authenticationBasicType": { + "description": "The type of basic authentication to use for Cluster Links. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"internal\"`. The allowed values and their meaning are:\n\n
\n\"internal\" - Use locally configured password.\n\"none\" - No authentication.\n
\n", + "enum": [ + "internal", + "none" + ], + "type": "string" + }, + "authenticationClientCertContent": { + "description": "The PEM formatted content for the client certificate used to login to the remote node. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`.", + "type": "string", + "x-requires-https": true + }, + "authenticationClientCertEnabled": { + "description": "Enable or disable client certificate authentication for Cluster Links. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean" + }, + "authenticationClientCertPassword": { + "description": "The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`.", + "type": "string", + "x-requires-https": true + }, + "directOnlyEnabled": { + "description": "Enable or disable direct messaging only. Guaranteed messages will not be transmitted through the cluster. The default value is `false`.", + "type": "boolean" + }, + "dmrClusterName": { + "description": "The name of the Cluster.", + "type": "string" + }, + "enabled": { + "description": "Enable or disable the Cluster. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean" + }, + "nodeName": { + "description": "The name of this node in the Cluster. This is the name that this broker (or redundant group of brokers) is know by to other nodes in the Cluster. The name is chosen automatically to be either this broker's Router Name or Mate Router Name, depending on which Active Standby Role (primary or backup) this broker plays in its redundancy group.", + "type": "string" + }, + "tlsServerCertEnforceTrustedCommonNameEnabled": { + "description": "Enable or disable the enforcing of the common name provided by the remote broker against the list of trusted common names configured for the Link. If enabled, the certificate's common name must match one of the trusted common names for the Link to be accepted. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "type": "boolean" + }, + "tlsServerCertMaxChainDepth": { + "description": "The maximum allowed depth of a certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`.", + "format": "int64", + "type": "integer" + }, + "tlsServerCertValidateDateEnabled": { + "description": "Enable or disable the validation of the \"Not Before\" and \"Not After\" validity dates in the certificate. When disabled, the certificate is accepted even if the certificate is not valid based on these dates. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean" + }, + "tlsServerCertValidateNameEnabled": { + "description": "Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the bridge. If enabled, the name used to connect to the bridge is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.18.", + "type": "boolean" + } + }, + "type": "object" + }, + "DmrClusterCertMatchingRule": { + "properties": { + "dmrClusterName": { + "description": "The name of the Cluster.", + "type": "string" + }, + "enabled": { + "description": "Enable or disable a certificate matching rule. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean" + }, + "ruleName": { + "description": "The name of the rule.", + "type": "string" + } + }, + "type": "object" + }, + "DmrClusterCertMatchingRuleAttributeFilter": { + "properties": { + "attributeName": { + "description": "Link Attribute to be tested. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "attributeValue": { + "description": "Expected attribute value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "dmrClusterName": { + "description": "The name of the Cluster.", + "type": "string" + }, + "filterName": { + "description": "The name of the filter.", + "type": "string" + }, + "ruleName": { + "description": "The name of the rule.", + "type": "string" + } + }, + "type": "object" + }, + "DmrClusterCertMatchingRuleAttributeFilterLinks": { + "properties": { + "uri": { + "description": "The URI of this Certificate Matching Rule Attribute Filter object.", + "type": "string" + } + }, + "type": "object" + }, + "DmrClusterCertMatchingRuleAttributeFilterResponse": { + "properties": { + "data": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilter" + }, + "links": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DmrClusterCertMatchingRuleAttributeFiltersResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilter" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DmrClusterCertMatchingRuleCondition": { + "properties": { + "attribute": { + "description": "Link Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The default value is `\"\"`.", + "type": "string" + }, + "dmrClusterName": { + "description": "The name of the Cluster.", + "type": "string" + }, + "expression": { + "description": "Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The default value is `\"\"`.", + "type": "string" + }, + "ruleName": { + "description": "The name of the rule.", + "type": "string" + }, + "source": { + "description": "Certificate field to be compared with the Attribute. The allowed values and their meaning are:\n\n
\n\"certificate-thumbprint\" - The attribute is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate.\n\"common-name\" - The attribute is extracted from the certificate's first instance of the Common Name attribute in the Subject DN.\n\"common-name-last\" - The attribute is extracted from the certificate's last instance of the Common Name attribute in the Subject DN.\n\"subject-alternate-name-msupn\" - The attribute is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature.\n\"uid\" - The attribute is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN.\n\"uid-last\" - The attribute is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN.\n\"org-unit\" - The attribute is extracted from the certificate's first instance of the Org Unit attribute in the Subject DN.\n\"org-unit-last\" - The attribute is extracted from the certificate's last instance of the Org Unit attribute in the Subject DN.\n\"issuer\" - The attribute is extracted from the certificate's Issuer DN.\n\"subject\" - The attribute is extracted from the certificate's Subject DN.\n\"serial-number\" - The attribute is extracted from the certificate's Serial Number.\n\"dns-name\" - The attribute is extracted from the certificate's Subject Alt Name DNSName.\n\"ip-address\" - The attribute is extracted from the certificate's Subject Alt Name IPAddress.\n
\n", + "enum": [ + "certificate-thumbprint", + "common-name", + "common-name-last", + "subject-alternate-name-msupn", + "uid", + "uid-last", + "org-unit", + "org-unit-last", + "issuer", + "subject", + "serial-number", + "dns-name", + "ip-address" + ], + "type": "string" + } + }, + "type": "object" + }, + "DmrClusterCertMatchingRuleConditionLinks": { + "properties": { + "uri": { + "description": "The URI of this Certificate Matching Rule Condition object.", + "type": "string" + } + }, + "type": "object" + }, + "DmrClusterCertMatchingRuleConditionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleCondition" + }, + "links": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleConditionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DmrClusterCertMatchingRuleConditionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleCondition" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleConditionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DmrClusterCertMatchingRuleLinks": { + "properties": { + "attributeFiltersUri": { + "description": "The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Attribute Filter objects.", + "type": "string" + }, + "conditionsUri": { + "description": "The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Condition objects.", + "type": "string" + }, + "uri": { + "description": "The URI of this Certificate Matching Rule object.", + "type": "string" + } + }, + "type": "object" + }, + "DmrClusterCertMatchingRuleResponse": { + "properties": { + "data": { + "$ref": "#/definitions/DmrClusterCertMatchingRule" + }, + "links": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DmrClusterCertMatchingRulesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/DmrClusterCertMatchingRule" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DmrClusterLink": { + "properties": { + "authenticationBasicPassword": { + "description": "The password used to authenticate with the remote node when using basic internal authentication. If this per-Link password is not configured, the Cluster's password is used instead. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "authenticationScheme": { + "description": "The authentication scheme to be used by the Link which initiates connections to the remote node. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"basic\"`. The allowed values and their meaning are:\n\n
\n\"basic\" - Basic Authentication Scheme (via username and password).\n\"client-certificate\" - Client Certificate Authentication Scheme (via certificate file or content).\n
\n", + "enum": [ + "basic", + "client-certificate" + ], + "type": "string" + }, + "clientProfileQueueControl1MaxDepth": { + "description": "The maximum depth of the \"Control 1\" (C-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.", + "format": "int32", + "type": "integer" + }, + "clientProfileQueueControl1MinMsgBurst": { + "description": "The number of messages that are always allowed entry into the \"Control 1\" (C-1) priority queue, regardless of the `clientProfileQueueControl1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`.", + "format": "int32", + "type": "integer" + }, + "clientProfileQueueDirect1MaxDepth": { + "description": "The maximum depth of the \"Direct 1\" (D-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.", + "format": "int32", + "type": "integer" + }, + "clientProfileQueueDirect1MinMsgBurst": { + "description": "The number of messages that are always allowed entry into the \"Direct 1\" (D-1) priority queue, regardless of the `clientProfileQueueDirect1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`.", + "format": "int32", + "type": "integer" + }, + "clientProfileQueueDirect2MaxDepth": { + "description": "The maximum depth of the \"Direct 2\" (D-2) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.", + "format": "int32", + "type": "integer" + }, + "clientProfileQueueDirect2MinMsgBurst": { + "description": "The number of messages that are always allowed entry into the \"Direct 2\" (D-2) priority queue, regardless of the `clientProfileQueueDirect2MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`.", + "format": "int32", + "type": "integer" + }, + "clientProfileQueueDirect3MaxDepth": { + "description": "The maximum depth of the \"Direct 3\" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.", + "format": "int32", + "type": "integer" + }, + "clientProfileQueueDirect3MinMsgBurst": { + "description": "The number of messages that are always allowed entry into the \"Direct 3\" (D-3) priority queue, regardless of the `clientProfileQueueDirect3MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`.", + "format": "int32", + "type": "integer" + }, + "clientProfileQueueGuaranteed1MaxDepth": { + "description": "The maximum depth of the \"Guaranteed 1\" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`.", + "format": "int32", + "type": "integer" + }, + "clientProfileQueueGuaranteed1MinMsgBurst": { + "description": "The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-3) priority queue, regardless of the `clientProfileQueueGuaranteed1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.", + "format": "int32", + "type": "integer" + }, + "clientProfileTcpCongestionWindowSize": { + "description": "The TCP initial congestion window size, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `2`.", + "format": "int64", + "type": "integer" + }, + "clientProfileTcpKeepaliveCount": { + "description": "The number of TCP keepalive retransmissions to be carried out before declaring that the remote end is not available. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`.", + "format": "int64", + "type": "integer" + }, + "clientProfileTcpKeepaliveIdleTime": { + "description": "The amount of time a connection must remain idle before TCP begins sending keepalive probes, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`.", + "format": "int64", + "type": "integer" + }, + "clientProfileTcpKeepaliveInterval": { + "description": "The amount of time between TCP keepalive retransmissions when no acknowledgement is received, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`.", + "format": "int64", + "type": "integer" + }, + "clientProfileTcpMaxSegmentSize": { + "description": "The TCP maximum segment size, in bytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1460`.", + "format": "int64", + "type": "integer" + }, + "clientProfileTcpMaxWindowSize": { + "description": "The TCP maximum window size, in kilobytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `256`.", + "format": "int64", + "type": "integer" + }, + "dmrClusterName": { + "description": "The name of the Cluster.", + "type": "string" + }, + "egressFlowWindowSize": { + "description": "The number of outstanding guaranteed messages that can be sent over the Link before acknowledgement is received by the sender. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.", + "format": "int64", + "type": "integer" + }, + "enabled": { + "description": "Enable or disable the Link. When disabled, subscription sets of this and the remote node are not kept up-to-date, and messages are not exchanged with the remote node. Published guaranteed messages will be queued up for future delivery based on current subscription sets. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean" + }, + "initiator": { + "description": "The initiator of the Link's TCP connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"lexical\"`. The allowed values and their meaning are:\n\n
\n\"lexical\" - The \"higher\" node-name initiates.\n\"local\" - The local node initiates.\n\"remote\" - The remote node initiates.\n
\n", + "enum": [ + "lexical", + "local", + "remote" + ], + "type": "string" + }, + "queueDeadMsgQueue": { + "description": "The name of the Dead Message Queue (DMQ) used by the Queue for discarded messages. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`.", + "type": "string" + }, + "queueEventSpoolUsageThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "queueMaxDeliveredUnackedMsgsPerFlow": { + "description": "The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1000000`.", + "format": "int64", + "type": "integer" + }, + "queueMaxMsgSpoolUsage": { + "description": "The maximum message spool usage by the Queue (quota), in megabytes (MB). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `800000`.", + "format": "int64", + "type": "integer" + }, + "queueMaxRedeliveryCount": { + "description": "The maximum number of times the Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "queueMaxTtl": { + "description": "The maximum time in seconds a message can stay in the Queue when `queueRespectTtlEnabled` is `true`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `queueMaxTtl` configured for the Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "queueRejectMsgToSenderOnDiscardBehavior": { + "description": "Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"always\"`. The allowed values and their meaning are:\n\n
\n\"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard.\n\"when-queue-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled.\n\"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard.\n
\n", + "enum": [ + "always", + "when-queue-enabled", + "never" + ], + "type": "string" + }, + "queueRespectTtlEnabled": { + "description": "Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean" + }, + "remoteNodeName": { + "description": "The name of the node at the remote end of the Link.", + "type": "string" + }, + "span": { + "description": "The span of the Link, either internal or external. Internal Links connect nodes within the same Cluster. External Links connect nodes within different Clusters. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"external\"`. The allowed values and their meaning are:\n\n
\n\"internal\" - Link to same cluster.\n\"external\" - Link to other cluster.\n
\n", + "enum": [ + "internal", + "external" + ], + "type": "string" + }, + "transportCompressedEnabled": { + "description": "Enable or disable compression on the Link. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean" + }, + "transportTlsEnabled": { + "description": "Enable or disable encryption (TLS) on the Link. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "DmrClusterLinkAttribute": { + "properties": { + "attributeName": { + "description": "The name of the Attribute.", + "type": "string" + }, + "attributeValue": { + "description": "The value of the Attribute.", + "type": "string" + }, + "dmrClusterName": { + "description": "The name of the Cluster.", + "type": "string" + }, + "remoteNodeName": { + "description": "The name of the node at the remote end of the Link.", + "type": "string" + } + }, + "type": "object" + }, + "DmrClusterLinkAttributeLinks": { + "properties": { + "uri": { + "description": "The URI of this Link Attribute object.", + "type": "string" + } + }, + "type": "object" + }, + "DmrClusterLinkAttributeResponse": { + "properties": { + "data": { + "$ref": "#/definitions/DmrClusterLinkAttribute" + }, + "links": { + "$ref": "#/definitions/DmrClusterLinkAttributeLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DmrClusterLinkAttributesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/DmrClusterLinkAttribute" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/DmrClusterLinkAttributeLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DmrClusterLinkLinks": { + "properties": { + "attributesUri": { + "description": "The URI of this Link's collection of Link Attribute objects. Available since 2.28.", + "type": "string" + }, + "remoteAddressesUri": { + "description": "The URI of this Link's collection of Remote Address objects.", + "type": "string" + }, + "tlsTrustedCommonNamesUri": { + "description": "The URI of this Link's collection of Trusted Common Name objects. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "type": "string" + }, + "uri": { + "description": "The URI of this Link object.", + "type": "string" + } + }, + "type": "object" + }, + "DmrClusterLinkRemoteAddress": { + "properties": { + "dmrClusterName": { + "description": "The name of the Cluster.", + "type": "string" + }, + "remoteAddress": { + "description": "The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed).", + "type": "string" + }, + "remoteNodeName": { + "description": "The name of the node at the remote end of the Link.", + "type": "string" + } + }, + "type": "object" + }, + "DmrClusterLinkRemoteAddressLinks": { + "properties": { + "uri": { + "description": "The URI of this Remote Address object.", + "type": "string" + } + }, + "type": "object" + }, + "DmrClusterLinkRemoteAddressResponse": { + "properties": { + "data": { + "$ref": "#/definitions/DmrClusterLinkRemoteAddress" + }, + "links": { + "$ref": "#/definitions/DmrClusterLinkRemoteAddressLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DmrClusterLinkRemoteAddressesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/DmrClusterLinkRemoteAddress" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/DmrClusterLinkRemoteAddressLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DmrClusterLinkResponse": { + "properties": { + "data": { + "$ref": "#/definitions/DmrClusterLink" + }, + "links": { + "$ref": "#/definitions/DmrClusterLinkLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DmrClusterLinkTlsTrustedCommonName": { + "properties": { + "dmrClusterName": { + "description": "The name of the Cluster. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "type": "string" + }, + "remoteNodeName": { + "description": "The name of the node at the remote end of the Link. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "type": "string" + }, + "tlsTrustedCommonName": { + "description": "The expected trusted common name of the remote certificate. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "type": "string" + } + }, + "type": "object" + }, + "DmrClusterLinkTlsTrustedCommonNameLinks": { + "properties": { + "uri": { + "description": "The URI of this Trusted Common Name object.", + "type": "string" + } + }, + "type": "object" + }, + "DmrClusterLinkTlsTrustedCommonNameResponse": { + "properties": { + "data": { + "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonName" + }, + "links": { + "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonNameLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DmrClusterLinkTlsTrustedCommonNamesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonName" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonNameLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DmrClusterLinks": { + "properties": { + "certMatchingRulesUri": { + "description": "The URI of this Cluster's collection of Certificate Matching Rule objects. Available since 2.28.", + "type": "string" + }, + "linksUri": { + "description": "The URI of this Cluster's collection of Link objects.", + "type": "string" + }, + "uri": { + "description": "The URI of this Cluster object.", + "type": "string" + } + }, + "type": "object" + }, + "DmrClusterLinksResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/DmrClusterLink" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/DmrClusterLinkLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DmrClusterResponse": { + "properties": { + "data": { + "$ref": "#/definitions/DmrCluster" + }, + "links": { + "$ref": "#/definitions/DmrClusterLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DmrClustersResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/DmrCluster" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/DmrClusterLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DomainCertAuthoritiesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/DomainCertAuthority" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/DomainCertAuthorityLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "DomainCertAuthority": { + "properties": { + "certAuthorityName": { + "description": "The name of the Certificate Authority.", + "type": "string" + }, + "certContent": { + "description": "The PEM formatted content for the trusted root certificate of a domain Certificate Authority. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + } + }, + "type": "object" + }, + "DomainCertAuthorityLinks": { + "properties": { + "uri": { + "description": "The URI of this Domain Certificate Authority object.", + "type": "string" + } + }, + "type": "object" + }, + "DomainCertAuthorityResponse": { + "properties": { + "data": { + "$ref": "#/definitions/DomainCertAuthority" + }, + "links": { + "$ref": "#/definitions/DomainCertAuthorityLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "EventThreshold": { + "properties": { + "clearPercent": { + "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "type": "integer" + }, + "clearValue": { + "description": "The clear threshold for the absolute value of this counter. Falling below this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "type": "integer" + }, + "setPercent": { + "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "type": "integer" + }, + "setValue": { + "description": "The set threshold for the absolute value of this counter. Exceeding this value will trigger a corresponding event. This attribute may not be returned in a GET.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "EventThresholdByPercent": { + "properties": { + "clearPercent": { + "description": "The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value will trigger a corresponding event.", + "format": "int64", + "type": "integer" + }, + "setPercent": { + "description": "The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value will trigger a corresponding event.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "EventThresholdByValue": { + "properties": { + "clearValue": { + "description": "The clear threshold for the absolute value of this counter or rate. Falling below this value will trigger a corresponding event.", + "format": "int64", + "type": "integer" + }, + "setValue": { + "description": "The set threshold for the absolute value of this counter or rate. Exceeding this value will trigger a corresponding event.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "MsgVpn": { + "properties": { + "alias": { + "description": "The name of another Message VPN which this Message VPN is an alias for. When this Message VPN is enabled, the alias has no effect. When this Message VPN is disabled, Clients (but not Bridges and routing Links) logging into this Message VPN are automatically logged in to the other Message VPN, and authentication and authorization take place in the context of the other Message VPN.\n\nAliases may form a non-circular chain, cascading one to the next. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14.", + "type": "string" + }, + "authenticationBasicEnabled": { + "description": "Enable or disable basic authentication for clients connecting to the Message VPN. Basic authentication is authentication that involves the use of a username and password to prove identity. If a user provides credentials for a different authentication scheme, this setting is not applicable. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "authenticationBasicProfileName": { + "description": "The name of the RADIUS or LDAP Profile to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`.", + "type": "string" + }, + "authenticationBasicRadiusDomain": { + "description": "The RADIUS domain to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "authenticationBasicType": { + "description": "The type of basic authentication to use for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"radius\"`. The allowed values and their meaning are:\n\n
\n\"internal\" - Internal database. Authentication is against Client Usernames.\n\"ldap\" - LDAP authentication. An LDAP profile name must be provided.\n\"radius\" - RADIUS authentication. A RADIUS profile name must be provided.\n\"none\" - No authentication. Anonymous login allowed.\n
\n", + "enum": [ + "internal", + "ldap", + "radius", + "none" + ], + "type": "string" + }, + "authenticationClientCertAllowApiProvidedUsernameEnabled": { + "description": "Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the certificate CN (Common Name) is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "authenticationClientCertCertificateMatchingRulesEnabled": { + "description": "Enable or disable certificate matching rules. When disabled, any valid certificate is accepted. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.27.", + "type": "boolean" + }, + "authenticationClientCertEnabled": { + "description": "Enable or disable client certificate authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "authenticationClientCertMaxChainDepth": { + "description": "The maximum depth for a client certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", + "format": "int64", + "type": "integer" + }, + "authenticationClientCertRevocationCheckMode": { + "description": "The desired behavior for client certificate revocation checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"allow-valid\"`. The allowed values and their meaning are:\n\n
\n\"allow-all\" - Allow the client to authenticate, the result of client certificate revocation check is ignored.\n\"allow-unknown\" - Allow the client to authenticate even if the revocation status of his certificate cannot be determined.\n\"allow-valid\" - Allow the client to authenticate only when the revocation check returned an explicit positive response.\n
\n Available since 2.6.", + "enum": [ + "allow-all", + "allow-unknown", + "allow-valid" + ], + "type": "string" + }, + "authenticationClientCertUsernameSource": { + "description": "The field from the client certificate to use as the client username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"common-name\"`. The allowed values and their meaning are:\n\n
\n\"certificate-thumbprint\" - The username is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate.\n\"common-name\" - The username is extracted from the certificate's first instance of the Common Name attribute in the Subject DN.\n\"common-name-last\" - The username is extracted from the certificate's last instance of the Common Name attribute in the Subject DN.\n\"subject-alternate-name-msupn\" - The username is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature.\n\"uid\" - The username is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN.\n\"uid-last\" - The username is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN.\n
\n Available since 2.6.", + "enum": [ + "certificate-thumbprint", + "common-name", + "common-name-last", + "subject-alternate-name-msupn", + "uid", + "uid-last" + ], + "type": "string" + }, + "authenticationClientCertValidateDateEnabled": { + "description": "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the client certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "authenticationKerberosAllowApiProvidedUsernameEnabled": { + "description": "Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "authenticationKerberosEnabled": { + "description": "Enable or disable Kerberos authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "authenticationOauthDefaultProfileName": { + "description": "The name of the profile to use when the client does not supply a profile name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.25.", + "type": "string" + }, + "authenticationOauthDefaultProviderName": { + "description": "The name of the provider to use when the client does not supply a provider name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthDefaultProviderName and authenticationOauthProviders replaced by authenticationOauthDefaultProfileName and authenticationOauthProfiles.", + "type": "string" + }, + "authenticationOauthEnabled": { + "description": "Enable or disable OAuth authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13.", + "type": "boolean" + }, + "authorizationLdapGroupMembershipAttributeName": { + "description": "The name of the attribute that is retrieved from the LDAP server as part of the LDAP search when authorizing a client connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"memberOf\"`.", + "type": "string" + }, + "authorizationLdapTrimClientUsernameDomainEnabled": { + "description": "Enable or disable client-username domain trimming for LDAP lookups of client connections. When enabled, the value of $CLIENT_USERNAME (when used for searching) will be truncated at the first occurance of the @ character. For example, if the client-username is in the form of an email address, then the domain portion will be removed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13.", + "type": "boolean" + }, + "authorizationProfileName": { + "description": "The name of the LDAP Profile to use for client authorization. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "authorizationType": { + "description": "The type of authorization to use for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"internal\"`. The allowed values and their meaning are:\n\n
\n\"ldap\" - LDAP authorization.\n\"internal\" - Internal authorization.\n
\n", + "enum": [ + "ldap", + "internal" + ], + "type": "string" + }, + "bridgingTlsServerCertEnforceTrustedCommonNameEnabled": { + "description": "Enable or disable validation of the Common Name (CN) in the server certificate from the remote broker. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the Bridge. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "type": "boolean" + }, + "bridgingTlsServerCertMaxChainDepth": { + "description": "The maximum depth for a server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", + "format": "int64", + "type": "integer" + }, + "bridgingTlsServerCertValidateDateEnabled": { + "description": "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the server certificate. When disabled, a certificate will be accepted even if the certificate is not valid based on these dates. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "bridgingTlsServerCertValidateNameEnabled": { + "description": "Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the bridge. If enabled, the name used to connect to the bridge is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18.", + "type": "boolean" + }, + "distributedCacheManagementEnabled": { + "description": "Enable or disable managing of cache instances over the message bus. The default value is `true`. Deprecated since 2.28. Distributed cache mangement is now redundancy aware and thus no longer requires administrative intervention for operational state.", + "type": "boolean" + }, + "dmrEnabled": { + "description": "Enable or disable Dynamic Message Routing (DMR) for the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.11.", + "type": "boolean" + }, + "enabled": { + "description": "Enable or disable the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "eventConnectionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventEgressFlowCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventEgressMsgRateThreshold": { + "$ref": "#/definitions/EventThresholdByValue" + }, + "eventEndpointCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventIngressFlowCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventIngressMsgRateThreshold": { + "$ref": "#/definitions/EventThresholdByValue" + }, + "eventLargeMsgThreshold": { + "description": "The threshold, in kilobytes, after which a message is considered to be large for the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1024`.", + "format": "int64", + "type": "integer" + }, + "eventLogTag": { + "description": "A prefix applied to all published Events in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "eventMsgSpoolUsageThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventPublishClientEnabled": { + "description": "Enable or disable Client level Event message publishing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "eventPublishMsgVpnEnabled": { + "description": "Enable or disable Message VPN level Event message publishing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "eventPublishSubscriptionMode": { + "description": "Subscription level Event message publishing mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"off\"`. The allowed values and their meaning are:\n\n
\n\"off\" - Disable client level event message publishing.\n\"on-with-format-v1\" - Enable client level event message publishing with format v1.\n\"on-with-no-unsubscribe-events-on-disconnect-format-v1\" - As \"on-with-format-v1\", but unsubscribe events are not generated when a client disconnects. Unsubscribe events are still raised when a client explicitly unsubscribes from its subscriptions.\n\"on-with-format-v2\" - Enable client level event message publishing with format v2.\n\"on-with-no-unsubscribe-events-on-disconnect-format-v2\" - As \"on-with-format-v2\", but unsubscribe events are not generated when a client disconnects. Unsubscribe events are still raised when a client explicitly unsubscribes from its subscriptions.\n
\n", + "enum": [ + "off", + "on-with-format-v1", + "on-with-no-unsubscribe-events-on-disconnect-format-v1", + "on-with-format-v2", + "on-with-no-unsubscribe-events-on-disconnect-format-v2" + ], + "type": "string" + }, + "eventPublishTopicFormatMqttEnabled": { + "description": "Enable or disable Event publish topics in MQTT format. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "eventPublishTopicFormatSmfEnabled": { + "description": "Enable or disable Event publish topics in SMF format. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "eventServiceAmqpConnectionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventServiceMqttConnectionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventServiceRestIncomingConnectionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventServiceSmfConnectionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventServiceWebConnectionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventSubscriptionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventTransactedSessionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventTransactionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "exportSubscriptionsEnabled": { + "description": "Enable or disable the export of subscriptions in the Message VPN to other routers in the network over Neighbor links. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "jndiEnabled": { + "description": "Enable or disable JNDI access for clients in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.2.", + "type": "boolean" + }, + "maxConnectionCount": { + "description": "The maximum number of client connections to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.", + "format": "int64", + "type": "integer" + }, + "maxEgressFlowCount": { + "description": "The maximum number of transmit flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "format": "int64", + "type": "integer" + }, + "maxEndpointCount": { + "description": "The maximum number of Queues and Topic Endpoints that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "format": "int64", + "type": "integer" + }, + "maxIngressFlowCount": { + "description": "The maximum number of receive flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "format": "int64", + "type": "integer" + }, + "maxMsgSpoolUsage": { + "description": "The maximum message spool usage by the Message VPN, in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "maxSubscriptionCount": { + "description": "The maximum number of local client subscriptions that can be added to the Message VPN. This limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.", + "format": "int64", + "type": "integer" + }, + "maxTransactedSessionCount": { + "description": "The maximum number of transacted sessions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.", + "format": "int64", + "type": "integer" + }, + "maxTransactionCount": { + "description": "The maximum number of transactions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.", + "format": "int64", + "type": "integer" + }, + "mqttRetainMaxMemory": { + "description": "The maximum total memory usage of the MQTT Retain feature for this Message VPN, in MB. If the maximum memory is reached, any arriving retain messages that require more memory are discarded. A value of -1 indicates that the memory is bounded only by the global max memory limit. A value of 0 prevents MQTT Retain from becoming operational. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. Available since 2.11.", + "format": "int32", + "type": "integer" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "replicationAckPropagationIntervalMsgCount": { + "description": "The acknowledgement (ACK) propagation interval for the replication Bridge, in number of replicated messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20`.", + "format": "int64", + "type": "integer" + }, + "replicationBridgeAuthenticationBasicClientUsername": { + "description": "The Client Username the replication Bridge uses to login to the remote Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "replicationBridgeAuthenticationBasicPassword": { + "description": "The password for the Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "replicationBridgeAuthenticationClientCertContent": { + "description": "The PEM formatted content for the client certificate used by this bridge to login to the Remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9.", + "type": "string", + "x-requires-https": true + }, + "replicationBridgeAuthenticationClientCertPassword": { + "description": "The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9.", + "type": "string", + "x-requires-https": true + }, + "replicationBridgeAuthenticationScheme": { + "description": "The authentication scheme for the replication Bridge in the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"basic\"`. The allowed values and their meaning are:\n\n
\n\"basic\" - Basic Authentication Scheme (via username and password).\n\"client-certificate\" - Client Certificate Authentication Scheme (via certificate file or content).\n
\n", + "enum": [ + "basic", + "client-certificate" + ], + "type": "string" + }, + "replicationBridgeCompressedDataEnabled": { + "description": "Enable or disable use of compression for the replication Bridge. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean" + }, + "replicationBridgeEgressFlowWindowSize": { + "description": "The size of the window used for guaranteed messages published to the replication Bridge, in messages. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.", + "format": "int64", + "type": "integer" + }, + "replicationBridgeRetryDelay": { + "description": "The number of seconds that must pass before retrying the replication Bridge connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`.", + "format": "int64", + "type": "integer" + }, + "replicationBridgeTlsEnabled": { + "description": "Enable or disable use of encryption (TLS) for the replication Bridge connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean" + }, + "replicationBridgeUnidirectionalClientProfileName": { + "description": "The Client Profile for the unidirectional replication Bridge in the Message VPN. It is used only for the TCP parameters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#client-profile\"`.", + "type": "string" + }, + "replicationEnabled": { + "description": "Enable or disable replication for the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean" + }, + "replicationEnabledQueueBehavior": { + "description": "The behavior to take when enabling replication for the Message VPN, depending on the existence of the replication Queue. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"fail-on-existing-queue\"`. The allowed values and their meaning are:\n\n
\n\"fail-on-existing-queue\" - The data replication queue must not already exist.\n\"force-use-existing-queue\" - The data replication queue must already exist. Any data messages on the Queue will be forwarded to interested applications. IMPORTANT: Before using this mode be certain that the messages are not stale or otherwise unsuitable to be forwarded. This mode can only be specified when the existing queue is configured the same as is currently specified under replication configuration otherwise the enabling of replication will fail.\n\"force-recreate-queue\" - The data replication queue must already exist. Any data messages on the Queue will be discarded. IMPORTANT: Before using this mode be certain that the messages on the existing data replication queue are not needed by interested applications.\n
\n", + "enum": [ + "fail-on-existing-queue", + "force-use-existing-queue", + "force-recreate-queue" + ], + "type": "string" + }, + "replicationQueueMaxMsgSpoolUsage": { + "description": "The maximum message spool usage by the replication Bridge local Queue (quota), in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `60000`.", + "format": "int64", + "type": "integer" + }, + "replicationQueueRejectMsgToSenderOnDiscardEnabled": { + "description": "Enable or disable whether messages discarded on the replication Bridge local Queue are rejected back to the sender. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "replicationRejectMsgWhenSyncIneligibleEnabled": { + "description": "Enable or disable whether guaranteed messages published to synchronously replicated Topics are rejected back to the sender when synchronous replication becomes ineligible. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "replicationRole": { + "description": "The replication role for the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"standby\"`. The allowed values and their meaning are:\n\n
\n\"active\" - Assume the Active role in replication for the Message VPN.\n\"standby\" - Assume the Standby role in replication for the Message VPN.\n
\n", + "enum": [ + "active", + "standby" + ], + "type": "string" + }, + "replicationTransactionMode": { + "description": "The transaction replication mode for all transactions within the Message VPN. Changing this value during operation will not affect existing transactions; it is only used upon starting a transaction. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"async\"`. The allowed values and their meaning are:\n\n
\n\"sync\" - Messages are acknowledged when replicated (spooled remotely).\n\"async\" - Messages are acknowledged when pending replication (spooled locally).\n
\n", + "enum": [ + "sync", + "async" + ], + "type": "string" + }, + "restTlsServerCertEnforceTrustedCommonNameEnabled": { + "description": "Enable or disable validation of the Common Name (CN) in the server certificate from the remote REST Consumer. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the REST Consumer. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", + "type": "boolean" + }, + "restTlsServerCertMaxChainDepth": { + "description": "The maximum depth for a REST Consumer server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", + "format": "int64", + "type": "integer" + }, + "restTlsServerCertValidateDateEnabled": { + "description": "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the REST Consumer server certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "restTlsServerCertValidateNameEnabled": { + "description": "Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the remote REST Consumer. If enabled, the name used to connect to the remote REST Consumer is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.17.", + "type": "boolean" + }, + "sempOverMsgBusAdminClientEnabled": { + "description": "Enable or disable \"admin client\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "sempOverMsgBusAdminDistributedCacheEnabled": { + "description": "Enable or disable \"admin distributed-cache\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "sempOverMsgBusAdminEnabled": { + "description": "Enable or disable \"admin\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "sempOverMsgBusEnabled": { + "description": "Enable or disable SEMP over the message bus for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "sempOverMsgBusShowEnabled": { + "description": "Enable or disable \"show\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "serviceAmqpMaxConnectionCount": { + "description": "The maximum number of AMQP client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.7.", + "format": "int64", + "type": "integer" + }, + "serviceAmqpPlainTextEnabled": { + "description": "Enable or disable the plain-text AMQP service in the Message VPN. Disabling causes clients connected to the corresponding listen-port to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.7.", + "type": "boolean" + }, + "serviceAmqpPlainTextListenPort": { + "description": "The port number for plain-text AMQP clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.7.", + "format": "int64", + "type": "integer" + }, + "serviceAmqpTlsEnabled": { + "description": "Enable or disable the use of encryption (TLS) for the AMQP service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.7.", + "type": "boolean" + }, + "serviceAmqpTlsListenPort": { + "description": "The port number for AMQP clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.7.", + "format": "int64", + "type": "integer" + }, + "serviceMqttAuthenticationClientCertRequest": { + "description": "Determines when to request a client certificate from an incoming MQTT client connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-enabled-in-message-vpn\"`. The allowed values and their meaning are:\n\n
\n\"always\" - Always ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration.\n\"never\" - Never ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration.\n\"when-enabled-in-message-vpn\" - Only ask for a client-certificate if client certificate authentication is enabled under \"message-vpn >  authentication > client-certificate > shutdown\".\n
\n Available since 2.21.", + "enum": [ + "always", + "never", + "when-enabled-in-message-vpn" + ], + "type": "string" + }, + "serviceMqttMaxConnectionCount": { + "description": "The maximum number of MQTT client connections that can be simultaneously connected to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.1.", + "format": "int64", + "type": "integer" + }, + "serviceMqttPlainTextEnabled": { + "description": "Enable or disable the plain-text MQTT service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.", + "type": "boolean" + }, + "serviceMqttPlainTextListenPort": { + "description": "The port number for plain-text MQTT clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.", + "format": "int64", + "type": "integer" + }, + "serviceMqttTlsEnabled": { + "description": "Enable or disable the use of encryption (TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.", + "type": "boolean" + }, + "serviceMqttTlsListenPort": { + "description": "The port number for MQTT clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.", + "format": "int64", + "type": "integer" + }, + "serviceMqttTlsWebSocketEnabled": { + "description": "Enable or disable the use of encrypted WebSocket (WebSocket over TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected by encrypted WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.", + "type": "boolean" + }, + "serviceMqttTlsWebSocketListenPort": { + "description": "The port number for MQTT clients that connect to the Message VPN using WebSocket over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.", + "format": "int64", + "type": "integer" + }, + "serviceMqttWebSocketEnabled": { + "description": "Enable or disable the use of WebSocket for the MQTT service in the Message VPN. Disabling causes clients currently connected by WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.", + "type": "boolean" + }, + "serviceMqttWebSocketListenPort": { + "description": "The port number for plain-text MQTT clients that connect to the Message VPN using WebSocket. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.", + "format": "int64", + "type": "integer" + }, + "serviceRestIncomingAuthenticationClientCertRequest": { + "description": "Determines when to request a client certificate from an incoming REST Producer connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-enabled-in-message-vpn\"`. The allowed values and their meaning are:\n\n
\n\"always\" - Always ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration.\n\"never\" - Never ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration.\n\"when-enabled-in-message-vpn\" - Only ask for a client-certificate if client certificate authentication is enabled under \"message-vpn >  authentication > client-certificate > shutdown\".\n
\n Available since 2.21.", + "enum": [ + "always", + "never", + "when-enabled-in-message-vpn" + ], + "type": "string" + }, + "serviceRestIncomingAuthorizationHeaderHandling": { + "description": "The handling of Authorization headers for incoming REST connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"drop\"`. The allowed values and their meaning are:\n\n
\n\"drop\" - Do not attach the Authorization header to the message as a user property. This configuration is most secure.\n\"forward\" - Forward the Authorization header, attaching it to the message as a user property in the same way as other headers. For best security, use the drop setting.\n\"legacy\" - If the Authorization header was used for authentication to the broker, do not attach it to the message. If the Authorization header was not used for authentication to the broker, attach it to the message as a user property in the same way as other headers. For best security, use the drop setting.\n
\n Available since 2.19.", + "enum": [ + "drop", + "forward", + "legacy" + ], + "type": "string" + }, + "serviceRestIncomingMaxConnectionCount": { + "description": "The maximum number of REST incoming client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.", + "format": "int64", + "type": "integer" + }, + "serviceRestIncomingPlainTextEnabled": { + "description": "Enable or disable the plain-text REST service for incoming clients in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "serviceRestIncomingPlainTextListenPort": { + "description": "The port number for incoming plain-text REST clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "serviceRestIncomingTlsEnabled": { + "description": "Enable or disable the use of encryption (TLS) for the REST service for incoming clients in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "serviceRestIncomingTlsListenPort": { + "description": "The port number for incoming REST clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "serviceRestMode": { + "description": "The REST service mode for incoming REST clients that connect to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"messaging\"`. The allowed values and their meaning are:\n\n
\n\"gateway\" - Act as a message gateway through which REST messages are propagated.\n\"messaging\" - Act as a message broker on which REST messages are queued.\n
\n Available since 2.6.", + "enum": [ + "gateway", + "messaging" + ], + "type": "string" + }, + "serviceRestOutgoingMaxConnectionCount": { + "description": "The maximum number of REST Consumer (outgoing) client connections that can be simultaneously connected to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.", + "format": "int64", + "type": "integer" + }, + "serviceSmfMaxConnectionCount": { + "description": "The maximum number of SMF client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.", + "format": "int64", + "type": "integer" + }, + "serviceSmfPlainTextEnabled": { + "description": "Enable or disable the plain-text SMF service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "serviceSmfTlsEnabled": { + "description": "Enable or disable the use of encryption (TLS) for the SMF service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "serviceWebAuthenticationClientCertRequest": { + "description": "Determines when to request a client certificate from a Web Transport client connecting via a TLS port. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-enabled-in-message-vpn\"`. The allowed values and their meaning are:\n\n
\n\"always\" - Always ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration.\n\"never\" - Never ask for a client certificate regardless of the \"message-vpn > authentication > client-certificate > shutdown\" configuration.\n\"when-enabled-in-message-vpn\" - Only ask for a client-certificate if client certificate authentication is enabled under \"message-vpn >  authentication > client-certificate > shutdown\".\n
\n Available since 2.21.", + "enum": [ + "always", + "never", + "when-enabled-in-message-vpn" + ], + "type": "string" + }, + "serviceWebMaxConnectionCount": { + "description": "The maximum number of Web Transport client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.", + "format": "int64", + "type": "integer" + }, + "serviceWebPlainTextEnabled": { + "description": "Enable or disable the plain-text Web Transport service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "serviceWebTlsEnabled": { + "description": "Enable or disable the use of TLS for the Web Transport service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "tlsAllowDowngradeToPlainTextEnabled": { + "description": "Enable or disable the allowing of TLS SMF clients to downgrade their connections to plain-text connections. Changing this will not affect existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "MsgVpnAclProfile": { + "properties": { + "aclProfileName": { + "description": "The name of the ACL Profile.", + "type": "string" + }, + "clientConnectDefaultAction": { + "description": "The default action to take when a client using the ACL Profile connects to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"disallow\"`. The allowed values and their meaning are:\n\n
\n\"allow\" - Allow client connection unless an exception is found for it.\n\"disallow\" - Disallow client connection unless an exception is found for it.\n
\n", + "enum": [ + "allow", + "disallow" + ], + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "publishTopicDefaultAction": { + "description": "The default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"disallow\"`. The allowed values and their meaning are:\n\n
\n\"allow\" - Allow topic unless an exception is found for it.\n\"disallow\" - Disallow topic unless an exception is found for it.\n
\n", + "enum": [ + "allow", + "disallow" + ], + "type": "string" + }, + "subscribeShareNameDefaultAction": { + "description": "The default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"allow\"`. The allowed values and their meaning are:\n\n
\n\"allow\" - Allow topic unless an exception is found for it.\n\"disallow\" - Disallow topic unless an exception is found for it.\n
\n Available since 2.14.", + "enum": [ + "allow", + "disallow" + ], + "type": "string" + }, + "subscribeTopicDefaultAction": { + "description": "The default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"disallow\"`. The allowed values and their meaning are:\n\n
\n\"allow\" - Allow topic unless an exception is found for it.\n\"disallow\" - Disallow topic unless an exception is found for it.\n
\n", + "enum": [ + "allow", + "disallow" + ], + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAclProfileClientConnectException": { + "properties": { + "aclProfileName": { + "description": "The name of the ACL Profile.", + "type": "string" + }, + "clientConnectExceptionAddress": { + "description": "The IP address/netmask of the client connect exception in CIDR form.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAclProfileClientConnectExceptionLinks": { + "properties": { + "uri": { + "description": "The URI of this Client Connect Exception object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAclProfileClientConnectExceptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnAclProfileClientConnectException" + }, + "links": { + "$ref": "#/definitions/MsgVpnAclProfileClientConnectExceptionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAclProfileClientConnectExceptionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnAclProfileClientConnectException" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnAclProfileClientConnectExceptionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAclProfileLinks": { + "properties": { + "clientConnectExceptionsUri": { + "description": "The URI of this ACL Profile's collection of Client Connect Exception objects.", + "type": "string" + }, + "publishExceptionsUri": { + "description": "The URI of this ACL Profile's collection of Publish Topic Exception objects. Deprecated since 2.14. Replaced by publishTopicExceptions.", + "type": "string" + }, + "publishTopicExceptionsUri": { + "description": "The URI of this ACL Profile's collection of Publish Topic Exception objects. Available since 2.14.", + "type": "string" + }, + "subscribeExceptionsUri": { + "description": "The URI of this ACL Profile's collection of Subscribe Topic Exception objects. Deprecated since 2.14. Replaced by subscribeTopicExceptions.", + "type": "string" + }, + "subscribeShareNameExceptionsUri": { + "description": "The URI of this ACL Profile's collection of Subscribe Share Name Exception objects. Available since 2.14.", + "type": "string" + }, + "subscribeTopicExceptionsUri": { + "description": "The URI of this ACL Profile's collection of Subscribe Topic Exception objects. Available since 2.14.", + "type": "string" + }, + "uri": { + "description": "The URI of this ACL Profile object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAclProfilePublishException": { + "properties": { + "aclProfileName": { + "description": "The name of the ACL Profile. Deprecated since 2.14. Replaced by publishTopicExceptions.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN. Deprecated since 2.14. Replaced by publishTopicExceptions.", + "type": "string" + }, + "publishExceptionTopic": { + "description": "The topic for the exception to the default action taken. May include wildcard characters. Deprecated since 2.14. Replaced by publishTopicExceptions.", + "type": "string" + }, + "topicSyntax": { + "description": "The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are:\n\n
\n\"smf\" - Topic uses SMF syntax.\n\"mqtt\" - Topic uses MQTT syntax.\n
\n Deprecated since 2.14. Replaced by publishTopicExceptions.", + "enum": [ + "smf", + "mqtt" + ], + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAclProfilePublishExceptionLinks": { + "properties": { + "uri": { + "description": "The URI of this Publish Topic Exception object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAclProfilePublishExceptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnAclProfilePublishException" + }, + "links": { + "$ref": "#/definitions/MsgVpnAclProfilePublishExceptionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAclProfilePublishExceptionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnAclProfilePublishException" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnAclProfilePublishExceptionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAclProfilePublishTopicException": { + "properties": { + "aclProfileName": { + "description": "The name of the ACL Profile.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "publishTopicException": { + "description": "The topic for the exception to the default action taken. May include wildcard characters.", + "type": "string" + }, + "publishTopicExceptionSyntax": { + "description": "The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are:\n\n
\n\"smf\" - Topic uses SMF syntax.\n\"mqtt\" - Topic uses MQTT syntax.\n
\n", + "enum": [ + "smf", + "mqtt" + ], + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAclProfilePublishTopicExceptionLinks": { + "properties": { + "uri": { + "description": "The URI of this Publish Topic Exception object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAclProfilePublishTopicExceptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnAclProfilePublishTopicException" + }, + "links": { + "$ref": "#/definitions/MsgVpnAclProfilePublishTopicExceptionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAclProfilePublishTopicExceptionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnAclProfilePublishTopicException" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnAclProfilePublishTopicExceptionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAclProfileResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnAclProfile" + }, + "links": { + "$ref": "#/definitions/MsgVpnAclProfileLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAclProfileSubscribeException": { + "properties": { + "aclProfileName": { + "description": "The name of the ACL Profile. Deprecated since 2.14. Replaced by subscribeTopicExceptions.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN. Deprecated since 2.14. Replaced by subscribeTopicExceptions.", + "type": "string" + }, + "subscribeExceptionTopic": { + "description": "The topic for the exception to the default action taken. May include wildcard characters. Deprecated since 2.14. Replaced by subscribeTopicExceptions.", + "type": "string" + }, + "topicSyntax": { + "description": "The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are:\n\n
\n\"smf\" - Topic uses SMF syntax.\n\"mqtt\" - Topic uses MQTT syntax.\n
\n Deprecated since 2.14. Replaced by subscribeTopicExceptions.", + "enum": [ + "smf", + "mqtt" + ], + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAclProfileSubscribeExceptionLinks": { + "properties": { + "uri": { + "description": "The URI of this Subscribe Topic Exception object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAclProfileSubscribeExceptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeException" + }, + "links": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeExceptionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAclProfileSubscribeExceptionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeException" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeExceptionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAclProfileSubscribeShareNameException": { + "properties": { + "aclProfileName": { + "description": "The name of the ACL Profile.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "subscribeShareNameException": { + "description": "The subscribe share name exception to the default action taken. May include wildcard characters.", + "type": "string" + }, + "subscribeShareNameExceptionSyntax": { + "description": "The syntax of the subscribe share name for the exception to the default action taken. The allowed values and their meaning are:\n\n
\n\"smf\" - Topic uses SMF syntax.\n\"mqtt\" - Topic uses MQTT syntax.\n
\n", + "enum": [ + "smf", + "mqtt" + ], + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAclProfileSubscribeShareNameExceptionLinks": { + "properties": { + "uri": { + "description": "The URI of this Subscribe Share Name Exception object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAclProfileSubscribeShareNameExceptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameException" + }, + "links": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameExceptionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAclProfileSubscribeShareNameExceptionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameException" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameExceptionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAclProfileSubscribeTopicException": { + "properties": { + "aclProfileName": { + "description": "The name of the ACL Profile.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "subscribeTopicException": { + "description": "The topic for the exception to the default action taken. May include wildcard characters.", + "type": "string" + }, + "subscribeTopicExceptionSyntax": { + "description": "The syntax of the topic for the exception to the default action taken. The allowed values and their meaning are:\n\n
\n\"smf\" - Topic uses SMF syntax.\n\"mqtt\" - Topic uses MQTT syntax.\n
\n", + "enum": [ + "smf", + "mqtt" + ], + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAclProfileSubscribeTopicExceptionLinks": { + "properties": { + "uri": { + "description": "The URI of this Subscribe Topic Exception object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAclProfileSubscribeTopicExceptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicException" + }, + "links": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicExceptionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAclProfileSubscribeTopicExceptionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicException" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicExceptionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAclProfilesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnAclProfile" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnAclProfileLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAuthenticationOauthProfile": { + "properties": { + "authorizationGroupsClaimName": { + "description": "The name of the groups claim. If non-empty, the specified claim will be used to determine groups for authorization. If empty, the authorizationType attribute of the Message VPN will be used to determine authorization. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"groups\"`.", + "type": "string" + }, + "clientId": { + "description": "The OAuth client id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "clientRequiredType": { + "description": "The required value for the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"JWT\"`.", + "type": "string" + }, + "clientSecret": { + "description": "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "clientValidateTypeEnabled": { + "description": "Enable or disable verification of the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "disconnectOnTokenExpirationEnabled": { + "description": "Enable or disable the disconnection of clients when their tokens expire. Changing this value does not affect existing clients, only new client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "enabled": { + "description": "Enable or disable the OAuth profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "endpointDiscovery": { + "description": "The OpenID Connect discovery endpoint or OAuth Authorization Server Metadata endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "endpointDiscoveryRefreshInterval": { + "description": "The number of seconds between discovery endpoint requests. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `86400`.", + "format": "int32", + "type": "integer" + }, + "endpointIntrospection": { + "description": "The OAuth introspection endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "endpointIntrospectionTimeout": { + "description": "The maximum time in seconds a token introspection request is allowed to take. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", + "format": "int32", + "type": "integer" + }, + "endpointJwks": { + "description": "The OAuth JWKS endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "endpointJwksRefreshInterval": { + "description": "The number of seconds between JWKS endpoint requests. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `86400`.", + "format": "int32", + "type": "integer" + }, + "endpointUserinfo": { + "description": "The OpenID Connect Userinfo endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "endpointUserinfoTimeout": { + "description": "The maximum time in seconds a userinfo request is allowed to take. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", + "format": "int32", + "type": "integer" + }, + "issuer": { + "description": "The Issuer Identifier for the OAuth provider. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "mqttUsernameValidateEnabled": { + "description": "Enable or disable whether the API provided MQTT client username will be validated against the username calculated from the token(s). When enabled, connection attempts by MQTT clients are rejected if they differ. Note that this value only applies to MQTT clients; SMF client usernames will not be validated. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "type": "string" + }, + "oauthRole": { + "description": "The OAuth role of the broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"client\"`. The allowed values and their meaning are:\n\n
\n\"client\" - The broker is in the OAuth client role.\n\"resource-server\" - The broker is in the OAuth resource server role.\n
\n", + "enum": [ + "client", + "resource-server" + ], + "type": "string" + }, + "resourceServerParseAccessTokenEnabled": { + "description": "Enable or disable parsing of the access token as a JWT. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "resourceServerRequiredAudience": { + "description": "The required audience value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "resourceServerRequiredIssuer": { + "description": "The required issuer value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "resourceServerRequiredScope": { + "description": "A space-separated list of scopes that must be present in the scope claim. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "resourceServerRequiredType": { + "description": "The required TYP value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"at+jwt\"`.", + "type": "string" + }, + "resourceServerValidateAudienceEnabled": { + "description": "Enable or disable verification of the audience claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "resourceServerValidateIssuerEnabled": { + "description": "Enable or disable verification of the issuer claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "resourceServerValidateScopeEnabled": { + "description": "Enable or disable verification of the scope claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "resourceServerValidateTypeEnabled": { + "description": "Enable or disable verification of the TYP field in the access token header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "usernameClaimName": { + "description": "The name of the username claim. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sub\"`.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAuthenticationOauthProfileClientRequiredClaim": { + "properties": { + "clientRequiredClaimName": { + "description": "The name of the ID token claim to verify.", + "type": "string" + }, + "clientRequiredClaimValue": { + "description": "The required claim value.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks": { + "properties": { + "uri": { + "description": "The URI of this Required Claim object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaim" + }, + "links": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaim" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAuthenticationOauthProfileLinks": { + "properties": { + "clientRequiredClaimsUri": { + "description": "The URI of this OAuth Profile's collection of Required Claim objects.", + "type": "string" + }, + "resourceServerRequiredClaimsUri": { + "description": "The URI of this OAuth Profile's collection of Required Claim objects.", + "type": "string" + }, + "uri": { + "description": "The URI of this OAuth Profile object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim": { + "properties": { + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "type": "string" + }, + "resourceServerRequiredClaimName": { + "description": "The name of the access token claim to verify.", + "type": "string" + }, + "resourceServerRequiredClaimValue": { + "description": "The required claim value.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks": { + "properties": { + "uri": { + "description": "The URI of this Required Claim object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim" + }, + "links": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAuthenticationOauthProfileResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" + }, + "links": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAuthenticationOauthProfilesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAuthenticationOauthProvider": { + "properties": { + "audienceClaimName": { + "description": "The audience claim name, indicating which part of the object to use for determining the audience. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"aud\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "type": "string" + }, + "audienceClaimSource": { + "description": "The audience claim source, indicating where to search for the audience value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"id-token\"`. The allowed values and their meaning are:\n\n
\n\"access-token\" - The OAuth v2 access_token.\n\"id-token\" - The OpenID Connect id_token.\n\"introspection\" - The result of introspecting the OAuth v2 access_token.\n
\n Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "enum": [ + "access-token", + "id-token", + "introspection" + ], + "type": "string" + }, + "audienceClaimValue": { + "description": "The required audience value for a token to be considered valid. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "type": "string" + }, + "audienceValidationEnabled": { + "description": "Enable or disable audience validation. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "type": "boolean" + }, + "authorizationGroupClaimName": { + "description": "The authorization group claim name, indicating which part of the object to use for determining the authorization group. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"scope\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "type": "string" + }, + "authorizationGroupClaimSource": { + "description": "The authorization group claim source, indicating where to search for the authorization group name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"id-token\"`. The allowed values and their meaning are:\n\n
\n\"access-token\" - The OAuth v2 access_token.\n\"id-token\" - The OpenID Connect id_token.\n\"introspection\" - The result of introspecting the OAuth v2 access_token.\n
\n Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "enum": [ + "access-token", + "id-token", + "introspection" + ], + "type": "string" + }, + "authorizationGroupEnabled": { + "description": "Enable or disable OAuth based authorization. When enabled, the configured authorization type for OAuth clients is overridden. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "type": "boolean" + }, + "disconnectOnTokenExpirationEnabled": { + "description": "Enable or disable the disconnection of clients when their tokens expire. Changing this value does not affect existing clients, only new client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "type": "boolean" + }, + "enabled": { + "description": "Enable or disable OAuth Provider client authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "type": "boolean" + }, + "jwksRefreshInterval": { + "description": "The number of seconds between forced JWKS public key refreshing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `86400`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "format": "int32", + "type": "integer" + }, + "jwksUri": { + "description": "The URI where the OAuth provider publishes its JWKS public keys. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN. Deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "type": "string" + }, + "oauthProviderName": { + "description": "The name of the OAuth Provider. Deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "type": "string" + }, + "tokenIgnoreTimeLimitsEnabled": { + "description": "Enable or disable whether to ignore time limits and accept tokens that are not yet valid or are no longer valid. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "type": "boolean" + }, + "tokenIntrospectionParameterName": { + "description": "The parameter name used to identify the token during access token introspection. A standards compliant OAuth introspection server expects \"token\". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"token\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "type": "string" + }, + "tokenIntrospectionPassword": { + "description": "The password to use when logging into the token introspection URI. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "type": "string" + }, + "tokenIntrospectionTimeout": { + "description": "The maximum time in seconds a token introspection is allowed to take. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "format": "int32", + "type": "integer" + }, + "tokenIntrospectionUri": { + "description": "The token introspection URI of the OAuth authentication server. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "type": "string" + }, + "tokenIntrospectionUsername": { + "description": "The username to use when logging into the token introspection URI. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "type": "string" + }, + "usernameClaimName": { + "description": "The username claim name, indicating which part of the object to use for determining the username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sub\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "type": "string" + }, + "usernameClaimSource": { + "description": "The username claim source, indicating where to search for the username value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"id-token\"`. The allowed values and their meaning are:\n\n
\n\"access-token\" - The OAuth v2 access_token.\n\"id-token\" - The OpenID Connect id_token.\n\"introspection\" - The result of introspecting the OAuth v2 access_token.\n
\n Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "enum": [ + "access-token", + "id-token", + "introspection" + ], + "type": "string" + }, + "usernameValidateEnabled": { + "description": "Enable or disable whether the API provided username will be validated against the username calculated from the token(s); the connection attempt is rejected if they differ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "type": "boolean" + } + }, + "type": "object" + }, + "MsgVpnAuthenticationOauthProviderLinks": { + "properties": { + "uri": { + "description": "The URI of this OAuth Provider object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAuthenticationOauthProviderResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProvider" + }, + "links": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAuthenticationOauthProvidersResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProvider" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAuthorizationGroup": { + "properties": { + "aclProfileName": { + "description": "The ACL Profile of the Authorization Group. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`.", + "type": "string" + }, + "authorizationGroupName": { + "description": "The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'.", + "type": "string" + }, + "clientProfileName": { + "description": "The Client Profile of the Authorization Group. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`.", + "type": "string" + }, + "enabled": { + "description": "Enable or disable the Authorization Group in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "orderAfterAuthorizationGroupName": { + "description": "Lower the priority to be less than this group. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.", + "type": "string" + }, + "orderBeforeAuthorizationGroupName": { + "description": "Raise the priority to be greater than this group. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAuthorizationGroupLinks": { + "properties": { + "uri": { + "description": "The URI of this Authorization Group object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAuthorizationGroupResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnAuthorizationGroup" + }, + "links": { + "$ref": "#/definitions/MsgVpnAuthorizationGroupLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAuthorizationGroupsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnAuthorizationGroup" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnAuthorizationGroupLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnBridge": { + "properties": { + "bridgeName": { + "description": "The name of the Bridge.", + "type": "string" + }, + "bridgeVirtualRouter": { + "description": "The virtual router of the Bridge. The allowed values and their meaning are:\n\n
\n\"primary\" - The Bridge is used for the primary virtual router.\n\"backup\" - The Bridge is used for the backup virtual router.\n\"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role.\n
\n", + "enum": [ + "primary", + "backup", + "auto" + ], + "type": "string" + }, + "enabled": { + "description": "Enable or disable the Bridge. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "maxTtl": { + "description": "The maximum time-to-live (TTL) in hops. Messages are discarded if their TTL exceeds this value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `8`.", + "format": "int64", + "type": "integer" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "remoteAuthenticationBasicClientUsername": { + "description": "The Client Username the Bridge uses to login to the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "remoteAuthenticationBasicPassword": { + "description": "The password for the Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "remoteAuthenticationClientCertContent": { + "description": "The PEM formatted content for the client certificate used by the Bridge to login to the remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9.", + "type": "string", + "x-requires-https": true + }, + "remoteAuthenticationClientCertPassword": { + "description": "The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9.", + "type": "string", + "x-requires-https": true + }, + "remoteAuthenticationScheme": { + "description": "The authentication scheme for the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"basic\"`. The allowed values and their meaning are:\n\n
\n\"basic\" - Basic Authentication Scheme (via username and password).\n\"client-certificate\" - Client Certificate Authentication Scheme (via certificate file or content).\n
\n", + "enum": [ + "basic", + "client-certificate" + ], + "type": "string" + }, + "remoteConnectionRetryCount": { + "description": "The maximum number of retry attempts to establish a connection to the remote Message VPN. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "remoteConnectionRetryDelay": { + "description": "The number of seconds the broker waits for the bridge connection to be established before attempting a new connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", + "format": "int64", + "type": "integer" + }, + "remoteDeliverToOnePriority": { + "description": "The priority for deliver-to-one (DTO) messages transmitted from the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"p1\"`. The allowed values and their meaning are:\n\n
\n\"p1\" - The 1st or highest priority.\n\"p2\" - The 2nd highest priority.\n\"p3\" - The 3rd highest priority.\n\"p4\" - The 4th highest priority.\n\"da\" - Ignore priority and deliver always.\n
\n", + "enum": [ + "p1", + "p2", + "p3", + "p4", + "da" + ], + "type": "string" + }, + "tlsCipherSuiteList": { + "description": "The colon-separated list of cipher suites supported for TLS connections to the remote Message VPN. The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnBridgeLinks": { + "properties": { + "remoteMsgVpnsUri": { + "description": "The URI of this Bridge's collection of Remote Message VPN objects.", + "type": "string" + }, + "remoteSubscriptionsUri": { + "description": "The URI of this Bridge's collection of Remote Subscription objects.", + "type": "string" + }, + "tlsTrustedCommonNamesUri": { + "description": "The URI of this Bridge's collection of Trusted Common Name objects. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "type": "string" + }, + "uri": { + "description": "The URI of this Bridge object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnBridgeRemoteMsgVpn": { + "properties": { + "bridgeName": { + "description": "The name of the Bridge.", + "type": "string" + }, + "bridgeVirtualRouter": { + "description": "The virtual router of the Bridge. The allowed values and their meaning are:\n\n
\n\"primary\" - The Bridge is used for the primary virtual router.\n\"backup\" - The Bridge is used for the backup virtual router.\n\"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role.\n
\n", + "enum": [ + "primary", + "backup", + "auto" + ], + "type": "string" + }, + "clientUsername": { + "description": "The Client Username the Bridge uses to login to the remote Message VPN. This per remote Message VPN value overrides the value provided for the Bridge overall. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "compressedDataEnabled": { + "description": "Enable or disable data compression for the remote Message VPN connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "connectOrder": { + "description": "The preference given to incoming connections from remote Message VPN hosts, from 1 (highest priority) to 4 (lowest priority). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`.", + "format": "int32", + "type": "integer" + }, + "egressFlowWindowSize": { + "description": "The number of outstanding guaranteed messages that can be transmitted over the remote Message VPN connection before an acknowledgement is received. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`.", + "format": "int64", + "type": "integer" + }, + "enabled": { + "description": "Enable or disable the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "password": { + "description": "The password for the Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "queueBinding": { + "description": "The queue binding of the Bridge in the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "remoteMsgVpnInterface": { + "description": "The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name.", + "type": "string" + }, + "remoteMsgVpnLocation": { + "description": "The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\").", + "type": "string" + }, + "remoteMsgVpnName": { + "description": "The name of the remote Message VPN.", + "type": "string" + }, + "tlsEnabled": { + "description": "Enable or disable encryption (TLS) for the remote Message VPN connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "unidirectionalClientProfile": { + "description": "The Client Profile for the unidirectional Bridge of the remote Message VPN. The Client Profile must exist in the local Message VPN, and it is used only for the TCP parameters. Note that the default client profile has a TCP maximum window size of 2MB. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#client-profile\"`.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnBridgeRemoteMsgVpnLinks": { + "properties": { + "uri": { + "description": "The URI of this Remote Message VPN object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnBridgeRemoteMsgVpnResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpn" + }, + "links": { + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnBridgeRemoteMsgVpnsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpn" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnBridgeRemoteSubscription": { + "properties": { + "bridgeName": { + "description": "The name of the Bridge.", + "type": "string" + }, + "bridgeVirtualRouter": { + "description": "The virtual router of the Bridge. The allowed values and their meaning are:\n\n
\n\"primary\" - The Bridge is used for the primary virtual router.\n\"backup\" - The Bridge is used for the backup virtual router.\n\"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role.\n
\n", + "enum": [ + "primary", + "backup", + "auto" + ], + "type": "string" + }, + "deliverAlwaysEnabled": { + "description": "Enable or disable deliver-always for the Bridge remote subscription topic instead of a deliver-to-one remote priority. A given topic for the Bridge may be deliver-to-one or deliver-always but not both.", + "type": "boolean" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "remoteSubscriptionTopic": { + "description": "The topic of the Bridge remote subscription.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnBridgeRemoteSubscriptionLinks": { + "properties": { + "uri": { + "description": "The URI of this Remote Subscription object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnBridgeRemoteSubscriptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnBridgeRemoteSubscription" + }, + "links": { + "$ref": "#/definitions/MsgVpnBridgeRemoteSubscriptionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnBridgeRemoteSubscriptionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnBridgeRemoteSubscription" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnBridgeRemoteSubscriptionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnBridgeResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnBridge" + }, + "links": { + "$ref": "#/definitions/MsgVpnBridgeLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnBridgeTlsTrustedCommonName": { + "properties": { + "bridgeName": { + "description": "The name of the Bridge. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "type": "string" + }, + "bridgeVirtualRouter": { + "description": "The virtual router of the Bridge. The allowed values and their meaning are:\n\n
\n\"primary\" - The Bridge is used for the primary virtual router.\n\"backup\" - The Bridge is used for the backup virtual router.\n\"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role.\n
\n Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "enum": [ + "primary", + "backup", + "auto" + ], + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "type": "string" + }, + "tlsTrustedCommonName": { + "description": "The expected trusted common name of the remote certificate. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnBridgeTlsTrustedCommonNameLinks": { + "properties": { + "uri": { + "description": "The URI of this Trusted Common Name object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnBridgeTlsTrustedCommonNameResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonName" + }, + "links": { + "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonNameLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnBridgeTlsTrustedCommonNamesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonName" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonNameLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnBridgesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnBridge" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnBridgeLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnCertMatchingRule": { + "properties": { + "enabled": { + "description": "Enable or disable a certificate matching rule. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "ruleName": { + "description": "The name of the rule.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnCertMatchingRuleAttributeFilter": { + "properties": { + "attributeName": { + "description": "Client Username Attribute to be tested. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "attributeValue": { + "description": "Expected attribute value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "filterName": { + "description": "The name of the filter.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "ruleName": { + "description": "The name of the rule.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnCertMatchingRuleAttributeFilterLinks": { + "properties": { + "uri": { + "description": "The URI of this Certificate Matching Rule Attribute Filter object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnCertMatchingRuleAttributeFilterResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilter" + }, + "links": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnCertMatchingRuleAttributeFiltersResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilter" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnCertMatchingRuleCondition": { + "properties": { + "attribute": { + "description": "Client Username Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The default value is `\"\"`.", + "type": "string" + }, + "expression": { + "description": "Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The default value is `\"\"`.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "ruleName": { + "description": "The name of the rule.", + "type": "string" + }, + "source": { + "description": "Certificate field to be compared with the Attribute. The allowed values and their meaning are:\n\n
\n\"certificate-thumbprint\" - The attribute is computed as the SHA-1 hash over the entire DER-encoded contents of the client certificate.\n\"common-name\" - The attribute is extracted from the certificate's first instance of the Common Name attribute in the Subject DN.\n\"common-name-last\" - The attribute is extracted from the certificate's last instance of the Common Name attribute in the Subject DN.\n\"subject-alternate-name-msupn\" - The attribute is extracted from the certificate's Other Name type of the Subject Alternative Name and must have the msUPN signature.\n\"uid\" - The attribute is extracted from the certificate's first instance of the User Identifier attribute in the Subject DN.\n\"uid-last\" - The attribute is extracted from the certificate's last instance of the User Identifier attribute in the Subject DN.\n\"org-unit\" - The attribute is extracted from the certificate's first instance of the Org Unit attribute in the Subject DN.\n\"org-unit-last\" - The attribute is extracted from the certificate's last instance of the Org Unit attribute in the Subject DN.\n\"issuer\" - The attribute is extracted from the certificate's Issuer DN.\n\"subject\" - The attribute is extracted from the certificate's Subject DN.\n\"serial-number\" - The attribute is extracted from the certificate's Serial Number.\n\"dns-name\" - The attribute is extracted from the certificate's Subject Alt Name DNSName.\n\"ip-address\" - The attribute is extracted from the certificate's Subject Alt Name IPAddress.\n
\n", + "enum": [ + "certificate-thumbprint", + "common-name", + "common-name-last", + "subject-alternate-name-msupn", + "uid", + "uid-last", + "org-unit", + "org-unit-last", + "issuer", + "subject", + "serial-number", + "dns-name", + "ip-address" + ], + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnCertMatchingRuleConditionLinks": { + "properties": { + "uri": { + "description": "The URI of this Certificate Matching Rule Condition object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnCertMatchingRuleConditionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleCondition" + }, + "links": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleConditionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnCertMatchingRuleConditionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleCondition" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleConditionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnCertMatchingRuleLinks": { + "properties": { + "attributeFiltersUri": { + "description": "The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Attribute Filter objects. Available since 2.28.", + "type": "string" + }, + "conditionsUri": { + "description": "The URI of this Certificate Matching Rule's collection of Certificate Matching Rule Condition objects.", + "type": "string" + }, + "uri": { + "description": "The URI of this Certificate Matching Rule object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnCertMatchingRuleResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnCertMatchingRule" + }, + "links": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnCertMatchingRulesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnCertMatchingRule" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnClientProfile": { + "properties": { + "allowBridgeConnectionsEnabled": { + "description": "Enable or disable allowing Bridge clients using the Client Profile to connect. Changing this setting does not affect existing Bridge client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "allowCutThroughForwardingEnabled": { + "description": "Enable or disable allowing clients using the Client Profile to bind to endpoints with the cut-through forwarding delivery mode. Changing this value does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.22. This attribute has been deprecated. Please visit the Solace Product Lifecycle Policy web page for details on deprecated features.", + "type": "boolean" + }, + "allowGuaranteedEndpointCreateDurability": { + "description": "The types of Queues and Topic Endpoints that clients using the client-profile can create. Changing this value does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"all\"`. The allowed values and their meaning are:\n\n
\n\"all\" - Client can create any type of endpoint.\n\"durable\" - Client can create only durable endpoints.\n\"non-durable\" - Client can create only non-durable endpoints.\n
\n Available since 2.14.", + "enum": [ + "all", + "durable", + "non-durable" + ], + "type": "string" + }, + "allowGuaranteedEndpointCreateEnabled": { + "description": "Enable or disable allowing clients using the Client Profile to create topic endponts or queues. Changing this value does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "allowGuaranteedMsgReceiveEnabled": { + "description": "Enable or disable allowing clients using the Client Profile to receive guaranteed messages. Changing this setting does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "allowGuaranteedMsgSendEnabled": { + "description": "Enable or disable allowing clients using the Client Profile to send guaranteed messages. Changing this setting does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "allowSharedSubscriptionsEnabled": { + "description": "Enable or disable allowing shared subscriptions. Changing this setting does not affect existing subscriptions. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.11.", + "type": "boolean" + }, + "allowTransactedSessionsEnabled": { + "description": "Enable or disable allowing clients using the Client Profile to establish transacted sessions. Changing this setting does not affect existing client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "apiQueueManagementCopyFromOnCreateName": { + "description": "The name of a queue to copy settings from when a new queue is created by a client using the Client Profile. The referenced queue must exist in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.14. This attribute has been replaced with `apiQueueManagementCopyFromOnCreateTemplateName`.", + "type": "string" + }, + "apiQueueManagementCopyFromOnCreateTemplateName": { + "description": "The name of a queue template to copy settings from when a new queue is created by a client using the Client Profile. If the referenced queue template does not exist, queue creation will fail when it tries to resolve this template. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14.", + "type": "string" + }, + "apiTopicEndpointManagementCopyFromOnCreateName": { + "description": "The name of a topic endpoint to copy settings from when a new topic endpoint is created by a client using the Client Profile. The referenced topic endpoint must exist in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.14. This attribute has been replaced with `apiTopicEndpointManagementCopyFromOnCreateTemplateName`.", + "type": "string" + }, + "apiTopicEndpointManagementCopyFromOnCreateTemplateName": { + "description": "The name of a topic endpoint template to copy settings from when a new topic endpoint is created by a client using the Client Profile. If the referenced topic endpoint template does not exist, topic endpoint creation will fail when it tries to resolve this template. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14.", + "type": "string" + }, + "clientProfileName": { + "description": "The name of the Client Profile.", + "type": "string" + }, + "compressionEnabled": { + "description": "Enable or disable allowing clients using the Client Profile to use compression. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.10.", + "type": "boolean" + }, + "elidingDelay": { + "description": "The amount of time to delay the delivery of messages to clients using the Client Profile after the initial message has been delivered (the eliding delay interval), in milliseconds. A value of 0 means there is no delay in delivering messages to clients. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "elidingEnabled": { + "description": "Enable or disable message eliding for clients using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "elidingMaxTopicCount": { + "description": "The maximum number of topics tracked for message eliding per client connection using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `256`.", + "format": "int64", + "type": "integer" + }, + "eventClientProvisionedEndpointSpoolUsageThreshold": { + "$ref": "#/definitions/EventThresholdByPercent" + }, + "eventConnectionCountPerClientUsernameThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventEgressFlowCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventEndpointCountPerClientUsernameThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventIngressFlowCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventServiceSmfConnectionCountPerClientUsernameThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventServiceWebConnectionCountPerClientUsernameThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventSubscriptionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventTransactedSessionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventTransactionCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "maxConnectionCountPerClientUsername": { + "description": "The maximum number of client connections per Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.", + "format": "int64", + "type": "integer" + }, + "maxEgressFlowCount": { + "description": "The maximum number of transmit flows that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "format": "int64", + "type": "integer" + }, + "maxEndpointCountPerClientUsername": { + "description": "The maximum number of queues and topic endpoints that can be created by clients with the same Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "format": "int64", + "type": "integer" + }, + "maxIngressFlowCount": { + "description": "The maximum number of receive flows that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "format": "int64", + "type": "integer" + }, + "maxMsgsPerTransaction": { + "description": "The maximum number of publisher and consumer messages combined that is allowed within a transaction for each client associated with this client-profile. Exceeding this limit will result in a transaction prepare or commit failure. Changing this value during operation will not affect existing sessions. It is only validated at transaction creation time. Large transactions consume more resources and are more likely to require retrieving messages from the ADB or from disk to process the transaction prepare or commit requests. The transaction processing rate may diminish if a large number of messages must be retrieved from the ADB or from disk. Care should be taken to not use excessively large transactions needlessly to avoid exceeding resource limits and to avoid reducing the overall broker performance. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `256`. Available since 2.20.", + "format": "int32", + "type": "integer" + }, + "maxSubscriptionCount": { + "description": "The maximum number of subscriptions per client using the Client Profile. This limit is not enforced when a client adds a subscription to an endpoint, except for MQTT QoS 1 subscriptions. In addition, this limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.", + "format": "int64", + "type": "integer" + }, + "maxTransactedSessionCount": { + "description": "The maximum number of transacted sessions that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10`.", + "format": "int64", + "type": "integer" + }, + "maxTransactionCount": { + "description": "The maximum number of transactions that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.", + "format": "int64", + "type": "integer" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "queueControl1MaxDepth": { + "description": "The maximum depth of the \"Control 1\" (C-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`.", + "format": "int32", + "type": "integer" + }, + "queueControl1MinMsgBurst": { + "description": "The number of messages that are always allowed entry into the \"Control 1\" (C-1) priority queue, regardless of the `queueControl1MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`.", + "format": "int32", + "type": "integer" + }, + "queueDirect1MaxDepth": { + "description": "The maximum depth of the \"Direct 1\" (D-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`.", + "format": "int32", + "type": "integer" + }, + "queueDirect1MinMsgBurst": { + "description": "The number of messages that are always allowed entry into the \"Direct 1\" (D-1) priority queue, regardless of the `queueDirect1MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`.", + "format": "int32", + "type": "integer" + }, + "queueDirect2MaxDepth": { + "description": "The maximum depth of the \"Direct 2\" (D-2) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`.", + "format": "int32", + "type": "integer" + }, + "queueDirect2MinMsgBurst": { + "description": "The number of messages that are always allowed entry into the \"Direct 2\" (D-2) priority queue, regardless of the `queueDirect2MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`.", + "format": "int32", + "type": "integer" + }, + "queueDirect3MaxDepth": { + "description": "The maximum depth of the \"Direct 3\" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`.", + "format": "int32", + "type": "integer" + }, + "queueDirect3MinMsgBurst": { + "description": "The number of messages that are always allowed entry into the \"Direct 3\" (D-3) priority queue, regardless of the `queueDirect3MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`.", + "format": "int32", + "type": "integer" + }, + "queueGuaranteed1MaxDepth": { + "description": "The maximum depth of the \"Guaranteed 1\" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`.", + "format": "int32", + "type": "integer" + }, + "queueGuaranteed1MinMsgBurst": { + "description": "The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-3) priority queue, regardless of the `queueGuaranteed1MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`.", + "format": "int32", + "type": "integer" + }, + "rejectMsgToSenderOnNoSubscriptionMatchEnabled": { + "description": "Enable or disable the sending of a negative acknowledgement (NACK) to a client using the Client Profile when discarding a guaranteed message due to no matching subscription found. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.2.", + "type": "boolean" + }, + "replicationAllowClientConnectWhenStandbyEnabled": { + "description": "Enable or disable allowing clients using the Client Profile to connect to the Message VPN when its replication state is standby. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "serviceMinKeepaliveTimeout": { + "description": "The minimum client keepalive timeout which will be enforced for client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30`. Available since 2.19.", + "format": "int32", + "type": "integer" + }, + "serviceSmfMaxConnectionCountPerClientUsername": { + "description": "The maximum number of SMF client connections per Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.", + "format": "int64", + "type": "integer" + }, + "serviceSmfMinKeepaliveEnabled": { + "description": "Enable or disable the enforcement of a minimum keepalive timeout for SMF clients. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.19.", + "type": "boolean" + }, + "serviceWebInactiveTimeout": { + "description": "The timeout for inactive Web Transport client sessions using the Client Profile, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30`.", + "format": "int64", + "type": "integer" + }, + "serviceWebMaxConnectionCountPerClientUsername": { + "description": "The maximum number of Web Transport client connections per Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.", + "format": "int64", + "type": "integer" + }, + "serviceWebMaxPayload": { + "description": "The maximum Web Transport payload size before fragmentation occurs for clients using the Client Profile, in bytes. The size of the header is not included. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000000`.", + "format": "int64", + "type": "integer" + }, + "tcpCongestionWindowSize": { + "description": "The TCP initial congestion window size for clients using the Client Profile, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2`.", + "format": "int64", + "type": "integer" + }, + "tcpKeepaliveCount": { + "description": "The number of TCP keepalive retransmissions to a client using the Client Profile before declaring that it is not available. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`.", + "format": "int64", + "type": "integer" + }, + "tcpKeepaliveIdleTime": { + "description": "The amount of time a client connection using the Client Profile must remain idle before TCP begins sending keepalive probes, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", + "format": "int64", + "type": "integer" + }, + "tcpKeepaliveInterval": { + "description": "The amount of time between TCP keepalive retransmissions to a client using the Client Profile when no acknowledgement is received, in seconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", + "format": "int64", + "type": "integer" + }, + "tcpMaxSegmentSize": { + "description": "The TCP maximum segment size for clients using the Client Profile, in bytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1460`.", + "format": "int64", + "type": "integer" + }, + "tcpMaxWindowSize": { + "description": "The TCP maximum window size for clients using the Client Profile, in kilobytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `256`.", + "format": "int64", + "type": "integer" + }, + "tlsAllowDowngradeToPlainTextEnabled": { + "description": "Enable or disable allowing a client using the Client Profile to downgrade an encrypted connection to plain text. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.8.", + "type": "boolean" + } + }, + "type": "object" + }, + "MsgVpnClientProfileLinks": { + "properties": { + "uri": { + "description": "The URI of this Client Profile object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnClientProfileResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnClientProfile" + }, + "links": { + "$ref": "#/definitions/MsgVpnClientProfileLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnClientProfilesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnClientProfile" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnClientProfileLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnClientUsername": { + "properties": { + "aclProfileName": { + "description": "The ACL Profile of the Client Username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`.", + "type": "string" + }, + "clientProfileName": { + "description": "The Client Profile of the Client Username. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`.", + "type": "string" + }, + "clientUsername": { + "description": "The name of the Client Username.", + "type": "string" + }, + "enabled": { + "description": "Enable or disable the Client Username. When disabled, all clients currently connected as the Client Username are disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "guaranteedEndpointPermissionOverrideEnabled": { + "description": "Enable or disable guaranteed endpoint permission override for the Client Username. When enabled all guaranteed endpoints may be accessed, modified or deleted with the same permission as the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "password": { + "description": "The password for the Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "subscriptionManagerEnabled": { + "description": "Enable or disable the subscription management capability of the Client Username. This is the ability to manage subscriptions on behalf of other Client Usernames. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "MsgVpnClientUsernameAttribute": { + "properties": { + "attributeName": { + "description": "The name of the Attribute.", + "type": "string" + }, + "attributeValue": { + "description": "The value of the Attribute.", + "type": "string" + }, + "clientUsername": { + "description": "The name of the Client Username.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnClientUsernameAttributeLinks": { + "properties": { + "uri": { + "description": "The URI of this Client Username Attribute object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnClientUsernameAttributeResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnClientUsernameAttribute" + }, + "links": { + "$ref": "#/definitions/MsgVpnClientUsernameAttributeLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnClientUsernameAttributesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnClientUsernameAttribute" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnClientUsernameAttributeLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnClientUsernameLinks": { + "properties": { + "attributesUri": { + "description": "The URI of this Client Username's collection of Client Username Attribute objects. Available since 2.27.", + "type": "string" + }, + "uri": { + "description": "The URI of this Client Username object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnClientUsernameResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnClientUsername" + }, + "links": { + "$ref": "#/definitions/MsgVpnClientUsernameLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnClientUsernamesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnClientUsername" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnClientUsernameLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnDistributedCache": { + "properties": { + "cacheName": { + "description": "The name of the Distributed Cache.", + "type": "string" + }, + "cacheVirtualRouter": { + "description": "The virtual router of the Distributed Cache. The default value is `\"auto\"`. The allowed values and their meaning are:\n\n
\n\"auto\" - The Distributed Cache is automatically assigned a virtual router at creation, depending on the broker's active-standby role.\n
\n Available since 2.28.", + "enum": [ + "auto" + ], + "type": "string" + }, + "enabled": { + "description": "Enable or disable the Distributed Cache. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "heartbeat": { + "description": "The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the message broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10`.", + "format": "int64", + "type": "integer" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "scheduledDeleteMsgDayList": { + "description": "The scheduled delete message day(s), specified as \"daily\" or a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. The empty-string (\"\") can also be specified, indicating no schedule is configured (\"scheduledDeleteMsgTimeList\" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "scheduledDeleteMsgTimeList": { + "description": "The scheduled delete message time(s), specified as \"hourly\" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. The empty-string (\"\") can also be specified, indicating no schedule is configured (\"scheduledDeleteMsgDayList\" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnDistributedCacheCluster": { + "properties": { + "cacheName": { + "description": "The name of the Distributed Cache.", + "type": "string" + }, + "clusterName": { + "description": "The name of the Cache Cluster.", + "type": "string" + }, + "deliverToOneOverrideEnabled": { + "description": "Enable or disable deliver-to-one override for the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "enabled": { + "description": "Enable or disable the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "eventDataByteRateThreshold": { + "$ref": "#/definitions/EventThresholdByValue" + }, + "eventDataMsgRateThreshold": { + "$ref": "#/definitions/EventThresholdByValue" + }, + "eventMaxMemoryThreshold": { + "$ref": "#/definitions/EventThresholdByPercent" + }, + "eventMaxTopicsThreshold": { + "$ref": "#/definitions/EventThresholdByPercent" + }, + "eventRequestQueueDepthThreshold": { + "$ref": "#/definitions/EventThresholdByPercent" + }, + "eventRequestRateThreshold": { + "$ref": "#/definitions/EventThresholdByValue" + }, + "eventResponseRateThreshold": { + "$ref": "#/definitions/EventThresholdByValue" + }, + "globalCachingEnabled": { + "description": "Enable or disable global caching for the Cache Cluster. When enabled, the Cache Instances will fetch topics from remote Home Cache Clusters when requested, and subscribe to those topics to cache them locally. When disabled, the Cache Instances will remove all subscriptions and cached messages for topics from remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "globalCachingHeartbeat": { + "description": "The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", + "format": "int64", + "type": "integer" + }, + "globalCachingTopicLifetime": { + "description": "The topic lifetime, in seconds. If no client requests are received for a given global topic over the duration of the topic lifetime, then the Cache Instance will remove the subscription and cached messages for that topic. A value of 0 disables aging. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3600`.", + "format": "int64", + "type": "integer" + }, + "maxMemory": { + "description": "The maximum memory usage, in megabytes (MB), for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2048`.", + "format": "int64", + "type": "integer" + }, + "maxMsgsPerTopic": { + "description": "The maximum number of messages per topic for each Cache Instance in the Cache Cluster. When at the maximum, old messages are removed as new messages arrive. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", + "format": "int64", + "type": "integer" + }, + "maxRequestQueueDepth": { + "description": "The maximum queue depth for cache requests received by the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `100000`.", + "format": "int64", + "type": "integer" + }, + "maxTopicCount": { + "description": "The maximum number of topics for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2000000`.", + "format": "int64", + "type": "integer" + }, + "msgLifetime": { + "description": "The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the Cache Instance will remove the message. A lifetime of 0 results in the message being retained indefinitely. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "newTopicAdvertisementEnabled": { + "description": "Enable or disable the advertising, onto the message bus, of new topics learned by each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "MsgVpnDistributedCacheClusterGlobalCachingHomeCluster": { + "properties": { + "cacheName": { + "description": "The name of the Distributed Cache.", + "type": "string" + }, + "clusterName": { + "description": "The name of the Cache Cluster.", + "type": "string" + }, + "homeClusterName": { + "description": "The name of the remote Home Cache Cluster.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks": { + "properties": { + "topicPrefixesUri": { + "description": "The URI of this Home Cache Cluster's collection of Topic Prefix objects.", + "type": "string" + }, + "uri": { + "description": "The URI of this Home Cache Cluster object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster" + }, + "links": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix": { + "properties": { + "cacheName": { + "description": "The name of the Distributed Cache.", + "type": "string" + }, + "clusterName": { + "description": "The name of the Cache Cluster.", + "type": "string" + }, + "homeClusterName": { + "description": "The name of the remote Home Cache Cluster.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "topicPrefix": { + "description": "A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks": { + "properties": { + "uri": { + "description": "The URI of this Topic Prefix object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix" + }, + "links": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnDistributedCacheClusterInstance": { + "properties": { + "autoStartEnabled": { + "description": "Enable or disable auto-start for the Cache Instance. When enabled, the Cache Instance will automatically attempt to transition from the Stopped operational state to Up whenever it restarts or reconnects to the message broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "cacheName": { + "description": "The name of the Distributed Cache.", + "type": "string" + }, + "clusterName": { + "description": "The name of the Cache Cluster.", + "type": "string" + }, + "enabled": { + "description": "Enable or disable the Cache Instance. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "instanceName": { + "description": "The name of the Cache Instance.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "stopOnLostMsgEnabled": { + "description": "Enable or disable stop-on-lost-message for the Cache Instance. When enabled, the Cache Instance will transition to the stopped operational state upon losing a message. When stopped, it cannot accept or respond to cache requests, but continues to cache messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + } + }, + "type": "object" + }, + "MsgVpnDistributedCacheClusterInstanceLinks": { + "properties": { + "uri": { + "description": "The URI of this Cache Instance object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnDistributedCacheClusterInstanceResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstance" + }, + "links": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnDistributedCacheClusterInstancesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstance" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnDistributedCacheClusterLinks": { + "properties": { + "globalCachingHomeClustersUri": { + "description": "The URI of this Cache Cluster's collection of Home Cache Cluster objects.", + "type": "string" + }, + "instancesUri": { + "description": "The URI of this Cache Cluster's collection of Cache Instance objects.", + "type": "string" + }, + "topicsUri": { + "description": "The URI of this Cache Cluster's collection of Topic objects.", + "type": "string" + }, + "uri": { + "description": "The URI of this Cache Cluster object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnDistributedCacheClusterResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnDistributedCacheCluster" + }, + "links": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnDistributedCacheClusterTopic": { + "properties": { + "cacheName": { + "description": "The name of the Distributed Cache.", + "type": "string" + }, + "clusterName": { + "description": "The name of the Cache Cluster.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "topic": { + "description": "The value of the Topic in the form a/b/c.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnDistributedCacheClusterTopicLinks": { + "properties": { + "uri": { + "description": "The URI of this Topic object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnDistributedCacheClusterTopicResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopic" + }, + "links": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopicLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnDistributedCacheClusterTopicsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopic" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopicLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnDistributedCacheClustersResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnDistributedCacheCluster" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnDistributedCacheLinks": { + "properties": { + "clustersUri": { + "description": "The URI of this Distributed Cache's collection of Cache Cluster objects.", + "type": "string" + }, + "uri": { + "description": "The URI of this Distributed Cache object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnDistributedCacheResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnDistributedCache" + }, + "links": { + "$ref": "#/definitions/MsgVpnDistributedCacheLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnDistributedCachesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnDistributedCache" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnDistributedCacheLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnDmrBridge": { + "properties": { + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "remoteMsgVpnName": { + "description": "The remote Message VPN of the DMR Bridge. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "remoteNodeName": { + "description": "The name of the node at the remote end of the DMR Bridge.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnDmrBridgeLinks": { + "properties": { + "uri": { + "description": "The URI of this DMR Bridge object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnDmrBridgeResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnDmrBridge" + }, + "links": { + "$ref": "#/definitions/MsgVpnDmrBridgeLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnDmrBridgesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnDmrBridge" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnDmrBridgeLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnJndiConnectionFactoriesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnJndiConnectionFactory" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnJndiConnectionFactoryLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnJndiConnectionFactory": { + "properties": { + "allowDuplicateClientIdEnabled": { + "description": "Enable or disable whether new JMS connections can use the same Client identifier (ID) as an existing connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.3.", + "type": "boolean" + }, + "clientDescription": { + "description": "The description of the Client. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "clientId": { + "description": "The Client identifier (ID). If not specified, a unique value for it will be generated. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "connectionFactoryName": { + "description": "The name of the JMS Connection Factory.", + "type": "string" + }, + "dtoReceiveOverrideEnabled": { + "description": "Enable or disable overriding by the Subscriber (Consumer) of the deliver-to-one (DTO) property on messages. When enabled, the Subscriber can receive all DTO tagged messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "dtoReceiveSubscriberLocalPriority": { + "description": "The priority for receiving deliver-to-one (DTO) messages by the Subscriber (Consumer) if the messages are published on the local broker that the Subscriber is directly connected to. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", + "format": "int32", + "type": "integer" + }, + "dtoReceiveSubscriberNetworkPriority": { + "description": "The priority for receiving deliver-to-one (DTO) messages by the Subscriber (Consumer) if the messages are published on a remote broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", + "format": "int32", + "type": "integer" + }, + "dtoSendEnabled": { + "description": "Enable or disable the deliver-to-one (DTO) property on messages sent by the Publisher (Producer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "dynamicEndpointCreateDurableEnabled": { + "description": "Enable or disable whether a durable endpoint will be dynamically created on the broker when the client calls \"Session.createDurableSubscriber()\" or \"Session.createQueue()\". The created endpoint respects the message time-to-live (TTL) according to the \"dynamicEndpointRespectTtlEnabled\" property. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "dynamicEndpointRespectTtlEnabled": { + "description": "Enable or disable whether dynamically created durable and non-durable endpoints respect the message time-to-live (TTL) property. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "guaranteedReceiveAckTimeout": { + "description": "The timeout for sending the acknowledgement (ACK) for guaranteed messages received by the Subscriber (Consumer), in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "format": "int32", + "type": "integer" + }, + "guaranteedReceiveReconnectRetryCount": { + "description": "The maximum number of attempts to reconnect to the host or list of hosts after the guaranteed messaging connection has been lost. The value \"-1\" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. Available since 2.14.", + "format": "int32", + "type": "integer" + }, + "guaranteedReceiveReconnectRetryWait": { + "description": "The amount of time to wait before making another attempt to connect or reconnect to the host after the guaranteed messaging connection has been lost, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`. Available since 2.14.", + "format": "int32", + "type": "integer" + }, + "guaranteedReceiveWindowSize": { + "description": "The size of the window for guaranteed messages received by the Subscriber (Consumer), in messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `18`.", + "format": "int32", + "type": "integer" + }, + "guaranteedReceiveWindowSizeAckThreshold": { + "description": "The threshold for sending the acknowledgement (ACK) for guaranteed messages received by the Subscriber (Consumer) as a percentage of `guaranteedReceiveWindowSize`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `60`.", + "format": "int32", + "type": "integer" + }, + "guaranteedSendAckTimeout": { + "description": "The timeout for receiving the acknowledgement (ACK) for guaranteed messages sent by the Publisher (Producer), in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2000`.", + "format": "int32", + "type": "integer" + }, + "guaranteedSendWindowSize": { + "description": "The size of the window for non-persistent guaranteed messages sent by the Publisher (Producer), in messages. For persistent messages the window size is fixed at 1. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`.", + "format": "int32", + "type": "integer" + }, + "messagingDefaultDeliveryMode": { + "description": "The default delivery mode for messages sent by the Publisher (Producer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"persistent\"`. The allowed values and their meaning are:\n\n
\n\"persistent\" - The broker spools messages (persists in the Message Spool) as part of the send operation.\n\"non-persistent\" - The broker does not spool messages (does not persist in the Message Spool) as part of the send operation.\n
\n", + "enum": [ + "persistent", + "non-persistent" + ], + "type": "string" + }, + "messagingDefaultDmqEligibleEnabled": { + "description": "Enable or disable whether messages sent by the Publisher (Producer) are Dead Message Queue (DMQ) eligible by default. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "messagingDefaultElidingEligibleEnabled": { + "description": "Enable or disable whether messages sent by the Publisher (Producer) are Eliding eligible by default. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "messagingJmsxUserIdEnabled": { + "description": "Enable or disable inclusion (adding or replacing) of the JMSXUserID property in messages sent by the Publisher (Producer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "messagingTextInXmlPayloadEnabled": { + "description": "Enable or disable encoding of JMS text messages in Publisher (Producer) messages as XML payload. When disabled, JMS text messages are encoded as a binary attachment. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "transportCompressionLevel": { + "description": "The ZLIB compression level for the connection to the broker. The value \"0\" means no compression, and the value \"-1\" means the compression level is specified in the JNDI Properties file. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`.", + "format": "int32", + "type": "integer" + }, + "transportConnectRetryCount": { + "description": "The maximum number of retry attempts to establish an initial connection to the host or list of hosts. The value \"0\" means a single attempt (no retries), and the value \"-1\" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int32", + "type": "integer" + }, + "transportConnectRetryPerHostCount": { + "description": "The maximum number of retry attempts to establish an initial connection to each host on the list of hosts. The value \"0\" means a single attempt (no retries), and the value \"-1\" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int32", + "type": "integer" + }, + "transportConnectTimeout": { + "description": "The timeout for establishing an initial connection to the broker, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30000`.", + "format": "int32", + "type": "integer" + }, + "transportDirectTransportEnabled": { + "description": "Enable or disable usage of the Direct Transport mode for sending non-persistent messages. When disabled, the Guaranteed Transport mode is used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "transportKeepaliveCount": { + "description": "The maximum number of consecutive application-level keepalive messages sent without the broker response before the connection to the broker is closed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", + "format": "int32", + "type": "integer" + }, + "transportKeepaliveEnabled": { + "description": "Enable or disable usage of application-level keepalive messages to maintain a connection with the broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "transportKeepaliveInterval": { + "description": "The interval between application-level keepalive messages, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`.", + "format": "int32", + "type": "integer" + }, + "transportMsgCallbackOnIoThreadEnabled": { + "description": "Enable or disable delivery of asynchronous messages directly from the I/O thread. Contact support before enabling this property. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "transportOptimizeDirectEnabled": { + "description": "Enable or disable optimization for the Direct Transport delivery mode. If enabled, the client application is limited to one Publisher (Producer) and one non-durable Subscriber (Consumer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "transportPort": { + "description": "The connection port number on the broker for SMF clients. The value \"-1\" means the port is specified in the JNDI Properties file. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`.", + "format": "int32", + "type": "integer" + }, + "transportReadTimeout": { + "description": "The timeout for reading a reply from the broker, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", + "format": "int32", + "type": "integer" + }, + "transportReceiveBufferSize": { + "description": "The size of the receive socket buffer, in bytes. It corresponds to the SO_RCVBUF socket option. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `65536`.", + "format": "int32", + "type": "integer" + }, + "transportReconnectRetryCount": { + "description": "The maximum number of attempts to reconnect to the host or list of hosts after the connection has been lost. The value \"-1\" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", + "format": "int32", + "type": "integer" + }, + "transportReconnectRetryWait": { + "description": "The amount of time before making another attempt to connect or reconnect to the host after the connection has been lost, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`.", + "format": "int32", + "type": "integer" + }, + "transportSendBufferSize": { + "description": "The size of the send socket buffer, in bytes. It corresponds to the SO_SNDBUF socket option. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `65536`.", + "format": "int32", + "type": "integer" + }, + "transportTcpNoDelayEnabled": { + "description": "Enable or disable the TCP_NODELAY option. When enabled, Nagle's algorithm for TCP/IP congestion control (RFC 896) is disabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "xaEnabled": { + "description": "Enable or disable this as an XA Connection Factory. When enabled, the Connection Factory can be cast to \"XAConnectionFactory\", \"XAQueueConnectionFactory\" or \"XATopicConnectionFactory\". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "MsgVpnJndiConnectionFactoryLinks": { + "properties": { + "uri": { + "description": "The URI of this JNDI Connection Factory object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnJndiConnectionFactoryResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnJndiConnectionFactory" + }, + "links": { + "$ref": "#/definitions/MsgVpnJndiConnectionFactoryLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnJndiQueue": { + "properties": { + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "physicalName": { + "description": "The physical name of the JMS Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "queueName": { + "description": "The JNDI name of the JMS Queue.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnJndiQueueLinks": { + "properties": { + "uri": { + "description": "The URI of this JNDI Queue object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnJndiQueueResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnJndiQueue" + }, + "links": { + "$ref": "#/definitions/MsgVpnJndiQueueLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnJndiQueuesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnJndiQueue" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnJndiQueueLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnJndiTopic": { + "properties": { + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "physicalName": { + "description": "The physical name of the JMS Topic. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "topicName": { + "description": "The JNDI name of the JMS Topic.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnJndiTopicLinks": { + "properties": { + "uri": { + "description": "The URI of this JNDI Topic object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnJndiTopicResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnJndiTopic" + }, + "links": { + "$ref": "#/definitions/MsgVpnJndiTopicLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnJndiTopicsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnJndiTopic" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnJndiTopicLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnLinks": { + "properties": { + "aclProfilesUri": { + "description": "The URI of this Message VPN's collection of ACL Profile objects.", + "type": "string" + }, + "authenticationOauthProfilesUri": { + "description": "The URI of this Message VPN's collection of OAuth Profile objects. Available since 2.25.", + "type": "string" + }, + "authenticationOauthProvidersUri": { + "description": "The URI of this Message VPN's collection of OAuth Provider objects. Deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "type": "string" + }, + "authorizationGroupsUri": { + "description": "The URI of this Message VPN's collection of Authorization Group objects.", + "type": "string" + }, + "bridgesUri": { + "description": "The URI of this Message VPN's collection of Bridge objects.", + "type": "string" + }, + "certMatchingRulesUri": { + "description": "The URI of this Message VPN's collection of Certificate Matching Rule objects. Available since 2.27.", + "type": "string" + }, + "clientProfilesUri": { + "description": "The URI of this Message VPN's collection of Client Profile objects.", + "type": "string" + }, + "clientUsernamesUri": { + "description": "The URI of this Message VPN's collection of Client Username objects.", + "type": "string" + }, + "distributedCachesUri": { + "description": "The URI of this Message VPN's collection of Distributed Cache objects. Available since 2.11.", + "type": "string" + }, + "dmrBridgesUri": { + "description": "The URI of this Message VPN's collection of DMR Bridge objects. Available since 2.11.", + "type": "string" + }, + "jndiConnectionFactoriesUri": { + "description": "The URI of this Message VPN's collection of JNDI Connection Factory objects. Available since 2.2.", + "type": "string" + }, + "jndiQueuesUri": { + "description": "The URI of this Message VPN's collection of JNDI Queue objects. Available since 2.2.", + "type": "string" + }, + "jndiTopicsUri": { + "description": "The URI of this Message VPN's collection of JNDI Topic objects. Available since 2.2.", + "type": "string" + }, + "mqttRetainCachesUri": { + "description": "The URI of this Message VPN's collection of MQTT Retain Cache objects. Available since 2.11.", + "type": "string" + }, + "mqttSessionsUri": { + "description": "The URI of this Message VPN's collection of MQTT Session objects. Available since 2.1.", + "type": "string" + }, + "queueTemplatesUri": { + "description": "The URI of this Message VPN's collection of Queue Template objects. Available since 2.14.", + "type": "string" + }, + "queuesUri": { + "description": "The URI of this Message VPN's collection of Queue objects.", + "type": "string" + }, + "replayLogsUri": { + "description": "The URI of this Message VPN's collection of Replay Log objects. Available since 2.10.", + "type": "string" + }, + "replicatedTopicsUri": { + "description": "The URI of this Message VPN's collection of Replicated Topic objects. Available since 2.1.", + "type": "string" + }, + "restDeliveryPointsUri": { + "description": "The URI of this Message VPN's collection of REST Delivery Point objects.", + "type": "string" + }, + "sequencedTopicsUri": { + "description": "The URI of this Message VPN's collection of Sequenced Topic objects.", + "type": "string" + }, + "topicEndpointTemplatesUri": { + "description": "The URI of this Message VPN's collection of Topic Endpoint Template objects. Available since 2.14.", + "type": "string" + }, + "topicEndpointsUri": { + "description": "The URI of this Message VPN's collection of Topic Endpoint objects. Available since 2.1.", + "type": "string" + }, + "uri": { + "description": "The URI of this Message VPN object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnMqttRetainCache": { + "properties": { + "cacheName": { + "description": "The name of the MQTT Retain Cache.", + "type": "string" + }, + "enabled": { + "description": "Enable or disable this MQTT Retain Cache. When the cache is disabled, neither retain messages nor retain requests will be delivered by the cache. However, live retain messages will continue to be delivered to currently connected MQTT clients. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "msgLifetime": { + "description": "The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the cache will remove the message. A lifetime of 0 results in the message being retained indefinitely, otherwise it must be 3 seconds or more. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnMqttRetainCacheLinks": { + "properties": { + "uri": { + "description": "The URI of this MQTT Retain Cache object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnMqttRetainCacheResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnMqttRetainCache" + }, + "links": { + "$ref": "#/definitions/MsgVpnMqttRetainCacheLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnMqttRetainCachesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnMqttRetainCache" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnMqttRetainCacheLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnMqttSession": { + "properties": { + "enabled": { + "description": "Enable or disable the MQTT Session. When disabled, the client is disconnected, new messages matching QoS 0 subscriptions are discarded, and new messages matching QoS 1 subscriptions are stored for future delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "mqttSessionClientId": { + "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", + "type": "string" + }, + "mqttSessionVirtualRouter": { + "description": "The virtual router of the MQTT Session. The allowed values and their meaning are:\n\n
\n\"primary\" - The MQTT Session belongs to the primary virtual router.\n\"backup\" - The MQTT Session belongs to the backup virtual router.\n\"auto\" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role.\n
\n", + "enum": [ + "primary", + "backup", + "auto" + ], + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "owner": { + "description": "The owner of the MQTT Session. For externally-created sessions this defaults to the Client Username of the connecting client. For management-created sessions this defaults to empty. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "queueConsumerAckPropagationEnabled": { + "description": "Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.14.", + "type": "boolean" + }, + "queueDeadMsgQueue": { + "description": "The name of the Dead Message Queue (DMQ) used by the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.14.", + "type": "string" + }, + "queueEventBindCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "queueEventMsgSpoolUsageThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "queueEventRejectLowPriorityMsgLimitThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "queueMaxBindCount": { + "description": "The maximum number of consumer flows that can bind to the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since 2.14.", + "format": "int64", + "type": "integer" + }, + "queueMaxDeliveredUnackedMsgsPerFlow": { + "description": "The maximum number of messages delivered but not acknowledged per flow for the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. Available since 2.14.", + "format": "int64", + "type": "integer" + }, + "queueMaxMsgSize": { + "description": "The maximum message size allowed in the MQTT Session Queue, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. Available since 2.14.", + "format": "int32", + "type": "integer" + }, + "queueMaxMsgSpoolUsage": { + "description": "The maximum message spool usage allowed by the MQTT Session Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`. Available since 2.14.", + "format": "int64", + "type": "integer" + }, + "queueMaxRedeliveryCount": { + "description": "The maximum number of times the MQTT Session Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14.", + "format": "int64", + "type": "integer" + }, + "queueMaxTtl": { + "description": "The maximum time in seconds a message can stay in the MQTT Session Queue when `queueRespectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `queueMaxTtl` configured for the MQTT Session Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14.", + "format": "int64", + "type": "integer" + }, + "queueRejectLowPriorityMsgEnabled": { + "description": "Enable or disable the checking of low priority messages against the `queueRejectLowPriorityMsgLimit`. This may only be enabled if `queueRejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.14.", + "type": "boolean" + }, + "queueRejectLowPriorityMsgLimit": { + "description": "The number of messages of any priority in the MQTT Session Queue above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.14.", + "format": "int64", + "type": "integer" + }, + "queueRejectMsgToSenderOnDiscardBehavior": { + "description": "Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are:\n\n
\n\"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard.\n\"when-queue-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled.\n\"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard.\n
\n Available since 2.14.", + "enum": [ + "always", + "when-queue-enabled", + "never" + ], + "type": "string" + }, + "queueRespectTtlEnabled": { + "description": "Enable or disable the respecting of the time-to-live (TTL) for messages in the MQTT Session Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.14.", + "type": "boolean" + } + }, + "type": "object" + }, + "MsgVpnMqttSessionLinks": { + "properties": { + "subscriptionsUri": { + "description": "The URI of this MQTT Session's collection of Subscription objects.", + "type": "string" + }, + "uri": { + "description": "The URI of this MQTT Session object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnMqttSessionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnMqttSession" + }, + "links": { + "$ref": "#/definitions/MsgVpnMqttSessionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnMqttSessionSubscription": { + "properties": { + "mqttSessionClientId": { + "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", + "type": "string" + }, + "mqttSessionVirtualRouter": { + "description": "The virtual router of the MQTT Session. The allowed values and their meaning are:\n\n
\n\"primary\" - The MQTT Session belongs to the primary virtual router.\n\"backup\" - The MQTT Session belongs to the backup virtual router.\n\"auto\" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role.\n
\n", + "enum": [ + "primary", + "backup", + "auto" + ], + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "subscriptionQos": { + "description": "The quality of service (QoS) for the subscription as either 0 (deliver at most once) or 1 (deliver at least once). QoS 2 is not supported, but QoS 2 messages attracted by QoS 0 or QoS 1 subscriptions are accepted and delivered accordingly. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "subscriptionTopic": { + "description": "The MQTT subscription topic.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnMqttSessionSubscriptionLinks": { + "properties": { + "uri": { + "description": "The URI of this Subscription object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnMqttSessionSubscriptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnMqttSessionSubscription" + }, + "links": { + "$ref": "#/definitions/MsgVpnMqttSessionSubscriptionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnMqttSessionSubscriptionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnMqttSessionSubscription" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnMqttSessionSubscriptionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnMqttSessionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnMqttSession" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnMqttSessionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnQueue": { + "properties": { + "accessType": { + "description": "The access type for delivering messages to consumer flows bound to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n
\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion.\n
\n", + "enum": [ + "exclusive", + "non-exclusive" + ], + "type": "string" + }, + "consumerAckPropagationEnabled": { + "description": "Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "deadMsgQueue": { + "description": "The name of the Dead Message Queue (DMQ) used by the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.2.", + "type": "string" + }, + "deliveryCountEnabled": { + "description": "Enable or disable the ability for client applications to query the message delivery count of messages received from the Queue. This is a controlled availability feature. Please contact support to find out if this feature is supported for your use case. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.19.", + "type": "boolean" + }, + "deliveryDelay": { + "description": "The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22.", + "format": "int64", + "type": "integer" + }, + "egressEnabled": { + "description": "Enable or disable the transmission of messages from the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "eventBindCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventMsgSpoolUsageThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventRejectLowPriorityMsgLimitThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "ingressEnabled": { + "description": "Enable or disable the reception of messages to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "maxBindCount": { + "description": "The maximum number of consumer flows that can bind to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "format": "int64", + "type": "integer" + }, + "maxDeliveredUnackedMsgsPerFlow": { + "description": "The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", + "format": "int64", + "type": "integer" + }, + "maxMsgSize": { + "description": "The maximum message size allowed in the Queue, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`.", + "format": "int32", + "type": "integer" + }, + "maxMsgSpoolUsage": { + "description": "The maximum message spool usage allowed by the Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`.", + "format": "int64", + "type": "integer" + }, + "maxRedeliveryCount": { + "description": "The maximum number of times the Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "maxTtl": { + "description": "The maximum time in seconds a message can stay in the Queue when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "owner": { + "description": "The Client Username that owns the Queue and has permission equivalent to `\"delete\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "permission": { + "description": "The permission level for all consumers of the Queue, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are:\n\n
\n\"no-access\" - Disallows all access.\n\"read-only\" - Read-only access to the messages.\n\"consume\" - Consume (read and remove) messages.\n\"modify-topic\" - Consume messages or modify the topic/selector.\n\"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.\n
\n", + "enum": [ + "no-access", + "read-only", + "consume", + "modify-topic", + "delete" + ], + "type": "string" + }, + "queueName": { + "description": "The name of the Queue.", + "type": "string" + }, + "redeliveryEnabled": { + "description": "Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the queue more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18.", + "type": "boolean" + }, + "rejectLowPriorityMsgEnabled": { + "description": "Enable or disable the checking of low priority messages against the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "rejectLowPriorityMsgLimit": { + "description": "The number of messages of any priority in the Queue above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "rejectMsgToSenderOnDiscardBehavior": { + "description": "Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are:\n\n
\n\"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard.\n\"when-queue-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled.\n\"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard.\n
\n Available since 2.1.", + "enum": [ + "always", + "when-queue-enabled", + "never" + ], + "type": "string" + }, + "respectMsgPriorityEnabled": { + "description": "Enable or disable the respecting of message priority. When enabled, messages contained in the Queue are delivered in priority order, from 9 (highest) to 0 (lowest). MQTT queues do not support enabling message priority. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.8.", + "type": "boolean" + }, + "respectTtlEnabled": { + "description": "Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "MsgVpnQueueLinks": { + "properties": { + "subscriptionsUri": { + "description": "The URI of this Queue's collection of Queue Subscription objects.", + "type": "string" + }, + "uri": { + "description": "The URI of this Queue object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnQueueResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnQueue" + }, + "links": { + "$ref": "#/definitions/MsgVpnQueueLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnQueueSubscription": { + "properties": { + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "queueName": { + "description": "The name of the Queue.", + "type": "string" + }, + "subscriptionTopic": { + "description": "The topic of the Subscription.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnQueueSubscriptionLinks": { + "properties": { + "uri": { + "description": "The URI of this Queue Subscription object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnQueueSubscriptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnQueueSubscription" + }, + "links": { + "$ref": "#/definitions/MsgVpnQueueSubscriptionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnQueueSubscriptionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnQueueSubscription" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnQueueSubscriptionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnQueueTemplate": { + "properties": { + "accessType": { + "description": "The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n
\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion.\n
\n", + "enum": [ + "exclusive", + "non-exclusive" + ], + "type": "string" + }, + "consumerAckPropagationEnabled": { + "description": "Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "deadMsgQueue": { + "description": "The name of the Dead Message Queue (DMQ). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`.", + "type": "string" + }, + "deliveryDelay": { + "description": "The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. This attribute does not apply to MQTT queues created from this template, but it may apply in future releases. Therefore, to maintain forward compatibility, do not set this value on templates that might be used for MQTT queues. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22.", + "format": "int64", + "type": "integer" + }, + "durabilityOverride": { + "description": "Controls the durability of queues created from this template. If non-durable, the created queue will be non-durable, regardless of the specified durability. If none, the created queue will have the requested durability. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - The durability of the endpoint will be as requested on create.\n\"non-durable\" - The durability of the created queue will be non-durable, regardless of what was requested.\n
\n", + "enum": [ + "none", + "non-durable" + ], + "type": "string" + }, + "eventBindCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventMsgSpoolUsageThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventRejectLowPriorityMsgLimitThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "maxBindCount": { + "description": "The maximum number of consumer flows that can bind. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.", + "format": "int64", + "type": "integer" + }, + "maxDeliveredUnackedMsgsPerFlow": { + "description": "The maximum number of messages delivered but not acknowledged per flow. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", + "format": "int64", + "type": "integer" + }, + "maxMsgSize": { + "description": "The maximum message size allowed, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`.", + "format": "int32", + "type": "integer" + }, + "maxMsgSpoolUsage": { + "description": "The maximum message spool usage allowed, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`.", + "format": "int64", + "type": "integer" + }, + "maxRedeliveryCount": { + "description": "The maximum number of message redelivery attempts that will occur prior to the message being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "maxTtl": { + "description": "The maximum time in seconds a message can stay in a Queue when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "permission": { + "description": "The permission level for all consumers, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are:\n\n
\n\"no-access\" - Disallows all access.\n\"read-only\" - Read-only access to the messages.\n\"consume\" - Consume (read and remove) messages.\n\"modify-topic\" - Consume messages or modify the topic/selector.\n\"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.\n
\n", + "enum": [ + "no-access", + "read-only", + "consume", + "modify-topic", + "delete" + ], + "type": "string" + }, + "queueNameFilter": { + "description": "A wildcardable pattern used to determine which Queues use settings from this Template. Two different wildcards are supported: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "queueTemplateName": { + "description": "The name of the Queue Template.", + "type": "string" + }, + "redeliveryEnabled": { + "description": "Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the queue more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18.", + "type": "boolean" + }, + "rejectLowPriorityMsgEnabled": { + "description": "Enable or disable the checking of low priority messages against the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "rejectLowPriorityMsgLimit": { + "description": "The number of messages of any priority above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "rejectMsgToSenderOnDiscardBehavior": { + "description": "Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs prevent the message from being delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"when-queue-enabled\"`. The allowed values and their meaning are:\n\n
\n\"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard.\n\"when-queue-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled.\n\"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard.\n
\n", + "enum": [ + "always", + "when-queue-enabled", + "never" + ], + "type": "string" + }, + "respectMsgPriorityEnabled": { + "description": "Enable or disable the respecting of message priority. When enabled, messages are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "respectTtlEnabled": { + "description": "Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "MsgVpnQueueTemplateLinks": { + "properties": { + "uri": { + "description": "The URI of this Queue Template object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnQueueTemplateResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnQueueTemplate" + }, + "links": { + "$ref": "#/definitions/MsgVpnQueueTemplateLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnQueueTemplatesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnQueueTemplate" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnQueueTemplateLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnQueuesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnQueue" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnQueueLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnReplayLog": { + "properties": { + "egressEnabled": { + "description": "Enable or disable the transmission of messages from the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "ingressEnabled": { + "description": "Enable or disable the reception of messages to the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "maxSpoolUsage": { + "description": "The maximum spool usage allowed by the Replay Log, in megabytes (MB). If this limit is exceeded, old messages will be trimmed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "replayLogName": { + "description": "The name of the Replay Log.", + "type": "string" + }, + "topicFilterEnabled": { + "description": "Enable or disable topic filtering for the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.27.", + "type": "boolean" + } + }, + "type": "object" + }, + "MsgVpnReplayLogLinks": { + "properties": { + "topicFilterSubscriptionsUri": { + "description": "The URI of this Replay Log's collection of Topic Filter Subscription objects. Available since 2.27.", + "type": "string" + }, + "uri": { + "description": "The URI of this Replay Log object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnReplayLogResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnReplayLog" + }, + "links": { + "$ref": "#/definitions/MsgVpnReplayLogLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnReplayLogTopicFilterSubscription": { + "properties": { + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "replayLogName": { + "description": "The name of the Replay Log.", + "type": "string" + }, + "topicFilterSubscription": { + "description": "The topic of the Subscription.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnReplayLogTopicFilterSubscriptionLinks": { + "properties": { + "uri": { + "description": "The URI of this Topic Filter Subscription object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnReplayLogTopicFilterSubscriptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscription" + }, + "links": { + "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscriptionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnReplayLogTopicFilterSubscriptionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscription" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscriptionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnReplayLogsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnReplayLog" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnReplayLogLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnReplicatedTopic": { + "properties": { + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "replicatedTopic": { + "description": "The topic for applying replication. Published messages matching this topic will be replicated to the standby site.", + "type": "string" + }, + "replicationMode": { + "description": "The replication mode for the Replicated Topic. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"async\"`. The allowed values and their meaning are:\n\n
\n\"sync\" - Messages are acknowledged when replicated (spooled remotely).\n\"async\" - Messages are acknowledged when pending replication (spooled locally).\n
\n", + "enum": [ + "sync", + "async" + ], + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnReplicatedTopicLinks": { + "properties": { + "uri": { + "description": "The URI of this Replicated Topic object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnReplicatedTopicResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnReplicatedTopic" + }, + "links": { + "$ref": "#/definitions/MsgVpnReplicatedTopicLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnReplicatedTopicsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnReplicatedTopic" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnReplicatedTopicLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpn" + }, + "links": { + "$ref": "#/definitions/MsgVpnLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPoint": { + "properties": { + "clientProfileName": { + "description": "The Client Profile of the REST Delivery Point. It must exist in the local Message VPN. Its TCP parameters are used for all REST Consumers in this RDP. Its queue properties are used by the RDP client. The Client Profile is used inside the auto-generated Client Username for this RDP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`.", + "type": "string" + }, + "enabled": { + "description": "Enable or disable the REST Delivery Point. When disabled, no connections are initiated or messages delivered to any of the contained REST Consumers. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "restDeliveryPointName": { + "description": "The name of the REST Delivery Point.", + "type": "string" + }, + "service": { + "description": "The name of the service that this REST Delivery Point connects to. Internally the broker does not use this value; it is informational only. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", + "type": "string" + }, + "vendor": { + "description": "The name of the vendor that this REST Delivery Point connects to. Internally the broker does not use this value; it is informational only. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointLinks": { + "properties": { + "queueBindingsUri": { + "description": "The URI of this REST Delivery Point's collection of Queue Binding objects.", + "type": "string" + }, + "restConsumersUri": { + "description": "The URI of this REST Delivery Point's collection of REST Consumer objects.", + "type": "string" + }, + "uri": { + "description": "The URI of this REST Delivery Point object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointQueueBinding": { + "properties": { + "gatewayReplaceTargetAuthorityEnabled": { + "description": "Enable or disable whether the authority for the request-target is replaced with that configured for the REST Consumer remote. When enabled, the broker sends HTTP requests in absolute-form, with the request-target's authority taken from the REST Consumer's remote host and port configuration. When disabled, the broker sends HTTP requests whose request-target matches that of the original request message, including whether to use absolute-form or origin-form. This configuration is applicable only when the Message VPN is in REST gateway mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.6.", + "type": "boolean" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "postRequestTarget": { + "description": "The request-target string to use when sending requests. It identifies the target resource on the far-end REST Consumer upon which to apply the request. There are generally two common forms for the request-target. The origin-form is most often used in practice and contains the path and query components of the target URI. If the path component is empty then the client must generally send a \"/\" as the path. When making a request to a proxy, most often the absolute-form is required. This configuration is only applicable when the Message VPN is in REST messaging mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "queueBindingName": { + "description": "The name of a queue in the Message VPN.", + "type": "string" + }, + "requestTargetEvaluation": { + "description": "The type of evaluation to perform on the request target. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Do not evaluate substitution expressions on the request target.\n\"substitution-expressions\" - Evaluate substitution expressions on the request target.\n
\n Available since 2.23.", + "enum": [ + "none", + "substitution-expressions" + ], + "type": "string" + }, + "restDeliveryPointName": { + "description": "The name of the REST Delivery Point.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointQueueBindingLinks": { + "properties": { + "requestHeadersUri": { + "description": "The URI of this Queue Binding's collection of Request Header objects. Available since 2.23.", + "type": "string" + }, + "uri": { + "description": "The URI of this Queue Binding object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointQueueBindingRequestHeader": { + "properties": { + "headerName": { + "description": "The name of the HTTP request header.", + "type": "string" + }, + "headerValue": { + "description": "A substitution expression for the value of the HTTP request header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "queueBindingName": { + "description": "The name of a queue in the Message VPN.", + "type": "string" + }, + "restDeliveryPointName": { + "description": "The name of the REST Delivery Point.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks": { + "properties": { + "uri": { + "description": "The URI of this Request Header object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeader" + }, + "links": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeader" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointQueueBindingResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBinding" + }, + "links": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointQueueBindingsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBinding" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnRestDeliveryPoint" + }, + "links": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumer": { + "properties": { + "authenticationAwsAccessKeyId": { + "description": "The AWS access key id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26.", + "type": "string" + }, + "authenticationAwsRegion": { + "description": "The AWS region id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26.", + "type": "string" + }, + "authenticationAwsSecretAccessKey": { + "description": "The AWS secret access key. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26.", + "type": "string" + }, + "authenticationAwsService": { + "description": "The AWS service id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26.", + "type": "string" + }, + "authenticationClientCertContent": { + "description": "The PEM formatted content for the client certificate that the REST Consumer will present to the REST host. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9.", + "type": "string", + "x-requires-https": true + }, + "authenticationClientCertPassword": { + "description": "The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9.", + "type": "string", + "x-requires-https": true + }, + "authenticationHttpBasicPassword": { + "description": "The password for the username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "authenticationHttpBasicUsername": { + "description": "The username that the REST Consumer will use to login to the REST host. Normally a username is only configured when basic authentication is selected for the REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "authenticationHttpHeaderName": { + "description": "The authentication header name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.15.", + "type": "string" + }, + "authenticationHttpHeaderValue": { + "description": "The authentication header value. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.15.", + "type": "string" + }, + "authenticationOauthClientId": { + "description": "The OAuth client ID. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", + "type": "string" + }, + "authenticationOauthClientScope": { + "description": "The OAuth scope. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", + "type": "string" + }, + "authenticationOauthClientSecret": { + "description": "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", + "type": "string" + }, + "authenticationOauthClientTokenEndpoint": { + "description": "The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. Must begin with \"https\". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", + "type": "string" + }, + "authenticationOauthJwtSecretKey": { + "description": "The OAuth secret key used to sign the token request JWT. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.21.", + "type": "string" + }, + "authenticationOauthJwtTokenEndpoint": { + "description": "The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.21.", + "type": "string" + }, + "authenticationScheme": { + "description": "The authentication scheme used by the REST Consumer to login to the REST host. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Login with no authentication. This may be useful for anonymous connections or when a REST Consumer does not require authentication.\n\"http-basic\" - Login with a username and optional password according to HTTP Basic authentication as per RFC2616.\n\"client-certificate\" - Login with a client TLS certificate as per RFC5246. Client certificate authentication is only available on TLS connections.\n\"http-header\" - Login with a specified HTTP header.\n\"oauth-client\" - Login with OAuth 2.0 client credentials.\n\"oauth-jwt\" - Login with OAuth (RFC 7523 JWT Profile).\n\"transparent\" - Login using the Authorization header from the message properties, if present. Transparent authentication passes along existing Authorization header metadata instead of discarding it. Note that if the message is coming from a REST producer, the REST service must be configured to forward the Authorization header.\n\"aws\" - Login using AWS Signature Version 4 authentication (AWS4-HMAC-SHA256).\n
\n", + "enum": [ + "none", + "http-basic", + "client-certificate", + "http-header", + "oauth-client", + "oauth-jwt", + "transparent", + "aws" + ], + "type": "string" + }, + "enabled": { + "description": "Enable or disable the REST Consumer. When disabled, no connections are initiated or messages delivered to this particular REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "httpMethod": { + "description": "The HTTP method to use (POST or PUT). This is used only when operating in the REST service \"messaging\" mode and is ignored in \"gateway\" mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"post\"`. The allowed values and their meaning are:\n\n
\n\"post\" - Use the POST HTTP method.\n\"put\" - Use the PUT HTTP method.\n
\n Available since 2.17.", + "enum": [ + "post", + "put" + ], + "type": "string" + }, + "localInterface": { + "description": "The interface that will be used for all outgoing connections associated with the REST Consumer. When unspecified, an interface is automatically chosen. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "maxPostWaitTime": { + "description": "The maximum amount of time (in seconds) to wait for an HTTP POST response from the REST Consumer. Once this time is exceeded, the TCP connection is reset. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30`.", + "format": "int32", + "type": "integer" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "outgoingConnectionCount": { + "description": "The number of concurrent TCP connections open to the REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", + "format": "int32", + "type": "integer" + }, + "remoteHost": { + "description": "The IP address or DNS name to which the broker is to connect to deliver messages for the REST Consumer. A host value must be configured for the REST Consumer to be operationally up. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "remotePort": { + "description": "The port associated with the host of the REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `8080`.", + "format": "int64", + "type": "integer" + }, + "restConsumerName": { + "description": "The name of the REST Consumer.", + "type": "string" + }, + "restDeliveryPointName": { + "description": "The name of the REST Delivery Point.", + "type": "string" + }, + "retryDelay": { + "description": "The number of seconds that must pass before retrying the remote REST Consumer connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.", + "format": "int32", + "type": "integer" + }, + "tlsCipherSuiteList": { + "description": "The colon-separated list of cipher suites the REST Consumer uses in its encrypted connection. The value `\"default\"` implies all supported suites ordered from most secure to least secure. The list of default cipher suites is available in the `tlsCipherSuiteMsgBackboneDefaultList` attribute of the Broker object in the Monitoring API. The REST Consumer should choose the first suite from this list that it supports. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`.", + "type": "string" + }, + "tlsEnabled": { + "description": "Enable or disable encryption (TLS) for the REST Consumer. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerLinks": { + "properties": { + "oauthJwtClaimsUri": { + "description": "The URI of this REST Consumer's collection of Claim objects. Available since 2.21.", + "type": "string" + }, + "tlsTrustedCommonNamesUri": { + "description": "The URI of this REST Consumer's collection of Trusted Common Name objects. Deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation.", + "type": "string" + }, + "uri": { + "description": "The URI of this REST Consumer object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim": { + "properties": { + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "oauthJwtClaimName": { + "description": "The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\".", + "type": "string" + }, + "oauthJwtClaimValue": { + "description": "The value of the additional claim, which must be a string containing a valid JSON value.", + "type": "string" + }, + "restConsumerName": { + "description": "The name of the REST Consumer.", + "type": "string" + }, + "restDeliveryPointName": { + "description": "The name of the REST Delivery Point.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks": { + "properties": { + "uri": { + "description": "The URI of this Claim object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim" + }, + "links": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumer" + }, + "links": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName": { + "properties": { + "msgVpnName": { + "description": "The name of the Message VPN. Deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation.", + "type": "string" + }, + "restConsumerName": { + "description": "The name of the REST Consumer. Deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation.", + "type": "string" + }, + "restDeliveryPointName": { + "description": "The name of the REST Delivery Point. Deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation.", + "type": "string" + }, + "tlsTrustedCommonName": { + "description": "The expected trusted common name of the remote certificate. Deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks": { + "properties": { + "uri": { + "description": "The URI of this Trusted Common Name object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName" + }, + "links": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointRestConsumersResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumer" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnRestDeliveryPointsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPoint" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnSequencedTopic": { + "properties": { + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "sequencedTopic": { + "description": "Topic for applying sequence numbers.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnSequencedTopicLinks": { + "properties": { + "uri": { + "description": "The URI of this Sequenced Topic object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnSequencedTopicResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnSequencedTopic" + }, + "links": { + "$ref": "#/definitions/MsgVpnSequencedTopicLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnSequencedTopicsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnSequencedTopic" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnSequencedTopicLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnTopicEndpoint": { + "properties": { + "accessType": { + "description": "The access type for delivering messages to consumer flows bound to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n
\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion.\n
\n Available since 2.4.", + "enum": [ + "exclusive", + "non-exclusive" + ], + "type": "string" + }, + "consumerAckPropagationEnabled": { + "description": "Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "deadMsgQueue": { + "description": "The name of the Dead Message Queue (DMQ) used by the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.2.", + "type": "string" + }, + "deliveryCountEnabled": { + "description": "Enable or disable the ability for client applications to query the message delivery count of messages received from the Topic Endpoint. This is a controlled availability feature. Please contact support to find out if this feature is supported for your use case. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.19.", + "type": "boolean" + }, + "deliveryDelay": { + "description": "The delay, in seconds, to apply to messages arriving on the Topic Endpoint before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22.", + "format": "int64", + "type": "integer" + }, + "egressEnabled": { + "description": "Enable or disable the transmission of messages from the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "eventBindCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventRejectLowPriorityMsgLimitThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventSpoolUsageThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "ingressEnabled": { + "description": "Enable or disable the reception of messages to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "maxBindCount": { + "description": "The maximum number of consumer flows that can bind to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. Available since 2.4.", + "format": "int64", + "type": "integer" + }, + "maxDeliveredUnackedMsgsPerFlow": { + "description": "The maximum number of messages delivered but not acknowledged per flow for the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", + "format": "int64", + "type": "integer" + }, + "maxMsgSize": { + "description": "The maximum message size allowed in the Topic Endpoint, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`.", + "format": "int32", + "type": "integer" + }, + "maxRedeliveryCount": { + "description": "The maximum number of times the Topic Endpoint will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "maxSpoolUsage": { + "description": "The maximum message spool usage allowed by the Topic Endpoint, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`.", + "format": "int64", + "type": "integer" + }, + "maxTtl": { + "description": "The maximum time in seconds a message can stay in the Topic Endpoint when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Topic Endpoint, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "owner": { + "description": "The Client Username that owns the Topic Endpoint and has permission equivalent to `\"delete\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "permission": { + "description": "The permission level for all consumers of the Topic Endpoint, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are:\n\n
\n\"no-access\" - Disallows all access.\n\"read-only\" - Read-only access to the messages.\n\"consume\" - Consume (read and remove) messages.\n\"modify-topic\" - Consume messages or modify the topic/selector.\n\"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.\n
\n", + "enum": [ + "no-access", + "read-only", + "consume", + "modify-topic", + "delete" + ], + "type": "string" + }, + "redeliveryEnabled": { + "description": "Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the topic-endpoint more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18.", + "type": "boolean" + }, + "rejectLowPriorityMsgEnabled": { + "description": "Enable or disable the checking of low priority messages against the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "rejectLowPriorityMsgLimit": { + "description": "The number of messages of any priority in the Topic Endpoint above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "rejectMsgToSenderOnDiscardBehavior": { + "description": "Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"never\"`. The allowed values and their meaning are:\n\n
\n\"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard.\n\"when-topic-endpoint-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Topic Endpoint is enabled.\n\"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard.\n
\n", + "enum": [ + "always", + "when-topic-endpoint-enabled", + "never" + ], + "type": "string" + }, + "respectMsgPriorityEnabled": { + "description": "Enable or disable the respecting of message priority. When enabled, messages contained in the Topic Endpoint are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.8.", + "type": "boolean" + }, + "respectTtlEnabled": { + "description": "Enable or disable the respecting of the time-to-live (TTL) for messages in the Topic Endpoint. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "topicEndpointName": { + "description": "The name of the Topic Endpoint.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnTopicEndpointLinks": { + "properties": { + "uri": { + "description": "The URI of this Topic Endpoint object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnTopicEndpointResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnTopicEndpoint" + }, + "links": { + "$ref": "#/definitions/MsgVpnTopicEndpointLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnTopicEndpointTemplate": { + "properties": { + "accessType": { + "description": "The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n
\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion.\n
\n", + "enum": [ + "exclusive", + "non-exclusive" + ], + "type": "string" + }, + "consumerAckPropagationEnabled": { + "description": "Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", + "type": "boolean" + }, + "deadMsgQueue": { + "description": "The name of the Dead Message Queue (DMQ). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`.", + "type": "string" + }, + "deliveryDelay": { + "description": "The delay, in seconds, to apply to messages arriving on the Topic Endpoint before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22.", + "format": "int64", + "type": "integer" + }, + "eventBindCountThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventMsgSpoolUsageThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "eventRejectLowPriorityMsgLimitThreshold": { + "$ref": "#/definitions/EventThreshold" + }, + "maxBindCount": { + "description": "The maximum number of consumer flows that can bind. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", + "format": "int64", + "type": "integer" + }, + "maxDeliveredUnackedMsgsPerFlow": { + "description": "The maximum number of messages delivered but not acknowledged per flow. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", + "format": "int64", + "type": "integer" + }, + "maxMsgSize": { + "description": "The maximum message size allowed, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`.", + "format": "int32", + "type": "integer" + }, + "maxMsgSpoolUsage": { + "description": "The maximum message spool usage allowed, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5000`.", + "format": "int64", + "type": "integer" + }, + "maxRedeliveryCount": { + "description": "The maximum number of message redelivery attempts that will occur prior to the message being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "maxTtl": { + "description": "The maximum time in seconds a message can stay in the Topic Endpoint when `respectTtlEnabled` is `\"true\"`. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the `maxTtl` configured for the Topic Endpoint, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "type": "string" + }, + "permission": { + "description": "The permission level for all consumers, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"no-access\"`. The allowed values and their meaning are:\n\n
\n\"no-access\" - Disallows all access.\n\"read-only\" - Read-only access to the messages.\n\"consume\" - Consume (read and remove) messages.\n\"modify-topic\" - Consume messages or modify the topic/selector.\n\"delete\" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.\n
\n", + "enum": [ + "no-access", + "read-only", + "consume", + "modify-topic", + "delete" + ], + "type": "string" + }, + "redeliveryEnabled": { + "description": "Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the topic-endpoint more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18.", + "type": "boolean" + }, + "rejectLowPriorityMsgEnabled": { + "description": "Enable or disable the checking of low priority messages against the `rejectLowPriorityMsgLimit`. This may only be enabled if `rejectMsgToSenderOnDiscardBehavior` does not have a value of `\"never\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "rejectLowPriorityMsgLimit": { + "description": "The number of messages that are permitted before low priority messages are rejected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "format": "int64", + "type": "integer" + }, + "rejectMsgToSenderOnDiscardBehavior": { + "description": "Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"never\"`. The allowed values and their meaning are:\n\n
\n\"always\" - Always return a negative acknowledgment (NACK) to the sending client on message discard.\n\"when-topic-endpoint-enabled\" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Topic Endpoint is enabled.\n\"never\" - Never return a negative acknowledgment (NACK) to the sending client on message discard.\n
\n", + "enum": [ + "always", + "when-topic-endpoint-enabled", + "never" + ], + "type": "string" + }, + "respectMsgPriorityEnabled": { + "description": "Enable or disable the respecting of message priority. When enabled, messages are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "respectTtlEnabled": { + "description": "Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean" + }, + "topicEndpointNameFilter": { + "description": "A wildcardable pattern used to determine which Topic Endpoints use settings from this Template. Two different wildcards are supported: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "topicEndpointTemplateName": { + "description": "The name of the Topic Endpoint Template.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnTopicEndpointTemplateLinks": { + "properties": { + "uri": { + "description": "The URI of this Topic Endpoint Template object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnTopicEndpointTemplateResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnTopicEndpointTemplate" + }, + "links": { + "$ref": "#/definitions/MsgVpnTopicEndpointTemplateLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnTopicEndpointTemplatesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnTopicEndpointTemplate" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnTopicEndpointTemplateLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnTopicEndpointsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnTopicEndpoint" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnTopicEndpointLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpn" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfile": { + "properties": { + "accessLevelGroupsClaimName": { + "description": "The name of the groups claim. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"groups\"`.", + "type": "string" + }, + "clientId": { + "description": "The OAuth client id. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "clientRedirectUri": { + "description": "The OAuth redirect URI. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "clientRequiredType": { + "description": "The required value for the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"JWT\"`.", + "type": "string" + }, + "clientScope": { + "description": "The OAuth scope. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"openid email\"`.", + "type": "string" + }, + "clientSecret": { + "description": "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "clientValidateTypeEnabled": { + "description": "Enable or disable verification of the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean" + }, + "defaultGlobalAccessLevel": { + "description": "The default global access level for this OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to global data.\n\"read-only\" - User has read-only access to global data.\n\"read-write\" - User has read-write access to most global data.\n\"admin\" - User has read-write access to all global data.\n
\n", + "enum": [ + "none", + "read-only", + "read-write", + "admin" + ], + "type": "string" + }, + "defaultMsgVpnAccessLevel": { + "description": "The default message VPN access level for the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to a Message VPN.\n\"read-only\" - User has read-only access to a Message VPN.\n\"read-write\" - User has read-write access to most Message VPN settings.\n
\n", + "enum": [ + "none", + "read-only", + "read-write" + ], + "type": "string" + }, + "displayName": { + "description": "The user friendly name for the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "enabled": { + "description": "Enable or disable the OAuth profile. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean" + }, + "endpointAuthorization": { + "description": "The OAuth authorization endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "endpointDiscovery": { + "description": "The OpenID Connect discovery endpoint or OAuth Authorization Server Metadata endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "endpointDiscoveryRefreshInterval": { + "description": "The number of seconds between discovery endpoint requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`.", + "format": "int32", + "type": "integer" + }, + "endpointIntrospection": { + "description": "The OAuth introspection endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "endpointIntrospectionTimeout": { + "description": "The maximum time in seconds a token introspection request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`.", + "format": "int32", + "type": "integer" + }, + "endpointJwks": { + "description": "The OAuth JWKS endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "endpointJwksRefreshInterval": { + "description": "The number of seconds between JWKS endpoint requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`.", + "format": "int32", + "type": "integer" + }, + "endpointToken": { + "description": "The OAuth token endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "endpointTokenTimeout": { + "description": "The maximum time in seconds a token request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`.", + "format": "int32", + "type": "integer" + }, + "endpointUserinfo": { + "description": "The OpenID Connect Userinfo endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "endpointUserinfoTimeout": { + "description": "The maximum time in seconds a userinfo request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`.", + "format": "int32", + "type": "integer" + }, + "interactiveEnabled": { + "description": "Enable or disable interactive logins via this OAuth provider. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean" + }, + "interactivePromptForExpiredSession": { + "description": "The value of the prompt parameter provided to the OAuth authorization server for login requests where the session has expired. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "interactivePromptForNewSession": { + "description": "The value of the prompt parameter provided to the OAuth authorization server for login requests where the session is new or the user has explicitly logged out. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"select_account\"`.", + "type": "string" + }, + "issuer": { + "description": "The Issuer Identifier for the OAuth provider. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "type": "string" + }, + "oauthRole": { + "description": "The OAuth role of the broker. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"client\"`. The allowed values and their meaning are:\n\n
\n\"client\" - The broker is in the OAuth client role.\n\"resource-server\" - The broker is in the OAuth resource server role.\n
\n", + "enum": [ + "client", + "resource-server" + ], + "type": "string" + }, + "resourceServerParseAccessTokenEnabled": { + "description": "Enable or disable parsing of the access token as a JWT. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean" + }, + "resourceServerRequiredAudience": { + "description": "The required audience value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "resourceServerRequiredIssuer": { + "description": "The required issuer value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "resourceServerRequiredScope": { + "description": "A space-separated list of scopes that must be present in the scope claim. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "resourceServerRequiredType": { + "description": "The required TYP value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"at+jwt\"`.", + "type": "string" + }, + "resourceServerValidateAudienceEnabled": { + "description": "Enable or disable verification of the audience claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean" + }, + "resourceServerValidateIssuerEnabled": { + "description": "Enable or disable verification of the issuer claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean" + }, + "resourceServerValidateScopeEnabled": { + "description": "Enable or disable verification of the scope claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean" + }, + "resourceServerValidateTypeEnabled": { + "description": "Enable or disable verification of the TYP field in the access token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean" + }, + "sempEnabled": { + "description": "Enable or disable authentication of SEMP requests with OAuth tokens. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.", + "type": "boolean" + }, + "usernameClaimName": { + "description": "The name of the username claim. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"sub\"`.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileAccessLevelGroup": { + "properties": { + "description": { + "description": "A description for the group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "globalAccessLevel": { + "description": "The global access level for this group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to global data.\n\"read-only\" - User has read-only access to global data.\n\"read-write\" - User has read-write access to most global data.\n\"admin\" - User has read-write access to all global data.\n
\n", + "enum": [ + "none", + "read-only", + "read-write", + "admin" + ], + "type": "string" + }, + "groupName": { + "description": "The name of the group.", + "type": "string" + }, + "msgVpnAccessLevel": { + "description": "The default message VPN access level for this group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to a Message VPN.\n\"read-only\" - User has read-only access to a Message VPN.\n\"read-write\" - User has read-write access to most Message VPN settings.\n
\n", + "enum": [ + "none", + "read-only", + "read-write" + ], + "type": "string" + }, + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileAccessLevelGroupLinks": { + "properties": { + "msgVpnAccessLevelExceptionsUri": { + "description": "The URI of this Group Access Level's collection of Message VPN Access-Level Exception objects.", + "type": "string" + }, + "uri": { + "description": "The URI of this Group Access Level object.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileAccessLevelGroupMsgVpnAccessLevelException": { + "properties": { + "accessLevel": { + "description": "The message VPN access level. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to a Message VPN.\n\"read-only\" - User has read-only access to a Message VPN.\n\"read-write\" - User has read-write access to most Message VPN settings.\n
\n", + "enum": [ + "none", + "read-only", + "read-write" + ], + "type": "string" + }, + "groupName": { + "description": "The name of the group.", + "type": "string" + }, + "msgVpnName": { + "description": "The name of the message VPN.", + "type": "string" + }, + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks": { + "properties": { + "uri": { + "description": "The URI of this Message VPN Access-Level Exception object.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelException" + }, + "links": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelException" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileAccessLevelGroupResponse": { + "properties": { + "data": { + "$ref": "#/definitions/OauthProfileAccessLevelGroup" + }, + "links": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileAccessLevelGroupsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/OauthProfileAccessLevelGroup" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileClientAllowedHost": { + "properties": { + "allowedHost": { + "description": "An allowed value for the Host header.", + "type": "string" + }, + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileClientAllowedHostLinks": { + "properties": { + "uri": { + "description": "The URI of this Allowed Host Value object.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileClientAllowedHostResponse": { + "properties": { + "data": { + "$ref": "#/definitions/OauthProfileClientAllowedHost" + }, + "links": { + "$ref": "#/definitions/OauthProfileClientAllowedHostLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileClientAllowedHostsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/OauthProfileClientAllowedHost" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/OauthProfileClientAllowedHostLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileClientAuthorizationParameter": { + "properties": { + "authorizationParameterName": { + "description": "The name of the authorization parameter.", + "type": "string" + }, + "authorizationParameterValue": { + "description": "The authorization parameter value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileClientAuthorizationParameterLinks": { + "properties": { + "uri": { + "description": "The URI of this Authorization Parameter object.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileClientAuthorizationParameterResponse": { + "properties": { + "data": { + "$ref": "#/definitions/OauthProfileClientAuthorizationParameter" + }, + "links": { + "$ref": "#/definitions/OauthProfileClientAuthorizationParameterLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileClientAuthorizationParametersResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/OauthProfileClientAuthorizationParameter" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/OauthProfileClientAuthorizationParameterLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileClientRequiredClaim": { + "properties": { + "clientRequiredClaimName": { + "description": "The name of the ID token claim to verify.", + "type": "string" + }, + "clientRequiredClaimValue": { + "description": "The required claim value, which must be a string containing a valid JSON value.", + "type": "string" + }, + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileClientRequiredClaimLinks": { + "properties": { + "uri": { + "description": "The URI of this Required Claim object.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileClientRequiredClaimResponse": { + "properties": { + "data": { + "$ref": "#/definitions/OauthProfileClientRequiredClaim" + }, + "links": { + "$ref": "#/definitions/OauthProfileClientRequiredClaimLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileClientRequiredClaimsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/OauthProfileClientRequiredClaim" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/OauthProfileClientRequiredClaimLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileDefaultMsgVpnAccessLevelException": { + "properties": { + "accessLevel": { + "description": "The message VPN access level. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - User has no access to a Message VPN.\n\"read-only\" - User has read-only access to a Message VPN.\n\"read-write\" - User has read-write access to most Message VPN settings.\n
\n", + "enum": [ + "none", + "read-only", + "read-write" + ], + "type": "string" + }, + "msgVpnName": { + "description": "The name of the message VPN.", + "type": "string" + }, + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileDefaultMsgVpnAccessLevelExceptionLinks": { + "properties": { + "uri": { + "description": "The URI of this Message VPN Access-Level Exception object.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileDefaultMsgVpnAccessLevelExceptionResponse": { + "properties": { + "data": { + "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelException" + }, + "links": { + "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelException" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelExceptionLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileLinks": { + "properties": { + "accessLevelGroupsUri": { + "description": "The URI of this OAuth Profile's collection of Group Access Level objects.", + "type": "string" + }, + "clientAllowedHostsUri": { + "description": "The URI of this OAuth Profile's collection of Allowed Host Value objects.", + "type": "string" + }, + "clientAuthorizationParametersUri": { + "description": "The URI of this OAuth Profile's collection of Authorization Parameter objects.", + "type": "string" + }, + "clientRequiredClaimsUri": { + "description": "The URI of this OAuth Profile's collection of Required Claim objects.", + "type": "string" + }, + "defaultMsgVpnAccessLevelExceptionsUri": { + "description": "The URI of this OAuth Profile's collection of Message VPN Access-Level Exception objects.", + "type": "string" + }, + "resourceServerRequiredClaimsUri": { + "description": "The URI of this OAuth Profile's collection of Required Claim objects.", + "type": "string" + }, + "uri": { + "description": "The URI of this OAuth Profile object.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileResourceServerRequiredClaim": { + "properties": { + "oauthProfileName": { + "description": "The name of the OAuth profile.", + "type": "string" + }, + "resourceServerRequiredClaimName": { + "description": "The name of the access token claim to verify.", + "type": "string" + }, + "resourceServerRequiredClaimValue": { + "description": "The required claim value, which must be a string containing a valid JSON value.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileResourceServerRequiredClaimLinks": { + "properties": { + "uri": { + "description": "The URI of this Required Claim object.", + "type": "string" + } + }, + "type": "object" + }, + "OauthProfileResourceServerRequiredClaimResponse": { + "properties": { + "data": { + "$ref": "#/definitions/OauthProfileResourceServerRequiredClaim" + }, + "links": { + "$ref": "#/definitions/OauthProfileResourceServerRequiredClaimLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileResourceServerRequiredClaimsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/OauthProfileResourceServerRequiredClaim" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/OauthProfileResourceServerRequiredClaimLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfileResponse": { + "properties": { + "data": { + "$ref": "#/definitions/OauthProfile" + }, + "links": { + "$ref": "#/definitions/OauthProfileLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "OauthProfilesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/OauthProfile" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/OauthProfileLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "SempError": { + "properties": { + "code": { + "description": "The error code which uniquely identifies the error that has occurred.", + "format": "int32", + "type": "integer" + }, + "description": { + "description": "The verbose description of the problem.", + "type": "string" + }, + "status": { + "description": "The terse status string associated with `code`.", + "type": "string" + } + }, + "required": [ + "code", + "status", + "description" + ], + "type": "object" + }, + "SempMeta": { + "properties": { + "count": { + "description": "The total number of objects requested, irrespective of page size. This may be a count of all objects in a collection or a filtered subset. It represents a snapshot in time and may change when paging through results.", + "format": "int64", + "type": "integer" + }, + "error": { + "$ref": "#/definitions/SempError" + }, + "paging": { + "$ref": "#/definitions/SempPaging" + }, + "request": { + "$ref": "#/definitions/SempRequest" + }, + "responseCode": { + "description": "The HTTP response code, one of 200 (success), 4xx (client error), or 5xx (server error).", + "format": "int32", + "type": "integer" + } + }, + "required": [ + "request", + "responseCode" + ], + "type": "object" + }, + "SempMetaOnlyResponse": { + "properties": { + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "SempPaging": { + "properties": { + "cursorQuery": { + "description": "The cursor, or position, for the next page of objects. Use this as the `cursor` query parameter of the next request.", + "type": "string" + }, + "nextPageUri": { + "description": "The URI of the next page of objects. `cursorQuery` is already embedded within this URI.", + "type": "string" + } + }, + "required": [ + "cursorQuery", + "nextPageUri" + ], + "type": "object" + }, + "SempRequest": { + "properties": { + "method": { + "description": "The HTTP method of the request which resulted in this response.", + "type": "string" + }, + "uri": { + "description": "The URI of the request which resulted in this response.", + "type": "string" + } + }, + "required": [ + "method" + ], + "type": "object" + }, + "SystemInformation": { + "properties": { + "platform": { + "description": "The platform running the SEMP API. Deprecated since 2.2. /systemInformation was replaced by /about/api.", + "type": "string" + }, + "sempVersion": { + "description": "The version of the SEMP API. Deprecated since 2.2. /systemInformation was replaced by /about/api.", + "type": "string" + } + }, + "type": "object" + }, + "SystemInformationLinks": { + "properties": { + "uri": { + "description": "The URI of this System Information object.", + "type": "string" + } + }, + "type": "object" + }, + "SystemInformationResponse": { + "properties": { + "data": { + "$ref": "#/definitions/SystemInformation" + }, + "links": { + "$ref": "#/definitions/SystemInformationLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "VirtualHostname": { + "properties": { + "enabled": { + "description": "Enable or disable Virtual Hostname to Message VPN mapping. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean" + }, + "msgVpnName": { + "description": "The message VPN to which this virtual hostname is mapped. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "type": "string" + }, + "virtualHostname": { + "description": "The virtual hostname.", + "type": "string" + } + }, + "type": "object" + }, + "VirtualHostnameLinks": { + "properties": { + "uri": { + "description": "The URI of this Virtual Hostname object.", + "type": "string" + } + }, + "type": "object" + }, + "VirtualHostnameResponse": { + "properties": { + "data": { + "$ref": "#/definitions/VirtualHostname" + }, + "links": { + "$ref": "#/definitions/VirtualHostnameLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "VirtualHostnamesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/VirtualHostname" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/VirtualHostnameLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + } + }, + "host": "www.solace.com", + "info": { + "contact": { + "email": "support@solace.com", + "name": "Solace", + "url": "http://www.solace.com" + }, + "description": "SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker.\n\nSEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API:\n\n\nAPI|Base Path|Purpose|Comments\n:---|:---|:---|:---\nConfiguration|/SEMP/v2/config|Reading and writing config state|See note 2\n\n\n\nThe following APIs are also available:\n\n\nAPI|Base Path|Purpose|Comments\n:---|:---|:---|:---\nAction|/SEMP/v2/action|Performing actions|See note 2\nMonitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2\n\n\n\nResources are always nouns, with individual objects being singular and collections being plural.\n\nObjects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`.\n\nActions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`.\n\nSome examples:\n\n```\n/SEMP/v2/config/msgVpns ; MsgVpn collection\n/SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\"\n/SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\"\n/SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\"\n/SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\"\n/SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\"\n/SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\"\n```\n\n## Collection Resources\n\nCollections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource.\n\n## Object and Action Resources\n\nObjects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself.\n\nActions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API.\n\nAttributes in an object or action may have any combination of the following properties:\n\n\nProperty|Meaning|Comments\n:---|:---|:---\nIdentifying|Attribute is involved in unique identification of the object, and appears in its URI|\nConst|Attribute value can only be chosen during object creation|\nRequired|Attribute must be provided in the request|\nRead-Only|Attribute can only be read, not written.|See note 3\nWrite-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property\nRequires-Disable|Attribute can only be changed when object is disabled|\nDeprecated|Attribute is deprecated, and will disappear in the next SEMP version|\nOpaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation\n\n\n\nIn some requests, certain attributes may only be provided in certain combinations with other attributes:\n\n\nRelationship|Meaning\n:---|:---\nRequires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request\nConflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request\n\n\n\nIn the monitoring API, any non-identifying attribute may not be returned in a GET.\n\n## HTTP Methods\n\nThe following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs:\n\n\nMethod|Resource|Meaning|Request Body|Response Body|Notes\n:---|:---|:---|:---|:---|:---\nPOST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned\nPUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4)\nPUT|Action|Performs action|Action arguments|Action metadata|\nPATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned\nDELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned\nGET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned\nGET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code\n\n\n\n## Common Query Parameters\n\nThe following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example:\n\n```\n; Request for the MsgVpns collection using two hypothetical query parameters\n; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively\n/SEMP/v2/config/msgVpns?q1=val1&q2=val2\n```\n\n### select\n\nInclude in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired.\n\nThe value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned.\n\nAll attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object.\n\nNames may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`).\n\nSome examples:\n\n```\n; List of all MsgVpn names\n/SEMP/v2/config/msgVpns?select=msgVpnName\n; List of all MsgVpn and their attributes except for their names\n/SEMP/v2/config/msgVpns?select=-msgVpnName\n; Authentication attributes of MsgVpn \"finance\"\n/SEMP/v2/config/msgVpns/finance?select=authentication*\n; All attributes of MsgVpn \"finance\" except for authentication attributes\n/SEMP/v2/config/msgVpns/finance?select=-authentication*\n; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\"\n/SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission\n```\n\n### where\n\nInclude in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions.\n\nThe value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form:\n\n```\nexpression = attribute-name OP value\nOP = '==' | '!=' | '<' | '>' | '<=' | '>='\n```\n\n`value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples:\n\n```\n; Only enabled MsgVpns\n/SEMP/v2/config/msgVpns?where=enabled==true\n; Only MsgVpns using basic non-LDAP authentication\n/SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap\n; Only MsgVpns that allow more than 100 client connections\n/SEMP/v2/config/msgVpns?where=maxConnectionCount>100\n; Only MsgVpns with msgVpnName starting with \"B\":\n/SEMP/v2/config/msgVpns?where=msgVpnName==B*\n```\n\n### count\n\nLimit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time.\n\n`count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging.\n\nFor example:\n```\n; Up to 25 MsgVpns\n/SEMP/v2/config/msgVpns?count=25\n```\n\n### cursor\n\nThe cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below.\n\nWhen a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects.\n\nApplications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty.\n\n### opaquePassword\n\nAttributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as:\n\n1. the same password that was used to retrieve the opaque attribute values is provided; and\n\n2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values.\n\nThe password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters.\n\nThe query parameter can only be used in the configuration API, and only over HTTPS.\n\n## Authentication\n\nWhen a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication.\n\nWhen HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session.\n\nThere are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session.\n\nIf certain attributes\u2014such as a user's password\u2014are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required.\n\nA client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint.\n\nSessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored.\n\n## Help\n\nVisit [our website](https://solace.com) to learn more about Solace.\n\nYou can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/).\n\nIf you need additional support, please contact us at [support@solace.com](mailto:support@solace.com).\n\n## Notes\n\nNote|Description\n:---:|:---\n1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\"\n2|This API is partially implemented. Only a subset of all objects are available.\n3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH.\n4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request.\n\n", + "title": "SEMP (Solace Element Management Protocol)", + "version": "2.28" + }, + "parameters": { + "countQuery": { + "default": 10, + "description": "Limit the count of objects in the response. See the documentation for the `count` parameter.", + "in": "query", + "minimum": 1, + "name": "count", + "required": false, + "type": "integer" + }, + "cursorQuery": { + "description": "The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter.", + "in": "query", + "name": "cursor", + "required": false, + "type": "string" + }, + "opaquePasswordQuery": { + "description": "Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the `opaquePassword` parameter.", + "in": "query", + "name": "opaquePassword", + "required": false, + "type": "string" + }, + "selectQuery": { + "collectionFormat": "csv", + "description": "Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter.", + "in": "query", + "items": { + "type": "string" + }, + "name": "select", + "required": false, + "type": "array" + }, + "whereQuery": { + "collectionFormat": "csv", + "description": "Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter.", + "in": "query", + "items": { + "type": "string" + }, + "name": "where", + "required": false, + "type": "array" + } + }, + "paths": { + "/": { + "get": { + "description": "Get a Broker object.\n\nThis object contains global configuration for the message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ntlsServerCertContent||x||x\ntlsServerCertPassword||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\nconfigSyncAuthenticationClientCertMaxChainDepth|global/read-only\nconfigSyncAuthenticationClientCertValidateDateEnabled|global/read-only\nconfigSyncClientProfileTcpInitialCongestionWindow|global/read-only\nconfigSyncClientProfileTcpKeepaliveCount|global/read-only\nconfigSyncClientProfileTcpKeepaliveIdle|global/read-only\nconfigSyncClientProfileTcpKeepaliveInterval|global/read-only\nconfigSyncClientProfileTcpMaxWindow|global/read-only\nconfigSyncClientProfileTcpMss|global/read-only\nconfigSyncEnabled|global/read-only\nconfigSyncSynchronizeUsernameEnabled|global/read-only\nconfigSyncTlsEnabled|global/read-only\nguaranteedMsgingDefragmentationScheduleDayList|global/read-only\nguaranteedMsgingDefragmentationScheduleEnabled|global/read-only\nguaranteedMsgingDefragmentationScheduleTimeList|global/read-only\nguaranteedMsgingDefragmentationThresholdEnabled|global/read-only\nguaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-only\nguaranteedMsgingDefragmentationThresholdMinInterval|global/read-only\nguaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-only\nguaranteedMsgingEnabled|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.setValue|global/read-only\nguaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-only\nguaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-only\nguaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.setValue|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-only\nguaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-only\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.setValue|global/read-only\nguaranteedMsgingMaxCacheUsage|global/read-only\nguaranteedMsgingMaxMsgSpoolUsage|global/read-only\nguaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-only\nguaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-only\nguaranteedMsgingTransactionReplicationCompatibilityMode|global/read-only\noauthProfileDefault|global/read-only\nserviceAmqpEnabled|global/read-only\nserviceAmqpTlsListenPort|global/read-only\nserviceEventConnectionCountThreshold.clearPercent|global/read-only\nserviceEventConnectionCountThreshold.clearValue|global/read-only\nserviceEventConnectionCountThreshold.setPercent|global/read-only\nserviceEventConnectionCountThreshold.setValue|global/read-only\nserviceHealthCheckEnabled|global/read-only\nserviceHealthCheckListenPort|global/read-only\nserviceMateLinkEnabled|global/read-only\nserviceMateLinkListenPort|global/read-only\nserviceMqttEnabled|global/read-only\nserviceMsgBackboneEnabled|global/read-only\nserviceRedundancyEnabled|global/read-only\nserviceRedundancyFirstListenPort|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-only\nserviceRestIncomingEnabled|global/read-only\nserviceRestOutgoingEnabled|global/read-only\nserviceSempCorsAllowAnyHostEnabled|global/read-only\nserviceSempLegacyTimeoutEnabled|global/read-only\nserviceSempPlainTextEnabled|global/read-only\nserviceSempPlainTextListenPort|global/read-only\nserviceSempSessionIdleTimeout|global/read-only\nserviceSempSessionMaxLifetime|global/read-only\nserviceSempTlsEnabled|global/read-only\nserviceSempTlsListenPort|global/read-only\nserviceSmfCompressionListenPort|global/read-only\nserviceSmfEnabled|global/read-only\nserviceSmfEventConnectionCountThreshold.clearPercent|global/read-only\nserviceSmfEventConnectionCountThreshold.clearValue|global/read-only\nserviceSmfEventConnectionCountThreshold.setPercent|global/read-only\nserviceSmfEventConnectionCountThreshold.setValue|global/read-only\nserviceSmfPlainTextListenPort|global/read-only\nserviceSmfRoutingControlListenPort|global/read-only\nserviceSmfTlsListenPort|global/read-only\nserviceTlsEventConnectionCountThreshold.clearPercent|global/read-only\nserviceTlsEventConnectionCountThreshold.clearValue|global/read-only\nserviceTlsEventConnectionCountThreshold.setPercent|global/read-only\nserviceTlsEventConnectionCountThreshold.setValue|global/read-only\nserviceWebTransportEnabled|global/read-only\nserviceWebTransportPlainTextListenPort|global/read-only\nserviceWebTransportTlsListenPort|global/read-only\nserviceWebTransportWebUrlSuffix|global/read-only\ntlsBlockVersion11Enabled|global/read-only\ntlsCipherSuiteManagementList|global/read-only\ntlsCipherSuiteMsgBackboneList|global/read-only\ntlsCipherSuiteSecureShellList|global/read-only\ntlsCrimeExploitProtectionEnabled|global/read-only\ntlsServerCertContent|global/read-only\ntlsStandardDomainCertificateAuthoritiesEnabled|vpn/read-only\ntlsTicketLifetime|global/read-only\nwebManagerAllowUnencryptedWizardsEnabled|vpn/read-only\nwebManagerCustomization|vpn/read-only\nwebManagerRedirectHttpEnabled|vpn/read-only\nwebManagerRedirectHttpOverrideTlsPort|vpn/read-only\n\n\n\nThis has been available since 2.13.", + "operationId": "getBroker", + "parameters": [ + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Broker object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/BrokerResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Broker object.", + "tags": [ + "all" + ] + }, + "patch": { + "description": "Update a Broker object. Any attribute missing from the request will be left unchanged.\n\nThis object contains global configuration for the message broker.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nserviceAmqpTlsListenPort||||x||\nserviceHealthCheckListenPort||||x||\nserviceMateLinkListenPort||||x||\nserviceRedundancyFirstListenPort||||x||\nserviceSempPlainTextListenPort||||x||\nserviceSempTlsListenPort||||x||\nserviceSmfCompressionListenPort||||x||\nserviceSmfPlainTextListenPort||||x||\nserviceSmfRoutingControlListenPort||||x||\nserviceSmfTlsListenPort||||x||\nserviceWebTransportPlainTextListenPort||||x||\nserviceWebTransportTlsListenPort||||x||\nserviceWebTransportWebUrlSuffix||||x||\ntlsServerCertContent|||x|||x\ntlsServerCertPassword|||x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nBroker|tlsServerCertPassword|tlsServerCertContent|\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\nEventThresholdByPercent|clearPercent|setPercent|\nEventThresholdByPercent|setPercent|clearPercent|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\nauthClientCertRevocationCheckMode|global/admin\nconfigSyncAuthenticationClientCertMaxChainDepth|global/read-write\nconfigSyncAuthenticationClientCertValidateDateEnabled|global/read-write\nconfigSyncClientProfileTcpInitialCongestionWindow|global/read-write\nconfigSyncClientProfileTcpKeepaliveCount|global/read-write\nconfigSyncClientProfileTcpKeepaliveIdle|global/read-write\nconfigSyncClientProfileTcpKeepaliveInterval|global/read-write\nconfigSyncClientProfileTcpMaxWindow|global/read-write\nconfigSyncClientProfileTcpMss|global/read-write\nconfigSyncEnabled|global/read-write\nconfigSyncSynchronizeUsernameEnabled|global/read-write\nconfigSyncTlsEnabled|global/read-write\nguaranteedMsgingDefragmentationScheduleDayList|global/read-write\nguaranteedMsgingDefragmentationScheduleEnabled|global/read-write\nguaranteedMsgingDefragmentationScheduleTimeList|global/read-write\nguaranteedMsgingDefragmentationThresholdEnabled|global/read-write\nguaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-write\nguaranteedMsgingDefragmentationThresholdMinInterval|global/read-write\nguaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-write\nguaranteedMsgingEnabled|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.setValue|global/read-write\nguaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-write\nguaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-write\nguaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-write\nguaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.setValue|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-write\nguaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventMsgCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-write\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.setValue|global/read-write\nguaranteedMsgingMaxCacheUsage|global/read-write\nguaranteedMsgingMaxMsgSpoolUsage|global/read-write\nguaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-write\nguaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-write\nguaranteedMsgingTransactionReplicationCompatibilityMode|global/read-write\noauthProfileDefault|global/admin\nserviceAmqpEnabled|global/read-write\nserviceAmqpTlsListenPort|global/read-write\nserviceEventConnectionCountThreshold.clearPercent|global/read-write\nserviceEventConnectionCountThreshold.clearValue|global/read-write\nserviceEventConnectionCountThreshold.setPercent|global/read-write\nserviceEventConnectionCountThreshold.setValue|global/read-write\nserviceHealthCheckEnabled|global/read-write\nserviceHealthCheckListenPort|global/read-write\nserviceMateLinkEnabled|global/read-write\nserviceMateLinkListenPort|global/read-write\nserviceMqttEnabled|global/read-write\nserviceMsgBackboneEnabled|global/read-write\nserviceRedundancyEnabled|global/read-write\nserviceRedundancyFirstListenPort|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-write\nserviceRestIncomingEnabled|global/read-write\nserviceRestOutgoingEnabled|global/read-write\nserviceSempCorsAllowAnyHostEnabled|global/read-write\nserviceSempLegacyTimeoutEnabled|global/read-write\nserviceSempPlainTextEnabled|global/read-write\nserviceSempPlainTextListenPort|global/read-write\nserviceSempSessionIdleTimeout|global/read-write\nserviceSempSessionMaxLifetime|global/read-write\nserviceSempTlsEnabled|global/read-write\nserviceSempTlsListenPort|global/read-write\nserviceSmfCompressionListenPort|global/read-write\nserviceSmfEnabled|global/read-write\nserviceSmfEventConnectionCountThreshold.clearPercent|global/read-write\nserviceSmfEventConnectionCountThreshold.clearValue|global/read-write\nserviceSmfEventConnectionCountThreshold.setPercent|global/read-write\nserviceSmfEventConnectionCountThreshold.setValue|global/read-write\nserviceSmfPlainTextListenPort|global/read-write\nserviceSmfRoutingControlListenPort|global/read-write\nserviceSmfTlsListenPort|global/read-write\nserviceTlsEventConnectionCountThreshold.clearPercent|global/read-write\nserviceTlsEventConnectionCountThreshold.clearValue|global/read-write\nserviceTlsEventConnectionCountThreshold.setPercent|global/read-write\nserviceTlsEventConnectionCountThreshold.setValue|global/read-write\nserviceWebTransportEnabled|global/read-write\nserviceWebTransportPlainTextListenPort|global/read-write\nserviceWebTransportTlsListenPort|global/read-write\nserviceWebTransportWebUrlSuffix|global/read-write\ntlsBlockVersion11Enabled|global/read-write\ntlsCipherSuiteManagementList|global/read-write\ntlsCipherSuiteMsgBackboneList|global/read-write\ntlsCipherSuiteSecureShellList|global/read-write\ntlsCrimeExploitProtectionEnabled|global/read-write\ntlsServerCertContent|global/read-write\ntlsServerCertPassword|global/read-write\ntlsStandardDomainCertificateAuthoritiesEnabled|global/read-write\ntlsTicketLifetime|global/read-write\nwebManagerAllowUnencryptedWizardsEnabled|global/read-write\nwebManagerCustomization|vpn/read-write\nwebManagerRedirectHttpEnabled|global/read-write\nwebManagerRedirectHttpOverrideTlsPort|global/read-write\n\n\n\nThis has been available since 2.13.", + "operationId": "updateBroker", + "parameters": [ + { + "description": "The Broker object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Broker" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Broker object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/BrokerResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Broker object.", + "tags": [ + "all" + ] + } + }, + "/about": { + "get": { + "description": "Get an About object.\n\nThis provides metadata about the SEMP API, such as the version of the API supported by the broker.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since 2.13.", + "operationId": "getAbout", + "parameters": [ + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The About object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/AboutResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get an About object.", + "tags": [ + "all", + "about" + ] + } + }, + "/about/api": { + "get": { + "description": "Get an API Description object.\n\nThe API Description object provides metadata about the SEMP API.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "getAboutApi", + "parameters": [ + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The API Description object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/AboutApiResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get an API Description object.", + "tags": [ + "all", + "about" + ] + } + }, + "/about/user": { + "get": { + "description": "Get a User object.\n\nSession and access level information about the user accessing the SEMP API.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "getAboutUser", + "parameters": [ + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The User object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/AboutUserResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a User object.", + "tags": [ + "all", + "about" + ] + } + }, + "/about/user/msgVpns": { + "get": { + "description": "Get a list of User Message VPN objects.\n\nThis provides information about the Message VPN access level for the username used to access the SEMP API.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "getAboutUserMsgVpns", + "parameters": [ + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of User Message VPN objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/AboutUserMsgVpnsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of User Message VPN objects.", + "tags": [ + "all", + "about" + ] + } + }, + "/about/user/msgVpns/{msgVpnName}": { + "get": { + "description": "Get a User Message VPN object.\n\nThis provides information about the Message VPN access level for the username used to access the SEMP API.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "getAboutUserMsgVpn", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The User Message VPN object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/AboutUserMsgVpnResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a User Message VPN object.", + "tags": [ + "all", + "about" + ] + } + }, + "/certAuthorities": { + "get": { + "deprecated": true, + "description": "Get a list of Certificate Authority objects.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x||x|\ncertContent|||x|\ncrlDayList|||x|\ncrlTimeList|||x|\ncrlUrl|||x|\nocspNonResponderCertEnabled|||x|\nocspOverrideUrl|||x|\nocspTimeout|||x|\nrevocationCheckEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "operationId": "getCertAuthorities", + "parameters": [ + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Certificate Authority objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/CertAuthoritiesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Certificate Authority objects.", + "tags": [ + "all", + "certAuthority" + ] + }, + "post": { + "deprecated": true, + "description": "Create a Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x|||x|\ncertContent|||||x|\ncrlDayList|||||x|\ncrlTimeList|||||x|\ncrlUrl|||||x|\nocspNonResponderCertEnabled|||||x|\nocspOverrideUrl|||||x|\nocspTimeout|||||x|\nrevocationCheckEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nCertAuthority|crlDayList|crlTimeList|\nCertAuthority|crlTimeList|crlDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "operationId": "createCertAuthority", + "parameters": [ + { + "description": "The Certificate Authority object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CertAuthority" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Authority object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/CertAuthorityResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Certificate Authority object.", + "tags": [ + "all", + "certAuthority" + ] + } + }, + "/certAuthorities/{certAuthorityName}": { + "delete": { + "deprecated": true, + "description": "Delete a Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "operationId": "deleteCertAuthority", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Certificate Authority object.", + "tags": [ + "all", + "certAuthority" + ] + }, + "get": { + "deprecated": true, + "description": "Get a Certificate Authority object.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x||x|\ncertContent|||x|\ncrlDayList|||x|\ncrlTimeList|||x|\ncrlUrl|||x|\nocspNonResponderCertEnabled|||x|\nocspOverrideUrl|||x|\nocspTimeout|||x|\nrevocationCheckEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "operationId": "getCertAuthority", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Authority object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/CertAuthorityResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Certificate Authority object.", + "tags": [ + "all", + "certAuthority" + ] + }, + "patch": { + "deprecated": true, + "description": "Update a Certificate Authority object. Any attribute missing from the request will be left unchanged.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\ncertAuthorityName|x|x|||x|\ncertContent|||||x|\ncrlDayList|||||x|\ncrlTimeList|||||x|\ncrlUrl||||x|x|\nocspNonResponderCertEnabled|||||x|\nocspOverrideUrl|||||x|\nocspTimeout|||||x|\nrevocationCheckEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nCertAuthority|crlDayList|crlTimeList|\nCertAuthority|crlTimeList|crlDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "operationId": "updateCertAuthority", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Authority object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CertAuthority" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Authority object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/CertAuthorityResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Certificate Authority object.", + "tags": [ + "all", + "certAuthority" + ] + }, + "put": { + "deprecated": true, + "description": "Replace a Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\ncertAuthorityName|x||x|||x|\ncertContent||||||x|\ncrlDayList||||||x|\ncrlTimeList||||||x|\ncrlUrl|||||x|x|\nocspNonResponderCertEnabled||||||x|\nocspOverrideUrl||||||x|\nocspTimeout||||||x|\nrevocationCheckEnabled||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nCertAuthority|crlDayList|crlTimeList|\nCertAuthority|crlTimeList|crlDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "operationId": "replaceCertAuthority", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Authority object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CertAuthority" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Authority object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/CertAuthorityResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Certificate Authority object.", + "tags": [ + "all", + "certAuthority" + ] + } + }, + "/certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames": { + "get": { + "deprecated": true, + "description": "Get a list of OCSP Responder Trusted Common Name objects.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x||x|\nocspTlsTrustedCommonName|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", + "operationId": "getCertAuthorityOcspTlsTrustedCommonNames", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonNamesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of OCSP Responder Trusted Common Name objects.", + "tags": [ + "all", + "certAuthority" + ] + }, + "post": { + "deprecated": true, + "description": "Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x||x||x|\nocspTlsTrustedCommonName|x|x|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", + "operationId": "createCertAuthorityOcspTlsTrustedCommonName", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "description": "The OCSP Responder Trusted Common Name object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonName" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonNameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create an OCSP Responder Trusted Common Name object.", + "tags": [ + "all", + "certAuthority" + ] + } + }, + "/certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}": { + "delete": { + "deprecated": true, + "description": "Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", + "operationId": "deleteCertAuthorityOcspTlsTrustedCommonName", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "description": "The expected Trusted Common Name of the OCSP responder remote certificate.", + "in": "path", + "name": "ocspTlsTrustedCommonName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete an OCSP Responder Trusted Common Name object.", + "tags": [ + "all", + "certAuthority" + ] + }, + "get": { + "deprecated": true, + "description": "Get an OCSP Responder Trusted Common Name object.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x||x|\nocspTlsTrustedCommonName|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", + "operationId": "getCertAuthorityOcspTlsTrustedCommonName", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "description": "The expected Trusted Common Name of the OCSP responder remote certificate.", + "in": "path", + "name": "ocspTlsTrustedCommonName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OCSP Responder Trusted Common Name object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/CertAuthorityOcspTlsTrustedCommonNameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get an OCSP Responder Trusted Common Name object.", + "tags": [ + "all", + "certAuthority" + ] + } + }, + "/clientCertAuthorities": { + "get": { + "description": "Get a list of Client Certificate Authority objects.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "getClientCertAuthorities", + "parameters": [ + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Client Certificate Authority objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/ClientCertAuthoritiesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Client Certificate Authority objects.", + "tags": [ + "all", + "clientCertAuthority" + ] + }, + "post": { + "description": "Create a Client Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nClientCertAuthority|crlDayList|crlTimeList|\nClientCertAuthority|crlTimeList|crlDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "createClientCertAuthority", + "parameters": [ + { + "description": "The Client Certificate Authority object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClientCertAuthority" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Certificate Authority object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/ClientCertAuthorityResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Client Certificate Authority object.", + "tags": [ + "all", + "clientCertAuthority" + ] + } + }, + "/clientCertAuthorities/{certAuthorityName}": { + "delete": { + "description": "Delete a Client Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "deleteClientCertAuthority", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Client Certificate Authority object.", + "tags": [ + "all", + "clientCertAuthority" + ] + }, + "get": { + "description": "Get a Client Certificate Authority object.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "getClientCertAuthority", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Certificate Authority object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/ClientCertAuthorityResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Client Certificate Authority object.", + "tags": [ + "all", + "clientCertAuthority" + ] + }, + "patch": { + "description": "Update a Client Certificate Authority object. Any attribute missing from the request will be left unchanged.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\ncertAuthorityName|x|x||||\ncrlUrl||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nClientCertAuthority|crlDayList|crlTimeList|\nClientCertAuthority|crlTimeList|crlDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "updateClientCertAuthority", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "description": "The Client Certificate Authority object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClientCertAuthority" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Certificate Authority object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/ClientCertAuthorityResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Client Certificate Authority object.", + "tags": [ + "all", + "clientCertAuthority" + ] + }, + "put": { + "description": "Replace a Client Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\ncertAuthorityName|x||x||||\ncrlUrl|||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nClientCertAuthority|crlDayList|crlTimeList|\nClientCertAuthority|crlTimeList|crlDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "replaceClientCertAuthority", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "description": "The Client Certificate Authority object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClientCertAuthority" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Certificate Authority object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/ClientCertAuthorityResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Client Certificate Authority object.", + "tags": [ + "all", + "clientCertAuthority" + ] + } + }, + "/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames": { + "get": { + "description": "Get a list of OCSP Responder Trusted Common Name objects.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||\nocspTlsTrustedCommonName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "getClientCertAuthorityOcspTlsTrustedCommonNames", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of OCSP Responder Trusted Common Name objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonNamesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of OCSP Responder Trusted Common Name objects.", + "tags": [ + "all", + "clientCertAuthority" + ] + }, + "post": { + "description": "Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x||x|||\nocspTlsTrustedCommonName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "createClientCertAuthorityOcspTlsTrustedCommonName", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "description": "The OCSP Responder Trusted Common Name object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonName" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OCSP Responder Trusted Common Name object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonNameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create an OCSP Responder Trusted Common Name object.", + "tags": [ + "all", + "clientCertAuthority" + ] + } + }, + "/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}": { + "delete": { + "description": "Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "deleteClientCertAuthorityOcspTlsTrustedCommonName", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "description": "The expected Trusted Common Name of the OCSP responder remote certificate.", + "in": "path", + "name": "ocspTlsTrustedCommonName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete an OCSP Responder Trusted Common Name object.", + "tags": [ + "all", + "clientCertAuthority" + ] + }, + "get": { + "description": "Get an OCSP Responder Trusted Common Name object.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||\nocspTlsTrustedCommonName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "getClientCertAuthorityOcspTlsTrustedCommonName", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "description": "The expected Trusted Common Name of the OCSP responder remote certificate.", + "in": "path", + "name": "ocspTlsTrustedCommonName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OCSP Responder Trusted Common Name object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/ClientCertAuthorityOcspTlsTrustedCommonNameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get an OCSP Responder Trusted Common Name object.", + "tags": [ + "all", + "clientCertAuthority" + ] + } + }, + "/dmrClusters": { + "get": { + "description": "Get a list of Cluster objects.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||x||x\nauthenticationClientCertContent||x||x\nauthenticationClientCertPassword||x||\ndmrClusterName|x|||\ntlsServerCertEnforceTrustedCommonNameEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getDmrClusters", + "parameters": [ + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Cluster objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClustersResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Cluster objects.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "post": { + "description": "Create a Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x||x\nauthenticationClientCertContent||||x||x\nauthenticationClientCertPassword||||x||\ndmrClusterName|x|x||||\nnodeName|||x|||\ntlsServerCertEnforceTrustedCommonNameEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrCluster|authenticationClientCertPassword|authenticationClientCertContent|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createDmrCluster", + "parameters": [ + { + "description": "The Cluster object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrCluster" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Cluster object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Cluster object.", + "tags": [ + "all", + "dmrCluster" + ] + } + }, + "/dmrClusters/{dmrClusterName}": { + "delete": { + "description": "Delete a Cluster object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteDmrCluster", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Cluster object.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "get": { + "description": "Get a Cluster object.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||x||x\nauthenticationClientCertContent||x||x\nauthenticationClientCertPassword||x||\ndmrClusterName|x|||\ntlsServerCertEnforceTrustedCommonNameEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getDmrCluster", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Cluster object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Cluster object.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "patch": { + "description": "Update a Cluster object. Any attribute missing from the request will be left unchanged.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nauthenticationBasicPassword|||x|x||x\nauthenticationClientCertContent|||x|x||x\nauthenticationClientCertPassword|||x|x||\ndirectOnlyEnabled||x||||\ndmrClusterName|x|x||||\nnodeName||x||||\ntlsServerCertEnforceTrustedCommonNameEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrCluster|authenticationClientCertPassword|authenticationClientCertContent|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "updateDmrCluster", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The Cluster object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrCluster" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Cluster object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Cluster object.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "put": { + "description": "Replace a Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nauthenticationBasicPassword||||x|x||x\nauthenticationClientCertContent||||x|x||x\nauthenticationClientCertPassword||||x|x||\ndirectOnlyEnabled||x|||||\ndmrClusterName|x||x||||\nnodeName|||x||||\ntlsServerCertEnforceTrustedCommonNameEnabled||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrCluster|authenticationClientCertPassword|authenticationClientCertContent|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "replaceDmrCluster", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The Cluster object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrCluster" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Cluster object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Cluster object.", + "tags": [ + "all", + "dmrCluster" + ] + } + }, + "/dmrClusters/{dmrClusterName}/certMatchingRules": { + "get": { + "description": "Get a list of Certificate Matching Rule objects.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||\nruleName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "getDmrClusterCertMatchingRules", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Certificate Matching Rule objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRulesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Certificate Matching Rule objects.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "post": { + "description": "Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ndmrClusterName|x||x|||\nruleName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "createDmrClusterCertMatchingRule", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Matching Rule object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRule" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Certificate Matching Rule object.", + "tags": [ + "all", + "dmrCluster" + ] + } + }, + "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}": { + "delete": { + "description": "Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "deleteDmrClusterCertMatchingRule", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Certificate Matching Rule object.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "get": { + "description": "Get a Certificate Matching Rule object.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||\nruleName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "getDmrClusterCertMatchingRule", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Certificate Matching Rule object.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "patch": { + "description": "Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\ndmrClusterName|x|x||||\nruleName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "updateDmrClusterCertMatchingRule", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Matching Rule object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRule" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Certificate Matching Rule object.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "put": { + "description": "Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\ndmrClusterName|x||x||||\nruleName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "replaceDmrClusterCertMatchingRule", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Matching Rule object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRule" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Certificate Matching Rule object.", + "tags": [ + "all", + "dmrCluster" + ] + } + }, + "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters": { + "get": { + "description": "Get a list of Certificate Matching Rule Attribute Filter objects.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||\nfilterName|x|||\nruleName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "getDmrClusterCertMatchingRuleAttributeFilters", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFiltersResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Certificate Matching Rule Attribute Filter objects.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "post": { + "description": "Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ndmrClusterName|x||x|||\nfilterName|x|x||||\nruleName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "createDmrClusterCertMatchingRuleAttributeFilter", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Matching Rule Attribute Filter object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilter" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Certificate Matching Rule Attribute Filter object.", + "tags": [ + "all", + "dmrCluster" + ] + } + }, + "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}": { + "delete": { + "description": "Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "deleteDmrClusterCertMatchingRuleAttributeFilter", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The name of the filter.", + "in": "path", + "name": "filterName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Certificate Matching Rule Attribute Filter object.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "get": { + "description": "Get a Certificate Matching Rule Attribute Filter object.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||\nfilterName|x|||\nruleName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "getDmrClusterCertMatchingRuleAttributeFilter", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The name of the filter.", + "in": "path", + "name": "filterName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Certificate Matching Rule Attribute Filter object.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "patch": { + "description": "Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\ndmrClusterName|x|x||||\nfilterName|x|x||||\nruleName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "updateDmrClusterCertMatchingRuleAttributeFilter", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The name of the filter.", + "in": "path", + "name": "filterName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Matching Rule Attribute Filter object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilter" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Certificate Matching Rule Attribute Filter object.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "put": { + "description": "Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\ndmrClusterName|x||x||||\nfilterName|x||x||||\nruleName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "replaceDmrClusterCertMatchingRuleAttributeFilter", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The name of the filter.", + "in": "path", + "name": "filterName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Matching Rule Attribute Filter object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilter" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleAttributeFilterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Certificate Matching Rule Attribute Filter object.", + "tags": [ + "all", + "dmrCluster" + ] + } + }, + "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions": { + "get": { + "description": "Get a list of Certificate Matching Rule Condition objects.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||\nruleName|x|||\nsource|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "getDmrClusterCertMatchingRuleConditions", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Certificate Matching Rule Condition objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleConditionsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Certificate Matching Rule Condition objects.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "post": { + "description": "Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ndmrClusterName|x||x|||\nruleName|x||x|||\nsource|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "createDmrClusterCertMatchingRuleCondition", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Matching Rule Condition object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleCondition" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule Condition object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleConditionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Certificate Matching Rule Condition object.", + "tags": [ + "all", + "dmrCluster" + ] + } + }, + "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source}": { + "delete": { + "description": "Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "deleteDmrClusterCertMatchingRuleCondition", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "Certificate field to be compared with the Attribute.", + "in": "path", + "name": "source", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Certificate Matching Rule Condition object.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "get": { + "description": "Get a Certificate Matching Rule Condition object.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||\nruleName|x|||\nsource|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "getDmrClusterCertMatchingRuleCondition", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "Certificate field to be compared with the Attribute.", + "in": "path", + "name": "source", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule Condition object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterCertMatchingRuleConditionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Certificate Matching Rule Condition object.", + "tags": [ + "all", + "dmrCluster" + ] + } + }, + "/dmrClusters/{dmrClusterName}/links": { + "get": { + "description": "Get a list of Link objects.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||x||x\ndmrClusterName|x|||\nremoteNodeName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getDmrClusterLinks", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Link objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterLinksResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Link objects.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "post": { + "description": "Create a Link object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x||x\ndmrClusterName|x||x|||\nremoteNodeName|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createDmrClusterLink", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The Link object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterLink" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Link object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterLinkResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Link object.", + "tags": [ + "all", + "dmrCluster" + ] + } + }, + "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}": { + "delete": { + "description": "Delete a Link object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteDmrClusterLink", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Link object.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "get": { + "description": "Get a Link object.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||x||x\ndmrClusterName|x|||\nremoteNodeName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getDmrClusterLink", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Link object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterLinkResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Link object.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "patch": { + "description": "Update a Link object. Any attribute missing from the request will be left unchanged.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nauthenticationBasicPassword|||x|x||x\nauthenticationScheme||||x||\ndmrClusterName|x|x||||\negressFlowWindowSize||||x||\ninitiator||||x||\nremoteNodeName|x|x||||\nspan||||x||\ntransportCompressedEnabled||||x||\ntransportTlsEnabled||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "updateDmrClusterLink", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The Link object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterLink" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Link object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterLinkResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Link object.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "put": { + "description": "Replace a Link object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nauthenticationBasicPassword||||x|x||x\nauthenticationScheme|||||x||\ndmrClusterName|x||x||||\negressFlowWindowSize|||||x||\ninitiator|||||x||\nremoteNodeName|x||x||||\nspan|||||x||\ntransportCompressedEnabled|||||x||\ntransportTlsEnabled|||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "replaceDmrClusterLink", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The Link object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterLink" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Link object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterLinkResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Link object.", + "tags": [ + "all", + "dmrCluster" + ] + } + }, + "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes": { + "get": { + "description": "Get a list of Link Attribute objects.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nattributeName|x|||\nattributeValue|x|||\ndmrClusterName|x|||\nremoteNodeName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "getDmrClusterLinkAttributes", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Link Attribute objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterLinkAttributesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Link Attribute objects.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "post": { + "description": "Create a Link Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nattributeName|x|x||||\nattributeValue|x|x||||\ndmrClusterName|x||x|||\nremoteNodeName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "createDmrClusterLinkAttribute", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The Link Attribute object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterLinkAttribute" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Link Attribute object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterLinkAttributeResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Link Attribute object.", + "tags": [ + "all", + "dmrCluster" + ] + } + }, + "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue}": { + "delete": { + "description": "Delete a Link Attribute object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "deleteDmrClusterLinkAttribute", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Attribute.", + "in": "path", + "name": "attributeName", + "required": true, + "type": "string" + }, + { + "description": "The value of the Attribute.", + "in": "path", + "name": "attributeValue", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Link Attribute object.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "get": { + "description": "Get a Link Attribute object.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nattributeName|x|||\nattributeValue|x|||\ndmrClusterName|x|||\nremoteNodeName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "getDmrClusterLinkAttribute", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Attribute.", + "in": "path", + "name": "attributeName", + "required": true, + "type": "string" + }, + { + "description": "The value of the Attribute.", + "in": "path", + "name": "attributeValue", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Link Attribute object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterLinkAttributeResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Link Attribute object.", + "tags": [ + "all", + "dmrCluster" + ] + } + }, + "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses": { + "get": { + "description": "Get a list of Remote Address objects.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||\nremoteAddress|x|||\nremoteNodeName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getDmrClusterLinkRemoteAddresses", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Remote Address objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterLinkRemoteAddressesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Remote Address objects.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "post": { + "description": "Create a Remote Address object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ndmrClusterName|x||x|||\nremoteAddress|x|x||||\nremoteNodeName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createDmrClusterLinkRemoteAddress", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The Remote Address object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterLinkRemoteAddress" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Remote Address object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterLinkRemoteAddressResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Remote Address object.", + "tags": [ + "all", + "dmrCluster" + ] + } + }, + "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress}": { + "delete": { + "description": "Delete a Remote Address object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteDmrClusterLinkRemoteAddress", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed).", + "in": "path", + "name": "remoteAddress", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Remote Address object.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "get": { + "description": "Get a Remote Address object.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||\nremoteAddress|x|||\nremoteNodeName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getDmrClusterLinkRemoteAddress", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed).", + "in": "path", + "name": "remoteAddress", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Remote Address object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterLinkRemoteAddressResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Remote Address object.", + "tags": [ + "all", + "dmrCluster" + ] + } + }, + "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames": { + "get": { + "deprecated": true, + "description": "Get a list of Trusted Common Name objects.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x||x|\nremoteNodeName|x||x|\ntlsTrustedCommonName|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "getDmrClusterLinkTlsTrustedCommonNames", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Trusted Common Name objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonNamesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Trusted Common Name objects.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "post": { + "deprecated": true, + "description": "Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ndmrClusterName|x||x||x|\nremoteNodeName|x||x||x|\ntlsTrustedCommonName|x|x|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "createDmrClusterLinkTlsTrustedCommonName", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The Trusted Common Name object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonName" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Trusted Common Name object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonNameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Trusted Common Name object.", + "tags": [ + "all", + "dmrCluster" + ] + } + }, + "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames/{tlsTrustedCommonName}": { + "delete": { + "deprecated": true, + "description": "Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "deleteDmrClusterLinkTlsTrustedCommonName", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The expected trusted common name of the remote certificate.", + "in": "path", + "name": "tlsTrustedCommonName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Trusted Common Name object.", + "tags": [ + "all", + "dmrCluster" + ] + }, + "get": { + "deprecated": true, + "description": "Get a Trusted Common Name object.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x||x|\nremoteNodeName|x||x|\ntlsTrustedCommonName|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "getDmrClusterLinkTlsTrustedCommonName", + "parameters": [ + { + "description": "The name of the Cluster.", + "in": "path", + "name": "dmrClusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the Link.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The expected trusted common name of the remote certificate.", + "in": "path", + "name": "tlsTrustedCommonName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Trusted Common Name object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DmrClusterLinkTlsTrustedCommonNameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Trusted Common Name object.", + "tags": [ + "all", + "dmrCluster" + ] + } + }, + "/domainCertAuthorities": { + "get": { + "description": "Get a list of Domain Certificate Authority objects.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "getDomainCertAuthorities", + "parameters": [ + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Domain Certificate Authority objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DomainCertAuthoritiesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Domain Certificate Authority objects.", + "tags": [ + "all", + "domainCertAuthority" + ] + }, + "post": { + "description": "Create a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "createDomainCertAuthority", + "parameters": [ + { + "description": "The Domain Certificate Authority object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DomainCertAuthority" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Domain Certificate Authority object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/DomainCertAuthorityResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Domain Certificate Authority object.", + "tags": [ + "all", + "domainCertAuthority" + ] + } + }, + "/domainCertAuthorities/{certAuthorityName}": { + "delete": { + "description": "Delete a Domain Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nCertificate Authorities trusted for domain verification.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "deleteDomainCertAuthority", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Domain Certificate Authority object.", + "tags": [ + "all", + "domainCertAuthority" + ] + }, + "get": { + "description": "Get a Domain Certificate Authority object.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "getDomainCertAuthority", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Domain Certificate Authority object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/DomainCertAuthorityResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Domain Certificate Authority object.", + "tags": [ + "all", + "domainCertAuthority" + ] + }, + "patch": { + "description": "Update a Domain Certificate Authority object. Any attribute missing from the request will be left unchanged.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\ncertAuthorityName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "updateDomainCertAuthority", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "description": "The Domain Certificate Authority object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DomainCertAuthority" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Domain Certificate Authority object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/DomainCertAuthorityResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Domain Certificate Authority object.", + "tags": [ + "all", + "domainCertAuthority" + ] + }, + "put": { + "description": "Replace a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\ncertAuthorityName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "operationId": "replaceDomainCertAuthority", + "parameters": [ + { + "description": "The name of the Certificate Authority.", + "in": "path", + "name": "certAuthorityName", + "required": true, + "type": "string" + }, + { + "description": "The Domain Certificate Authority object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DomainCertAuthority" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Domain Certificate Authority object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/DomainCertAuthorityResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Domain Certificate Authority object.", + "tags": [ + "all", + "domainCertAuthority" + ] + } + }, + "/msgVpns": { + "get": { + "description": "Get a list of Message VPN objects.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x|\ndistributedCacheManagementEnabled|||x|\nmsgVpnName|x|||\nreplicationBridgeAuthenticationBasicPassword||x||x\nreplicationBridgeAuthenticationClientCertContent||x||x\nreplicationBridgeAuthenticationClientCertPassword||x||\nreplicationEnabledQueueBehavior||x||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpns", + "parameters": [ + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Message VPN objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Message VPN objects.", + "tags": [ + "all", + "msgVpn" + ] + }, + "post": { + "description": "Create a Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\ndistributedCacheManagementEnabled|||||x|\nmsgVpnName|x|x||||\nreplicationBridgeAuthenticationBasicPassword||||x||x\nreplicationBridgeAuthenticationClientCertContent||||x||x\nreplicationBridgeAuthenticationClientCertPassword||||x||\nreplicationEnabledQueueBehavior||||x||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\nEventThresholdByValue|clearValue|setValue|\nEventThresholdByValue|setValue|clearValue|\nMsgVpn|authenticationBasicProfileName|authenticationBasicType|\nMsgVpn|authorizationProfileName|authorizationType|\nMsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled|\nMsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled|\nMsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword|\nMsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername|\nMsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent|\nMsgVpn|replicationEnabledQueueBehavior|replicationEnabled|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpn", + "parameters": [ + { + "description": "The Message VPN object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpn" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Message VPN object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Message VPN object.", + "tags": [ + "all", + "msgVpn" + ] + } + }, + "/msgVpns/{msgVpnName}": { + "delete": { + "description": "Delete a Message VPN object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpn", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Message VPN object.", + "tags": [ + "all", + "msgVpn" + ] + }, + "get": { + "description": "Get a Message VPN object.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x|\ndistributedCacheManagementEnabled|||x|\nmsgVpnName|x|||\nreplicationBridgeAuthenticationBasicPassword||x||x\nreplicationBridgeAuthenticationClientCertContent||x||x\nreplicationBridgeAuthenticationClientCertPassword||x||\nreplicationEnabledQueueBehavior||x||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpn", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Message VPN object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Message VPN object.", + "tags": [ + "all", + "msgVpn" + ] + }, + "patch": { + "description": "Update a Message VPN object. Any attribute missing from the request will be left unchanged.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nauthenticationOauthDefaultProviderName|||||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\ndistributedCacheManagementEnabled|||||x|\nmsgVpnName|x|x||||\nreplicationBridgeAuthenticationBasicPassword|||x|||x\nreplicationBridgeAuthenticationClientCertContent|||x|||x\nreplicationBridgeAuthenticationClientCertPassword|||x|||\nreplicationEnabledQueueBehavior|||x|||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\nEventThresholdByValue|clearValue|setValue|\nEventThresholdByValue|setValue|clearValue|\nMsgVpn|authenticationBasicProfileName|authenticationBasicType|\nMsgVpn|authorizationProfileName|authorizationType|\nMsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled|\nMsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled|\nMsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword|\nMsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername|\nMsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent|\nMsgVpn|replicationEnabledQueueBehavior|replicationEnabled|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\nalias|global/read-write\nauthenticationBasicEnabled|global/read-write\nauthenticationBasicProfileName|global/read-write\nauthenticationBasicRadiusDomain|global/read-write\nauthenticationBasicType|global/read-write\nauthenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationClientCertCertificateMatchingRulesEnabled|global/read-write\nauthenticationClientCertEnabled|global/read-write\nauthenticationClientCertMaxChainDepth|global/read-write\nauthenticationClientCertRevocationCheckMode|global/read-write\nauthenticationClientCertUsernameSource|global/read-write\nauthenticationClientCertValidateDateEnabled|global/read-write\nauthenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationKerberosEnabled|global/read-write\nauthenticationOauthEnabled|global/read-write\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nbridgingTlsServerCertMaxChainDepth|global/read-write\nbridgingTlsServerCertValidateDateEnabled|global/read-write\nbridgingTlsServerCertValidateNameEnabled|global/read-write\ndmrEnabled|global/read-write\nexportSubscriptionsEnabled|global/read-write\nmaxConnectionCount|global/read-write\nmaxEgressFlowCount|global/read-write\nmaxEndpointCount|global/read-write\nmaxIngressFlowCount|global/read-write\nmaxMsgSpoolUsage|global/read-write\nmaxSubscriptionCount|global/read-write\nmaxTransactedSessionCount|global/read-write\nmaxTransactionCount|global/read-write\nmqttRetainMaxMemory|global/read-write\nreplicationBridgeAuthenticationBasicClientUsername|global/read-write\nreplicationBridgeAuthenticationBasicPassword|global/read-write\nreplicationBridgeAuthenticationClientCertContent|global/read-write\nreplicationBridgeAuthenticationClientCertPassword|global/read-write\nreplicationBridgeAuthenticationScheme|global/read-write\nreplicationBridgeCompressedDataEnabled|global/read-write\nreplicationBridgeEgressFlowWindowSize|global/read-write\nreplicationBridgeRetryDelay|global/read-write\nreplicationBridgeTlsEnabled|global/read-write\nreplicationBridgeUnidirectionalClientProfileName|global/read-write\nreplicationEnabled|global/read-write\nreplicationEnabledQueueBehavior|global/read-write\nreplicationQueueMaxMsgSpoolUsage|global/read-write\nreplicationRole|global/read-write\nrestTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nrestTlsServerCertMaxChainDepth|global/read-write\nrestTlsServerCertValidateDateEnabled|global/read-write\nrestTlsServerCertValidateNameEnabled|global/read-write\nsempOverMsgBusAdminClientEnabled|global/read-write\nsempOverMsgBusAdminDistributedCacheEnabled|global/read-write\nsempOverMsgBusAdminEnabled|global/read-write\nsempOverMsgBusEnabled|global/read-write\nsempOverMsgBusShowEnabled|global/read-write\nserviceAmqpMaxConnectionCount|global/read-write\nserviceAmqpPlainTextListenPort|global/read-write\nserviceAmqpTlsListenPort|global/read-write\nserviceMqttMaxConnectionCount|global/read-write\nserviceMqttPlainTextListenPort|global/read-write\nserviceMqttTlsListenPort|global/read-write\nserviceMqttTlsWebSocketListenPort|global/read-write\nserviceMqttWebSocketListenPort|global/read-write\nserviceRestIncomingMaxConnectionCount|global/read-write\nserviceRestIncomingPlainTextListenPort|global/read-write\nserviceRestIncomingTlsListenPort|global/read-write\nserviceRestOutgoingMaxConnectionCount|global/read-write\nserviceSmfMaxConnectionCount|global/read-write\nserviceWebMaxConnectionCount|global/read-write\n\n\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpn", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Message VPN object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpn" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Message VPN object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Message VPN object.", + "tags": [ + "all", + "msgVpn" + ] + }, + "put": { + "description": "Replace a Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nauthenticationOauthDefaultProviderName||||||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled||||||x|\ndistributedCacheManagementEnabled||||||x|\nmsgVpnName|x||x||||\nreplicationBridgeAuthenticationBasicPassword||||x|||x\nreplicationBridgeAuthenticationClientCertContent||||x|||x\nreplicationBridgeAuthenticationClientCertPassword||||x|||\nreplicationEnabledQueueBehavior||||x|||\nrestTlsServerCertEnforceTrustedCommonNameEnabled||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\nEventThresholdByValue|clearValue|setValue|\nEventThresholdByValue|setValue|clearValue|\nMsgVpn|authenticationBasicProfileName|authenticationBasicType|\nMsgVpn|authorizationProfileName|authorizationType|\nMsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled|\nMsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled|\nMsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword|\nMsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername|\nMsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent|\nMsgVpn|replicationEnabledQueueBehavior|replicationEnabled|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\nalias|global/read-write\nauthenticationBasicEnabled|global/read-write\nauthenticationBasicProfileName|global/read-write\nauthenticationBasicRadiusDomain|global/read-write\nauthenticationBasicType|global/read-write\nauthenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationClientCertCertificateMatchingRulesEnabled|global/read-write\nauthenticationClientCertEnabled|global/read-write\nauthenticationClientCertMaxChainDepth|global/read-write\nauthenticationClientCertRevocationCheckMode|global/read-write\nauthenticationClientCertUsernameSource|global/read-write\nauthenticationClientCertValidateDateEnabled|global/read-write\nauthenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationKerberosEnabled|global/read-write\nauthenticationOauthEnabled|global/read-write\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nbridgingTlsServerCertMaxChainDepth|global/read-write\nbridgingTlsServerCertValidateDateEnabled|global/read-write\nbridgingTlsServerCertValidateNameEnabled|global/read-write\ndmrEnabled|global/read-write\nexportSubscriptionsEnabled|global/read-write\nmaxConnectionCount|global/read-write\nmaxEgressFlowCount|global/read-write\nmaxEndpointCount|global/read-write\nmaxIngressFlowCount|global/read-write\nmaxMsgSpoolUsage|global/read-write\nmaxSubscriptionCount|global/read-write\nmaxTransactedSessionCount|global/read-write\nmaxTransactionCount|global/read-write\nmqttRetainMaxMemory|global/read-write\nreplicationBridgeAuthenticationBasicClientUsername|global/read-write\nreplicationBridgeAuthenticationBasicPassword|global/read-write\nreplicationBridgeAuthenticationClientCertContent|global/read-write\nreplicationBridgeAuthenticationClientCertPassword|global/read-write\nreplicationBridgeAuthenticationScheme|global/read-write\nreplicationBridgeCompressedDataEnabled|global/read-write\nreplicationBridgeEgressFlowWindowSize|global/read-write\nreplicationBridgeRetryDelay|global/read-write\nreplicationBridgeTlsEnabled|global/read-write\nreplicationBridgeUnidirectionalClientProfileName|global/read-write\nreplicationEnabled|global/read-write\nreplicationEnabledQueueBehavior|global/read-write\nreplicationQueueMaxMsgSpoolUsage|global/read-write\nreplicationRole|global/read-write\nrestTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nrestTlsServerCertMaxChainDepth|global/read-write\nrestTlsServerCertValidateDateEnabled|global/read-write\nrestTlsServerCertValidateNameEnabled|global/read-write\nsempOverMsgBusAdminClientEnabled|global/read-write\nsempOverMsgBusAdminDistributedCacheEnabled|global/read-write\nsempOverMsgBusAdminEnabled|global/read-write\nsempOverMsgBusEnabled|global/read-write\nsempOverMsgBusShowEnabled|global/read-write\nserviceAmqpMaxConnectionCount|global/read-write\nserviceAmqpPlainTextListenPort|global/read-write\nserviceAmqpTlsListenPort|global/read-write\nserviceMqttMaxConnectionCount|global/read-write\nserviceMqttPlainTextListenPort|global/read-write\nserviceMqttTlsListenPort|global/read-write\nserviceMqttTlsWebSocketListenPort|global/read-write\nserviceMqttWebSocketListenPort|global/read-write\nserviceRestIncomingMaxConnectionCount|global/read-write\nserviceRestIncomingPlainTextListenPort|global/read-write\nserviceRestIncomingTlsListenPort|global/read-write\nserviceRestOutgoingMaxConnectionCount|global/read-write\nserviceSmfMaxConnectionCount|global/read-write\nserviceWebMaxConnectionCount|global/read-write\n\n\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpn", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Message VPN object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpn" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Message VPN object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Message VPN object.", + "tags": [ + "all", + "msgVpn" + ] + } + }, + "/msgVpns/{msgVpnName}/aclProfiles": { + "get": { + "description": "Get a list of ACL Profile objects.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnAclProfiles", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of ACL Profile objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfilesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of ACL Profile objects.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + }, + "post": { + "description": "Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|x|x||||\nmsgVpnName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnAclProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The ACL Profile object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAclProfile" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The ACL Profile object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create an ACL Profile object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}": { + "delete": { + "description": "Delete an ACL Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnAclProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete an ACL Profile object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + }, + "get": { + "description": "Get an ACL Profile object.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnAclProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The ACL Profile object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get an ACL Profile object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + }, + "patch": { + "description": "Update an ACL Profile object. Any attribute missing from the request will be left unchanged.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\naclProfileName|x|x||||\nmsgVpnName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpnAclProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The ACL Profile object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAclProfile" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The ACL Profile object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update an ACL Profile object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + }, + "put": { + "description": "Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\naclProfileName|x||x||||\nmsgVpnName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpnAclProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The ACL Profile object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAclProfile" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The ACL Profile object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace an ACL Profile object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions": { + "get": { + "description": "Get a list of Client Connect Exception objects.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nclientConnectExceptionAddress|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnAclProfileClientConnectExceptions", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Client Connect Exception objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileClientConnectExceptionsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Client Connect Exception objects.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + }, + "post": { + "description": "Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|x||x|||\nclientConnectExceptionAddress|x|x||||\nmsgVpnName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnAclProfileClientConnectException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Client Connect Exception object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileClientConnectException" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Connect Exception object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileClientConnectExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Client Connect Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress}": { + "delete": { + "description": "Delete a Client Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnAclProfileClientConnectException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The IP address/netmask of the client connect exception in CIDR form.", + "in": "path", + "name": "clientConnectExceptionAddress", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Client Connect Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + }, + "get": { + "description": "Get a Client Connect Exception object.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nclientConnectExceptionAddress|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnAclProfileClientConnectException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The IP address/netmask of the client connect exception in CIDR form.", + "in": "path", + "name": "clientConnectExceptionAddress", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Connect Exception object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileClientConnectExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Client Connect Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions": { + "get": { + "deprecated": true, + "description": "Get a list of Publish Topic Exception objects.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x||x|\nmsgVpnName|x||x|\npublishExceptionTopic|x||x|\ntopicSyntax|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", + "operationId": "getMsgVpnAclProfilePublishExceptions", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Publish Topic Exception objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfilePublishExceptionsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Publish Topic Exception objects.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + }, + "post": { + "deprecated": true, + "description": "Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|x||x||x|\nmsgVpnName|x||x||x|\npublishExceptionTopic|x|x|||x|\ntopicSyntax|x|x|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", + "operationId": "createMsgVpnAclProfilePublishException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Publish Topic Exception object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAclProfilePublishException" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Publish Topic Exception object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfilePublishExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Publish Topic Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions/{topicSyntax},{publishExceptionTopic}": { + "delete": { + "deprecated": true, + "description": "Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", + "operationId": "deleteMsgVpnAclProfilePublishException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The syntax of the topic for the exception to the default action taken.", + "in": "path", + "name": "topicSyntax", + "required": true, + "type": "string" + }, + { + "description": "The topic for the exception to the default action taken. May include wildcard characters.", + "in": "path", + "name": "publishExceptionTopic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Publish Topic Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + }, + "get": { + "deprecated": true, + "description": "Get a Publish Topic Exception object.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x||x|\nmsgVpnName|x||x|\npublishExceptionTopic|x||x|\ntopicSyntax|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", + "operationId": "getMsgVpnAclProfilePublishException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The syntax of the topic for the exception to the default action taken.", + "in": "path", + "name": "topicSyntax", + "required": true, + "type": "string" + }, + { + "description": "The topic for the exception to the default action taken. May include wildcard characters.", + "in": "path", + "name": "publishExceptionTopic", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Publish Topic Exception object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfilePublishExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Publish Topic Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions": { + "get": { + "description": "Get a list of Publish Topic Exception objects.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nmsgVpnName|x|||\npublishTopicException|x|||\npublishTopicExceptionSyntax|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "getMsgVpnAclProfilePublishTopicExceptions", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Publish Topic Exception objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfilePublishTopicExceptionsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Publish Topic Exception objects.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + }, + "post": { + "description": "Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|x||x|||\nmsgVpnName|x||x|||\npublishTopicException|x|x||||\npublishTopicExceptionSyntax|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "createMsgVpnAclProfilePublishTopicException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Publish Topic Exception object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAclProfilePublishTopicException" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Publish Topic Exception object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfilePublishTopicExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Publish Topic Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException}": { + "delete": { + "description": "Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "deleteMsgVpnAclProfilePublishTopicException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The syntax of the topic for the exception to the default action taken.", + "in": "path", + "name": "publishTopicExceptionSyntax", + "required": true, + "type": "string" + }, + { + "description": "The topic for the exception to the default action taken. May include wildcard characters.", + "in": "path", + "name": "publishTopicException", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Publish Topic Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + }, + "get": { + "description": "Get a Publish Topic Exception object.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nmsgVpnName|x|||\npublishTopicException|x|||\npublishTopicExceptionSyntax|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "getMsgVpnAclProfilePublishTopicException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The syntax of the topic for the exception to the default action taken.", + "in": "path", + "name": "publishTopicExceptionSyntax", + "required": true, + "type": "string" + }, + { + "description": "The topic for the exception to the default action taken. May include wildcard characters.", + "in": "path", + "name": "publishTopicException", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Publish Topic Exception object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfilePublishTopicExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Publish Topic Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions": { + "get": { + "deprecated": true, + "description": "Get a list of Subscribe Topic Exception objects.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x||x|\nmsgVpnName|x||x|\nsubscribeExceptionTopic|x||x|\ntopicSyntax|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", + "operationId": "getMsgVpnAclProfileSubscribeExceptions", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Subscribe Topic Exception objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeExceptionsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Subscribe Topic Exception objects.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + }, + "post": { + "deprecated": true, + "description": "Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|x||x||x|\nmsgVpnName|x||x||x|\nsubscribeExceptionTopic|x|x|||x|\ntopicSyntax|x|x|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", + "operationId": "createMsgVpnAclProfileSubscribeException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Subscribe Topic Exception object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeException" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Subscribe Topic Exception object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Subscribe Topic Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions/{topicSyntax},{subscribeExceptionTopic}": { + "delete": { + "deprecated": true, + "description": "Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", + "operationId": "deleteMsgVpnAclProfileSubscribeException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The syntax of the topic for the exception to the default action taken.", + "in": "path", + "name": "topicSyntax", + "required": true, + "type": "string" + }, + { + "description": "The topic for the exception to the default action taken. May include wildcard characters.", + "in": "path", + "name": "subscribeExceptionTopic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Subscribe Topic Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + }, + "get": { + "deprecated": true, + "description": "Get a Subscribe Topic Exception object.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x||x|\nmsgVpnName|x||x|\nsubscribeExceptionTopic|x||x|\ntopicSyntax|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", + "operationId": "getMsgVpnAclProfileSubscribeException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The syntax of the topic for the exception to the default action taken.", + "in": "path", + "name": "topicSyntax", + "required": true, + "type": "string" + }, + { + "description": "The topic for the exception to the default action taken. May include wildcard characters.", + "in": "path", + "name": "subscribeExceptionTopic", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Subscribe Topic Exception object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Subscribe Topic Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions": { + "get": { + "description": "Get a list of Subscribe Share Name Exception objects.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nmsgVpnName|x|||\nsubscribeShareNameException|x|||\nsubscribeShareNameExceptionSyntax|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "getMsgVpnAclProfileSubscribeShareNameExceptions", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Subscribe Share Name Exception objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameExceptionsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Subscribe Share Name Exception objects.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + }, + "post": { + "description": "Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|x||x|||\nmsgVpnName|x||x|||\nsubscribeShareNameException|x|x||||\nsubscribeShareNameExceptionSyntax|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "createMsgVpnAclProfileSubscribeShareNameException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Subscribe Share Name Exception object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameException" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Subscribe Share Name Exception object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Subscribe Share Name Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException}": { + "delete": { + "description": "Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "deleteMsgVpnAclProfileSubscribeShareNameException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The syntax of the subscribe share name for the exception to the default action taken.", + "in": "path", + "name": "subscribeShareNameExceptionSyntax", + "required": true, + "type": "string" + }, + { + "description": "The subscribe share name exception to the default action taken. May include wildcard characters.", + "in": "path", + "name": "subscribeShareNameException", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Subscribe Share Name Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + }, + "get": { + "description": "Get a Subscribe Share Name Exception object.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nmsgVpnName|x|||\nsubscribeShareNameException|x|||\nsubscribeShareNameExceptionSyntax|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "getMsgVpnAclProfileSubscribeShareNameException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The syntax of the subscribe share name for the exception to the default action taken.", + "in": "path", + "name": "subscribeShareNameExceptionSyntax", + "required": true, + "type": "string" + }, + { + "description": "The subscribe share name exception to the default action taken. May include wildcard characters.", + "in": "path", + "name": "subscribeShareNameException", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Subscribe Share Name Exception object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeShareNameExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Subscribe Share Name Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions": { + "get": { + "description": "Get a list of Subscribe Topic Exception objects.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nmsgVpnName|x|||\nsubscribeTopicException|x|||\nsubscribeTopicExceptionSyntax|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "getMsgVpnAclProfileSubscribeTopicExceptions", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Subscribe Topic Exception objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicExceptionsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Subscribe Topic Exception objects.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + }, + "post": { + "description": "Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|x||x|||\nmsgVpnName|x||x|||\nsubscribeTopicException|x|x||||\nsubscribeTopicExceptionSyntax|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "createMsgVpnAclProfileSubscribeTopicException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Subscribe Topic Exception object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicException" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Subscribe Topic Exception object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Subscribe Topic Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException}": { + "delete": { + "description": "Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "deleteMsgVpnAclProfileSubscribeTopicException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The syntax of the topic for the exception to the default action taken.", + "in": "path", + "name": "subscribeTopicExceptionSyntax", + "required": true, + "type": "string" + }, + { + "description": "The topic for the exception to the default action taken. May include wildcard characters.", + "in": "path", + "name": "subscribeTopicException", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Subscribe Topic Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + }, + "get": { + "description": "Get a Subscribe Topic Exception object.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nmsgVpnName|x|||\nsubscribeTopicException|x|||\nsubscribeTopicExceptionSyntax|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "getMsgVpnAclProfileSubscribeTopicException", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ACL Profile.", + "in": "path", + "name": "aclProfileName", + "required": true, + "type": "string" + }, + { + "description": "The syntax of the topic for the exception to the default action taken.", + "in": "path", + "name": "subscribeTopicExceptionSyntax", + "required": true, + "type": "string" + }, + { + "description": "The topic for the exception to the default action taken. May include wildcard characters.", + "in": "path", + "name": "subscribeTopicException", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Subscribe Topic Exception object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAclProfileSubscribeTopicExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Subscribe Topic Exception object.", + "tags": [ + "all", + "msgVpn", + "aclProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/authenticationOauthProfiles": { + "get": { + "description": "Get a list of OAuth Profile objects.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientSecret||x||x\nmsgVpnName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfiles", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of OAuth Profile objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfilesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of OAuth Profile objects.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ] + }, + "post": { + "description": "Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nclientSecret||||x||x\nmsgVpnName|x||x|||\noauthProfileName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "createMsgVpnAuthenticationOauthProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The OAuth Profile object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OAuth Profile object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create an OAuth Profile object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}": { + "delete": { + "description": "Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "deleteMsgVpnAuthenticationOauthProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete an OAuth Profile object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ] + }, + "get": { + "description": "Get an OAuth Profile object.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientSecret||x||x\nmsgVpnName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OAuth Profile object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get an OAuth Profile object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ] + }, + "patch": { + "description": "Update an OAuth Profile object. Any attribute missing from the request will be left unchanged.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nclientSecret|||x|||x\nmsgVpnName|x|x||||\noauthProfileName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "updateMsgVpnAuthenticationOauthProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The OAuth Profile object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OAuth Profile object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update an OAuth Profile object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ] + }, + "put": { + "description": "Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nclientSecret||||x|||x\nmsgVpnName|x||x||||\noauthProfileName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "replaceMsgVpnAuthenticationOauthProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The OAuth Profile object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OAuth Profile object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace an OAuth Profile object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims": { + "get": { + "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|||\nmsgVpnName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfileClientRequiredClaims", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Required Claim objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Required Claim objects.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ] + }, + "post": { + "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|x||||\nclientRequiredClaimValue||x||||\nmsgVpnName|x||x|||\noauthProfileName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "createMsgVpnAuthenticationOauthProfileClientRequiredClaim", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Required Claim object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaim" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Required Claim object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Required Claim object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}": { + "delete": { + "description": "Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the ID token.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ID token claim to verify.", + "in": "path", + "name": "clientRequiredClaimName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Required Claim object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ] + }, + "get": { + "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|||\nmsgVpnName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfileClientRequiredClaim", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ID token claim to verify.", + "in": "path", + "name": "clientRequiredClaimName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Required Claim object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Required Claim object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims": { + "get": { + "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\noauthProfileName|x|||\nresourceServerRequiredClaimName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Required Claim objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Required Claim objects.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ] + }, + "post": { + "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\noauthProfileName|x||x|||\nresourceServerRequiredClaimName|x|x||||\nresourceServerRequiredClaimValue||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Required Claim object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Required Claim object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Required Claim object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}": { + "delete": { + "description": "Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the access token.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the access token claim to verify.", + "in": "path", + "name": "resourceServerRequiredClaimName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Required Claim object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ] + }, + "get": { + "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\noauthProfileName|x|||\nresourceServerRequiredClaimName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the access token claim to verify.", + "in": "path", + "name": "resourceServerRequiredClaimName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Required Claim object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Required Claim object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/authenticationOauthProviders": { + "get": { + "deprecated": true, + "description": "Get a list of OAuth Provider objects.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naudienceClaimName|||x|\naudienceClaimSource|||x|\naudienceClaimValue|||x|\naudienceValidationEnabled|||x|\nauthorizationGroupClaimName|||x|\nauthorizationGroupClaimSource|||x|\nauthorizationGroupEnabled|||x|\ndisconnectOnTokenExpirationEnabled|||x|\nenabled|||x|\njwksRefreshInterval|||x|\njwksUri|||x|\nmsgVpnName|x||x|\noauthProviderName|x||x|\ntokenIgnoreTimeLimitsEnabled|||x|\ntokenIntrospectionParameterName|||x|\ntokenIntrospectionPassword||x|x|x\ntokenIntrospectionTimeout|||x|\ntokenIntrospectionUri|||x|\ntokenIntrospectionUsername|||x|\nusernameClaimName|||x|\nusernameClaimSource|||x|\nusernameValidateEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "operationId": "getMsgVpnAuthenticationOauthProviders", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of OAuth Provider objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProvidersResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of OAuth Provider objects.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProvider" + ] + }, + "post": { + "deprecated": true, + "description": "Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naudienceClaimName|||||x|\naudienceClaimSource|||||x|\naudienceClaimValue|||||x|\naudienceValidationEnabled|||||x|\nauthorizationGroupClaimName|||||x|\nauthorizationGroupClaimSource|||||x|\nauthorizationGroupEnabled|||||x|\ndisconnectOnTokenExpirationEnabled|||||x|\nenabled|||||x|\njwksRefreshInterval|||||x|\njwksUri|||||x|\nmsgVpnName|x||x||x|\noauthProviderName|x|x|||x|\ntokenIgnoreTimeLimitsEnabled|||||x|\ntokenIntrospectionParameterName|||||x|\ntokenIntrospectionPassword||||x|x|x\ntokenIntrospectionTimeout|||||x|\ntokenIntrospectionUri|||||x|\ntokenIntrospectionUsername|||||x|\nusernameClaimName|||||x|\nusernameClaimSource|||||x|\nusernameValidateEnabled|||||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "operationId": "createMsgVpnAuthenticationOauthProvider", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The OAuth Provider object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProvider" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OAuth Provider object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create an OAuth Provider object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProvider" + ] + } + }, + "/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}": { + "delete": { + "deprecated": true, + "description": "Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "operationId": "deleteMsgVpnAuthenticationOauthProvider", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth Provider.", + "in": "path", + "name": "oauthProviderName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete an OAuth Provider object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProvider" + ] + }, + "get": { + "deprecated": true, + "description": "Get an OAuth Provider object.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naudienceClaimName|||x|\naudienceClaimSource|||x|\naudienceClaimValue|||x|\naudienceValidationEnabled|||x|\nauthorizationGroupClaimName|||x|\nauthorizationGroupClaimSource|||x|\nauthorizationGroupEnabled|||x|\ndisconnectOnTokenExpirationEnabled|||x|\nenabled|||x|\njwksRefreshInterval|||x|\njwksUri|||x|\nmsgVpnName|x||x|\noauthProviderName|x||x|\ntokenIgnoreTimeLimitsEnabled|||x|\ntokenIntrospectionParameterName|||x|\ntokenIntrospectionPassword||x|x|x\ntokenIntrospectionTimeout|||x|\ntokenIntrospectionUri|||x|\ntokenIntrospectionUsername|||x|\nusernameClaimName|||x|\nusernameClaimSource|||x|\nusernameValidateEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "operationId": "getMsgVpnAuthenticationOauthProvider", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth Provider.", + "in": "path", + "name": "oauthProviderName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OAuth Provider object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get an OAuth Provider object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProvider" + ] + }, + "patch": { + "deprecated": true, + "description": "Update an OAuth Provider object. Any attribute missing from the request will be left unchanged.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\naudienceClaimName|||||x|\naudienceClaimSource|||||x|\naudienceClaimValue|||||x|\naudienceValidationEnabled|||||x|\nauthorizationGroupClaimName|||||x|\nauthorizationGroupClaimSource|||||x|\nauthorizationGroupEnabled|||||x|\ndisconnectOnTokenExpirationEnabled|||||x|\nenabled|||||x|\njwksRefreshInterval|||||x|\njwksUri|||||x|\nmsgVpnName|x|x|||x|\noauthProviderName|x|x|||x|\ntokenIgnoreTimeLimitsEnabled|||||x|\ntokenIntrospectionParameterName|||||x|\ntokenIntrospectionPassword|||x||x|x\ntokenIntrospectionTimeout|||||x|\ntokenIntrospectionUri|||||x|\ntokenIntrospectionUsername|||||x|\nusernameClaimName|||||x|\nusernameClaimSource|||||x|\nusernameValidateEnabled|||||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "operationId": "updateMsgVpnAuthenticationOauthProvider", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth Provider.", + "in": "path", + "name": "oauthProviderName", + "required": true, + "type": "string" + }, + { + "description": "The OAuth Provider object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProvider" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OAuth Provider object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update an OAuth Provider object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProvider" + ] + }, + "put": { + "deprecated": true, + "description": "Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\naudienceClaimName||||||x|\naudienceClaimSource||||||x|\naudienceClaimValue||||||x|\naudienceValidationEnabled||||||x|\nauthorizationGroupClaimName||||||x|\nauthorizationGroupClaimSource||||||x|\nauthorizationGroupEnabled||||||x|\ndisconnectOnTokenExpirationEnabled||||||x|\nenabled||||||x|\njwksRefreshInterval||||||x|\njwksUri||||||x|\nmsgVpnName|x||x|||x|\noauthProviderName|x||x|||x|\ntokenIgnoreTimeLimitsEnabled||||||x|\ntokenIntrospectionParameterName||||||x|\ntokenIntrospectionPassword||||x||x|x\ntokenIntrospectionTimeout||||||x|\ntokenIntrospectionUri||||||x|\ntokenIntrospectionUsername||||||x|\nusernameClaimName||||||x|\nusernameClaimSource||||||x|\nusernameValidateEnabled||||||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "operationId": "replaceMsgVpnAuthenticationOauthProvider", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth Provider.", + "in": "path", + "name": "oauthProviderName", + "required": true, + "type": "string" + }, + { + "description": "The OAuth Provider object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProvider" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OAuth Provider object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProviderResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace an OAuth Provider object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProvider" + ] + } + }, + "/msgVpns/{msgVpnName}/authorizationGroups": { + "get": { + "description": "Get a list of Authorization Group objects.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthorizationGroupName|x|||\nmsgVpnName|x|||\norderAfterAuthorizationGroupName||x||\norderBeforeAuthorizationGroupName||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnAuthorizationGroups", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Authorization Group objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthorizationGroupsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Authorization Group objects.", + "tags": [ + "all", + "msgVpn", + "authorizationGroup" + ] + }, + "post": { + "description": "Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthorizationGroupName|x|x||||\nmsgVpnName|x||x|||\norderAfterAuthorizationGroupName||||x||\norderBeforeAuthorizationGroupName||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName\nMsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnAuthorizationGroup", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Authorization Group object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAuthorizationGroup" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Authorization Group object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthorizationGroupResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create an Authorization Group object.", + "tags": [ + "all", + "msgVpn", + "authorizationGroup" + ] + } + }, + "/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}": { + "delete": { + "description": "Delete an Authorization Group object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnAuthorizationGroup", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'.", + "in": "path", + "name": "authorizationGroupName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete an Authorization Group object.", + "tags": [ + "all", + "msgVpn", + "authorizationGroup" + ] + }, + "get": { + "description": "Get an Authorization Group object.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthorizationGroupName|x|||\nmsgVpnName|x|||\norderAfterAuthorizationGroupName||x||\norderBeforeAuthorizationGroupName||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnAuthorizationGroup", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'.", + "in": "path", + "name": "authorizationGroupName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Authorization Group object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthorizationGroupResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get an Authorization Group object.", + "tags": [ + "all", + "msgVpn", + "authorizationGroup" + ] + }, + "patch": { + "description": "Update an Authorization Group object. Any attribute missing from the request will be left unchanged.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\naclProfileName||||x||\nauthorizationGroupName|x|x||||\nclientProfileName||||x||\nmsgVpnName|x|x||||\norderAfterAuthorizationGroupName|||x|||\norderBeforeAuthorizationGroupName|||x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName\nMsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpnAuthorizationGroup", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'.", + "in": "path", + "name": "authorizationGroupName", + "required": true, + "type": "string" + }, + { + "description": "The Authorization Group object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAuthorizationGroup" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Authorization Group object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthorizationGroupResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update an Authorization Group object.", + "tags": [ + "all", + "msgVpn", + "authorizationGroup" + ] + }, + "put": { + "description": "Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\naclProfileName|||||x||\nauthorizationGroupName|x||x||||\nclientProfileName|||||x||\nmsgVpnName|x||x||||\norderAfterAuthorizationGroupName||||x|||\norderBeforeAuthorizationGroupName||||x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName\nMsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpnAuthorizationGroup", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Authorization Group. For LDAP groups, special care is needed if the group name contains special characters such as '#', '+', ';', '=' as the value of the group name returned from the LDAP server might prepend those characters with '\\'. For example a group name called 'test#,lab,com' will be returned from the LDAP server as 'test\\#,lab,com'.", + "in": "path", + "name": "authorizationGroupName", + "required": true, + "type": "string" + }, + { + "description": "The Authorization Group object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAuthorizationGroup" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Authorization Group object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthorizationGroupResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace an Authorization Group object.", + "tags": [ + "all", + "msgVpn", + "authorizationGroup" + ] + } + }, + "/msgVpns/{msgVpnName}/bridges": { + "get": { + "description": "Get a list of Bridge objects.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridgeName|x|||\nbridgeVirtualRouter|x|||\nmsgVpnName|x|||\nremoteAuthenticationBasicPassword||x||x\nremoteAuthenticationClientCertContent||x||x\nremoteAuthenticationClientCertPassword||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnBridges", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Bridge objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnBridgesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Bridge objects.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + }, + "post": { + "description": "Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|x||||\nbridgeVirtualRouter|x|x||||\nmsgVpnName|x||x|||\nremoteAuthenticationBasicPassword||||x||x\nremoteAuthenticationClientCertContent||||x||x\nremoteAuthenticationClientCertPassword||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword|\nMsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername|\nMsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnBridge", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Bridge object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnBridge" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Bridge object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnBridgeResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Bridge object.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + } + }, + "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}": { + "delete": { + "description": "Delete a Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnBridge", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Bridge object.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + }, + "get": { + "description": "Get a Bridge object.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridgeName|x|||\nbridgeVirtualRouter|x|||\nmsgVpnName|x|||\nremoteAuthenticationBasicPassword||x||x\nremoteAuthenticationClientCertContent||x||x\nremoteAuthenticationClientCertPassword||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnBridge", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Bridge object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnBridgeResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Bridge object.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + }, + "patch": { + "description": "Update a Bridge object. Any attribute missing from the request will be left unchanged.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nbridgeName|x|x||||\nbridgeVirtualRouter|x|x||||\nmaxTtl||||x||\nmsgVpnName|x|x||||\nremoteAuthenticationBasicClientUsername||||x||\nremoteAuthenticationBasicPassword|||x|x||x\nremoteAuthenticationClientCertContent|||x|x||x\nremoteAuthenticationClientCertPassword|||x|x||\nremoteAuthenticationScheme||||x||\nremoteDeliverToOnePriority||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword|\nMsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername|\nMsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpnBridge", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The Bridge object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnBridge" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Bridge object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnBridgeResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Bridge object.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + }, + "put": { + "description": "Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nbridgeName|x||x||||\nbridgeVirtualRouter|x||x||||\nmaxTtl|||||x||\nmsgVpnName|x||x||||\nremoteAuthenticationBasicClientUsername|||||x||\nremoteAuthenticationBasicPassword||||x|x||x\nremoteAuthenticationClientCertContent||||x|x||x\nremoteAuthenticationClientCertPassword||||x|x||\nremoteAuthenticationScheme|||||x||\nremoteDeliverToOnePriority|||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword|\nMsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername|\nMsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpnBridge", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The Bridge object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnBridge" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Bridge object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnBridgeResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Bridge object.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + } + }, + "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns": { + "get": { + "description": "Get a list of Remote Message VPN objects.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridgeName|x|||\nbridgeVirtualRouter|x|||\nmsgVpnName|x|||\npassword||x||x\nremoteMsgVpnInterface|x|||\nremoteMsgVpnLocation|x|||\nremoteMsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnBridgeRemoteMsgVpns", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Remote Message VPN objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Remote Message VPN objects.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + }, + "post": { + "description": "Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x||x|||\nbridgeVirtualRouter|x||x|||\nmsgVpnName|x||x|||\npassword||||x||x\nremoteMsgVpnInterface|x|||||\nremoteMsgVpnLocation|x|x||||\nremoteMsgVpnName|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnBridgeRemoteMsgVpn|clientUsername|password|\nMsgVpnBridgeRemoteMsgVpn|password|clientUsername|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnBridgeRemoteMsgVpn", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The Remote Message VPN object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpn" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Remote Message VPN object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Remote Message VPN object.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + } + }, + "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}": { + "delete": { + "description": "Delete a Remote Message VPN object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnBridgeRemoteMsgVpn", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The name of the remote Message VPN.", + "in": "path", + "name": "remoteMsgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\").", + "in": "path", + "name": "remoteMsgVpnLocation", + "required": true, + "type": "string" + }, + { + "description": "The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name.", + "in": "path", + "name": "remoteMsgVpnInterface", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Remote Message VPN object.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + }, + "get": { + "description": "Get a Remote Message VPN object.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridgeName|x|||\nbridgeVirtualRouter|x|||\nmsgVpnName|x|||\npassword||x||x\nremoteMsgVpnInterface|x|||\nremoteMsgVpnLocation|x|||\nremoteMsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnBridgeRemoteMsgVpn", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The name of the remote Message VPN.", + "in": "path", + "name": "remoteMsgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\").", + "in": "path", + "name": "remoteMsgVpnLocation", + "required": true, + "type": "string" + }, + { + "description": "The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name.", + "in": "path", + "name": "remoteMsgVpnInterface", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Remote Message VPN object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Remote Message VPN object.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + }, + "patch": { + "description": "Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nbridgeName|x|x||||\nbridgeVirtualRouter|x|x||||\nclientUsername||||x||\ncompressedDataEnabled||||x||\negressFlowWindowSize||||x||\nmsgVpnName|x|x||||\npassword|||x|x||x\nremoteMsgVpnInterface|x|x||||\nremoteMsgVpnLocation|x|x||||\nremoteMsgVpnName|x|x||||\ntlsEnabled||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnBridgeRemoteMsgVpn|clientUsername|password|\nMsgVpnBridgeRemoteMsgVpn|password|clientUsername|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpnBridgeRemoteMsgVpn", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The name of the remote Message VPN.", + "in": "path", + "name": "remoteMsgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\").", + "in": "path", + "name": "remoteMsgVpnLocation", + "required": true, + "type": "string" + }, + { + "description": "The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name.", + "in": "path", + "name": "remoteMsgVpnInterface", + "required": true, + "type": "string" + }, + { + "description": "The Remote Message VPN object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpn" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Remote Message VPN object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Remote Message VPN object.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + }, + "put": { + "description": "Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nbridgeName|x||x||||\nbridgeVirtualRouter|x||x||||\nclientUsername|||||x||\ncompressedDataEnabled|||||x||\negressFlowWindowSize|||||x||\nmsgVpnName|x||x||||\npassword||||x|x||x\nremoteMsgVpnInterface|x||x||||\nremoteMsgVpnLocation|x||x||||\nremoteMsgVpnName|x||x||||\ntlsEnabled|||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnBridgeRemoteMsgVpn|clientUsername|password|\nMsgVpnBridgeRemoteMsgVpn|password|clientUsername|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpnBridgeRemoteMsgVpn", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The name of the remote Message VPN.", + "in": "path", + "name": "remoteMsgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\").", + "in": "path", + "name": "remoteMsgVpnLocation", + "required": true, + "type": "string" + }, + { + "description": "The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remoteMsgVpnLocation` must not be a virtual router name.", + "in": "path", + "name": "remoteMsgVpnInterface", + "required": true, + "type": "string" + }, + { + "description": "The Remote Message VPN object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpn" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Remote Message VPN object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnBridgeRemoteMsgVpnResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Remote Message VPN object.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + } + }, + "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions": { + "get": { + "description": "Get a list of Remote Subscription objects.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridgeName|x|||\nbridgeVirtualRouter|x|||\nmsgVpnName|x|||\nremoteSubscriptionTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnBridgeRemoteSubscriptions", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Remote Subscription objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnBridgeRemoteSubscriptionsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Remote Subscription objects.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + }, + "post": { + "description": "Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x||x|||\nbridgeVirtualRouter|x||x|||\ndeliverAlwaysEnabled||x||||\nmsgVpnName|x||x|||\nremoteSubscriptionTopic|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnBridgeRemoteSubscription", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The Remote Subscription object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnBridgeRemoteSubscription" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Remote Subscription object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnBridgeRemoteSubscriptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Remote Subscription object.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + } + }, + "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic}": { + "delete": { + "description": "Delete a Remote Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnBridgeRemoteSubscription", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The topic of the Bridge remote subscription.", + "in": "path", + "name": "remoteSubscriptionTopic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Remote Subscription object.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + }, + "get": { + "description": "Get a Remote Subscription object.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridgeName|x|||\nbridgeVirtualRouter|x|||\nmsgVpnName|x|||\nremoteSubscriptionTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnBridgeRemoteSubscription", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The topic of the Bridge remote subscription.", + "in": "path", + "name": "remoteSubscriptionTopic", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Remote Subscription object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnBridgeRemoteSubscriptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Remote Subscription object.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + } + }, + "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames": { + "get": { + "deprecated": true, + "description": "Get a list of Trusted Common Name objects.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridgeName|x||x|\nbridgeVirtualRouter|x||x|\nmsgVpnName|x||x|\ntlsTrustedCommonName|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "getMsgVpnBridgeTlsTrustedCommonNames", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Trusted Common Name objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonNamesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Trusted Common Name objects.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + }, + "post": { + "deprecated": true, + "description": "Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x||x||x|\nbridgeVirtualRouter|x||x||x|\nmsgVpnName|x||x||x|\ntlsTrustedCommonName|x|x|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "createMsgVpnBridgeTlsTrustedCommonName", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The Trusted Common Name object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonName" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Trusted Common Name object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonNameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Trusted Common Name object.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + } + }, + "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames/{tlsTrustedCommonName}": { + "delete": { + "deprecated": true, + "description": "Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "deleteMsgVpnBridgeTlsTrustedCommonName", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The expected trusted common name of the remote certificate.", + "in": "path", + "name": "tlsTrustedCommonName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Trusted Common Name object.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + }, + "get": { + "deprecated": true, + "description": "Get a Trusted Common Name object.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridgeName|x||x|\nbridgeVirtualRouter|x||x|\nmsgVpnName|x||x|\ntlsTrustedCommonName|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "getMsgVpnBridgeTlsTrustedCommonName", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Bridge.", + "in": "path", + "name": "bridgeName", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the Bridge.", + "in": "path", + "name": "bridgeVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The expected trusted common name of the remote certificate.", + "in": "path", + "name": "tlsTrustedCommonName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Trusted Common Name object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnBridgeTlsTrustedCommonNameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Trusted Common Name object.", + "tags": [ + "all", + "msgVpn", + "bridge" + ] + } + }, + "/msgVpns/{msgVpnName}/certMatchingRules": { + "get": { + "description": "Get a list of Certificate Matching Rule objects.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nruleName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "getMsgVpnCertMatchingRules", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Certificate Matching Rule objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRulesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Certificate Matching Rule objects.", + "tags": [ + "all", + "msgVpn", + "certMatchingRule" + ] + }, + "post": { + "description": "Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\nruleName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "createMsgVpnCertMatchingRule", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Matching Rule object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRule" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Certificate Matching Rule object.", + "tags": [ + "all", + "msgVpn", + "certMatchingRule" + ] + } + }, + "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}": { + "delete": { + "description": "Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "deleteMsgVpnCertMatchingRule", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Certificate Matching Rule object.", + "tags": [ + "all", + "msgVpn", + "certMatchingRule" + ] + }, + "get": { + "description": "Get a Certificate Matching Rule object.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nruleName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "getMsgVpnCertMatchingRule", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Certificate Matching Rule object.", + "tags": [ + "all", + "msgVpn", + "certMatchingRule" + ] + }, + "patch": { + "description": "Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x|x||||\nruleName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "updateMsgVpnCertMatchingRule", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Matching Rule object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRule" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Certificate Matching Rule object.", + "tags": [ + "all", + "msgVpn", + "certMatchingRule" + ] + }, + "put": { + "description": "Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x||x||||\nruleName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "replaceMsgVpnCertMatchingRule", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Matching Rule object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRule" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Certificate Matching Rule object.", + "tags": [ + "all", + "msgVpn", + "certMatchingRule" + ] + } + }, + "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters": { + "get": { + "description": "Get a list of Certificate Matching Rule Attribute Filter objects.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nfilterName|x|||\nmsgVpnName|x|||\nruleName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "getMsgVpnCertMatchingRuleAttributeFilters", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFiltersResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Certificate Matching Rule Attribute Filter objects.", + "tags": [ + "all", + "msgVpn", + "certMatchingRule" + ] + }, + "post": { + "description": "Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nfilterName|x|x||||\nmsgVpnName|x||x|||\nruleName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "createMsgVpnCertMatchingRuleAttributeFilter", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Matching Rule Attribute Filter object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilter" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Certificate Matching Rule Attribute Filter object.", + "tags": [ + "all", + "msgVpn", + "certMatchingRule" + ] + } + }, + "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}": { + "delete": { + "description": "Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "deleteMsgVpnCertMatchingRuleAttributeFilter", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The name of the filter.", + "in": "path", + "name": "filterName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Certificate Matching Rule Attribute Filter object.", + "tags": [ + "all", + "msgVpn", + "certMatchingRule" + ] + }, + "get": { + "description": "Get a Certificate Matching Rule Attribute Filter object.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nfilterName|x|||\nmsgVpnName|x|||\nruleName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "getMsgVpnCertMatchingRuleAttributeFilter", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The name of the filter.", + "in": "path", + "name": "filterName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Certificate Matching Rule Attribute Filter object.", + "tags": [ + "all", + "msgVpn", + "certMatchingRule" + ] + }, + "patch": { + "description": "Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nfilterName|x|x||||\nmsgVpnName|x|x||||\nruleName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "updateMsgVpnCertMatchingRuleAttributeFilter", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The name of the filter.", + "in": "path", + "name": "filterName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Matching Rule Attribute Filter object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilter" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Certificate Matching Rule Attribute Filter object.", + "tags": [ + "all", + "msgVpn", + "certMatchingRule" + ] + }, + "put": { + "description": "Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nfilterName|x||x||||\nmsgVpnName|x||x||||\nruleName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "operationId": "replaceMsgVpnCertMatchingRuleAttributeFilter", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The name of the filter.", + "in": "path", + "name": "filterName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Matching Rule Attribute Filter object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilter" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleAttributeFilterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Certificate Matching Rule Attribute Filter object.", + "tags": [ + "all", + "msgVpn", + "certMatchingRule" + ] + } + }, + "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions": { + "get": { + "description": "Get a list of Certificate Matching Rule Condition objects.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nruleName|x|||\nsource|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "getMsgVpnCertMatchingRuleConditions", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Certificate Matching Rule Condition objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleConditionsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Certificate Matching Rule Condition objects.", + "tags": [ + "all", + "msgVpn", + "certMatchingRule" + ] + }, + "post": { + "description": "Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\nruleName|x||x|||\nsource|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "createMsgVpnCertMatchingRuleCondition", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "The Certificate Matching Rule Condition object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleCondition" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule Condition object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleConditionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Certificate Matching Rule Condition object.", + "tags": [ + "all", + "msgVpn", + "certMatchingRule" + ] + } + }, + "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source}": { + "delete": { + "description": "Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "deleteMsgVpnCertMatchingRuleCondition", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "Certificate field to be compared with the Attribute.", + "in": "path", + "name": "source", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Certificate Matching Rule Condition object.", + "tags": [ + "all", + "msgVpn", + "certMatchingRule" + ] + }, + "get": { + "description": "Get a Certificate Matching Rule Condition object.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nruleName|x|||\nsource|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "getMsgVpnCertMatchingRuleCondition", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the rule.", + "in": "path", + "name": "ruleName", + "required": true, + "type": "string" + }, + { + "description": "Certificate field to be compared with the Attribute.", + "in": "path", + "name": "source", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Certificate Matching Rule Condition object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnCertMatchingRuleConditionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Certificate Matching Rule Condition object.", + "tags": [ + "all", + "msgVpn", + "certMatchingRule" + ] + } + }, + "/msgVpns/{msgVpnName}/clientProfiles": { + "get": { + "description": "Get a list of Client Profile objects.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled|||x|\napiQueueManagementCopyFromOnCreateName|||x|\napiTopicEndpointManagementCopyFromOnCreateName|||x|\nclientProfileName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnClientProfiles", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Client Profile objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnClientProfilesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Client Profile objects.", + "tags": [ + "all", + "msgVpn", + "clientProfile" + ] + }, + "post": { + "description": "Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled|||||x|\napiQueueManagementCopyFromOnCreateName|||||x|\napiTopicEndpointManagementCopyFromOnCreateName|||||x|\nclientProfileName|x|x||||\nmsgVpnName|x||x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\nEventThresholdByPercent|clearPercent|setPercent|\nEventThresholdByPercent|setPercent|clearPercent|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnClientProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Client Profile object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnClientProfile" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Profile object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnClientProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Client Profile object.", + "tags": [ + "all", + "msgVpn", + "clientProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}": { + "delete": { + "description": "Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnClientProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Client Profile.", + "in": "path", + "name": "clientProfileName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Client Profile object.", + "tags": [ + "all", + "msgVpn", + "clientProfile" + ] + }, + "get": { + "description": "Get a Client Profile object.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled|||x|\napiQueueManagementCopyFromOnCreateName|||x|\napiTopicEndpointManagementCopyFromOnCreateName|||x|\nclientProfileName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnClientProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Client Profile.", + "in": "path", + "name": "clientProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Profile object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnClientProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Client Profile object.", + "tags": [ + "all", + "msgVpn", + "clientProfile" + ] + }, + "patch": { + "description": "Update a Client Profile object. Any attribute missing from the request will be left unchanged.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nallowCutThroughForwardingEnabled|||||x|\napiQueueManagementCopyFromOnCreateName|||||x|\napiTopicEndpointManagementCopyFromOnCreateName|||||x|\nclientProfileName|x|x||||\nmsgVpnName|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\nEventThresholdByPercent|clearPercent|setPercent|\nEventThresholdByPercent|setPercent|clearPercent|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpnClientProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Client Profile.", + "in": "path", + "name": "clientProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Client Profile object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnClientProfile" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Profile object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnClientProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Client Profile object.", + "tags": [ + "all", + "msgVpn", + "clientProfile" + ] + }, + "put": { + "description": "Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nallowCutThroughForwardingEnabled||||||x|\napiQueueManagementCopyFromOnCreateName||||||x|\napiTopicEndpointManagementCopyFromOnCreateName||||||x|\nclientProfileName|x||x||||\nmsgVpnName|x||x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\nEventThresholdByPercent|clearPercent|setPercent|\nEventThresholdByPercent|setPercent|clearPercent|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpnClientProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Client Profile.", + "in": "path", + "name": "clientProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Client Profile object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnClientProfile" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Profile object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnClientProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Client Profile object.", + "tags": [ + "all", + "msgVpn", + "clientProfile" + ] + } + }, + "/msgVpns/{msgVpnName}/clientUsernames": { + "get": { + "description": "Get a list of Client Username objects.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientUsername|x|||\nmsgVpnName|x|||\npassword||x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnClientUsernames", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Client Username objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnClientUsernamesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Client Username objects.", + "tags": [ + "all", + "msgVpn", + "clientUsername" + ] + }, + "post": { + "description": "Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nclientUsername|x|x||||\nmsgVpnName|x||x|||\npassword||||x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnClientUsername", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Client Username object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnClientUsername" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Username object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnClientUsernameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Client Username object.", + "tags": [ + "all", + "msgVpn", + "clientUsername" + ] + } + }, + "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}": { + "delete": { + "description": "Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnClientUsername", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Client Username.", + "in": "path", + "name": "clientUsername", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Client Username object.", + "tags": [ + "all", + "msgVpn", + "clientUsername" + ] + }, + "get": { + "description": "Get a Client Username object.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientUsername|x|||\nmsgVpnName|x|||\npassword||x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnClientUsername", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Client Username.", + "in": "path", + "name": "clientUsername", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Username object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnClientUsernameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Client Username object.", + "tags": [ + "all", + "msgVpn", + "clientUsername" + ] + }, + "patch": { + "description": "Update a Client Username object. Any attribute missing from the request will be left unchanged.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\naclProfileName||||x||\nclientProfileName||||x||\nclientUsername|x|x||||\nmsgVpnName|x|x||||\npassword|||x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpnClientUsername", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Client Username.", + "in": "path", + "name": "clientUsername", + "required": true, + "type": "string" + }, + { + "description": "The Client Username object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnClientUsername" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Username object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnClientUsernameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Client Username object.", + "tags": [ + "all", + "msgVpn", + "clientUsername" + ] + }, + "put": { + "description": "Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\naclProfileName|||||x||\nclientProfileName|||||x||\nclientUsername|x||x||||\nmsgVpnName|x||x||||\npassword||||x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpnClientUsername", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Client Username.", + "in": "path", + "name": "clientUsername", + "required": true, + "type": "string" + }, + { + "description": "The Client Username object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnClientUsername" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Username object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnClientUsernameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Client Username object.", + "tags": [ + "all", + "msgVpn", + "clientUsername" + ] + } + }, + "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes": { + "get": { + "description": "Get a list of Client Username Attribute objects.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nattributeName|x|||\nattributeValue|x|||\nclientUsername|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "getMsgVpnClientUsernameAttributes", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Client Username.", + "in": "path", + "name": "clientUsername", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Client Username Attribute objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnClientUsernameAttributesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Client Username Attribute objects.", + "tags": [ + "all", + "msgVpn", + "clientUsername" + ] + }, + "post": { + "description": "Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nattributeName|x|x||||\nattributeValue|x|x||||\nclientUsername|x||x|||\nmsgVpnName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "createMsgVpnClientUsernameAttribute", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Client Username.", + "in": "path", + "name": "clientUsername", + "required": true, + "type": "string" + }, + { + "description": "The Client Username Attribute object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnClientUsernameAttribute" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Username Attribute object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnClientUsernameAttributeResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Client Username Attribute object.", + "tags": [ + "all", + "msgVpn", + "clientUsername" + ] + } + }, + "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue}": { + "delete": { + "description": "Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "deleteMsgVpnClientUsernameAttribute", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Client Username.", + "in": "path", + "name": "clientUsername", + "required": true, + "type": "string" + }, + { + "description": "The name of the Attribute.", + "in": "path", + "name": "attributeName", + "required": true, + "type": "string" + }, + { + "description": "The value of the Attribute.", + "in": "path", + "name": "attributeValue", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Client Username Attribute object.", + "tags": [ + "all", + "msgVpn", + "clientUsername" + ] + }, + "get": { + "description": "Get a Client Username Attribute object.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nattributeName|x|||\nattributeValue|x|||\nclientUsername|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "getMsgVpnClientUsernameAttribute", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Client Username.", + "in": "path", + "name": "clientUsername", + "required": true, + "type": "string" + }, + { + "description": "The name of the Attribute.", + "in": "path", + "name": "attributeName", + "required": true, + "type": "string" + }, + { + "description": "The value of the Attribute.", + "in": "path", + "name": "attributeValue", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Client Username Attribute object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnClientUsernameAttributeResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Client Username Attribute object.", + "tags": [ + "all", + "msgVpn", + "clientUsername" + ] + } + }, + "/msgVpns/{msgVpnName}/distributedCaches": { + "get": { + "description": "Get a list of Distributed Cache objects.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCaches", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Distributed Cache objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCachesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Distributed Cache objects.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "post": { + "description": "Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x|x||||\nmsgVpnName|x||x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList|\nMsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createMsgVpnDistributedCache", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Distributed Cache object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCache" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Distributed Cache object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Distributed Cache object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + } + }, + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}": { + "delete": { + "description": "Delete a Distributed Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteMsgVpnDistributedCache", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Distributed Cache object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "get": { + "description": "Get a Distributed Cache object.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCache", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Distributed Cache object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Distributed Cache object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "patch": { + "description": "Update a Distributed Cache object. Any attribute missing from the request will be left unchanged.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\ncacheName|x|x||||\ncacheVirtualRouter||x||||\nmsgVpnName|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList|\nMsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "updateMsgVpnDistributedCache", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The Distributed Cache object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCache" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Distributed Cache object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Distributed Cache object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "put": { + "description": "Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\ncacheName|x||x||||\ncacheVirtualRouter||x|||||\nmsgVpnName|x||x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList|\nMsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "replaceMsgVpnDistributedCache", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The Distributed Cache object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCache" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Distributed Cache object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Distributed Cache object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + } + }, + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters": { + "get": { + "description": "Get a list of Cache Cluster objects.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusters", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Cache Cluster objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClustersResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Cache Cluster objects.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "post": { + "description": "Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x||x|||\nclusterName|x|x||||\nmsgVpnName|x||x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThresholdByPercent|clearPercent|setPercent|\nEventThresholdByPercent|setPercent|clearPercent|\nEventThresholdByValue|clearValue|setValue|\nEventThresholdByValue|setValue|clearValue|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createMsgVpnDistributedCacheCluster", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The Cache Cluster object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheCluster" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Cache Cluster object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Cache Cluster object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + } + }, + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}": { + "delete": { + "description": "Delete a Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteMsgVpnDistributedCacheCluster", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Cache Cluster object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "get": { + "description": "Get a Cache Cluster object.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheCluster", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Cache Cluster object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Cache Cluster object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "patch": { + "description": "Update a Cache Cluster object. Any attribute missing from the request will be left unchanged.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\ncacheName|x|x||||\nclusterName|x|x||||\nmsgVpnName|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThresholdByPercent|clearPercent|setPercent|\nEventThresholdByPercent|setPercent|clearPercent|\nEventThresholdByValue|clearValue|setValue|\nEventThresholdByValue|setValue|clearValue|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "updateMsgVpnDistributedCacheCluster", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The Cache Cluster object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheCluster" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Cache Cluster object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Cache Cluster object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "put": { + "description": "Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\ncacheName|x||x||||\nclusterName|x||x||||\nmsgVpnName|x||x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThresholdByPercent|clearPercent|setPercent|\nEventThresholdByPercent|setPercent|clearPercent|\nEventThresholdByValue|clearValue|setValue|\nEventThresholdByValue|setValue|clearValue|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "replaceMsgVpnDistributedCacheCluster", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The Cache Cluster object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheCluster" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Cache Cluster object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Cache Cluster object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + } + }, + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters": { + "get": { + "description": "Get a list of Home Cache Cluster objects.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\nhomeClusterName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Home Cache Cluster objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Home Cache Cluster objects.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "post": { + "description": "Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x||x|||\nclusterName|x||x|||\nhomeClusterName|x|x||||\nmsgVpnName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The Home Cache Cluster object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Home Cache Cluster object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Home Cache Cluster object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + } + }, + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}": { + "delete": { + "description": "Delete a Home Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the remote Home Cache Cluster.", + "in": "path", + "name": "homeClusterName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Home Cache Cluster object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "get": { + "description": "Get a Home Cache Cluster object.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\nhomeClusterName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the remote Home Cache Cluster.", + "in": "path", + "name": "homeClusterName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Home Cache Cluster object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Home Cache Cluster object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + } + }, + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes": { + "get": { + "description": "Get a list of Topic Prefix objects.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\nhomeClusterName|x|||\nmsgVpnName|x|||\ntopicPrefix|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the remote Home Cache Cluster.", + "in": "path", + "name": "homeClusterName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Topic Prefix objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Topic Prefix objects.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "post": { + "description": "Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x||x|||\nclusterName|x||x|||\nhomeClusterName|x||x|||\nmsgVpnName|x||x|||\ntopicPrefix|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the remote Home Cache Cluster.", + "in": "path", + "name": "homeClusterName", + "required": true, + "type": "string" + }, + { + "description": "The Topic Prefix object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Topic Prefix object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Topic Prefix object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + } + }, + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix}": { + "delete": { + "description": "Delete a Topic Prefix object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the remote Home Cache Cluster.", + "in": "path", + "name": "homeClusterName", + "required": true, + "type": "string" + }, + { + "description": "A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix.", + "in": "path", + "name": "topicPrefix", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Topic Prefix object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "get": { + "description": "Get a Topic Prefix object.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\nhomeClusterName|x|||\nmsgVpnName|x|||\ntopicPrefix|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the remote Home Cache Cluster.", + "in": "path", + "name": "homeClusterName", + "required": true, + "type": "string" + }, + { + "description": "A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix.", + "in": "path", + "name": "topicPrefix", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Topic Prefix object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Topic Prefix object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + } + }, + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances": { + "get": { + "description": "Get a list of Cache Instance objects.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\ninstanceName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusterInstances", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Cache Instance objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstancesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Cache Instance objects.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "post": { + "description": "Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x||x|||\nclusterName|x||x|||\ninstanceName|x|x||||\nmsgVpnName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createMsgVpnDistributedCacheClusterInstance", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The Cache Instance object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstance" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Cache Instance object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Cache Instance object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + } + }, + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}": { + "delete": { + "description": "Delete a Cache Instance object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteMsgVpnDistributedCacheClusterInstance", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Instance.", + "in": "path", + "name": "instanceName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Cache Instance object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "get": { + "description": "Get a Cache Instance object.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\ninstanceName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusterInstance", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Instance.", + "in": "path", + "name": "instanceName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Cache Instance object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Cache Instance object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "patch": { + "description": "Update a Cache Instance object. Any attribute missing from the request will be left unchanged.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\ncacheName|x|x||||\nclusterName|x|x||||\ninstanceName|x|x||||\nmsgVpnName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "updateMsgVpnDistributedCacheClusterInstance", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Instance.", + "in": "path", + "name": "instanceName", + "required": true, + "type": "string" + }, + { + "description": "The Cache Instance object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstance" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Cache Instance object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Cache Instance object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "put": { + "description": "Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\ncacheName|x||x||||\nclusterName|x||x||||\ninstanceName|x||x||||\nmsgVpnName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "replaceMsgVpnDistributedCacheClusterInstance", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Instance.", + "in": "path", + "name": "instanceName", + "required": true, + "type": "string" + }, + { + "description": "The Cache Instance object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstance" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Cache Instance object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Cache Instance object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + } + }, + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics": { + "get": { + "description": "Get a list of Topic objects.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\nmsgVpnName|x|||\ntopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusterTopics", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Topic objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopicsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Topic objects.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "post": { + "description": "Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x||x|||\nclusterName|x||x|||\nmsgVpnName|x||x|||\ntopic|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createMsgVpnDistributedCacheClusterTopic", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The Topic object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopic" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Topic object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopicResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Topic object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + } + }, + "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic}": { + "delete": { + "description": "Delete a Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteMsgVpnDistributedCacheClusterTopic", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The value of the Topic in the form a/b/c.", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Topic object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + }, + "get": { + "description": "Get a Topic object.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\nmsgVpnName|x|||\ntopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDistributedCacheClusterTopic", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Distributed Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Cache Cluster.", + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "description": "The value of the Topic in the form a/b/c.", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Topic object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDistributedCacheClusterTopicResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Topic object.", + "tags": [ + "all", + "msgVpn", + "distributedCache" + ] + } + }, + "/msgVpns/{msgVpnName}/dmrBridges": { + "get": { + "description": "Get a list of DMR Bridge objects.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nremoteNodeName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDmrBridges", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of DMR Bridge objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDmrBridgesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of DMR Bridge objects.", + "tags": [ + "all", + "msgVpn", + "dmrBridge" + ] + }, + "post": { + "description": "Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\nremoteNodeName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createMsgVpnDmrBridge", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The DMR Bridge object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDmrBridge" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The DMR Bridge object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDmrBridgeResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a DMR Bridge object.", + "tags": [ + "all", + "msgVpn", + "dmrBridge" + ] + } + }, + "/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}": { + "delete": { + "description": "Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteMsgVpnDmrBridge", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the DMR Bridge.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a DMR Bridge object.", + "tags": [ + "all", + "msgVpn", + "dmrBridge" + ] + }, + "get": { + "description": "Get a DMR Bridge object.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nremoteNodeName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnDmrBridge", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the DMR Bridge.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The DMR Bridge object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDmrBridgeResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a DMR Bridge object.", + "tags": [ + "all", + "msgVpn", + "dmrBridge" + ] + }, + "patch": { + "description": "Update a DMR Bridge object. Any attribute missing from the request will be left unchanged.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x|x||||\nremoteNodeName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "updateMsgVpnDmrBridge", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the DMR Bridge.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The DMR Bridge object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDmrBridge" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The DMR Bridge object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDmrBridgeResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a DMR Bridge object.", + "tags": [ + "all", + "msgVpn", + "dmrBridge" + ] + }, + "put": { + "description": "Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x||x||||\nremoteNodeName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "replaceMsgVpnDmrBridge", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the node at the remote end of the DMR Bridge.", + "in": "path", + "name": "remoteNodeName", + "required": true, + "type": "string" + }, + { + "description": "The DMR Bridge object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnDmrBridge" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The DMR Bridge object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnDmrBridgeResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a DMR Bridge object.", + "tags": [ + "all", + "msgVpn", + "dmrBridge" + ] + } + }, + "/msgVpns/{msgVpnName}/jndiConnectionFactories": { + "get": { + "description": "Get a list of JNDI Connection Factory objects.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nconnectionFactoryName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "getMsgVpnJndiConnectionFactories", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of JNDI Connection Factory objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnJndiConnectionFactoriesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of JNDI Connection Factory objects.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + }, + "post": { + "description": "Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nconnectionFactoryName|x|x||||\nmsgVpnName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "createMsgVpnJndiConnectionFactory", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI Connection Factory object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnJndiConnectionFactory" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The JNDI Connection Factory object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnJndiConnectionFactoryResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a JNDI Connection Factory object.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + } + }, + "/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}": { + "delete": { + "description": "Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "deleteMsgVpnJndiConnectionFactory", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the JMS Connection Factory.", + "in": "path", + "name": "connectionFactoryName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a JNDI Connection Factory object.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + }, + "get": { + "description": "Get a JNDI Connection Factory object.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nconnectionFactoryName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "getMsgVpnJndiConnectionFactory", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the JMS Connection Factory.", + "in": "path", + "name": "connectionFactoryName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The JNDI Connection Factory object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnJndiConnectionFactoryResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a JNDI Connection Factory object.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + }, + "patch": { + "description": "Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nconnectionFactoryName|x|x||||\nmsgVpnName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "updateMsgVpnJndiConnectionFactory", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the JMS Connection Factory.", + "in": "path", + "name": "connectionFactoryName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI Connection Factory object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnJndiConnectionFactory" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The JNDI Connection Factory object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnJndiConnectionFactoryResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a JNDI Connection Factory object.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + }, + "put": { + "description": "Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nconnectionFactoryName|x||x||||\nmsgVpnName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "replaceMsgVpnJndiConnectionFactory", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the JMS Connection Factory.", + "in": "path", + "name": "connectionFactoryName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI Connection Factory object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnJndiConnectionFactory" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The JNDI Connection Factory object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnJndiConnectionFactoryResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a JNDI Connection Factory object.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + } + }, + "/msgVpns/{msgVpnName}/jndiQueues": { + "get": { + "description": "Get a list of JNDI Queue objects.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "getMsgVpnJndiQueues", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of JNDI Queue objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnJndiQueuesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of JNDI Queue objects.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + }, + "post": { + "description": "Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\nqueueName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "createMsgVpnJndiQueue", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI Queue object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnJndiQueue" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The JNDI Queue object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnJndiQueueResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a JNDI Queue object.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + } + }, + "/msgVpns/{msgVpnName}/jndiQueues/{queueName}": { + "delete": { + "description": "Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "deleteMsgVpnJndiQueue", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI name of the JMS Queue.", + "in": "path", + "name": "queueName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a JNDI Queue object.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + }, + "get": { + "description": "Get a JNDI Queue object.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "getMsgVpnJndiQueue", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI name of the JMS Queue.", + "in": "path", + "name": "queueName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The JNDI Queue object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnJndiQueueResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a JNDI Queue object.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + }, + "patch": { + "description": "Update a JNDI Queue object. Any attribute missing from the request will be left unchanged.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x|x||||\nqueueName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "updateMsgVpnJndiQueue", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI name of the JMS Queue.", + "in": "path", + "name": "queueName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI Queue object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnJndiQueue" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The JNDI Queue object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnJndiQueueResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a JNDI Queue object.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + }, + "put": { + "description": "Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x||x||||\nqueueName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "replaceMsgVpnJndiQueue", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI name of the JMS Queue.", + "in": "path", + "name": "queueName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI Queue object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnJndiQueue" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The JNDI Queue object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnJndiQueueResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a JNDI Queue object.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + } + }, + "/msgVpns/{msgVpnName}/jndiTopics": { + "get": { + "description": "Get a list of JNDI Topic objects.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\ntopicName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "getMsgVpnJndiTopics", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of JNDI Topic objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnJndiTopicsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of JNDI Topic objects.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + }, + "post": { + "description": "Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\ntopicName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "createMsgVpnJndiTopic", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI Topic object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnJndiTopic" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The JNDI Topic object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnJndiTopicResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a JNDI Topic object.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + } + }, + "/msgVpns/{msgVpnName}/jndiTopics/{topicName}": { + "delete": { + "description": "Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "deleteMsgVpnJndiTopic", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI name of the JMS Topic.", + "in": "path", + "name": "topicName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a JNDI Topic object.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + }, + "get": { + "description": "Get a JNDI Topic object.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\ntopicName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "getMsgVpnJndiTopic", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI name of the JMS Topic.", + "in": "path", + "name": "topicName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The JNDI Topic object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnJndiTopicResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a JNDI Topic object.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + }, + "patch": { + "description": "Update a JNDI Topic object. Any attribute missing from the request will be left unchanged.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x|x||||\ntopicName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "updateMsgVpnJndiTopic", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI name of the JMS Topic.", + "in": "path", + "name": "topicName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI Topic object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnJndiTopic" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The JNDI Topic object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnJndiTopicResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a JNDI Topic object.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + }, + "put": { + "description": "Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x||x||||\ntopicName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "operationId": "replaceMsgVpnJndiTopic", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI name of the JMS Topic.", + "in": "path", + "name": "topicName", + "required": true, + "type": "string" + }, + { + "description": "The JNDI Topic object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnJndiTopic" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The JNDI Topic object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnJndiTopicResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a JNDI Topic object.", + "tags": [ + "all", + "msgVpn", + "jndi" + ] + } + }, + "/msgVpns/{msgVpnName}/mqttRetainCaches": { + "get": { + "description": "Get a list of MQTT Retain Cache objects.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnMqttRetainCaches", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of MQTT Retain Cache objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnMqttRetainCachesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of MQTT Retain Cache objects.", + "tags": [ + "all", + "msgVpn", + "mqttRetainCache" + ] + }, + "post": { + "description": "Create an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x|x||||\nmsgVpnName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "createMsgVpnMqttRetainCache", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The MQTT Retain Cache object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnMqttRetainCache" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The MQTT Retain Cache object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnMqttRetainCacheResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create an MQTT Retain Cache object.", + "tags": [ + "all", + "msgVpn", + "mqttRetainCache" + ] + } + }, + "/msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}": { + "delete": { + "description": "Delete an MQTT Retain Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "deleteMsgVpnMqttRetainCache", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the MQTT Retain Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete an MQTT Retain Cache object.", + "tags": [ + "all", + "msgVpn", + "mqttRetainCache" + ] + }, + "get": { + "description": "Get an MQTT Retain Cache object.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "getMsgVpnMqttRetainCache", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the MQTT Retain Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The MQTT Retain Cache object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnMqttRetainCacheResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get an MQTT Retain Cache object.", + "tags": [ + "all", + "msgVpn", + "mqttRetainCache" + ] + }, + "patch": { + "description": "Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\ncacheName|x|x||||\nmsgVpnName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "updateMsgVpnMqttRetainCache", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the MQTT Retain Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The MQTT Retain Cache object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnMqttRetainCache" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The MQTT Retain Cache object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnMqttRetainCacheResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update an MQTT Retain Cache object.", + "tags": [ + "all", + "msgVpn", + "mqttRetainCache" + ] + }, + "put": { + "description": "Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\ncacheName|x||x||||\nmsgVpnName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "operationId": "replaceMsgVpnMqttRetainCache", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the MQTT Retain Cache.", + "in": "path", + "name": "cacheName", + "required": true, + "type": "string" + }, + { + "description": "The MQTT Retain Cache object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnMqttRetainCache" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The MQTT Retain Cache object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnMqttRetainCacheResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace an MQTT Retain Cache object.", + "tags": [ + "all", + "msgVpn", + "mqttRetainCache" + ] + } + }, + "/msgVpns/{msgVpnName}/mqttSessions": { + "get": { + "description": "Get a list of MQTT Session objects.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|||\nmqttSessionVirtualRouter|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "getMsgVpnMqttSessions", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of MQTT Session objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnMqttSessionsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of MQTT Session objects.", + "tags": [ + "all", + "msgVpn", + "mqttSession" + ] + }, + "post": { + "description": "Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|x||||\nmqttSessionVirtualRouter|x|x||||\nmsgVpnName|x||x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "createMsgVpnMqttSession", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The MQTT Session object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnMqttSession" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The MQTT Session object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnMqttSessionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create an MQTT Session object.", + "tags": [ + "all", + "msgVpn", + "mqttSession" + ] + } + }, + "/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}": { + "delete": { + "description": "Delete an MQTT Session object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "deleteMsgVpnMqttSession", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", + "in": "path", + "name": "mqttSessionClientId", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the MQTT Session.", + "in": "path", + "name": "mqttSessionVirtualRouter", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete an MQTT Session object.", + "tags": [ + "all", + "msgVpn", + "mqttSession" + ] + }, + "get": { + "description": "Get an MQTT Session object.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|||\nmqttSessionVirtualRouter|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "getMsgVpnMqttSession", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", + "in": "path", + "name": "mqttSessionClientId", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the MQTT Session.", + "in": "path", + "name": "mqttSessionVirtualRouter", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The MQTT Session object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnMqttSessionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get an MQTT Session object.", + "tags": [ + "all", + "msgVpn", + "mqttSession" + ] + }, + "patch": { + "description": "Update an MQTT Session object. Any attribute missing from the request will be left unchanged.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nmqttSessionClientId|x|x||||\nmqttSessionVirtualRouter|x|x||||\nmsgVpnName|x|x||||\nowner||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "updateMsgVpnMqttSession", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", + "in": "path", + "name": "mqttSessionClientId", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the MQTT Session.", + "in": "path", + "name": "mqttSessionVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The MQTT Session object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnMqttSession" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The MQTT Session object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnMqttSessionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update an MQTT Session object.", + "tags": [ + "all", + "msgVpn", + "mqttSession" + ] + }, + "put": { + "description": "Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nmqttSessionClientId|x||x||||\nmqttSessionVirtualRouter|x||x||||\nmsgVpnName|x||x||||\nowner|||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "replaceMsgVpnMqttSession", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", + "in": "path", + "name": "mqttSessionClientId", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the MQTT Session.", + "in": "path", + "name": "mqttSessionVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The MQTT Session object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnMqttSession" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The MQTT Session object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnMqttSessionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace an MQTT Session object.", + "tags": [ + "all", + "msgVpn", + "mqttSession" + ] + } + }, + "/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions": { + "get": { + "description": "Get a list of Subscription objects.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|||\nmqttSessionVirtualRouter|x|||\nmsgVpnName|x|||\nsubscriptionTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "getMsgVpnMqttSessionSubscriptions", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", + "in": "path", + "name": "mqttSessionClientId", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the MQTT Session.", + "in": "path", + "name": "mqttSessionVirtualRouter", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Subscription objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnMqttSessionSubscriptionsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Subscription objects.", + "tags": [ + "all", + "msgVpn", + "mqttSession" + ] + }, + "post": { + "description": "Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmqttSessionClientId|x||x|||\nmqttSessionVirtualRouter|x||x|||\nmsgVpnName|x||x|||\nsubscriptionTopic|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "createMsgVpnMqttSessionSubscription", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", + "in": "path", + "name": "mqttSessionClientId", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the MQTT Session.", + "in": "path", + "name": "mqttSessionVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The Subscription object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnMqttSessionSubscription" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Subscription object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnMqttSessionSubscriptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Subscription object.", + "tags": [ + "all", + "msgVpn", + "mqttSession" + ] + } + }, + "/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}": { + "delete": { + "description": "Delete a Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "deleteMsgVpnMqttSessionSubscription", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", + "in": "path", + "name": "mqttSessionClientId", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the MQTT Session.", + "in": "path", + "name": "mqttSessionVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The MQTT subscription topic.", + "in": "path", + "name": "subscriptionTopic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Subscription object.", + "tags": [ + "all", + "msgVpn", + "mqttSession" + ] + }, + "get": { + "description": "Get a Subscription object.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|||\nmqttSessionVirtualRouter|x|||\nmsgVpnName|x|||\nsubscriptionTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "getMsgVpnMqttSessionSubscription", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", + "in": "path", + "name": "mqttSessionClientId", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the MQTT Session.", + "in": "path", + "name": "mqttSessionVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The MQTT subscription topic.", + "in": "path", + "name": "subscriptionTopic", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Subscription object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnMqttSessionSubscriptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Subscription object.", + "tags": [ + "all", + "msgVpn", + "mqttSession" + ] + }, + "patch": { + "description": "Update a Subscription object. Any attribute missing from the request will be left unchanged.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nmqttSessionClientId|x|x||||\nmqttSessionVirtualRouter|x|x||||\nmsgVpnName|x|x||||\nsubscriptionTopic|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "updateMsgVpnMqttSessionSubscription", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", + "in": "path", + "name": "mqttSessionClientId", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the MQTT Session.", + "in": "path", + "name": "mqttSessionVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The MQTT subscription topic.", + "in": "path", + "name": "subscriptionTopic", + "required": true, + "type": "string" + }, + { + "description": "The Subscription object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnMqttSessionSubscription" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Subscription object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnMqttSessionSubscriptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Subscription object.", + "tags": [ + "all", + "msgVpn", + "mqttSession" + ] + }, + "put": { + "description": "Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nmqttSessionClientId|x||x||||\nmqttSessionVirtualRouter|x||x||||\nmsgVpnName|x||x||||\nsubscriptionTopic|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "replaceMsgVpnMqttSessionSubscription", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.", + "in": "path", + "name": "mqttSessionClientId", + "required": true, + "type": "string" + }, + { + "description": "The virtual router of the MQTT Session.", + "in": "path", + "name": "mqttSessionVirtualRouter", + "required": true, + "type": "string" + }, + { + "description": "The MQTT subscription topic.", + "in": "path", + "name": "subscriptionTopic", + "required": true, + "type": "string" + }, + { + "description": "The Subscription object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnMqttSessionSubscription" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Subscription object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnMqttSessionSubscriptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Subscription object.", + "tags": [ + "all", + "msgVpn", + "mqttSession" + ] + } + }, + "/msgVpns/{msgVpnName}/queueTemplates": { + "get": { + "description": "Get a list of Queue Template objects.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueTemplateName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "getMsgVpnQueueTemplates", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Queue Template objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnQueueTemplatesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Queue Template objects.", + "tags": [ + "all", + "msgVpn", + "queueTemplate" + ] + }, + "post": { + "description": "Create a Queue Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\nqueueTemplateName|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "createMsgVpnQueueTemplate", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Queue Template object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnQueueTemplate" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Queue Template object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnQueueTemplateResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Queue Template object.", + "tags": [ + "all", + "msgVpn", + "queueTemplate" + ] + } + }, + "/msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}": { + "delete": { + "description": "Delete a Queue Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "deleteMsgVpnQueueTemplate", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Queue Template.", + "in": "path", + "name": "queueTemplateName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Queue Template object.", + "tags": [ + "all", + "msgVpn", + "queueTemplate" + ] + }, + "get": { + "description": "Get a Queue Template object.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueTemplateName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "getMsgVpnQueueTemplate", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Queue Template.", + "in": "path", + "name": "queueTemplateName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Queue Template object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnQueueTemplateResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Queue Template object.", + "tags": [ + "all", + "msgVpn", + "queueTemplate" + ] + }, + "patch": { + "description": "Update a Queue Template object. Any attribute missing from the request will be left unchanged.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x|x||||\nqueueTemplateName|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "updateMsgVpnQueueTemplate", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Queue Template.", + "in": "path", + "name": "queueTemplateName", + "required": true, + "type": "string" + }, + { + "description": "The Queue Template object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnQueueTemplate" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Queue Template object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnQueueTemplateResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Queue Template object.", + "tags": [ + "all", + "msgVpn", + "queueTemplate" + ] + }, + "put": { + "description": "Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x||x||||\nqueueTemplateName|x||x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "replaceMsgVpnQueueTemplate", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Queue Template.", + "in": "path", + "name": "queueTemplateName", + "required": true, + "type": "string" + }, + { + "description": "The Queue Template object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnQueueTemplate" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Queue Template object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnQueueTemplateResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Queue Template object.", + "tags": [ + "all", + "msgVpn", + "queueTemplate" + ] + } + }, + "/msgVpns/{msgVpnName}/queues": { + "get": { + "description": "Get a list of Queue objects.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnQueues", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Queue objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnQueuesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Queue objects.", + "tags": [ + "all", + "msgVpn", + "queue" + ] + }, + "post": { + "description": "Create a Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\nqueueName|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnQueue", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Queue object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnQueue" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Queue object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnQueueResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Queue object.", + "tags": [ + "all", + "msgVpn", + "queue" + ] + } + }, + "/msgVpns/{msgVpnName}/queues/{queueName}": { + "delete": { + "description": "Delete a Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnQueue", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Queue.", + "in": "path", + "name": "queueName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Queue object.", + "tags": [ + "all", + "msgVpn", + "queue" + ] + }, + "get": { + "description": "Get a Queue object.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnQueue", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Queue.", + "in": "path", + "name": "queueName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Queue object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnQueueResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Queue object.", + "tags": [ + "all", + "msgVpn", + "queue" + ] + }, + "patch": { + "description": "Update a Queue object. Any attribute missing from the request will be left unchanged.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\naccessType||||x||\nmsgVpnName|x|x||||\nowner||||x||\npermission||||x||\nqueueName|x|x||||\nrespectMsgPriorityEnabled||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpnQueue", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Queue.", + "in": "path", + "name": "queueName", + "required": true, + "type": "string" + }, + { + "description": "The Queue object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnQueue" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Queue object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnQueueResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Queue object.", + "tags": [ + "all", + "msgVpn", + "queue" + ] + }, + "put": { + "description": "Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\naccessType|||||x||\nmsgVpnName|x||x||||\nowner|||||x||\npermission|||||x||\nqueueName|x||x||||\nrespectMsgPriorityEnabled|||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpnQueue", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Queue.", + "in": "path", + "name": "queueName", + "required": true, + "type": "string" + }, + { + "description": "The Queue object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnQueue" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Queue object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnQueueResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Queue object.", + "tags": [ + "all", + "msgVpn", + "queue" + ] + } + }, + "/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions": { + "get": { + "description": "Get a list of Queue Subscription objects.\n\nOne or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueName|x|||\nsubscriptionTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnQueueSubscriptions", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Queue.", + "in": "path", + "name": "queueName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Queue Subscription objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnQueueSubscriptionsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Queue Subscription objects.", + "tags": [ + "all", + "msgVpn", + "queue" + ] + }, + "post": { + "description": "Create a Queue Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOne or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\nqueueName|x||x|||\nsubscriptionTopic|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnQueueSubscription", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Queue.", + "in": "path", + "name": "queueName", + "required": true, + "type": "string" + }, + { + "description": "The Queue Subscription object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnQueueSubscription" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Queue Subscription object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnQueueSubscriptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Queue Subscription object.", + "tags": [ + "all", + "msgVpn", + "queue" + ] + } + }, + "/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic}": { + "delete": { + "description": "Delete a Queue Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOne or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnQueueSubscription", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Queue.", + "in": "path", + "name": "queueName", + "required": true, + "type": "string" + }, + { + "description": "The topic of the Subscription.", + "in": "path", + "name": "subscriptionTopic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Queue Subscription object.", + "tags": [ + "all", + "msgVpn", + "queue" + ] + }, + "get": { + "description": "Get a Queue Subscription object.\n\nOne or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueName|x|||\nsubscriptionTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnQueueSubscription", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Queue.", + "in": "path", + "name": "queueName", + "required": true, + "type": "string" + }, + { + "description": "The topic of the Subscription.", + "in": "path", + "name": "subscriptionTopic", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Queue Subscription object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnQueueSubscriptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Queue Subscription object.", + "tags": [ + "all", + "msgVpn", + "queue" + ] + } + }, + "/msgVpns/{msgVpnName}/replayLogs": { + "get": { + "description": "Get a list of Replay Log objects.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nreplayLogName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.10.", + "operationId": "getMsgVpnReplayLogs", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Replay Log objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnReplayLogsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Replay Log objects.", + "tags": [ + "all", + "msgVpn", + "replayLog" + ] + }, + "post": { + "description": "Create a Replay Log object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\nreplayLogName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.10.", + "operationId": "createMsgVpnReplayLog", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Replay Log object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnReplayLog" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Replay Log object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnReplayLogResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Replay Log object.", + "tags": [ + "all", + "msgVpn", + "replayLog" + ] + } + }, + "/msgVpns/{msgVpnName}/replayLogs/{replayLogName}": { + "delete": { + "description": "Delete a Replay Log object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.10.", + "operationId": "deleteMsgVpnReplayLog", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Replay Log.", + "in": "path", + "name": "replayLogName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Replay Log object.", + "tags": [ + "all", + "msgVpn", + "replayLog" + ] + }, + "get": { + "description": "Get a Replay Log object.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nreplayLogName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.10.", + "operationId": "getMsgVpnReplayLog", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Replay Log.", + "in": "path", + "name": "replayLogName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Replay Log object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnReplayLogResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Replay Log object.", + "tags": [ + "all", + "msgVpn", + "replayLog" + ] + }, + "patch": { + "description": "Update a Replay Log object. Any attribute missing from the request will be left unchanged.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x|x||||\nreplayLogName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.10.", + "operationId": "updateMsgVpnReplayLog", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Replay Log.", + "in": "path", + "name": "replayLogName", + "required": true, + "type": "string" + }, + { + "description": "The Replay Log object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnReplayLog" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Replay Log object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnReplayLogResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Replay Log object.", + "tags": [ + "all", + "msgVpn", + "replayLog" + ] + }, + "put": { + "description": "Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x||x||||\nreplayLogName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.10.", + "operationId": "replaceMsgVpnReplayLog", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Replay Log.", + "in": "path", + "name": "replayLogName", + "required": true, + "type": "string" + }, + { + "description": "The Replay Log object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnReplayLog" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Replay Log object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnReplayLogResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Replay Log object.", + "tags": [ + "all", + "msgVpn", + "replayLog" + ] + } + }, + "/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions": { + "get": { + "description": "Get a list of Topic Filter Subscription objects.\n\nOne or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nreplayLogName|x|||\ntopicFilterSubscription|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "getMsgVpnReplayLogTopicFilterSubscriptions", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Replay Log.", + "in": "path", + "name": "replayLogName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Topic Filter Subscription objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscriptionsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Topic Filter Subscription objects.", + "tags": [ + "all", + "msgVpn", + "replayLog" + ] + }, + "post": { + "description": "Create a Topic Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOne or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\nreplayLogName|x||x|||\ntopicFilterSubscription|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "createMsgVpnReplayLogTopicFilterSubscription", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Replay Log.", + "in": "path", + "name": "replayLogName", + "required": true, + "type": "string" + }, + { + "description": "The Topic Filter Subscription object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscription" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Topic Filter Subscription object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscriptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Topic Filter Subscription object.", + "tags": [ + "all", + "msgVpn", + "replayLog" + ] + } + }, + "/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription}": { + "delete": { + "description": "Delete a Topic Filter Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOne or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "deleteMsgVpnReplayLogTopicFilterSubscription", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Replay Log.", + "in": "path", + "name": "replayLogName", + "required": true, + "type": "string" + }, + { + "description": "The topic of the Subscription.", + "in": "path", + "name": "topicFilterSubscription", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Topic Filter Subscription object.", + "tags": [ + "all", + "msgVpn", + "replayLog" + ] + }, + "get": { + "description": "Get a Topic Filter Subscription object.\n\nOne or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nreplayLogName|x|||\ntopicFilterSubscription|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", + "operationId": "getMsgVpnReplayLogTopicFilterSubscription", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Replay Log.", + "in": "path", + "name": "replayLogName", + "required": true, + "type": "string" + }, + { + "description": "The topic of the Subscription.", + "in": "path", + "name": "topicFilterSubscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Topic Filter Subscription object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnReplayLogTopicFilterSubscriptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Topic Filter Subscription object.", + "tags": [ + "all", + "msgVpn", + "replayLog" + ] + } + }, + "/msgVpns/{msgVpnName}/replicatedTopics": { + "get": { + "description": "Get a list of Replicated Topic objects.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nreplicatedTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "getMsgVpnReplicatedTopics", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Replicated Topic objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnReplicatedTopicsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Replicated Topic objects.", + "tags": [ + "all", + "msgVpn", + "replicatedTopic" + ] + }, + "post": { + "description": "Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\nreplicatedTopic|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "createMsgVpnReplicatedTopic", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Replicated Topic object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnReplicatedTopic" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Replicated Topic object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnReplicatedTopicResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Replicated Topic object.", + "tags": [ + "all", + "msgVpn", + "replicatedTopic" + ] + } + }, + "/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}": { + "delete": { + "description": "Delete a Replicated Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "deleteMsgVpnReplicatedTopic", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The topic for applying replication. Published messages matching this topic will be replicated to the standby site.", + "in": "path", + "name": "replicatedTopic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Replicated Topic object.", + "tags": [ + "all", + "msgVpn", + "replicatedTopic" + ] + }, + "get": { + "description": "Get a Replicated Topic object.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nreplicatedTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "getMsgVpnReplicatedTopic", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The topic for applying replication. Published messages matching this topic will be replicated to the standby site.", + "in": "path", + "name": "replicatedTopic", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Replicated Topic object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnReplicatedTopicResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Replicated Topic object.", + "tags": [ + "all", + "msgVpn", + "replicatedTopic" + ] + }, + "patch": { + "description": "Update a Replicated Topic object. Any attribute missing from the request will be left unchanged.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x|x||||\nreplicatedTopic|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "updateMsgVpnReplicatedTopic", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The topic for applying replication. Published messages matching this topic will be replicated to the standby site.", + "in": "path", + "name": "replicatedTopic", + "required": true, + "type": "string" + }, + { + "description": "The Replicated Topic object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnReplicatedTopic" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Replicated Topic object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnReplicatedTopicResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Replicated Topic object.", + "tags": [ + "all", + "msgVpn", + "replicatedTopic" + ] + }, + "put": { + "description": "Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x||x||||\nreplicatedTopic|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "replaceMsgVpnReplicatedTopic", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The topic for applying replication. Published messages matching this topic will be replicated to the standby site.", + "in": "path", + "name": "replicatedTopic", + "required": true, + "type": "string" + }, + { + "description": "The Replicated Topic object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnReplicatedTopic" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Replicated Topic object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnReplicatedTopicResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Replicated Topic object.", + "tags": [ + "all", + "msgVpn", + "replicatedTopic" + ] + } + }, + "/msgVpns/{msgVpnName}/restDeliveryPoints": { + "get": { + "description": "Get a list of REST Delivery Point objects.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnRestDeliveryPoints", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of REST Delivery Point objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of REST Delivery Point objects.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "post": { + "description": "Create a REST Delivery Point object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\nrestDeliveryPointName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnRestDeliveryPoint", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The REST Delivery Point object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPoint" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The REST Delivery Point object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a REST Delivery Point object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + } + }, + "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}": { + "delete": { + "description": "Delete a REST Delivery Point object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnRestDeliveryPoint", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a REST Delivery Point object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "get": { + "description": "Get a REST Delivery Point object.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnRestDeliveryPoint", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The REST Delivery Point object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a REST Delivery Point object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "patch": { + "description": "Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nclientProfileName||||x||\nmsgVpnName|x|x||||\nrestDeliveryPointName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpnRestDeliveryPoint", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The REST Delivery Point object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPoint" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The REST Delivery Point object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a REST Delivery Point object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "put": { + "description": "Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nclientProfileName|||||x||\nmsgVpnName|x||x||||\nrestDeliveryPointName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpnRestDeliveryPoint", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The REST Delivery Point object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPoint" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The REST Delivery Point object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a REST Delivery Point object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + } + }, + "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings": { + "get": { + "description": "Get a list of Queue Binding objects.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueBindingName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnRestDeliveryPointQueueBindings", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Queue Binding objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Queue Binding objects.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "post": { + "description": "Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\nqueueBindingName|x|x||||\nrestDeliveryPointName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnRestDeliveryPointQueueBinding", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The Queue Binding object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBinding" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Queue Binding object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Queue Binding object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + } + }, + "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}": { + "delete": { + "description": "Delete a Queue Binding object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnRestDeliveryPointQueueBinding", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of a queue in the Message VPN.", + "in": "path", + "name": "queueBindingName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Queue Binding object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "get": { + "description": "Get a Queue Binding object.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueBindingName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnRestDeliveryPointQueueBinding", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of a queue in the Message VPN.", + "in": "path", + "name": "queueBindingName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Queue Binding object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Queue Binding object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "patch": { + "description": "Update a Queue Binding object. Any attribute missing from the request will be left unchanged.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x|x||||\nqueueBindingName|x|x||||\nrestDeliveryPointName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpnRestDeliveryPointQueueBinding", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of a queue in the Message VPN.", + "in": "path", + "name": "queueBindingName", + "required": true, + "type": "string" + }, + { + "description": "The Queue Binding object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBinding" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Queue Binding object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Queue Binding object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "put": { + "description": "Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x||x||||\nqueueBindingName|x||x||||\nrestDeliveryPointName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpnRestDeliveryPointQueueBinding", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of a queue in the Message VPN.", + "in": "path", + "name": "queueBindingName", + "required": true, + "type": "string" + }, + { + "description": "The Queue Binding object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBinding" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Queue Binding object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Queue Binding object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + } + }, + "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders": { + "get": { + "description": "Get a list of Request Header objects.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nheaderName|x|||\nmsgVpnName|x|||\nqueueBindingName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.23.", + "operationId": "getMsgVpnRestDeliveryPointQueueBindingRequestHeaders", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of a queue in the Message VPN.", + "in": "path", + "name": "queueBindingName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Request Header objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Request Header objects.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "post": { + "description": "Create a Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nheaderName|x|x||||\nmsgVpnName|x||x|||\nqueueBindingName|x||x|||\nrestDeliveryPointName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.23.", + "operationId": "createMsgVpnRestDeliveryPointQueueBindingRequestHeader", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of a queue in the Message VPN.", + "in": "path", + "name": "queueBindingName", + "required": true, + "type": "string" + }, + { + "description": "The Request Header object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeader" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Request Header object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Request Header object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + } + }, + "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}": { + "delete": { + "description": "Delete a Request Header object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA request header to be added to the HTTP request.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.23.", + "operationId": "deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of a queue in the Message VPN.", + "in": "path", + "name": "queueBindingName", + "required": true, + "type": "string" + }, + { + "description": "The name of the HTTP request header.", + "in": "path", + "name": "headerName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Request Header object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "get": { + "description": "Get a Request Header object.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nheaderName|x|||\nmsgVpnName|x|||\nqueueBindingName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.23.", + "operationId": "getMsgVpnRestDeliveryPointQueueBindingRequestHeader", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of a queue in the Message VPN.", + "in": "path", + "name": "queueBindingName", + "required": true, + "type": "string" + }, + { + "description": "The name of the HTTP request header.", + "in": "path", + "name": "headerName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Request Header object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Request Header object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "patch": { + "description": "Update a Request Header object. Any attribute missing from the request will be left unchanged.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nheaderName|x|x||||\nmsgVpnName|x|x||||\nqueueBindingName|x|x||||\nrestDeliveryPointName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.23.", + "operationId": "updateMsgVpnRestDeliveryPointQueueBindingRequestHeader", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of a queue in the Message VPN.", + "in": "path", + "name": "queueBindingName", + "required": true, + "type": "string" + }, + { + "description": "The name of the HTTP request header.", + "in": "path", + "name": "headerName", + "required": true, + "type": "string" + }, + { + "description": "The Request Header object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeader" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Request Header object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Request Header object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "put": { + "description": "Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nheaderName|x||x||||\nmsgVpnName|x||x||||\nqueueBindingName|x||x||||\nrestDeliveryPointName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.23.", + "operationId": "replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of a queue in the Message VPN.", + "in": "path", + "name": "queueBindingName", + "required": true, + "type": "string" + }, + { + "description": "The name of the HTTP request header.", + "in": "path", + "name": "headerName", + "required": true, + "type": "string" + }, + { + "description": "The Request Header object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeader" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Request Header object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Request Header object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + } + }, + "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers": { + "get": { + "description": "Get a list of REST Consumer objects.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey||x||x\nauthenticationClientCertContent||x||x\nauthenticationClientCertPassword||x||\nauthenticationHttpBasicPassword||x||x\nauthenticationHttpHeaderValue||x||x\nauthenticationOauthClientSecret||x||x\nauthenticationOauthJwtSecretKey||x||x\nmsgVpnName|x|||\nrestConsumerName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnRestDeliveryPointRestConsumers", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of REST Consumer objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumersResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of REST Consumer objects.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "post": { + "description": "Create a REST Consumer object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey||||x||x\nauthenticationClientCertContent||||x||x\nauthenticationClientCertPassword||||x||\nauthenticationHttpBasicPassword||||x||x\nauthenticationHttpHeaderValue||||x||x\nauthenticationOauthClientSecret||||x||x\nauthenticationOauthJwtSecretKey||||x||x\nmsgVpnName|x||x|||\nrestConsumerName|x|x||||\nrestDeliveryPointName|x||x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent|\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername|\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword|\nMsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled|\nMsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnRestDeliveryPointRestConsumer", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The REST Consumer object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumer" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The REST Consumer object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a REST Consumer object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + } + }, + "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}": { + "delete": { + "description": "Delete a REST Consumer object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnRestDeliveryPointRestConsumer", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Consumer.", + "in": "path", + "name": "restConsumerName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a REST Consumer object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "get": { + "description": "Get a REST Consumer object.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey||x||x\nauthenticationClientCertContent||x||x\nauthenticationClientCertPassword||x||\nauthenticationHttpBasicPassword||x||x\nauthenticationHttpHeaderValue||x||x\nauthenticationOauthClientSecret||x||x\nauthenticationOauthJwtSecretKey||x||x\nmsgVpnName|x|||\nrestConsumerName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnRestDeliveryPointRestConsumer", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Consumer.", + "in": "path", + "name": "restConsumerName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The REST Consumer object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a REST Consumer object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "patch": { + "description": "Update a REST Consumer object. Any attribute missing from the request will be left unchanged.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nauthenticationAwsSecretAccessKey|||x|||x\nauthenticationClientCertContent|||x|x||x\nauthenticationClientCertPassword|||x|x||\nauthenticationHttpBasicPassword|||x|x||x\nauthenticationHttpBasicUsername||||x||\nauthenticationHttpHeaderValue|||x|||x\nauthenticationOauthClientId||||x||\nauthenticationOauthClientScope||||x||\nauthenticationOauthClientSecret|||x|x||x\nauthenticationOauthClientTokenEndpoint||||x||\nauthenticationOauthJwtSecretKey|||x|x||x\nauthenticationOauthJwtTokenEndpoint||||x||\nauthenticationScheme||||x||\nmsgVpnName|x|x||||\noutgoingConnectionCount||||x||\nremoteHost||||x||\nremotePort||||x||\nrestConsumerName|x|x||||\nrestDeliveryPointName|x|x||||\ntlsCipherSuiteList||||x||\ntlsEnabled||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent|\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername|\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword|\nMsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled|\nMsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "updateMsgVpnRestDeliveryPointRestConsumer", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Consumer.", + "in": "path", + "name": "restConsumerName", + "required": true, + "type": "string" + }, + { + "description": "The REST Consumer object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumer" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The REST Consumer object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a REST Consumer object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "put": { + "description": "Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nauthenticationAwsSecretAccessKey||||x|||x\nauthenticationClientCertContent||||x|x||x\nauthenticationClientCertPassword||||x|x||\nauthenticationHttpBasicPassword||||x|x||x\nauthenticationHttpBasicUsername|||||x||\nauthenticationHttpHeaderValue||||x|||x\nauthenticationOauthClientId|||||x||\nauthenticationOauthClientScope|||||x||\nauthenticationOauthClientSecret||||x|x||x\nauthenticationOauthClientTokenEndpoint|||||x||\nauthenticationOauthJwtSecretKey||||x|x||x\nauthenticationOauthJwtTokenEndpoint|||||x||\nauthenticationScheme|||||x||\nmsgVpnName|x||x||||\noutgoingConnectionCount|||||x||\nremoteHost|||||x||\nremotePort|||||x||\nrestConsumerName|x||x||||\nrestDeliveryPointName|x||x||||\ntlsCipherSuiteList|||||x||\ntlsEnabled|||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent|\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername|\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword|\nMsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled|\nMsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "replaceMsgVpnRestDeliveryPointRestConsumer", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Consumer.", + "in": "path", + "name": "restConsumerName", + "required": true, + "type": "string" + }, + { + "description": "The REST Consumer object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumer" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The REST Consumer object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a REST Consumer object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + } + }, + "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims": { + "get": { + "description": "Get a list of Claim objects.\n\nA Claim is added to the JWT sent to the OAuth token request endpoint.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\noauthJwtClaimName|x|||\nrestConsumerName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.21.", + "operationId": "getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Consumer.", + "in": "path", + "name": "restConsumerName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Claim objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Claim objects.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "post": { + "description": "Create a Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Claim is added to the JWT sent to the OAuth token request endpoint.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\noauthJwtClaimName|x|x||||\noauthJwtClaimValue||x||||\nrestConsumerName|x||x|||\nrestDeliveryPointName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.21.", + "operationId": "createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Consumer.", + "in": "path", + "name": "restConsumerName", + "required": true, + "type": "string" + }, + { + "description": "The Claim object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Claim object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Claim object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + } + }, + "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName}": { + "delete": { + "description": "Delete a Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Claim is added to the JWT sent to the OAuth token request endpoint.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.21.", + "operationId": "deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Consumer.", + "in": "path", + "name": "restConsumerName", + "required": true, + "type": "string" + }, + { + "description": "The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\".", + "in": "path", + "name": "oauthJwtClaimName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Claim object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "get": { + "description": "Get a Claim object.\n\nA Claim is added to the JWT sent to the OAuth token request endpoint.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\noauthJwtClaimName|x|||\nrestConsumerName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.21.", + "operationId": "getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Consumer.", + "in": "path", + "name": "restConsumerName", + "required": true, + "type": "string" + }, + { + "description": "The name of the additional claim. Cannot be \"exp\", \"iat\", or \"jti\".", + "in": "path", + "name": "oauthJwtClaimName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Claim object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Claim object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + } + }, + "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames": { + "get": { + "deprecated": true, + "description": "Get a list of Trusted Common Name objects.\n\nThe Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|\nrestConsumerName|x||x|\nrestDeliveryPointName|x||x|\ntlsTrustedCommonName|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Consumer.", + "in": "path", + "name": "restConsumerName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Trusted Common Name objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Trusted Common Name objects.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "post": { + "deprecated": true, + "description": "Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x||x|\nrestConsumerName|x||x||x|\nrestDeliveryPointName|x||x||x|\ntlsTrustedCommonName|x|x|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Consumer.", + "in": "path", + "name": "restConsumerName", + "required": true, + "type": "string" + }, + { + "description": "The Trusted Common Name object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Trusted Common Name object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Trusted Common Name object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + } + }, + "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames/{tlsTrustedCommonName}": { + "delete": { + "deprecated": true, + "description": "Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Consumer.", + "in": "path", + "name": "restConsumerName", + "required": true, + "type": "string" + }, + { + "description": "The expected trusted common name of the remote certificate.", + "in": "path", + "name": "tlsTrustedCommonName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Trusted Common Name object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + }, + "get": { + "deprecated": true, + "description": "Get a Trusted Common Name object.\n\nThe Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|\nrestConsumerName|x||x|\nrestDeliveryPointName|x||x|\ntlsTrustedCommonName|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation.", + "operationId": "getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Delivery Point.", + "in": "path", + "name": "restDeliveryPointName", + "required": true, + "type": "string" + }, + { + "description": "The name of the REST Consumer.", + "in": "path", + "name": "restConsumerName", + "required": true, + "type": "string" + }, + { + "description": "The expected trusted common name of the remote certificate.", + "in": "path", + "name": "tlsTrustedCommonName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Trusted Common Name object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Trusted Common Name object.", + "tags": [ + "all", + "msgVpn", + "restDeliveryPoint" + ] + } + }, + "/msgVpns/{msgVpnName}/sequencedTopics": { + "get": { + "description": "Get a list of Sequenced Topic objects.\n\nA Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nsequencedTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnSequencedTopics", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Sequenced Topic objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnSequencedTopicsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Sequenced Topic objects.", + "tags": [ + "all", + "msgVpn" + ] + }, + "post": { + "description": "Create a Sequenced Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\nsequencedTopic|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "createMsgVpnSequencedTopic", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Sequenced Topic object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnSequencedTopic" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Sequenced Topic object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnSequencedTopicResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Sequenced Topic object.", + "tags": [ + "all", + "msgVpn" + ] + } + }, + "/msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic}": { + "delete": { + "description": "Delete a Sequenced Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "deleteMsgVpnSequencedTopic", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "Topic for applying sequence numbers.", + "in": "path", + "name": "sequencedTopic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Sequenced Topic object.", + "tags": [ + "all", + "msgVpn" + ] + }, + "get": { + "description": "Get a Sequenced Topic object.\n\nA Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nsequencedTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "operationId": "getMsgVpnSequencedTopic", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "Topic for applying sequence numbers.", + "in": "path", + "name": "sequencedTopic", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Sequenced Topic object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnSequencedTopicResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Sequenced Topic object.", + "tags": [ + "all", + "msgVpn" + ] + } + }, + "/msgVpns/{msgVpnName}/topicEndpointTemplates": { + "get": { + "description": "Get a list of Topic Endpoint Template objects.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\ntopicEndpointTemplateName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "getMsgVpnTopicEndpointTemplates", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Topic Endpoint Template objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnTopicEndpointTemplatesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Topic Endpoint Template objects.", + "tags": [ + "all", + "msgVpn", + "topicEndpointTemplate" + ] + }, + "post": { + "description": "Create a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\ntopicEndpointTemplateName|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "createMsgVpnTopicEndpointTemplate", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Topic Endpoint Template object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnTopicEndpointTemplate" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Topic Endpoint Template object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnTopicEndpointTemplateResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Topic Endpoint Template object.", + "tags": [ + "all", + "msgVpn", + "topicEndpointTemplate" + ] + } + }, + "/msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}": { + "delete": { + "description": "Delete a Topic Endpoint Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "deleteMsgVpnTopicEndpointTemplate", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Topic Endpoint Template.", + "in": "path", + "name": "topicEndpointTemplateName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Topic Endpoint Template object.", + "tags": [ + "all", + "msgVpn", + "topicEndpointTemplate" + ] + }, + "get": { + "description": "Get a Topic Endpoint Template object.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\ntopicEndpointTemplateName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "getMsgVpnTopicEndpointTemplate", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Topic Endpoint Template.", + "in": "path", + "name": "topicEndpointTemplateName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Topic Endpoint Template object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnTopicEndpointTemplateResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Topic Endpoint Template object.", + "tags": [ + "all", + "msgVpn", + "topicEndpointTemplate" + ] + }, + "patch": { + "description": "Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x|x||||\ntopicEndpointTemplateName|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "updateMsgVpnTopicEndpointTemplate", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Topic Endpoint Template.", + "in": "path", + "name": "topicEndpointTemplateName", + "required": true, + "type": "string" + }, + { + "description": "The Topic Endpoint Template object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnTopicEndpointTemplate" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Topic Endpoint Template object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnTopicEndpointTemplateResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Topic Endpoint Template object.", + "tags": [ + "all", + "msgVpn", + "topicEndpointTemplate" + ] + }, + "put": { + "description": "Replace a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x||x||||\ntopicEndpointTemplateName|x||x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "operationId": "replaceMsgVpnTopicEndpointTemplate", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Topic Endpoint Template.", + "in": "path", + "name": "topicEndpointTemplateName", + "required": true, + "type": "string" + }, + { + "description": "The Topic Endpoint Template object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnTopicEndpointTemplate" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Topic Endpoint Template object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnTopicEndpointTemplateResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Topic Endpoint Template object.", + "tags": [ + "all", + "msgVpn", + "topicEndpointTemplate" + ] + } + }, + "/msgVpns/{msgVpnName}/topicEndpoints": { + "get": { + "description": "Get a list of Topic Endpoint objects.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\ntopicEndpointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "getMsgVpnTopicEndpoints", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Topic Endpoint objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnTopicEndpointsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Topic Endpoint objects.", + "tags": [ + "all", + "msgVpn", + "topicEndpoint" + ] + }, + "post": { + "description": "Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||\ntopicEndpointName|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "createMsgVpnTopicEndpoint", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Topic Endpoint object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnTopicEndpoint" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Topic Endpoint object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnTopicEndpointResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Topic Endpoint object.", + "tags": [ + "all", + "msgVpn", + "topicEndpoint" + ] + } + }, + "/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}": { + "delete": { + "description": "Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "deleteMsgVpnTopicEndpoint", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Topic Endpoint.", + "in": "path", + "name": "topicEndpointName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Topic Endpoint object.", + "tags": [ + "all", + "msgVpn", + "topicEndpoint" + ] + }, + "get": { + "description": "Get a Topic Endpoint object.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\ntopicEndpointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "getMsgVpnTopicEndpoint", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Topic Endpoint.", + "in": "path", + "name": "topicEndpointName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Topic Endpoint object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnTopicEndpointResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Topic Endpoint object.", + "tags": [ + "all", + "msgVpn", + "topicEndpoint" + ] + }, + "patch": { + "description": "Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\naccessType||||x||\nmsgVpnName|x|x||||\nowner||||x||\npermission||||x||\nrespectMsgPriorityEnabled||||x||\ntopicEndpointName|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "updateMsgVpnTopicEndpoint", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Topic Endpoint.", + "in": "path", + "name": "topicEndpointName", + "required": true, + "type": "string" + }, + { + "description": "The Topic Endpoint object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnTopicEndpoint" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Topic Endpoint object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnTopicEndpointResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Topic Endpoint object.", + "tags": [ + "all", + "msgVpn", + "topicEndpoint" + ] + }, + "put": { + "description": "Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\naccessType|||||x||\nmsgVpnName|x||x||||\nowner|||||x||\npermission|||||x||\nrespectMsgPriorityEnabled|||||x||\ntopicEndpointName|x||x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nEventThreshold|clearPercent|setPercent|clearValue, setValue\nEventThreshold|clearValue|setValue|clearPercent, setPercent\nEventThreshold|setPercent|clearPercent|clearValue, setValue\nEventThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "operationId": "replaceMsgVpnTopicEndpoint", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the Topic Endpoint.", + "in": "path", + "name": "topicEndpointName", + "required": true, + "type": "string" + }, + { + "description": "The Topic Endpoint object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnTopicEndpoint" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Topic Endpoint object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnTopicEndpointResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Topic Endpoint object.", + "tags": [ + "all", + "msgVpn", + "topicEndpoint" + ] + } + }, + "/oauthProfiles": { + "get": { + "description": "Get a list of OAuth Profile objects.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientSecret||x||x\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "getOauthProfiles", + "parameters": [ + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of OAuth Profile objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfilesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of OAuth Profile objects.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "post": { + "description": "Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nclientSecret||||x||x\noauthProfileName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "createOauthProfile", + "parameters": [ + { + "description": "The OAuth Profile object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfile" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OAuth Profile object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create an OAuth Profile object.", + "tags": [ + "all", + "oauthProfile" + ] + } + }, + "/oauthProfiles/{oauthProfileName}": { + "delete": { + "description": "Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "deleteOauthProfile", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete an OAuth Profile object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "get": { + "description": "Get an OAuth Profile object.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientSecret||x||x\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "getOauthProfile", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OAuth Profile object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get an OAuth Profile object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "patch": { + "description": "Update an OAuth Profile object. Any attribute missing from the request will be left unchanged.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nclientSecret|||x|||x\noauthProfileName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\naccessLevelGroupsClaimName|global/admin\nclientId|global/admin\nclientRedirectUri|global/admin\nclientRequiredType|global/admin\nclientScope|global/admin\nclientSecret|global/admin\nclientValidateTypeEnabled|global/admin\ndefaultGlobalAccessLevel|global/admin\ndisplayName|global/admin\nenabled|global/admin\nendpointAuthorization|global/admin\nendpointDiscovery|global/admin\nendpointDiscoveryRefreshInterval|global/admin\nendpointIntrospection|global/admin\nendpointIntrospectionTimeout|global/admin\nendpointJwks|global/admin\nendpointJwksRefreshInterval|global/admin\nendpointToken|global/admin\nendpointTokenTimeout|global/admin\nendpointUserinfo|global/admin\nendpointUserinfoTimeout|global/admin\ninteractiveEnabled|global/admin\ninteractivePromptForExpiredSession|global/admin\ninteractivePromptForNewSession|global/admin\nissuer|global/admin\noauthRole|global/admin\nresourceServerParseAccessTokenEnabled|global/admin\nresourceServerRequiredAudience|global/admin\nresourceServerRequiredIssuer|global/admin\nresourceServerRequiredScope|global/admin\nresourceServerRequiredType|global/admin\nresourceServerValidateAudienceEnabled|global/admin\nresourceServerValidateIssuerEnabled|global/admin\nresourceServerValidateScopeEnabled|global/admin\nresourceServerValidateTypeEnabled|global/admin\nsempEnabled|global/admin\nusernameClaimName|global/admin\n\n\n\nThis has been available since 2.24.", + "operationId": "updateOauthProfile", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The OAuth Profile object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfile" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OAuth Profile object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update an OAuth Profile object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "put": { + "description": "Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nclientSecret||||x|||x\noauthProfileName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\naccessLevelGroupsClaimName|global/admin\nclientId|global/admin\nclientRedirectUri|global/admin\nclientRequiredType|global/admin\nclientScope|global/admin\nclientSecret|global/admin\nclientValidateTypeEnabled|global/admin\ndefaultGlobalAccessLevel|global/admin\ndisplayName|global/admin\nenabled|global/admin\nendpointAuthorization|global/admin\nendpointDiscovery|global/admin\nendpointDiscoveryRefreshInterval|global/admin\nendpointIntrospection|global/admin\nendpointIntrospectionTimeout|global/admin\nendpointJwks|global/admin\nendpointJwksRefreshInterval|global/admin\nendpointToken|global/admin\nendpointTokenTimeout|global/admin\nendpointUserinfo|global/admin\nendpointUserinfoTimeout|global/admin\ninteractiveEnabled|global/admin\ninteractivePromptForExpiredSession|global/admin\ninteractivePromptForNewSession|global/admin\nissuer|global/admin\noauthRole|global/admin\nresourceServerParseAccessTokenEnabled|global/admin\nresourceServerRequiredAudience|global/admin\nresourceServerRequiredIssuer|global/admin\nresourceServerRequiredScope|global/admin\nresourceServerRequiredType|global/admin\nresourceServerValidateAudienceEnabled|global/admin\nresourceServerValidateIssuerEnabled|global/admin\nresourceServerValidateScopeEnabled|global/admin\nresourceServerValidateTypeEnabled|global/admin\nsempEnabled|global/admin\nusernameClaimName|global/admin\n\n\n\nThis has been available since 2.24.", + "operationId": "replaceOauthProfile", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The OAuth Profile object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfile" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OAuth Profile object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace an OAuth Profile object.", + "tags": [ + "all", + "oauthProfile" + ] + } + }, + "/oauthProfiles/{oauthProfileName}/accessLevelGroups": { + "get": { + "description": "Get a list of Group Access Level objects.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ngroupName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "getOauthProfileAccessLevelGroups", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Group Access Level objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Group Access Level objects.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "post": { + "description": "Create a Group Access Level object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ngroupName|x|x||||\noauthProfileName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\nglobalAccessLevel|global/admin\n\n\n\nThis has been available since 2.24.", + "operationId": "createOauthProfileAccessLevelGroup", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Group Access Level object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfileAccessLevelGroup" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Group Access Level object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Group Access Level object.", + "tags": [ + "all", + "oauthProfile" + ] + } + }, + "/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}": { + "delete": { + "description": "Delete a Group Access Level object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "deleteOauthProfileAccessLevelGroup", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the group.", + "in": "path", + "name": "groupName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Group Access Level object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "get": { + "description": "Get a Group Access Level object.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ngroupName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "getOauthProfileAccessLevelGroup", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the group.", + "in": "path", + "name": "groupName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Group Access Level object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Group Access Level object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "patch": { + "description": "Update a Group Access Level object. Any attribute missing from the request will be left unchanged.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\ngroupName|x|x||||\noauthProfileName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\nglobalAccessLevel|global/admin\n\n\n\nThis has been available since 2.24.", + "operationId": "updateOauthProfileAccessLevelGroup", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the group.", + "in": "path", + "name": "groupName", + "required": true, + "type": "string" + }, + { + "description": "The Group Access Level object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfileAccessLevelGroup" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Group Access Level object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Group Access Level object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "put": { + "description": "Replace a Group Access Level object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\ngroupName|x||x||||\noauthProfileName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\nglobalAccessLevel|global/admin\n\n\n\nThis has been available since 2.24.", + "operationId": "replaceOauthProfileAccessLevelGroup", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the group.", + "in": "path", + "name": "groupName", + "required": true, + "type": "string" + }, + { + "description": "The Group Access Level object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfileAccessLevelGroup" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Group Access Level object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Group Access Level object.", + "tags": [ + "all", + "oauthProfile" + ] + } + }, + "/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions": { + "get": { + "description": "Get a list of Message VPN Access-Level Exception objects.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ngroupName|x|||\nmsgVpnName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the group.", + "in": "path", + "name": "groupName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Message VPN Access-Level Exception objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Message VPN Access-Level Exception objects.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "post": { + "description": "Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\ngroupName|x||x|||\nmsgVpnName|x|x||||\noauthProfileName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "createOauthProfileAccessLevelGroupMsgVpnAccessLevelException", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the group.", + "in": "path", + "name": "groupName", + "required": true, + "type": "string" + }, + { + "description": "The Message VPN Access-Level Exception object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelException" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Message VPN Access-Level Exception object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Message VPN Access-Level Exception object.", + "tags": [ + "all", + "oauthProfile" + ] + } + }, + "/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName}": { + "delete": { + "description": "Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nMessage VPN access-level exceptions for members of this group.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the group.", + "in": "path", + "name": "groupName", + "required": true, + "type": "string" + }, + { + "description": "The name of the message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Message VPN Access-Level Exception object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "get": { + "description": "Get a Message VPN Access-Level Exception object.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ngroupName|x|||\nmsgVpnName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "getOauthProfileAccessLevelGroupMsgVpnAccessLevelException", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the group.", + "in": "path", + "name": "groupName", + "required": true, + "type": "string" + }, + { + "description": "The name of the message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Message VPN Access-Level Exception object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Message VPN Access-Level Exception object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "patch": { + "description": "Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\ngroupName|x|x||||\nmsgVpnName|x|x||||\noauthProfileName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the group.", + "in": "path", + "name": "groupName", + "required": true, + "type": "string" + }, + { + "description": "The name of the message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Message VPN Access-Level Exception object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelException" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Message VPN Access-Level Exception object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "put": { + "description": "Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\ngroupName|x||x||||\nmsgVpnName|x||x||||\noauthProfileName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the group.", + "in": "path", + "name": "groupName", + "required": true, + "type": "string" + }, + { + "description": "The name of the message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Message VPN Access-Level Exception object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelException" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Message VPN Access-Level Exception object.", + "tags": [ + "all", + "oauthProfile" + ] + } + }, + "/oauthProfiles/{oauthProfileName}/clientAllowedHosts": { + "get": { + "description": "Get a list of Allowed Host Value objects.\n\nA valid hostname for this broker in OAuth redirects.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nallowedHost|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "getOauthProfileClientAllowedHosts", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Allowed Host Value objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileClientAllowedHostsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Allowed Host Value objects.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "post": { + "description": "Create an Allowed Host Value object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA valid hostname for this broker in OAuth redirects.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nallowedHost|x|x||||\noauthProfileName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "createOauthProfileClientAllowedHost", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Allowed Host Value object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfileClientAllowedHost" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Allowed Host Value object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileClientAllowedHostResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create an Allowed Host Value object.", + "tags": [ + "all", + "oauthProfile" + ] + } + }, + "/oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost}": { + "delete": { + "description": "Delete an Allowed Host Value object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA valid hostname for this broker in OAuth redirects.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "deleteOauthProfileClientAllowedHost", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "An allowed value for the Host header.", + "in": "path", + "name": "allowedHost", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete an Allowed Host Value object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "get": { + "description": "Get an Allowed Host Value object.\n\nA valid hostname for this broker in OAuth redirects.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nallowedHost|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "getOauthProfileClientAllowedHost", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "An allowed value for the Host header.", + "in": "path", + "name": "allowedHost", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Allowed Host Value object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileClientAllowedHostResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get an Allowed Host Value object.", + "tags": [ + "all", + "oauthProfile" + ] + } + }, + "/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters": { + "get": { + "description": "Get a list of Authorization Parameter objects.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthorizationParameterName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "getOauthProfileClientAuthorizationParameters", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Authorization Parameter objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileClientAuthorizationParametersResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Authorization Parameter objects.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "post": { + "description": "Create an Authorization Parameter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthorizationParameterName|x|x||||\noauthProfileName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "createOauthProfileClientAuthorizationParameter", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Authorization Parameter object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfileClientAuthorizationParameter" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Authorization Parameter object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileClientAuthorizationParameterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create an Authorization Parameter object.", + "tags": [ + "all", + "oauthProfile" + ] + } + }, + "/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName}": { + "delete": { + "description": "Delete an Authorization Parameter object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "deleteOauthProfileClientAuthorizationParameter", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the authorization parameter.", + "in": "path", + "name": "authorizationParameterName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete an Authorization Parameter object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "get": { + "description": "Get an Authorization Parameter object.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthorizationParameterName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "getOauthProfileClientAuthorizationParameter", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the authorization parameter.", + "in": "path", + "name": "authorizationParameterName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Authorization Parameter object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileClientAuthorizationParameterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get an Authorization Parameter object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "patch": { + "description": "Update an Authorization Parameter object. Any attribute missing from the request will be left unchanged.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nauthorizationParameterName|x|x||||\noauthProfileName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "updateOauthProfileClientAuthorizationParameter", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the authorization parameter.", + "in": "path", + "name": "authorizationParameterName", + "required": true, + "type": "string" + }, + { + "description": "The Authorization Parameter object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfileClientAuthorizationParameter" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Authorization Parameter object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileClientAuthorizationParameterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update an Authorization Parameter object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "put": { + "description": "Replace an Authorization Parameter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nauthorizationParameterName|x||x||||\noauthProfileName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "replaceOauthProfileClientAuthorizationParameter", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the authorization parameter.", + "in": "path", + "name": "authorizationParameterName", + "required": true, + "type": "string" + }, + { + "description": "The Authorization Parameter object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfileClientAuthorizationParameter" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Authorization Parameter object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileClientAuthorizationParameterResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace an Authorization Parameter object.", + "tags": [ + "all", + "oauthProfile" + ] + } + }, + "/oauthProfiles/{oauthProfileName}/clientRequiredClaims": { + "get": { + "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "getOauthProfileClientRequiredClaims", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Required Claim objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileClientRequiredClaimsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Required Claim objects.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "post": { + "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|x||||\nclientRequiredClaimValue||x||||\noauthProfileName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "createOauthProfileClientRequiredClaim", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Required Claim object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfileClientRequiredClaim" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Required Claim object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileClientRequiredClaimResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Required Claim object.", + "tags": [ + "all", + "oauthProfile" + ] + } + }, + "/oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}": { + "delete": { + "description": "Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nAdditional claims to be verified in the ID token.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "deleteOauthProfileClientRequiredClaim", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ID token claim to verify.", + "in": "path", + "name": "clientRequiredClaimName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Required Claim object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "get": { + "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "getOauthProfileClientRequiredClaim", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ID token claim to verify.", + "in": "path", + "name": "clientRequiredClaimName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Required Claim object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileClientRequiredClaimResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Required Claim object.", + "tags": [ + "all", + "oauthProfile" + ] + } + }, + "/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions": { + "get": { + "description": "Get a list of Message VPN Access-Level Exception objects.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "getOauthProfileDefaultMsgVpnAccessLevelExceptions", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Message VPN Access-Level Exception objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Message VPN Access-Level Exception objects.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "post": { + "description": "Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|x||||\noauthProfileName|x||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "createOauthProfileDefaultMsgVpnAccessLevelException", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Message VPN Access-Level Exception object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelException" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Message VPN Access-Level Exception object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Message VPN Access-Level Exception object.", + "tags": [ + "all", + "oauthProfile" + ] + } + }, + "/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName}": { + "delete": { + "description": "Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nDefault message VPN access-level exceptions.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "deleteOauthProfileDefaultMsgVpnAccessLevelException", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Message VPN Access-Level Exception object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "get": { + "description": "Get a Message VPN Access-Level Exception object.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "getOauthProfileDefaultMsgVpnAccessLevelException", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Message VPN Access-Level Exception object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Message VPN Access-Level Exception object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "patch": { + "description": "Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x|x||||\noauthProfileName|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "updateOauthProfileDefaultMsgVpnAccessLevelException", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Message VPN Access-Level Exception object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelException" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Message VPN Access-Level Exception object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Message VPN Access-Level Exception object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "put": { + "description": "Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nmsgVpnName|x||x||||\noauthProfileName|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "replaceOauthProfileDefaultMsgVpnAccessLevelException", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The Message VPN Access-Level Exception object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelException" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Message VPN Access-Level Exception object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileDefaultMsgVpnAccessLevelExceptionResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Message VPN Access-Level Exception object.", + "tags": [ + "all", + "oauthProfile" + ] + } + }, + "/oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims": { + "get": { + "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\noauthProfileName|x|||\nresourceServerRequiredClaimName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "getOauthProfileResourceServerRequiredClaims", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Required Claim objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileResourceServerRequiredClaimsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Required Claim objects.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "post": { + "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\noauthProfileName|x||x|||\nresourceServerRequiredClaimName|x|x||||\nresourceServerRequiredClaimValue||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "createOauthProfileResourceServerRequiredClaim", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Required Claim object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OauthProfileResourceServerRequiredClaim" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Required Claim object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileResourceServerRequiredClaimResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Required Claim object.", + "tags": [ + "all", + "oauthProfile" + ] + } + }, + "/oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}": { + "delete": { + "description": "Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nAdditional claims to be verified in the access token.\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "deleteOauthProfileResourceServerRequiredClaim", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the access token claim to verify.", + "in": "path", + "name": "resourceServerRequiredClaimName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Required Claim object.", + "tags": [ + "all", + "oauthProfile" + ] + }, + "get": { + "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\noauthProfileName|x|||\nresourceServerRequiredClaimName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "operationId": "getOauthProfileResourceServerRequiredClaim", + "parameters": [ + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the access token claim to verify.", + "in": "path", + "name": "resourceServerRequiredClaimName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Required Claim object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/OauthProfileResourceServerRequiredClaimResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Required Claim object.", + "tags": [ + "all", + "oauthProfile" + ] + } + }, + "/systemInformation": { + "get": { + "deprecated": true, + "description": "Get a System Information object.\n\nThe System Information object provides metadata about the SEMP API.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nplatform|||x|\nsempVersion|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been deprecated since 2.2. /systemInformation was replaced by /about/api.", + "operationId": "getSystemInformation", + "parameters": [ + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The System Information object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/SystemInformationResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a System Information object.", + "tags": [ + "all", + "systemInformation" + ] + } + }, + "/virtualHostnames": { + "get": { + "description": "Get a list of Virtual Hostname objects.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nvirtualHostname|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.17.", + "operationId": "getVirtualHostnames", + "parameters": [ + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Virtual Hostname objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/VirtualHostnamesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Virtual Hostname objects.", + "tags": [ + "all", + "virtualHostname" + ] + }, + "post": { + "description": "Create a Virtual Hostname object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nvirtualHostname|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.17.", + "operationId": "createVirtualHostname", + "parameters": [ + { + "description": "The Virtual Hostname object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHostname" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Virtual Hostname object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/VirtualHostnameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Virtual Hostname object.", + "tags": [ + "all", + "virtualHostname" + ] + } + }, + "/virtualHostnames/{virtualHostname}": { + "delete": { + "description": "Delete a Virtual Hostname object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.17.", + "operationId": "deleteVirtualHostname", + "parameters": [ + { + "description": "The virtual hostname.", + "in": "path", + "name": "virtualHostname", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Virtual Hostname object.", + "tags": [ + "all", + "virtualHostname" + ] + }, + "get": { + "description": "Get a Virtual Hostname object.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nvirtualHostname|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.17.", + "operationId": "getVirtualHostname", + "parameters": [ + { + "description": "The virtual hostname.", + "in": "path", + "name": "virtualHostname", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Virtual Hostname object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/VirtualHostnameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Virtual Hostname object.", + "tags": [ + "all", + "virtualHostname" + ] + }, + "patch": { + "description": "Update a Virtual Hostname object. Any attribute missing from the request will be left unchanged.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---\nvirtualHostname|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.17.", + "operationId": "updateVirtualHostname", + "parameters": [ + { + "description": "The virtual hostname.", + "in": "path", + "name": "virtualHostname", + "required": true, + "type": "string" + }, + { + "description": "The Virtual Hostname object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHostname" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Virtual Hostname object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/VirtualHostnameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Virtual Hostname object.", + "tags": [ + "all", + "virtualHostname" + ] + }, + "put": { + "description": "Replace a Virtual Hostname object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque\n:---|:---|:---|:---|:---|:---|:---|:---\nvirtualHostname|x||x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.17.", + "operationId": "replaceVirtualHostname", + "parameters": [ + { + "description": "The virtual hostname.", + "in": "path", + "name": "virtualHostname", + "required": true, + "type": "string" + }, + { + "description": "The Virtual Hostname object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHostname" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Virtual Hostname object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/VirtualHostnameResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Virtual Hostname object.", + "tags": [ + "all", + "virtualHostname" + ] + } + } + }, + "produces": [ + "application/json" + ], + "schemes": [ + "http", + "https" + ], + "securityDefinitions": { + "basicAuth": { + "description": "basic authentication", + "type": "basic" + } + }, + "swagger": "2.0", + "tags": [] +} \ No newline at end of file diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AboutApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AboutApiTest.java deleted file mode 100644 index d3bd05730..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AboutApiTest.java +++ /dev/null @@ -1,130 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutApiResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserMsgVpnResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserMsgVpnsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for AboutApi - */ -@Ignore -public class AboutApiTest { - - private final AboutApi api = new AboutApi(); - - - /** - * Get an About object. - * - * Get an About object. This provides metadata about the SEMP API, such as the version of the API supported by the broker. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.13. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getAboutTest() { - String opaquePassword = null; - List select = null; - AboutResponse response = api.getAbout(opaquePassword, select); - - // TODO: test validations - } - - /** - * Get an API Description object. - * - * Get an API Description object. The API Description object provides metadata about the SEMP API. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getAboutApiTest() { - String opaquePassword = null; - List select = null; - AboutApiResponse response = api.getAboutApi(opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a User object. - * - * Get a User object. Session and access level information about the user accessing the SEMP API. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getAboutUserTest() { - String opaquePassword = null; - List select = null; - AboutUserResponse response = api.getAboutUser(opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a User Message VPN object. - * - * Get a User Message VPN object. This provides information about the Message VPN access level for the username used to access the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getAboutUserMsgVpnTest() { - String msgVpnName = null; - String opaquePassword = null; - List select = null; - AboutUserMsgVpnResponse response = api.getAboutUserMsgVpn(msgVpnName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of User Message VPN objects. - * - * Get a list of User Message VPN objects. This provides information about the Message VPN access level for the username used to access the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getAboutUserMsgVpnsTest() { - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - AboutUserMsgVpnsResponse response = api.getAboutUserMsgVpns(count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AclProfileApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AclProfileApiTest.java deleted file mode 100644 index 2af835e7a..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AclProfileApiTest.java +++ /dev/null @@ -1,663 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for AclProfileApi - */ -@Ignore -public class AclProfileApiTest { - - private final AclProfileApi api = new AclProfileApi(); - - - /** - * Create an ACL Profile object. - * - * Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfileTest() { - String msgVpnName = null; - MsgVpnAclProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileResponse response = api.createMsgVpnAclProfile(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Client Connect Exception object. - * - * Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| clientConnectExceptionAddress|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfileClientConnectExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfileClientConnectException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileClientConnectExceptionResponse response = api.createMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Publish Topic Exception object. - * - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| publishExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfilePublishExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfilePublishException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfilePublishExceptionResponse response = api.createMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Publish Topic Exception object. - * - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| publishTopicException|x|x|||| publishTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfilePublishTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfilePublishTopicException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfilePublishTopicExceptionResponse response = api.createMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Subscribe Topic Exception object. - * - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| subscribeExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfileSubscribeExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfileSubscribeException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeExceptionResponse response = api.createMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Subscribe Share Name Exception object. - * - * Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeShareNameException|x|x|||| subscribeShareNameExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfileSubscribeShareNameExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfileSubscribeShareNameException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeShareNameExceptionResponse response = api.createMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Subscribe Topic Exception object. - * - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeTopicException|x|x|||| subscribeTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfileSubscribeTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfileSubscribeTopicException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeTopicExceptionResponse response = api.createMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete an ACL Profile object. - * - * Delete an ACL Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfileTest() { - String msgVpnName = null; - String aclProfileName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfile(msgVpnName, aclProfileName); - - // TODO: test validations - } - - /** - * Delete a Client Connect Exception object. - * - * Delete a Client Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfileClientConnectExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String clientConnectExceptionAddress = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress); - - // TODO: test validations - } - - /** - * Delete a Publish Topic Exception object. - * - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfilePublishExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String topicSyntax = null; - String publishExceptionTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic); - - // TODO: test validations - } - - /** - * Delete a Publish Topic Exception object. - * - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfilePublishTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String publishTopicExceptionSyntax = null; - String publishTopicException = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException); - - // TODO: test validations - } - - /** - * Delete a Subscribe Topic Exception object. - * - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfileSubscribeExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String topicSyntax = null; - String subscribeExceptionTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic); - - // TODO: test validations - } - - /** - * Delete a Subscribe Share Name Exception object. - * - * Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfileSubscribeShareNameExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String subscribeShareNameExceptionSyntax = null; - String subscribeShareNameException = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException); - - // TODO: test validations - } - - /** - * Delete a Subscribe Topic Exception object. - * - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfileSubscribeTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String subscribeTopicExceptionSyntax = null; - String subscribeTopicException = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException); - - // TODO: test validations - } - - /** - * Get an ACL Profile object. - * - * Get an ACL Profile object. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileTest() { - String msgVpnName = null; - String aclProfileName = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileResponse response = api.getMsgVpnAclProfile(msgVpnName, aclProfileName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Client Connect Exception object. - * - * Get a Client Connect Exception object. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileClientConnectExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String clientConnectExceptionAddress = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileClientConnectExceptionResponse response = api.getMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Client Connect Exception objects. - * - * Get a list of Client Connect Exception objects. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileClientConnectExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfileClientConnectExceptionsResponse response = api.getMsgVpnAclProfileClientConnectExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Publish Topic Exception object. - * - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfilePublishExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String topicSyntax = null; - String publishExceptionTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfilePublishExceptionResponse response = api.getMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Publish Topic Exception objects. - * - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfilePublishExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfilePublishExceptionsResponse response = api.getMsgVpnAclProfilePublishExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Publish Topic Exception object. - * - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfilePublishTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String publishTopicExceptionSyntax = null; - String publishTopicException = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfilePublishTopicExceptionResponse response = api.getMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Publish Topic Exception objects. - * - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfilePublishTopicExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfilePublishTopicExceptionsResponse response = api.getMsgVpnAclProfilePublishTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Subscribe Topic Exception object. - * - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String topicSyntax = null; - String subscribeExceptionTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeExceptionResponse response = api.getMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Subscribe Topic Exception objects. - * - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfileSubscribeExceptionsResponse response = api.getMsgVpnAclProfileSubscribeExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Subscribe Share Name Exception object. - * - * Get a Subscribe Share Name Exception object. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeShareNameExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String subscribeShareNameExceptionSyntax = null; - String subscribeShareNameException = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeShareNameExceptionResponse response = api.getMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Subscribe Share Name Exception objects. - * - * Get a list of Subscribe Share Name Exception objects. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeShareNameExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfileSubscribeShareNameExceptionsResponse response = api.getMsgVpnAclProfileSubscribeShareNameExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Subscribe Topic Exception object. - * - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String subscribeTopicExceptionSyntax = null; - String subscribeTopicException = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeTopicExceptionResponse response = api.getMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Subscribe Topic Exception objects. - * - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeTopicExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfileSubscribeTopicExceptionsResponse response = api.getMsgVpnAclProfileSubscribeTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of ACL Profile objects. - * - * Get a list of ACL Profile objects. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfilesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfilesResponse response = api.getMsgVpnAclProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace an ACL Profile object. - * - * Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnAclProfileTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileResponse response = api.replaceMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an ACL Profile object. - * - * Update an ACL Profile object. Any attribute missing from the request will be left unchanged. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnAclProfileTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileResponse response = api.updateMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AllApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AllApiTest.java deleted file mode 100644 index 7163bf9d7..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AllApiTest.java +++ /dev/null @@ -1,7894 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutApiResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserMsgVpnResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserMsgVpnsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.Broker; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.BrokerResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthoritiesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthoritiesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFilterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFiltersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleConditionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleConditionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRulesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLink; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttributeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttributesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddress; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddressResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddressesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinksResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClustersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthoritiesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthorityResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProvider; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProviderResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProvidersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroupResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroupsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpnResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpnsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFiltersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleConditionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleConditionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRulesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsername; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttributeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttributesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstance; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstanceResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstancesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClustersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCachesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridgeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridgesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactoriesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactory; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactoryResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueueResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueuesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCacheResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCachesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSession; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplateResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplatesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueuesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLog; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBinding; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeader; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumer; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplateResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplatesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHost; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHostResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHostsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParameter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParameterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParametersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SystemInformationResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostname; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostnameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostnamesResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for AllApi - */ -@Ignore -public class AllApiTest { - - private final AllApi api = new AllApi(); - - - /** - * Create a Certificate Authority object. - * - * Create a Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||x| certContent|||||x| crlDayList|||||x| crlTimeList|||||x| crlUrl|||||x| ocspNonResponderCertEnabled|||||x| ocspOverrideUrl|||||x| ocspTimeout|||||x| revocationCheckEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createCertAuthorityTest() { - CertAuthority body = null; - String opaquePassword = null; - List select = null; - CertAuthorityResponse response = api.createCertAuthority(body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an OCSP Responder Trusted Common Name object. - * - * Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x||x||x| ocspTlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createCertAuthorityOcspTlsTrustedCommonNameTest() { - String certAuthorityName = null; - CertAuthorityOcspTlsTrustedCommonName body = null; - String opaquePassword = null; - List select = null; - CertAuthorityOcspTlsTrustedCommonNameResponse response = api.createCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Client Certificate Authority object. - * - * Create a Client Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createClientCertAuthorityTest() { - ClientCertAuthority body = null; - String opaquePassword = null; - List select = null; - ClientCertAuthorityResponse response = api.createClientCertAuthority(body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an OCSP Responder Trusted Common Name object. - * - * Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x||x||| ocspTlsTrustedCommonName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createClientCertAuthorityOcspTlsTrustedCommonNameTest() { - String certAuthorityName = null; - ClientCertAuthorityOcspTlsTrustedCommonName body = null; - String opaquePassword = null; - List select = null; - ClientCertAuthorityOcspTlsTrustedCommonNameResponse response = api.createClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Cluster object. - * - * Create a Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationBasicPassword||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| dmrClusterName|x|x|||| nodeName|||x||| tlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDmrClusterTest() { - DmrCluster body = null; - String opaquePassword = null; - List select = null; - DmrClusterResponse response = api.createDmrCluster(body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Certificate Matching Rule object. - * - * Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDmrClusterCertMatchingRuleTest() { - String dmrClusterName = null; - DmrClusterCertMatchingRule body = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleResponse response = api.createDmrClusterCertMatchingRule(dmrClusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Certificate Matching Rule Attribute Filter object. - * - * Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| filterName|x|x|||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDmrClusterCertMatchingRuleAttributeFilterTest() { - String dmrClusterName = null; - String ruleName = null; - DmrClusterCertMatchingRuleAttributeFilter body = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleAttributeFilterResponse response = api.createDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Certificate Matching Rule Condition object. - * - * Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDmrClusterCertMatchingRuleConditionTest() { - String dmrClusterName = null; - String ruleName = null; - DmrClusterCertMatchingRuleCondition body = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleConditionResponse response = api.createDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Link object. - * - * Create a Link object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationBasicPassword||||x||x dmrClusterName|x||x||| remoteNodeName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDmrClusterLinkTest() { - String dmrClusterName = null; - DmrClusterLink body = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkResponse response = api.createDmrClusterLink(dmrClusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Link Attribute object. - * - * Create a Link Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| dmrClusterName|x||x||| remoteNodeName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDmrClusterLinkAttributeTest() { - String dmrClusterName = null; - String remoteNodeName = null; - DmrClusterLinkAttribute body = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkAttributeResponse response = api.createDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Remote Address object. - * - * Create a Remote Address object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| remoteAddress|x|x|||| remoteNodeName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDmrClusterLinkRemoteAddressTest() { - String dmrClusterName = null; - String remoteNodeName = null; - DmrClusterLinkRemoteAddress body = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkRemoteAddressResponse response = api.createDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Trusted Common Name object. - * - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||x| remoteNodeName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDmrClusterLinkTlsTrustedCommonNameTest() { - String dmrClusterName = null; - String remoteNodeName = null; - DmrClusterLinkTlsTrustedCommonName body = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkTlsTrustedCommonNameResponse response = api.createDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Domain Certificate Authority object. - * - * Create a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Certificate Authorities trusted for domain verification. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDomainCertAuthorityTest() { - DomainCertAuthority body = null; - String opaquePassword = null; - List select = null; - DomainCertAuthorityResponse response = api.createDomainCertAuthority(body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Message VPN object. - * - * Create a Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| distributedCacheManagementEnabled|||||x| msgVpnName|x|x|||| replicationBridgeAuthenticationBasicPassword||||x||x replicationBridgeAuthenticationClientCertContent||||x||x replicationBridgeAuthenticationClientCertPassword||||x|| replicationEnabledQueueBehavior||||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnTest() { - MsgVpn body = null; - String opaquePassword = null; - List select = null; - MsgVpnResponse response = api.createMsgVpn(body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an ACL Profile object. - * - * Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfileTest() { - String msgVpnName = null; - MsgVpnAclProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileResponse response = api.createMsgVpnAclProfile(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Client Connect Exception object. - * - * Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| clientConnectExceptionAddress|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfileClientConnectExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfileClientConnectException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileClientConnectExceptionResponse response = api.createMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Publish Topic Exception object. - * - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| publishExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfilePublishExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfilePublishException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfilePublishExceptionResponse response = api.createMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Publish Topic Exception object. - * - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| publishTopicException|x|x|||| publishTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfilePublishTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfilePublishTopicException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfilePublishTopicExceptionResponse response = api.createMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Subscribe Topic Exception object. - * - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| subscribeExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfileSubscribeExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfileSubscribeException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeExceptionResponse response = api.createMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Subscribe Share Name Exception object. - * - * Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeShareNameException|x|x|||| subscribeShareNameExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfileSubscribeShareNameExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfileSubscribeShareNameException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeShareNameExceptionResponse response = api.createMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Subscribe Topic Exception object. - * - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeTopicException|x|x|||| subscribeTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfileSubscribeTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfileSubscribeTopicException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeTopicExceptionResponse response = api.createMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an OAuth Profile object. - * - * Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x msgVpnName|x||x||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAuthenticationOauthProfileTest() { - String msgVpnName = null; - MsgVpnAuthenticationOauthProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResponse response = api.createMsgVpnAuthenticationOauthProfile(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Required Claim object. - * - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| msgVpnName|x||x||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAuthenticationOauthProfileClientRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - MsgVpnAuthenticationOauthProfileClientRequiredClaim body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse response = api.createMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Required Claim object. - * - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse response = api.createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an OAuth Provider object. - * - * Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x||x||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword||||x|x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAuthenticationOauthProviderTest() { - String msgVpnName = null; - MsgVpnAuthenticationOauthProvider body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProviderResponse response = api.createMsgVpnAuthenticationOauthProvider(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an Authorization Group object. - * - * Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationGroupName|x|x|||| msgVpnName|x||x||| orderAfterAuthorizationGroupName||||x|| orderBeforeAuthorizationGroupName||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAuthorizationGroupTest() { - String msgVpnName = null; - MsgVpnAuthorizationGroup body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthorizationGroupResponse response = api.createMsgVpnAuthorizationGroup(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Bridge object. - * - * Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| msgVpnName|x||x||| remoteAuthenticationBasicPassword||||x||x remoteAuthenticationClientCertContent||||x||x remoteAuthenticationClientCertPassword||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnBridgeTest() { - String msgVpnName = null; - MsgVpnBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeResponse response = api.createMsgVpnBridge(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Remote Message VPN object. - * - * Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| msgVpnName|x||x||| password||||x||x remoteMsgVpnInterface|x||||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnBridgeRemoteMsgVpnTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - MsgVpnBridgeRemoteMsgVpn body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteMsgVpnResponse response = api.createMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Remote Subscription object. - * - * Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| deliverAlwaysEnabled||x|||| msgVpnName|x||x||| remoteSubscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnBridgeRemoteSubscriptionTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - MsgVpnBridgeRemoteSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteSubscriptionResponse response = api.createMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Trusted Common Name object. - * - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||x| bridgeVirtualRouter|x||x||x| msgVpnName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnBridgeTlsTrustedCommonNameTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - MsgVpnBridgeTlsTrustedCommonName body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeTlsTrustedCommonNameResponse response = api.createMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Certificate Matching Rule object. - * - * Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnCertMatchingRuleTest() { - String msgVpnName = null; - MsgVpnCertMatchingRule body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleResponse response = api.createMsgVpnCertMatchingRule(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Certificate Matching Rule Attribute Filter object. - * - * Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: filterName|x|x|||| msgVpnName|x||x||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnCertMatchingRuleAttributeFilterTest() { - String msgVpnName = null; - String ruleName = null; - MsgVpnCertMatchingRuleAttributeFilter body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleAttributeFilterResponse response = api.createMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Certificate Matching Rule Condition object. - * - * Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnCertMatchingRuleConditionTest() { - String msgVpnName = null; - String ruleName = null; - MsgVpnCertMatchingRuleCondition body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleConditionResponse response = api.createMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Client Profile object. - * - * Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnClientProfileTest() { - String msgVpnName = null; - MsgVpnClientProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientProfileResponse response = api.createMsgVpnClientProfile(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Client Username object. - * - * Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientUsername|x|x|||| msgVpnName|x||x||| password||||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnClientUsernameTest() { - String msgVpnName = null; - MsgVpnClientUsername body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameResponse response = api.createMsgVpnClientUsername(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Client Username Attribute object. - * - * Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| clientUsername|x||x||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnClientUsernameAttributeTest() { - String msgVpnName = null; - String clientUsername = null; - MsgVpnClientUsernameAttribute body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameAttributeResponse response = api.createMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Distributed Cache object. - * - * Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheTest() { - String msgVpnName = null; - MsgVpnDistributedCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheResponse response = api.createMsgVpnDistributedCache(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Cache Cluster object. - * - * Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheClusterTest() { - String msgVpnName = null; - String cacheName = null; - MsgVpnDistributedCacheCluster body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterResponse response = api.createMsgVpnDistributedCacheCluster(msgVpnName, cacheName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Home Cache Cluster object. - * - * Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeCluster body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse response = api.createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Topic Prefix object. - * - * Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x||x||| msgVpnName|x||x||| topicPrefix|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse response = api.createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Cache Instance object. - * - * Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| instanceName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheClusterInstanceTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - MsgVpnDistributedCacheClusterInstance body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterInstanceResponse response = api.createMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Topic object. - * - * Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| msgVpnName|x||x||| topic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheClusterTopicTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - MsgVpnDistributedCacheClusterTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterTopicResponse response = api.createMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a DMR Bridge object. - * - * Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDmrBridgeTest() { - String msgVpnName = null; - MsgVpnDmrBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnDmrBridgeResponse response = api.createMsgVpnDmrBridge(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a JNDI Connection Factory object. - * - * Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: connectionFactoryName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnJndiConnectionFactoryTest() { - String msgVpnName = null; - MsgVpnJndiConnectionFactory body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiConnectionFactoryResponse response = api.createMsgVpnJndiConnectionFactory(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a JNDI Queue object. - * - * Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnJndiQueueTest() { - String msgVpnName = null; - MsgVpnJndiQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiQueueResponse response = api.createMsgVpnJndiQueue(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a JNDI Topic object. - * - * Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnJndiTopicTest() { - String msgVpnName = null; - MsgVpnJndiTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiTopicResponse response = api.createMsgVpnJndiTopic(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an MQTT Retain Cache object. - * - * Create an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnMqttRetainCacheTest() { - String msgVpnName = null; - MsgVpnMqttRetainCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttRetainCacheResponse response = api.createMsgVpnMqttRetainCache(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an MQTT Session object. - * - * Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnMqttSessionTest() { - String msgVpnName = null; - MsgVpnMqttSession body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionResponse response = api.createMsgVpnMqttSession(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Subscription object. - * - * Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x||x||| mqttSessionVirtualRouter|x||x||| msgVpnName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnMqttSessionSubscriptionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - MsgVpnMqttSessionSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionSubscriptionResponse response = api.createMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Queue object. - * - * Create a Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnQueueTest() { - String msgVpnName = null; - MsgVpnQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueResponse response = api.createMsgVpnQueue(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Queue Subscription object. - * - * Create a Queue Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnQueueSubscriptionTest() { - String msgVpnName = null; - String queueName = null; - MsgVpnQueueSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueSubscriptionResponse response = api.createMsgVpnQueueSubscription(msgVpnName, queueName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Queue Template object. - * - * Create a Queue Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnQueueTemplateTest() { - String msgVpnName = null; - MsgVpnQueueTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueTemplateResponse response = api.createMsgVpnQueueTemplate(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Replay Log object. - * - * Create a Replay Log object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnReplayLogTest() { - String msgVpnName = null; - MsgVpnReplayLog body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogResponse response = api.createMsgVpnReplayLog(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Topic Filter Subscription object. - * - * Create a Topic Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x||x||| topicFilterSubscription|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnReplayLogTopicFilterSubscriptionTest() { - String msgVpnName = null; - String replayLogName = null; - MsgVpnReplayLogTopicFilterSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogTopicFilterSubscriptionResponse response = api.createMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Replicated Topic object. - * - * Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnReplicatedTopicTest() { - String msgVpnName = null; - MsgVpnReplicatedTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplicatedTopicResponse response = api.createMsgVpnReplicatedTopic(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a REST Delivery Point object. - * - * Create a REST Delivery Point object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointTest() { - String msgVpnName = null; - MsgVpnRestDeliveryPoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointResponse response = api.createMsgVpnRestDeliveryPoint(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Queue Binding object. - * - * Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueBindingName|x|x|||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointQueueBindingTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - MsgVpnRestDeliveryPointQueueBinding body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingResponse response = api.createMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Request Header object. - * - * Create a Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: headerName|x|x|||| msgVpnName|x||x||| queueBindingName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointQueueBindingRequestHeaderTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse response = api.createMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a REST Consumer object. - * - * Create a REST Consumer object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| authenticationHttpBasicPassword||||x||x authenticationHttpHeaderValue||||x||x authenticationOauthClientSecret||||x||x authenticationOauthJwtSecretKey||||x||x msgVpnName|x||x||| restConsumerName|x|x|||| restDeliveryPointName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointRestConsumerTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - MsgVpnRestDeliveryPointRestConsumer body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerResponse response = api.createMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Claim object. - * - * Create a Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthJwtClaimName|x|x|||| oauthJwtClaimValue||x|||| restConsumerName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse response = api.createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Trusted Common Name object. - * - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||x| restConsumerName|x||x||x| restDeliveryPointName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse response = api.createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Sequenced Topic object. - * - * Create a Sequenced Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| sequencedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnSequencedTopicTest() { - String msgVpnName = null; - MsgVpnSequencedTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnSequencedTopicResponse response = api.createMsgVpnSequencedTopic(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Topic Endpoint object. - * - * Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnTopicEndpointTest() { - String msgVpnName = null; - MsgVpnTopicEndpoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointResponse response = api.createMsgVpnTopicEndpoint(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Topic Endpoint Template object. - * - * Create a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnTopicEndpointTemplateTest() { - String msgVpnName = null; - MsgVpnTopicEndpointTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointTemplateResponse response = api.createMsgVpnTopicEndpointTemplate(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an OAuth Profile object. - * - * Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createOauthProfileTest() { - OauthProfile body = null; - String opaquePassword = null; - List select = null; - OauthProfileResponse response = api.createOauthProfile(body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Group Access Level object. - * - * Create a Group Access Level object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: groupName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createOauthProfileAccessLevelGroupTest() { - String oauthProfileName = null; - OauthProfileAccessLevelGroup body = null; - String opaquePassword = null; - List select = null; - OauthProfileAccessLevelGroupResponse response = api.createOauthProfileAccessLevelGroup(oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Message VPN Access-Level Exception object. - * - * Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: groupName|x||x||| msgVpnName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String groupName = null; - OauthProfileAccessLevelGroupMsgVpnAccessLevelException body = null; - String opaquePassword = null; - List select = null; - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse response = api.createOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an Allowed Host Value object. - * - * Create an Allowed Host Value object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowedHost|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createOauthProfileClientAllowedHostTest() { - String oauthProfileName = null; - OauthProfileClientAllowedHost body = null; - String opaquePassword = null; - List select = null; - OauthProfileClientAllowedHostResponse response = api.createOauthProfileClientAllowedHost(oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an Authorization Parameter object. - * - * Create an Authorization Parameter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationParameterName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createOauthProfileClientAuthorizationParameterTest() { - String oauthProfileName = null; - OauthProfileClientAuthorizationParameter body = null; - String opaquePassword = null; - List select = null; - OauthProfileClientAuthorizationParameterResponse response = api.createOauthProfileClientAuthorizationParameter(oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Required Claim object. - * - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createOauthProfileClientRequiredClaimTest() { - String oauthProfileName = null; - OauthProfileClientRequiredClaim body = null; - String opaquePassword = null; - List select = null; - OauthProfileClientRequiredClaimResponse response = api.createOauthProfileClientRequiredClaim(oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Message VPN Access-Level Exception object. - * - * Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Default message VPN access-level exceptions. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createOauthProfileDefaultMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - OauthProfileDefaultMsgVpnAccessLevelException body = null; - String opaquePassword = null; - List select = null; - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse response = api.createOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Required Claim object. - * - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createOauthProfileResourceServerRequiredClaimTest() { - String oauthProfileName = null; - OauthProfileResourceServerRequiredClaim body = null; - String opaquePassword = null; - List select = null; - OauthProfileResourceServerRequiredClaimResponse response = api.createOauthProfileResourceServerRequiredClaim(oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Virtual Hostname object. - * - * Create a Virtual Hostname object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: virtualHostname|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createVirtualHostnameTest() { - VirtualHostname body = null; - String opaquePassword = null; - List select = null; - VirtualHostnameResponse response = api.createVirtualHostname(body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Certificate Authority object. - * - * Delete a Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteCertAuthorityTest() { - String certAuthorityName = null; - SempMetaOnlyResponse response = api.deleteCertAuthority(certAuthorityName); - - // TODO: test validations - } - - /** - * Delete an OCSP Responder Trusted Common Name object. - * - * Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteCertAuthorityOcspTlsTrustedCommonNameTest() { - String certAuthorityName = null; - String ocspTlsTrustedCommonName = null; - SempMetaOnlyResponse response = api.deleteCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName); - - // TODO: test validations - } - - /** - * Delete a Client Certificate Authority object. - * - * Delete a Client Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteClientCertAuthorityTest() { - String certAuthorityName = null; - SempMetaOnlyResponse response = api.deleteClientCertAuthority(certAuthorityName); - - // TODO: test validations - } - - /** - * Delete an OCSP Responder Trusted Common Name object. - * - * Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteClientCertAuthorityOcspTlsTrustedCommonNameTest() { - String certAuthorityName = null; - String ocspTlsTrustedCommonName = null; - SempMetaOnlyResponse response = api.deleteClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName); - - // TODO: test validations - } - - /** - * Delete a Cluster object. - * - * Delete a Cluster object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDmrClusterTest() { - String dmrClusterName = null; - SempMetaOnlyResponse response = api.deleteDmrCluster(dmrClusterName); - - // TODO: test validations - } - - /** - * Delete a Certificate Matching Rule object. - * - * Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDmrClusterCertMatchingRuleTest() { - String dmrClusterName = null; - String ruleName = null; - SempMetaOnlyResponse response = api.deleteDmrClusterCertMatchingRule(dmrClusterName, ruleName); - - // TODO: test validations - } - - /** - * Delete a Certificate Matching Rule Attribute Filter object. - * - * Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Attribute Filter compares a link attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDmrClusterCertMatchingRuleAttributeFilterTest() { - String dmrClusterName = null; - String ruleName = null; - String filterName = null; - SempMetaOnlyResponse response = api.deleteDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName); - - // TODO: test validations - } - - /** - * Delete a Certificate Matching Rule Condition object. - * - * Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDmrClusterCertMatchingRuleConditionTest() { - String dmrClusterName = null; - String ruleName = null; - String source = null; - SempMetaOnlyResponse response = api.deleteDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, source); - - // TODO: test validations - } - - /** - * Delete a Link object. - * - * Delete a Link object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDmrClusterLinkTest() { - String dmrClusterName = null; - String remoteNodeName = null; - SempMetaOnlyResponse response = api.deleteDmrClusterLink(dmrClusterName, remoteNodeName); - - // TODO: test validations - } - - /** - * Delete a Link Attribute object. - * - * Delete a Link Attribute object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDmrClusterLinkAttributeTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String attributeName = null; - String attributeValue = null; - SempMetaOnlyResponse response = api.deleteDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, attributeName, attributeValue); - - // TODO: test validations - } - - /** - * Delete a Remote Address object. - * - * Delete a Remote Address object. The deletion of instances of this object are synchronized to HA mates via config-sync. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDmrClusterLinkRemoteAddressTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String remoteAddress = null; - SempMetaOnlyResponse response = api.deleteDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, remoteAddress); - - // TODO: test validations - } - - /** - * Delete a Trusted Common Name object. - * - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDmrClusterLinkTlsTrustedCommonNameTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String tlsTrustedCommonName = null; - SempMetaOnlyResponse response = api.deleteDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, tlsTrustedCommonName); - - // TODO: test validations - } - - /** - * Delete a Domain Certificate Authority object. - * - * Delete a Domain Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Certificate Authorities trusted for domain verification. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDomainCertAuthorityTest() { - String certAuthorityName = null; - SempMetaOnlyResponse response = api.deleteDomainCertAuthority(certAuthorityName); - - // TODO: test validations - } - - /** - * Delete a Message VPN object. - * - * Delete a Message VPN object. The deletion of instances of this object are synchronized to HA mates via config-sync. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnTest() { - String msgVpnName = null; - SempMetaOnlyResponse response = api.deleteMsgVpn(msgVpnName); - - // TODO: test validations - } - - /** - * Delete an ACL Profile object. - * - * Delete an ACL Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfileTest() { - String msgVpnName = null; - String aclProfileName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfile(msgVpnName, aclProfileName); - - // TODO: test validations - } - - /** - * Delete a Client Connect Exception object. - * - * Delete a Client Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfileClientConnectExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String clientConnectExceptionAddress = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress); - - // TODO: test validations - } - - /** - * Delete a Publish Topic Exception object. - * - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfilePublishExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String topicSyntax = null; - String publishExceptionTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic); - - // TODO: test validations - } - - /** - * Delete a Publish Topic Exception object. - * - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfilePublishTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String publishTopicExceptionSyntax = null; - String publishTopicException = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException); - - // TODO: test validations - } - - /** - * Delete a Subscribe Topic Exception object. - * - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfileSubscribeExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String topicSyntax = null; - String subscribeExceptionTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic); - - // TODO: test validations - } - - /** - * Delete a Subscribe Share Name Exception object. - * - * Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfileSubscribeShareNameExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String subscribeShareNameExceptionSyntax = null; - String subscribeShareNameException = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException); - - // TODO: test validations - } - - /** - * Delete a Subscribe Topic Exception object. - * - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfileSubscribeTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String subscribeTopicExceptionSyntax = null; - String subscribeTopicException = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException); - - // TODO: test validations - } - - /** - * Delete an OAuth Profile object. - * - * Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAuthenticationOauthProfileTest() { - String msgVpnName = null; - String oauthProfileName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName); - - // TODO: test validations - } - - /** - * Delete a Required Claim object. - * - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAuthenticationOauthProfileClientRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - String clientRequiredClaimName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName); - - // TODO: test validations - } - - /** - * Delete a Required Claim object. - * - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - String resourceServerRequiredClaimName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName); - - // TODO: test validations - } - - /** - * Delete an OAuth Provider object. - * - * Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAuthenticationOauthProviderTest() { - String msgVpnName = null; - String oauthProviderName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName); - - // TODO: test validations - } - - /** - * Delete an Authorization Group object. - * - * Delete an Authorization Group object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAuthorizationGroupTest() { - String msgVpnName = null; - String authorizationGroupName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName); - - // TODO: test validations - } - - /** - * Delete a Bridge object. - * - * Delete a Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnBridgeTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - SempMetaOnlyResponse response = api.deleteMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter); - - // TODO: test validations - } - - /** - * Delete a Remote Message VPN object. - * - * Delete a Remote Message VPN object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnBridgeRemoteMsgVpnTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteMsgVpnName = null; - String remoteMsgVpnLocation = null; - String remoteMsgVpnInterface = null; - SempMetaOnlyResponse response = api.deleteMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface); - - // TODO: test validations - } - - /** - * Delete a Remote Subscription object. - * - * Delete a Remote Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnBridgeRemoteSubscriptionTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteSubscriptionTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic); - - // TODO: test validations - } - - /** - * Delete a Trusted Common Name object. - * - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnBridgeTlsTrustedCommonNameTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String tlsTrustedCommonName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName); - - // TODO: test validations - } - - /** - * Delete a Certificate Matching Rule object. - * - * Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnCertMatchingRuleTest() { - String msgVpnName = null; - String ruleName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnCertMatchingRule(msgVpnName, ruleName); - - // TODO: test validations - } - - /** - * Delete a Certificate Matching Rule Attribute Filter object. - * - * Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnCertMatchingRuleAttributeFilterTest() { - String msgVpnName = null; - String ruleName = null; - String filterName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName); - - // TODO: test validations - } - - /** - * Delete a Certificate Matching Rule Condition object. - * - * Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnCertMatchingRuleConditionTest() { - String msgVpnName = null; - String ruleName = null; - String source = null; - SempMetaOnlyResponse response = api.deleteMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source); - - // TODO: test validations - } - - /** - * Delete a Client Profile object. - * - * Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnClientProfileTest() { - String msgVpnName = null; - String clientProfileName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnClientProfile(msgVpnName, clientProfileName); - - // TODO: test validations - } - - /** - * Delete a Client Username object. - * - * Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnClientUsernameTest() { - String msgVpnName = null; - String clientUsername = null; - SempMetaOnlyResponse response = api.deleteMsgVpnClientUsername(msgVpnName, clientUsername); - - // TODO: test validations - } - - /** - * Delete a Client Username Attribute object. - * - * Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnClientUsernameAttributeTest() { - String msgVpnName = null; - String clientUsername = null; - String attributeName = null; - String attributeValue = null; - SempMetaOnlyResponse response = api.deleteMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue); - - // TODO: test validations - } - - /** - * Delete a Distributed Cache object. - * - * Delete a Distributed Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheTest() { - String msgVpnName = null; - String cacheName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCache(msgVpnName, cacheName); - - // TODO: test validations - } - - /** - * Delete a Cache Cluster object. - * - * Delete a Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName); - - // TODO: test validations - } - - /** - * Delete a Home Cache Cluster object. - * - * Delete a Home Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName); - - // TODO: test validations - } - - /** - * Delete a Topic Prefix object. - * - * Delete a Topic Prefix object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - String topicPrefix = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix); - - // TODO: test validations - } - - /** - * Delete a Cache Instance object. - * - * Delete a Cache Instance object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheClusterInstanceTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String instanceName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName); - - // TODO: test validations - } - - /** - * Delete a Topic object. - * - * Delete a Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheClusterTopicTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String topic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic); - - // TODO: test validations - } - - /** - * Delete a DMR Bridge object. - * - * Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDmrBridgeTest() { - String msgVpnName = null; - String remoteNodeName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDmrBridge(msgVpnName, remoteNodeName); - - // TODO: test validations - } - - /** - * Delete a JNDI Connection Factory object. - * - * Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnJndiConnectionFactoryTest() { - String msgVpnName = null; - String connectionFactoryName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName); - - // TODO: test validations - } - - /** - * Delete a JNDI Queue object. - * - * Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnJndiQueueTest() { - String msgVpnName = null; - String queueName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnJndiQueue(msgVpnName, queueName); - - // TODO: test validations - } - - /** - * Delete a JNDI Topic object. - * - * Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnJndiTopicTest() { - String msgVpnName = null; - String topicName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnJndiTopic(msgVpnName, topicName); - - // TODO: test validations - } - - /** - * Delete an MQTT Retain Cache object. - * - * Delete an MQTT Retain Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnMqttRetainCacheTest() { - String msgVpnName = null; - String cacheName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnMqttRetainCache(msgVpnName, cacheName); - - // TODO: test validations - } - - /** - * Delete an MQTT Session object. - * - * Delete an MQTT Session object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnMqttSessionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - SempMetaOnlyResponse response = api.deleteMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter); - - // TODO: test validations - } - - /** - * Delete a Subscription object. - * - * Delete a Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnMqttSessionSubscriptionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - String subscriptionTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic); - - // TODO: test validations - } - - /** - * Delete a Queue object. - * - * Delete a Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnQueueTest() { - String msgVpnName = null; - String queueName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnQueue(msgVpnName, queueName); - - // TODO: test validations - } - - /** - * Delete a Queue Subscription object. - * - * Delete a Queue Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnQueueSubscriptionTest() { - String msgVpnName = null; - String queueName = null; - String subscriptionTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic); - - // TODO: test validations - } - - /** - * Delete a Queue Template object. - * - * Delete a Queue Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnQueueTemplateTest() { - String msgVpnName = null; - String queueTemplateName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnQueueTemplate(msgVpnName, queueTemplateName); - - // TODO: test validations - } - - /** - * Delete a Replay Log object. - * - * Delete a Replay Log object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnReplayLogTest() { - String msgVpnName = null; - String replayLogName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnReplayLog(msgVpnName, replayLogName); - - // TODO: test validations - } - - /** - * Delete a Topic Filter Subscription object. - * - * Delete a Topic Filter Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnReplayLogTopicFilterSubscriptionTest() { - String msgVpnName = null; - String replayLogName = null; - String topicFilterSubscription = null; - SempMetaOnlyResponse response = api.deleteMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription); - - // TODO: test validations - } - - /** - * Delete a Replicated Topic object. - * - * Delete a Replicated Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnReplicatedTopicTest() { - String msgVpnName = null; - String replicatedTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnReplicatedTopic(msgVpnName, replicatedTopic); - - // TODO: test validations - } - - /** - * Delete a REST Delivery Point object. - * - * Delete a REST Delivery Point object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName); - - // TODO: test validations - } - - /** - * Delete a Queue Binding object. - * - * Delete a Queue Binding object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointQueueBindingTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName); - - // TODO: test validations - } - - /** - * Delete a Request Header object. - * - * Delete a Request Header object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointQueueBindingRequestHeaderTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - String headerName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName); - - // TODO: test validations - } - - /** - * Delete a REST Consumer object. - * - * Delete a REST Consumer object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointRestConsumerTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName); - - // TODO: test validations - } - - /** - * Delete a Claim object. - * - * Delete a Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String oauthJwtClaimName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName); - - // TODO: test validations - } - - /** - * Delete a Trusted Common Name object. - * - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String tlsTrustedCommonName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName); - - // TODO: test validations - } - - /** - * Delete a Sequenced Topic object. - * - * Delete a Sequenced Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnSequencedTopicTest() { - String msgVpnName = null; - String sequencedTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnSequencedTopic(msgVpnName, sequencedTopic); - - // TODO: test validations - } - - /** - * Delete a Topic Endpoint object. - * - * Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnTopicEndpointTest() { - String msgVpnName = null; - String topicEndpointName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnTopicEndpoint(msgVpnName, topicEndpointName); - - // TODO: test validations - } - - /** - * Delete a Topic Endpoint Template object. - * - * Delete a Topic Endpoint Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnTopicEndpointTemplateTest() { - String msgVpnName = null; - String topicEndpointTemplateName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName); - - // TODO: test validations - } - - /** - * Delete an OAuth Profile object. - * - * Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteOauthProfileTest() { - String oauthProfileName = null; - SempMetaOnlyResponse response = api.deleteOauthProfile(oauthProfileName); - - // TODO: test validations - } - - /** - * Delete a Group Access Level object. - * - * Delete a Group Access Level object. The deletion of instances of this object are synchronized to HA mates via config-sync. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteOauthProfileAccessLevelGroupTest() { - String oauthProfileName = null; - String groupName = null; - SempMetaOnlyResponse response = api.deleteOauthProfileAccessLevelGroup(oauthProfileName, groupName); - - // TODO: test validations - } - - /** - * Delete a Message VPN Access-Level Exception object. - * - * Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. Message VPN access-level exceptions for members of this group. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String groupName = null; - String msgVpnName = null; - SempMetaOnlyResponse response = api.deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName); - - // TODO: test validations - } - - /** - * Delete an Allowed Host Value object. - * - * Delete an Allowed Host Value object. The deletion of instances of this object are synchronized to HA mates via config-sync. A valid hostname for this broker in OAuth redirects. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteOauthProfileClientAllowedHostTest() { - String oauthProfileName = null; - String allowedHost = null; - SempMetaOnlyResponse response = api.deleteOauthProfileClientAllowedHost(oauthProfileName, allowedHost); - - // TODO: test validations - } - - /** - * Delete an Authorization Parameter object. - * - * Delete an Authorization Parameter object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional parameters to be passed to the OAuth authorization endpoint. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteOauthProfileClientAuthorizationParameterTest() { - String oauthProfileName = null; - String authorizationParameterName = null; - SempMetaOnlyResponse response = api.deleteOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName); - - // TODO: test validations - } - - /** - * Delete a Required Claim object. - * - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteOauthProfileClientRequiredClaimTest() { - String oauthProfileName = null; - String clientRequiredClaimName = null; - SempMetaOnlyResponse response = api.deleteOauthProfileClientRequiredClaim(oauthProfileName, clientRequiredClaimName); - - // TODO: test validations - } - - /** - * Delete a Message VPN Access-Level Exception object. - * - * Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. Default message VPN access-level exceptions. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteOauthProfileDefaultMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String msgVpnName = null; - SempMetaOnlyResponse response = api.deleteOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName); - - // TODO: test validations - } - - /** - * Delete a Required Claim object. - * - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteOauthProfileResourceServerRequiredClaimTest() { - String oauthProfileName = null; - String resourceServerRequiredClaimName = null; - SempMetaOnlyResponse response = api.deleteOauthProfileResourceServerRequiredClaim(oauthProfileName, resourceServerRequiredClaimName); - - // TODO: test validations - } - - /** - * Delete a Virtual Hostname object. - * - * Delete a Virtual Hostname object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteVirtualHostnameTest() { - String virtualHostname = null; - SempMetaOnlyResponse response = api.deleteVirtualHostname(virtualHostname); - - // TODO: test validations - } - - /** - * Get an About object. - * - * Get an About object. This provides metadata about the SEMP API, such as the version of the API supported by the broker. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.13. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getAboutTest() { - String opaquePassword = null; - List select = null; - AboutResponse response = api.getAbout(opaquePassword, select); - - // TODO: test validations - } - - /** - * Get an API Description object. - * - * Get an API Description object. The API Description object provides metadata about the SEMP API. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getAboutApiTest() { - String opaquePassword = null; - List select = null; - AboutApiResponse response = api.getAboutApi(opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a User object. - * - * Get a User object. Session and access level information about the user accessing the SEMP API. A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getAboutUserTest() { - String opaquePassword = null; - List select = null; - AboutUserResponse response = api.getAboutUser(opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a User Message VPN object. - * - * Get a User Message VPN object. This provides information about the Message VPN access level for the username used to access the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getAboutUserMsgVpnTest() { - String msgVpnName = null; - String opaquePassword = null; - List select = null; - AboutUserMsgVpnResponse response = api.getAboutUserMsgVpn(msgVpnName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of User Message VPN objects. - * - * Get a list of User Message VPN objects. This provides information about the Message VPN access level for the username used to access the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getAboutUserMsgVpnsTest() { - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - AboutUserMsgVpnsResponse response = api.getAboutUserMsgVpns(count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Broker object. - * - * Get a Broker object. This object contains global configuration for the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: tlsServerCertContent||x||x tlsServerCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: configSyncAuthenticationClientCertMaxChainDepth|global/read-only configSyncAuthenticationClientCertValidateDateEnabled|global/read-only configSyncClientProfileTcpInitialCongestionWindow|global/read-only configSyncClientProfileTcpKeepaliveCount|global/read-only configSyncClientProfileTcpKeepaliveIdle|global/read-only configSyncClientProfileTcpKeepaliveInterval|global/read-only configSyncClientProfileTcpMaxWindow|global/read-only configSyncClientProfileTcpMss|global/read-only configSyncEnabled|global/read-only configSyncSynchronizeUsernameEnabled|global/read-only configSyncTlsEnabled|global/read-only guaranteedMsgingDefragmentationScheduleDayList|global/read-only guaranteedMsgingDefragmentationScheduleEnabled|global/read-only guaranteedMsgingDefragmentationScheduleTimeList|global/read-only guaranteedMsgingDefragmentationThresholdEnabled|global/read-only guaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-only guaranteedMsgingDefragmentationThresholdMinInterval|global/read-only guaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-only guaranteedMsgingEnabled|global/read-only guaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-only guaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-only guaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-only guaranteedMsgingEventCacheUsageThreshold.setValue|global/read-only guaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-only guaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-only guaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-only guaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-only guaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-only guaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-only guaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-only guaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-only guaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-only guaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-only guaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-only guaranteedMsgingEventEndpointCountThreshold.setValue|global/read-only guaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-only guaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-only guaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-only guaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-only guaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-only guaranteedMsgingEventMsgCountThreshold.setPercent|global/read-only guaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-only guaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-only guaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-only guaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-only guaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-only guaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-only guaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-only guaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-only guaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-only guaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-only guaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-only guaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-only guaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-only guaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-only guaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-only guaranteedMsgingEventTransactionCountThreshold.setValue|global/read-only guaranteedMsgingMaxCacheUsage|global/read-only guaranteedMsgingMaxMsgSpoolUsage|global/read-only guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-only guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-only guaranteedMsgingTransactionReplicationCompatibilityMode|global/read-only oauthProfileDefault|global/read-only serviceAmqpEnabled|global/read-only serviceAmqpTlsListenPort|global/read-only serviceEventConnectionCountThreshold.clearPercent|global/read-only serviceEventConnectionCountThreshold.clearValue|global/read-only serviceEventConnectionCountThreshold.setPercent|global/read-only serviceEventConnectionCountThreshold.setValue|global/read-only serviceHealthCheckEnabled|global/read-only serviceHealthCheckListenPort|global/read-only serviceMateLinkEnabled|global/read-only serviceMateLinkListenPort|global/read-only serviceMqttEnabled|global/read-only serviceMsgBackboneEnabled|global/read-only serviceRedundancyEnabled|global/read-only serviceRedundancyFirstListenPort|global/read-only serviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-only serviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-only serviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-only serviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-only serviceRestIncomingEnabled|global/read-only serviceRestOutgoingEnabled|global/read-only serviceSempCorsAllowAnyHostEnabled|global/read-only serviceSempLegacyTimeoutEnabled|global/read-only serviceSempPlainTextEnabled|global/read-only serviceSempPlainTextListenPort|global/read-only serviceSempSessionIdleTimeout|global/read-only serviceSempSessionMaxLifetime|global/read-only serviceSempTlsEnabled|global/read-only serviceSempTlsListenPort|global/read-only serviceSmfCompressionListenPort|global/read-only serviceSmfEnabled|global/read-only serviceSmfEventConnectionCountThreshold.clearPercent|global/read-only serviceSmfEventConnectionCountThreshold.clearValue|global/read-only serviceSmfEventConnectionCountThreshold.setPercent|global/read-only serviceSmfEventConnectionCountThreshold.setValue|global/read-only serviceSmfPlainTextListenPort|global/read-only serviceSmfRoutingControlListenPort|global/read-only serviceSmfTlsListenPort|global/read-only serviceTlsEventConnectionCountThreshold.clearPercent|global/read-only serviceTlsEventConnectionCountThreshold.clearValue|global/read-only serviceTlsEventConnectionCountThreshold.setPercent|global/read-only serviceTlsEventConnectionCountThreshold.setValue|global/read-only serviceWebTransportEnabled|global/read-only serviceWebTransportPlainTextListenPort|global/read-only serviceWebTransportTlsListenPort|global/read-only serviceWebTransportWebUrlSuffix|global/read-only tlsBlockVersion11Enabled|global/read-only tlsCipherSuiteManagementList|global/read-only tlsCipherSuiteMsgBackboneList|global/read-only tlsCipherSuiteSecureShellList|global/read-only tlsCrimeExploitProtectionEnabled|global/read-only tlsServerCertContent|global/read-only tlsStandardDomainCertificateAuthoritiesEnabled|vpn/read-only tlsTicketLifetime|global/read-only webManagerAllowUnencryptedWizardsEnabled|vpn/read-only webManagerCustomization|vpn/read-only webManagerRedirectHttpEnabled|vpn/read-only webManagerRedirectHttpOverrideTlsPort|vpn/read-only This has been available since 2.13. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getBrokerTest() { - String opaquePassword = null; - List select = null; - BrokerResponse response = api.getBroker(opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Certificate Authority objects. - * - * Get a list of Certificate Authority objects. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| certContent|||x| crlDayList|||x| crlTimeList|||x| crlUrl|||x| ocspNonResponderCertEnabled|||x| ocspOverrideUrl|||x| ocspTimeout|||x| revocationCheckEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getCertAuthoritiesTest() { - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - CertAuthoritiesResponse response = api.getCertAuthorities(count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Certificate Authority object. - * - * Get a Certificate Authority object. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| certContent|||x| crlDayList|||x| crlTimeList|||x| crlUrl|||x| ocspNonResponderCertEnabled|||x| ocspOverrideUrl|||x| ocspTimeout|||x| revocationCheckEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getCertAuthorityTest() { - String certAuthorityName = null; - String opaquePassword = null; - List select = null; - CertAuthorityResponse response = api.getCertAuthority(certAuthorityName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get an OCSP Responder Trusted Common Name object. - * - * Get an OCSP Responder Trusted Common Name object. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| ocspTlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getCertAuthorityOcspTlsTrustedCommonNameTest() { - String certAuthorityName = null; - String ocspTlsTrustedCommonName = null; - String opaquePassword = null; - List select = null; - CertAuthorityOcspTlsTrustedCommonNameResponse response = api.getCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of OCSP Responder Trusted Common Name objects. - * - * Get a list of OCSP Responder Trusted Common Name objects. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| ocspTlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getCertAuthorityOcspTlsTrustedCommonNamesTest() { - String certAuthorityName = null; - String opaquePassword = null; - List where = null; - List select = null; - CertAuthorityOcspTlsTrustedCommonNamesResponse response = api.getCertAuthorityOcspTlsTrustedCommonNames(certAuthorityName, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Client Certificate Authority objects. - * - * Get a list of Client Certificate Authority objects. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getClientCertAuthoritiesTest() { - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - ClientCertAuthoritiesResponse response = api.getClientCertAuthorities(count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Client Certificate Authority object. - * - * Get a Client Certificate Authority object. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getClientCertAuthorityTest() { - String certAuthorityName = null; - String opaquePassword = null; - List select = null; - ClientCertAuthorityResponse response = api.getClientCertAuthority(certAuthorityName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get an OCSP Responder Trusted Common Name object. - * - * Get an OCSP Responder Trusted Common Name object. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| ocspTlsTrustedCommonName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getClientCertAuthorityOcspTlsTrustedCommonNameTest() { - String certAuthorityName = null; - String ocspTlsTrustedCommonName = null; - String opaquePassword = null; - List select = null; - ClientCertAuthorityOcspTlsTrustedCommonNameResponse response = api.getClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of OCSP Responder Trusted Common Name objects. - * - * Get a list of OCSP Responder Trusted Common Name objects. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| ocspTlsTrustedCommonName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getClientCertAuthorityOcspTlsTrustedCommonNamesTest() { - String certAuthorityName = null; - String opaquePassword = null; - List where = null; - List select = null; - ClientCertAuthorityOcspTlsTrustedCommonNamesResponse response = api.getClientCertAuthorityOcspTlsTrustedCommonNames(certAuthorityName, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Cluster object. - * - * Get a Cluster object. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| dmrClusterName|x||| tlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterTest() { - String dmrClusterName = null; - String opaquePassword = null; - List select = null; - DmrClusterResponse response = api.getDmrCluster(dmrClusterName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Certificate Matching Rule object. - * - * Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterCertMatchingRuleTest() { - String dmrClusterName = null; - String ruleName = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleResponse response = api.getDmrClusterCertMatchingRule(dmrClusterName, ruleName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Certificate Matching Rule Attribute Filter object. - * - * Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| filterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterCertMatchingRuleAttributeFilterTest() { - String dmrClusterName = null; - String ruleName = null; - String filterName = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleAttributeFilterResponse response = api.getDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Certificate Matching Rule Attribute Filter objects. - * - * Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| filterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterCertMatchingRuleAttributeFiltersTest() { - String dmrClusterName = null; - String ruleName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - DmrClusterCertMatchingRuleAttributeFiltersResponse response = api.getDmrClusterCertMatchingRuleAttributeFilters(dmrClusterName, ruleName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Certificate Matching Rule Condition object. - * - * Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterCertMatchingRuleConditionTest() { - String dmrClusterName = null; - String ruleName = null; - String source = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleConditionResponse response = api.getDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, source, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Certificate Matching Rule Condition objects. - * - * Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterCertMatchingRuleConditionsTest() { - String dmrClusterName = null; - String ruleName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - DmrClusterCertMatchingRuleConditionsResponse response = api.getDmrClusterCertMatchingRuleConditions(dmrClusterName, ruleName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Certificate Matching Rule objects. - * - * Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterCertMatchingRulesTest() { - String dmrClusterName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - DmrClusterCertMatchingRulesResponse response = api.getDmrClusterCertMatchingRules(dmrClusterName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Link object. - * - * Get a Link object. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterLinkTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkResponse response = api.getDmrClusterLink(dmrClusterName, remoteNodeName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Link Attribute object. - * - * Get a Link Attribute object. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterLinkAttributeTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String attributeName = null; - String attributeValue = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkAttributeResponse response = api.getDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, attributeName, attributeValue, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Link Attribute objects. - * - * Get a list of Link Attribute objects. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterLinkAttributesTest() { - String dmrClusterName = null; - String remoteNodeName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - DmrClusterLinkAttributesResponse response = api.getDmrClusterLinkAttributes(dmrClusterName, remoteNodeName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Remote Address object. - * - * Get a Remote Address object. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| remoteAddress|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterLinkRemoteAddressTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String remoteAddress = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkRemoteAddressResponse response = api.getDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, remoteAddress, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Remote Address objects. - * - * Get a list of Remote Address objects. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| remoteAddress|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterLinkRemoteAddressesTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String opaquePassword = null; - List where = null; - List select = null; - DmrClusterLinkRemoteAddressesResponse response = api.getDmrClusterLinkRemoteAddresses(dmrClusterName, remoteNodeName, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Trusted Common Name object. - * - * Get a Trusted Common Name object. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||x| remoteNodeName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterLinkTlsTrustedCommonNameTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String tlsTrustedCommonName = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkTlsTrustedCommonNameResponse response = api.getDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, tlsTrustedCommonName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Trusted Common Name objects. - * - * Get a list of Trusted Common Name objects. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||x| remoteNodeName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterLinkTlsTrustedCommonNamesTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String opaquePassword = null; - List where = null; - List select = null; - DmrClusterLinkTlsTrustedCommonNamesResponse response = api.getDmrClusterLinkTlsTrustedCommonNames(dmrClusterName, remoteNodeName, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Link objects. - * - * Get a list of Link objects. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterLinksTest() { - String dmrClusterName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - DmrClusterLinksResponse response = api.getDmrClusterLinks(dmrClusterName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Cluster objects. - * - * Get a list of Cluster objects. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| dmrClusterName|x||| tlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClustersTest() { - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - DmrClustersResponse response = api.getDmrClusters(count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Domain Certificate Authority objects. - * - * Get a list of Domain Certificate Authority objects. Certificate Authorities trusted for domain verification. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDomainCertAuthoritiesTest() { - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - DomainCertAuthoritiesResponse response = api.getDomainCertAuthorities(count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Domain Certificate Authority object. - * - * Get a Domain Certificate Authority object. Certificate Authorities trusted for domain verification. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDomainCertAuthorityTest() { - String certAuthorityName = null; - String opaquePassword = null; - List select = null; - DomainCertAuthorityResponse response = api.getDomainCertAuthority(certAuthorityName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Message VPN object. - * - * Get a Message VPN object. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| distributedCacheManagementEnabled|||x| msgVpnName|x||| replicationBridgeAuthenticationBasicPassword||x||x replicationBridgeAuthenticationClientCertContent||x||x replicationBridgeAuthenticationClientCertPassword||x|| replicationEnabledQueueBehavior||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnTest() { - String msgVpnName = null; - String opaquePassword = null; - List select = null; - MsgVpnResponse response = api.getMsgVpn(msgVpnName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get an ACL Profile object. - * - * Get an ACL Profile object. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileTest() { - String msgVpnName = null; - String aclProfileName = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileResponse response = api.getMsgVpnAclProfile(msgVpnName, aclProfileName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Client Connect Exception object. - * - * Get a Client Connect Exception object. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileClientConnectExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String clientConnectExceptionAddress = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileClientConnectExceptionResponse response = api.getMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Client Connect Exception objects. - * - * Get a list of Client Connect Exception objects. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileClientConnectExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfileClientConnectExceptionsResponse response = api.getMsgVpnAclProfileClientConnectExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Publish Topic Exception object. - * - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfilePublishExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String topicSyntax = null; - String publishExceptionTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfilePublishExceptionResponse response = api.getMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Publish Topic Exception objects. - * - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfilePublishExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfilePublishExceptionsResponse response = api.getMsgVpnAclProfilePublishExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Publish Topic Exception object. - * - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfilePublishTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String publishTopicExceptionSyntax = null; - String publishTopicException = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfilePublishTopicExceptionResponse response = api.getMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Publish Topic Exception objects. - * - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfilePublishTopicExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfilePublishTopicExceptionsResponse response = api.getMsgVpnAclProfilePublishTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Subscribe Topic Exception object. - * - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String topicSyntax = null; - String subscribeExceptionTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeExceptionResponse response = api.getMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Subscribe Topic Exception objects. - * - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfileSubscribeExceptionsResponse response = api.getMsgVpnAclProfileSubscribeExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Subscribe Share Name Exception object. - * - * Get a Subscribe Share Name Exception object. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeShareNameExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String subscribeShareNameExceptionSyntax = null; - String subscribeShareNameException = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeShareNameExceptionResponse response = api.getMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Subscribe Share Name Exception objects. - * - * Get a list of Subscribe Share Name Exception objects. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeShareNameExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfileSubscribeShareNameExceptionsResponse response = api.getMsgVpnAclProfileSubscribeShareNameExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Subscribe Topic Exception object. - * - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String subscribeTopicExceptionSyntax = null; - String subscribeTopicException = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeTopicExceptionResponse response = api.getMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Subscribe Topic Exception objects. - * - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeTopicExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfileSubscribeTopicExceptionsResponse response = api.getMsgVpnAclProfileSubscribeTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of ACL Profile objects. - * - * Get a list of ACL Profile objects. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfilesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfilesResponse response = api.getMsgVpnAclProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get an OAuth Profile object. - * - * Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfileTest() { - String msgVpnName = null; - String oauthProfileName = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResponse response = api.getMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Required Claim object. - * - * Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfileClientRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - String clientRequiredClaimName = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse response = api.getMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Required Claim objects. - * - * Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfileClientRequiredClaimsTest() { - String msgVpnName = null; - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse response = api.getMsgVpnAuthenticationOauthProfileClientRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Required Claim object. - * - * Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - String resourceServerRequiredClaimName = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse response = api.getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Required Claim objects. - * - * Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsTest() { - String msgVpnName = null; - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse response = api.getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of OAuth Profile objects. - * - * Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfilesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAuthenticationOauthProfilesResponse response = api.getMsgVpnAuthenticationOauthProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get an OAuth Provider object. - * - * Get an OAuth Provider object. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProviderTest() { - String msgVpnName = null; - String oauthProviderName = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProviderResponse response = api.getMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of OAuth Provider objects. - * - * Get a list of OAuth Provider objects. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProvidersTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAuthenticationOauthProvidersResponse response = api.getMsgVpnAuthenticationOauthProviders(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get an Authorization Group object. - * - * Get an Authorization Group object. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthorizationGroupTest() { - String msgVpnName = null; - String authorizationGroupName = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthorizationGroupResponse response = api.getMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Authorization Group objects. - * - * Get a list of Authorization Group objects. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthorizationGroupsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAuthorizationGroupsResponse response = api.getMsgVpnAuthorizationGroups(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Bridge object. - * - * Get a Bridge object. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeResponse response = api.getMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Remote Message VPN object. - * - * Get a Remote Message VPN object. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeRemoteMsgVpnTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteMsgVpnName = null; - String remoteMsgVpnLocation = null; - String remoteMsgVpnInterface = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteMsgVpnResponse response = api.getMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Remote Message VPN objects. - * - * Get a list of Remote Message VPN objects. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeRemoteMsgVpnsTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnBridgeRemoteMsgVpnsResponse response = api.getMsgVpnBridgeRemoteMsgVpns(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Remote Subscription object. - * - * Get a Remote Subscription object. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeRemoteSubscriptionTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteSubscriptionTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteSubscriptionResponse response = api.getMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Remote Subscription objects. - * - * Get a list of Remote Subscription objects. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeRemoteSubscriptionsTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnBridgeRemoteSubscriptionsResponse response = api.getMsgVpnBridgeRemoteSubscriptions(msgVpnName, bridgeName, bridgeVirtualRouter, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Trusted Common Name object. - * - * Get a Trusted Common Name object. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeTlsTrustedCommonNameTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String tlsTrustedCommonName = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeTlsTrustedCommonNameResponse response = api.getMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Trusted Common Name objects. - * - * Get a list of Trusted Common Name objects. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeTlsTrustedCommonNamesTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnBridgeTlsTrustedCommonNamesResponse response = api.getMsgVpnBridgeTlsTrustedCommonNames(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Bridge objects. - * - * Get a list of Bridge objects. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnBridgesResponse response = api.getMsgVpnBridges(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Certificate Matching Rule object. - * - * Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRuleTest() { - String msgVpnName = null; - String ruleName = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleResponse response = api.getMsgVpnCertMatchingRule(msgVpnName, ruleName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Certificate Matching Rule Attribute Filter object. - * - * Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRuleAttributeFilterTest() { - String msgVpnName = null; - String ruleName = null; - String filterName = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleAttributeFilterResponse response = api.getMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Certificate Matching Rule Attribute Filter objects. - * - * Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRuleAttributeFiltersTest() { - String msgVpnName = null; - String ruleName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnCertMatchingRuleAttributeFiltersResponse response = api.getMsgVpnCertMatchingRuleAttributeFilters(msgVpnName, ruleName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Certificate Matching Rule Condition object. - * - * Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRuleConditionTest() { - String msgVpnName = null; - String ruleName = null; - String source = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleConditionResponse response = api.getMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Certificate Matching Rule Condition objects. - * - * Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRuleConditionsTest() { - String msgVpnName = null; - String ruleName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnCertMatchingRuleConditionsResponse response = api.getMsgVpnCertMatchingRuleConditions(msgVpnName, ruleName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Certificate Matching Rule objects. - * - * Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRulesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnCertMatchingRulesResponse response = api.getMsgVpnCertMatchingRules(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Client Profile object. - * - * Get a Client Profile object. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientProfileTest() { - String msgVpnName = null; - String clientProfileName = null; - String opaquePassword = null; - List select = null; - MsgVpnClientProfileResponse response = api.getMsgVpnClientProfile(msgVpnName, clientProfileName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Client Profile objects. - * - * Get a list of Client Profile objects. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientProfilesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnClientProfilesResponse response = api.getMsgVpnClientProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Client Username object. - * - * Get a Client Username object. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientUsernameTest() { - String msgVpnName = null; - String clientUsername = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameResponse response = api.getMsgVpnClientUsername(msgVpnName, clientUsername, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Client Username Attribute object. - * - * Get a Client Username Attribute object. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientUsernameAttributeTest() { - String msgVpnName = null; - String clientUsername = null; - String attributeName = null; - String attributeValue = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameAttributeResponse response = api.getMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Client Username Attribute objects. - * - * Get a list of Client Username Attribute objects. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientUsernameAttributesTest() { - String msgVpnName = null; - String clientUsername = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnClientUsernameAttributesResponse response = api.getMsgVpnClientUsernameAttributes(msgVpnName, clientUsername, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Client Username objects. - * - * Get a list of Client Username objects. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientUsernamesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnClientUsernamesResponse response = api.getMsgVpnClientUsernames(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Distributed Cache object. - * - * Get a Distributed Cache object. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheTest() { - String msgVpnName = null; - String cacheName = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheResponse response = api.getMsgVpnDistributedCache(msgVpnName, cacheName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Cache Cluster object. - * - * Get a Cache Cluster object. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterResponse response = api.getMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Home Cache Cluster object. - * - * Get a Home Cache Cluster object. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse response = api.getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Topic Prefix object. - * - * Get a Topic Prefix object. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - String topicPrefix = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse response = api.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Topic Prefix objects. - * - * Get a list of Topic Prefix objects. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse response = api.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes(msgVpnName, cacheName, clusterName, homeClusterName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Home Cache Cluster objects. - * - * Get a list of Home Cache Cluster objects. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterGlobalCachingHomeClustersTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse response = api.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Cache Instance object. - * - * Get a Cache Instance object. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterInstanceTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String instanceName = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterInstanceResponse response = api.getMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Cache Instance objects. - * - * Get a list of Cache Instance objects. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterInstancesTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCacheClusterInstancesResponse response = api.getMsgVpnDistributedCacheClusterInstances(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Topic object. - * - * Get a Topic object. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterTopicTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String topic = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterTopicResponse response = api.getMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Topic objects. - * - * Get a list of Topic objects. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterTopicsTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCacheClusterTopicsResponse response = api.getMsgVpnDistributedCacheClusterTopics(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Cache Cluster objects. - * - * Get a list of Cache Cluster objects. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClustersTest() { - String msgVpnName = null; - String cacheName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCacheClustersResponse response = api.getMsgVpnDistributedCacheClusters(msgVpnName, cacheName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Distributed Cache objects. - * - * Get a list of Distributed Cache objects. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCachesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCachesResponse response = api.getMsgVpnDistributedCaches(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a DMR Bridge object. - * - * Get a DMR Bridge object. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDmrBridgeTest() { - String msgVpnName = null; - String remoteNodeName = null; - String opaquePassword = null; - List select = null; - MsgVpnDmrBridgeResponse response = api.getMsgVpnDmrBridge(msgVpnName, remoteNodeName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of DMR Bridge objects. - * - * Get a list of DMR Bridge objects. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDmrBridgesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDmrBridgesResponse response = api.getMsgVpnDmrBridges(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of JNDI Connection Factory objects. - * - * Get a list of JNDI Connection Factory objects. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiConnectionFactoriesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnJndiConnectionFactoriesResponse response = api.getMsgVpnJndiConnectionFactories(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a JNDI Connection Factory object. - * - * Get a JNDI Connection Factory object. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiConnectionFactoryTest() { - String msgVpnName = null; - String connectionFactoryName = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiConnectionFactoryResponse response = api.getMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a JNDI Queue object. - * - * Get a JNDI Queue object. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiQueueTest() { - String msgVpnName = null; - String queueName = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiQueueResponse response = api.getMsgVpnJndiQueue(msgVpnName, queueName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of JNDI Queue objects. - * - * Get a list of JNDI Queue objects. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiQueuesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnJndiQueuesResponse response = api.getMsgVpnJndiQueues(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a JNDI Topic object. - * - * Get a JNDI Topic object. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiTopicTest() { - String msgVpnName = null; - String topicName = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiTopicResponse response = api.getMsgVpnJndiTopic(msgVpnName, topicName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of JNDI Topic objects. - * - * Get a list of JNDI Topic objects. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiTopicsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnJndiTopicsResponse response = api.getMsgVpnJndiTopics(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get an MQTT Retain Cache object. - * - * Get an MQTT Retain Cache object. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttRetainCacheTest() { - String msgVpnName = null; - String cacheName = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttRetainCacheResponse response = api.getMsgVpnMqttRetainCache(msgVpnName, cacheName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of MQTT Retain Cache objects. - * - * Get a list of MQTT Retain Cache objects. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttRetainCachesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnMqttRetainCachesResponse response = api.getMsgVpnMqttRetainCaches(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get an MQTT Session object. - * - * Get an MQTT Session object. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttSessionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionResponse response = api.getMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Subscription object. - * - * Get a Subscription object. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttSessionSubscriptionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - String subscriptionTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionSubscriptionResponse response = api.getMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Subscription objects. - * - * Get a list of Subscription objects. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttSessionSubscriptionsTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnMqttSessionSubscriptionsResponse response = api.getMsgVpnMqttSessionSubscriptions(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of MQTT Session objects. - * - * Get a list of MQTT Session objects. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttSessionsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnMqttSessionsResponse response = api.getMsgVpnMqttSessions(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Queue object. - * - * Get a Queue object. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueueTest() { - String msgVpnName = null; - String queueName = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueResponse response = api.getMsgVpnQueue(msgVpnName, queueName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Queue Subscription object. - * - * Get a Queue Subscription object. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueueSubscriptionTest() { - String msgVpnName = null; - String queueName = null; - String subscriptionTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueSubscriptionResponse response = api.getMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Queue Subscription objects. - * - * Get a list of Queue Subscription objects. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueueSubscriptionsTest() { - String msgVpnName = null; - String queueName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnQueueSubscriptionsResponse response = api.getMsgVpnQueueSubscriptions(msgVpnName, queueName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Queue Template object. - * - * Get a Queue Template object. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueueTemplateTest() { - String msgVpnName = null; - String queueTemplateName = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueTemplateResponse response = api.getMsgVpnQueueTemplate(msgVpnName, queueTemplateName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Queue Template objects. - * - * Get a list of Queue Template objects. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueueTemplatesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnQueueTemplatesResponse response = api.getMsgVpnQueueTemplates(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Queue objects. - * - * Get a list of Queue objects. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueuesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnQueuesResponse response = api.getMsgVpnQueues(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Replay Log object. - * - * Get a Replay Log object. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplayLogTest() { - String msgVpnName = null; - String replayLogName = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogResponse response = api.getMsgVpnReplayLog(msgVpnName, replayLogName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Topic Filter Subscription object. - * - * Get a Topic Filter Subscription object. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplayLogTopicFilterSubscriptionTest() { - String msgVpnName = null; - String replayLogName = null; - String topicFilterSubscription = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogTopicFilterSubscriptionResponse response = api.getMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Topic Filter Subscription objects. - * - * Get a list of Topic Filter Subscription objects. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplayLogTopicFilterSubscriptionsTest() { - String msgVpnName = null; - String replayLogName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnReplayLogTopicFilterSubscriptionsResponse response = api.getMsgVpnReplayLogTopicFilterSubscriptions(msgVpnName, replayLogName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Replay Log objects. - * - * Get a list of Replay Log objects. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplayLogsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnReplayLogsResponse response = api.getMsgVpnReplayLogs(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Replicated Topic object. - * - * Get a Replicated Topic object. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplicatedTopicTest() { - String msgVpnName = null; - String replicatedTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnReplicatedTopicResponse response = api.getMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Replicated Topic objects. - * - * Get a list of Replicated Topic objects. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplicatedTopicsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnReplicatedTopicsResponse response = api.getMsgVpnReplicatedTopics(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a REST Delivery Point object. - * - * Get a REST Delivery Point object. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointResponse response = api.getMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Queue Binding object. - * - * Get a Queue Binding object. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointQueueBindingTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingResponse response = api.getMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Request Header object. - * - * Get a Request Header object. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointQueueBindingRequestHeaderTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - String headerName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse response = api.getMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Request Header objects. - * - * Get a list of Request Header objects. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointQueueBindingRequestHeadersTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse response = api.getMsgVpnRestDeliveryPointQueueBindingRequestHeaders(msgVpnName, restDeliveryPointName, queueBindingName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Queue Binding objects. - * - * Get a list of Queue Binding objects. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointQueueBindingsTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingsResponse response = api.getMsgVpnRestDeliveryPointQueueBindings(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a REST Consumer object. - * - * Get a REST Consumer object. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumerTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerResponse response = api.getMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Claim object. - * - * Get a Claim object. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String oauthJwtClaimName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse response = api.getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Claim objects. - * - * Get a list of Claim objects. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse response = api.getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims(msgVpnName, restDeliveryPointName, restConsumerName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Trusted Common Name object. - * - * Get a Trusted Common Name object. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String tlsTrustedCommonName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse response = api.getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Trusted Common Name objects. - * - * Get a list of Trusted Common Name objects. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse response = api.getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of REST Consumer objects. - * - * Get a list of REST Consumer objects. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumersTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumersResponse response = api.getMsgVpnRestDeliveryPointRestConsumers(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of REST Delivery Point objects. - * - * Get a list of REST Delivery Point objects. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointsResponse response = api.getMsgVpnRestDeliveryPoints(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Sequenced Topic object. - * - * Get a Sequenced Topic object. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| sequencedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnSequencedTopicTest() { - String msgVpnName = null; - String sequencedTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnSequencedTopicResponse response = api.getMsgVpnSequencedTopic(msgVpnName, sequencedTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Sequenced Topic objects. - * - * Get a list of Sequenced Topic objects. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| sequencedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnSequencedTopicsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnSequencedTopicsResponse response = api.getMsgVpnSequencedTopics(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Topic Endpoint object. - * - * Get a Topic Endpoint object. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnTopicEndpointTest() { - String msgVpnName = null; - String topicEndpointName = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointResponse response = api.getMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Topic Endpoint Template object. - * - * Get a Topic Endpoint Template object. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnTopicEndpointTemplateTest() { - String msgVpnName = null; - String topicEndpointTemplateName = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointTemplateResponse response = api.getMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Topic Endpoint Template objects. - * - * Get a list of Topic Endpoint Template objects. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnTopicEndpointTemplatesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnTopicEndpointTemplatesResponse response = api.getMsgVpnTopicEndpointTemplates(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Topic Endpoint objects. - * - * Get a list of Topic Endpoint objects. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnTopicEndpointsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnTopicEndpointsResponse response = api.getMsgVpnTopicEndpoints(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Message VPN objects. - * - * Get a list of Message VPN objects. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| distributedCacheManagementEnabled|||x| msgVpnName|x||| replicationBridgeAuthenticationBasicPassword||x||x replicationBridgeAuthenticationClientCertContent||x||x replicationBridgeAuthenticationClientCertPassword||x|| replicationEnabledQueueBehavior||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnsTest() { - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnsResponse response = api.getMsgVpns(count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get an OAuth Profile object. - * - * Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileTest() { - String oauthProfileName = null; - String opaquePassword = null; - List select = null; - OauthProfileResponse response = api.getOauthProfile(oauthProfileName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Group Access Level object. - * - * Get a Group Access Level object. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileAccessLevelGroupTest() { - String oauthProfileName = null; - String groupName = null; - String opaquePassword = null; - List select = null; - OauthProfileAccessLevelGroupResponse response = api.getOauthProfileAccessLevelGroup(oauthProfileName, groupName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Message VPN Access-Level Exception object. - * - * Get a Message VPN Access-Level Exception object. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String groupName = null; - String msgVpnName = null; - String opaquePassword = null; - List select = null; - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse response = api.getOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Message VPN Access-Level Exception objects. - * - * Get a list of Message VPN Access-Level Exception objects. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsTest() { - String oauthProfileName = null; - String groupName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse response = api.getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions(oauthProfileName, groupName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Group Access Level objects. - * - * Get a list of Group Access Level objects. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileAccessLevelGroupsTest() { - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - OauthProfileAccessLevelGroupsResponse response = api.getOauthProfileAccessLevelGroups(oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get an Allowed Host Value object. - * - * Get an Allowed Host Value object. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowedHost|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileClientAllowedHostTest() { - String oauthProfileName = null; - String allowedHost = null; - String opaquePassword = null; - List select = null; - OauthProfileClientAllowedHostResponse response = api.getOauthProfileClientAllowedHost(oauthProfileName, allowedHost, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Allowed Host Value objects. - * - * Get a list of Allowed Host Value objects. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowedHost|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileClientAllowedHostsTest() { - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - OauthProfileClientAllowedHostsResponse response = api.getOauthProfileClientAllowedHosts(oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get an Authorization Parameter object. - * - * Get an Authorization Parameter object. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationParameterName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileClientAuthorizationParameterTest() { - String oauthProfileName = null; - String authorizationParameterName = null; - String opaquePassword = null; - List select = null; - OauthProfileClientAuthorizationParameterResponse response = api.getOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Authorization Parameter objects. - * - * Get a list of Authorization Parameter objects. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationParameterName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileClientAuthorizationParametersTest() { - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - OauthProfileClientAuthorizationParametersResponse response = api.getOauthProfileClientAuthorizationParameters(oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Required Claim object. - * - * Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileClientRequiredClaimTest() { - String oauthProfileName = null; - String clientRequiredClaimName = null; - String opaquePassword = null; - List select = null; - OauthProfileClientRequiredClaimResponse response = api.getOauthProfileClientRequiredClaim(oauthProfileName, clientRequiredClaimName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Required Claim objects. - * - * Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileClientRequiredClaimsTest() { - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - OauthProfileClientRequiredClaimsResponse response = api.getOauthProfileClientRequiredClaims(oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Message VPN Access-Level Exception object. - * - * Get a Message VPN Access-Level Exception object. Default message VPN access-level exceptions. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileDefaultMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String msgVpnName = null; - String opaquePassword = null; - List select = null; - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse response = api.getOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Message VPN Access-Level Exception objects. - * - * Get a list of Message VPN Access-Level Exception objects. Default message VPN access-level exceptions. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileDefaultMsgVpnAccessLevelExceptionsTest() { - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse response = api.getOauthProfileDefaultMsgVpnAccessLevelExceptions(oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Required Claim object. - * - * Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileResourceServerRequiredClaimTest() { - String oauthProfileName = null; - String resourceServerRequiredClaimName = null; - String opaquePassword = null; - List select = null; - OauthProfileResourceServerRequiredClaimResponse response = api.getOauthProfileResourceServerRequiredClaim(oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Required Claim objects. - * - * Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileResourceServerRequiredClaimsTest() { - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - OauthProfileResourceServerRequiredClaimsResponse response = api.getOauthProfileResourceServerRequiredClaims(oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of OAuth Profile objects. - * - * Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfilesTest() { - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - OauthProfilesResponse response = api.getOauthProfiles(count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a System Information object. - * - * Get a System Information object. The System Information object provides metadata about the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: platform|||x| sempVersion|||x| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been deprecated since 2.2. /systemInformation was replaced by /about/api. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getSystemInformationTest() { - String opaquePassword = null; - List select = null; - SystemInformationResponse response = api.getSystemInformation(opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Virtual Hostname object. - * - * Get a Virtual Hostname object. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: virtualHostname|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.17. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getVirtualHostnameTest() { - String virtualHostname = null; - String opaquePassword = null; - List select = null; - VirtualHostnameResponse response = api.getVirtualHostname(virtualHostname, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Virtual Hostname objects. - * - * Get a list of Virtual Hostname objects. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: virtualHostname|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.17. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getVirtualHostnamesTest() { - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - VirtualHostnamesResponse response = api.getVirtualHostnames(count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Certificate Authority object. - * - * Replace a Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||x| certContent||||||x| crlDayList||||||x| crlTimeList||||||x| crlUrl|||||x|x| ocspNonResponderCertEnabled||||||x| ocspOverrideUrl||||||x| ocspTimeout||||||x| revocationCheckEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceCertAuthorityTest() { - String certAuthorityName = null; - CertAuthority body = null; - String opaquePassword = null; - List select = null; - CertAuthorityResponse response = api.replaceCertAuthority(certAuthorityName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Client Certificate Authority object. - * - * Replace a Client Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||| crlUrl|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceClientCertAuthorityTest() { - String certAuthorityName = null; - ClientCertAuthority body = null; - String opaquePassword = null; - List select = null; - ClientCertAuthorityResponse response = api.replaceClientCertAuthority(certAuthorityName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Cluster object. - * - * Replace a Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword||||x|x||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| directOnlyEnabled||x||||| dmrClusterName|x||x|||| nodeName|||x|||| tlsServerCertEnforceTrustedCommonNameEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceDmrClusterTest() { - String dmrClusterName = null; - DmrCluster body = null; - String opaquePassword = null; - List select = null; - DmrClusterResponse response = api.replaceDmrCluster(dmrClusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Certificate Matching Rule object. - * - * Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- dmrClusterName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceDmrClusterCertMatchingRuleTest() { - String dmrClusterName = null; - String ruleName = null; - DmrClusterCertMatchingRule body = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleResponse response = api.replaceDmrClusterCertMatchingRule(dmrClusterName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Certificate Matching Rule Attribute Filter object. - * - * Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- dmrClusterName|x||x|||| filterName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceDmrClusterCertMatchingRuleAttributeFilterTest() { - String dmrClusterName = null; - String ruleName = null; - String filterName = null; - DmrClusterCertMatchingRuleAttributeFilter body = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleAttributeFilterResponse response = api.replaceDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Link object. - * - * Replace a Link object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword||||x|x||x authenticationScheme|||||x|| dmrClusterName|x||x|||| egressFlowWindowSize|||||x|| initiator|||||x|| remoteNodeName|x||x|||| span|||||x|| transportCompressedEnabled|||||x|| transportTlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceDmrClusterLinkTest() { - String dmrClusterName = null; - String remoteNodeName = null; - DmrClusterLink body = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkResponse response = api.replaceDmrClusterLink(dmrClusterName, remoteNodeName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Domain Certificate Authority object. - * - * Replace a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Certificate Authorities trusted for domain verification. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceDomainCertAuthorityTest() { - String certAuthorityName = null; - DomainCertAuthority body = null; - String opaquePassword = null; - List select = null; - DomainCertAuthorityResponse response = api.replaceDomainCertAuthority(certAuthorityName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Message VPN object. - * - * Replace a Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationOauthDefaultProviderName||||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled||||||x| distributedCacheManagementEnabled||||||x| msgVpnName|x||x|||| replicationBridgeAuthenticationBasicPassword||||x|||x replicationBridgeAuthenticationClientCertContent||||x|||x replicationBridgeAuthenticationClientCertPassword||||x||| replicationEnabledQueueBehavior||||x||| restTlsServerCertEnforceTrustedCommonNameEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: alias|global/read-write authenticationBasicEnabled|global/read-write authenticationBasicProfileName|global/read-write authenticationBasicRadiusDomain|global/read-write authenticationBasicType|global/read-write authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write authenticationClientCertCertificateMatchingRulesEnabled|global/read-write authenticationClientCertEnabled|global/read-write authenticationClientCertMaxChainDepth|global/read-write authenticationClientCertRevocationCheckMode|global/read-write authenticationClientCertUsernameSource|global/read-write authenticationClientCertValidateDateEnabled|global/read-write authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write authenticationKerberosEnabled|global/read-write authenticationOauthEnabled|global/read-write bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write bridgingTlsServerCertMaxChainDepth|global/read-write bridgingTlsServerCertValidateDateEnabled|global/read-write bridgingTlsServerCertValidateNameEnabled|global/read-write dmrEnabled|global/read-write exportSubscriptionsEnabled|global/read-write maxConnectionCount|global/read-write maxEgressFlowCount|global/read-write maxEndpointCount|global/read-write maxIngressFlowCount|global/read-write maxMsgSpoolUsage|global/read-write maxSubscriptionCount|global/read-write maxTransactedSessionCount|global/read-write maxTransactionCount|global/read-write mqttRetainMaxMemory|global/read-write replicationBridgeAuthenticationBasicClientUsername|global/read-write replicationBridgeAuthenticationBasicPassword|global/read-write replicationBridgeAuthenticationClientCertContent|global/read-write replicationBridgeAuthenticationClientCertPassword|global/read-write replicationBridgeAuthenticationScheme|global/read-write replicationBridgeCompressedDataEnabled|global/read-write replicationBridgeEgressFlowWindowSize|global/read-write replicationBridgeRetryDelay|global/read-write replicationBridgeTlsEnabled|global/read-write replicationBridgeUnidirectionalClientProfileName|global/read-write replicationEnabled|global/read-write replicationEnabledQueueBehavior|global/read-write replicationQueueMaxMsgSpoolUsage|global/read-write replicationRole|global/read-write restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write restTlsServerCertMaxChainDepth|global/read-write restTlsServerCertValidateDateEnabled|global/read-write restTlsServerCertValidateNameEnabled|global/read-write sempOverMsgBusAdminClientEnabled|global/read-write sempOverMsgBusAdminDistributedCacheEnabled|global/read-write sempOverMsgBusAdminEnabled|global/read-write sempOverMsgBusEnabled|global/read-write sempOverMsgBusShowEnabled|global/read-write serviceAmqpMaxConnectionCount|global/read-write serviceAmqpPlainTextListenPort|global/read-write serviceAmqpTlsListenPort|global/read-write serviceMqttMaxConnectionCount|global/read-write serviceMqttPlainTextListenPort|global/read-write serviceMqttTlsListenPort|global/read-write serviceMqttTlsWebSocketListenPort|global/read-write serviceMqttWebSocketListenPort|global/read-write serviceRestIncomingMaxConnectionCount|global/read-write serviceRestIncomingPlainTextListenPort|global/read-write serviceRestIncomingTlsListenPort|global/read-write serviceRestOutgoingMaxConnectionCount|global/read-write serviceSmfMaxConnectionCount|global/read-write serviceWebMaxConnectionCount|global/read-write This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnTest() { - String msgVpnName = null; - MsgVpn body = null; - String opaquePassword = null; - List select = null; - MsgVpnResponse response = api.replaceMsgVpn(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace an ACL Profile object. - * - * Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnAclProfileTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileResponse response = api.replaceMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace an OAuth Profile object. - * - * Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnAuthenticationOauthProfileTest() { - String msgVpnName = null; - String oauthProfileName = null; - MsgVpnAuthenticationOauthProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResponse response = api.replaceMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace an OAuth Provider object. - * - * Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- audienceClaimName||||||x| audienceClaimSource||||||x| audienceClaimValue||||||x| audienceValidationEnabled||||||x| authorizationGroupClaimName||||||x| authorizationGroupClaimSource||||||x| authorizationGroupEnabled||||||x| disconnectOnTokenExpirationEnabled||||||x| enabled||||||x| jwksRefreshInterval||||||x| jwksUri||||||x| msgVpnName|x||x|||x| oauthProviderName|x||x|||x| tokenIgnoreTimeLimitsEnabled||||||x| tokenIntrospectionParameterName||||||x| tokenIntrospectionPassword||||x||x|x tokenIntrospectionTimeout||||||x| tokenIntrospectionUri||||||x| tokenIntrospectionUsername||||||x| usernameClaimName||||||x| usernameClaimSource||||||x| usernameValidateEnabled||||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnAuthenticationOauthProviderTest() { - String msgVpnName = null; - String oauthProviderName = null; - MsgVpnAuthenticationOauthProvider body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProviderResponse response = api.replaceMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace an Authorization Group object. - * - * Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| authorizationGroupName|x||x|||| clientProfileName|||||x|| msgVpnName|x||x|||| orderAfterAuthorizationGroupName||||x||| orderBeforeAuthorizationGroupName||||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnAuthorizationGroupTest() { - String msgVpnName = null; - String authorizationGroupName = null; - MsgVpnAuthorizationGroup body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthorizationGroupResponse response = api.replaceMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Bridge object. - * - * Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| maxTtl|||||x|| msgVpnName|x||x|||| remoteAuthenticationBasicClientUsername|||||x|| remoteAuthenticationBasicPassword||||x|x||x remoteAuthenticationClientCertContent||||x|x||x remoteAuthenticationClientCertPassword||||x|x|| remoteAuthenticationScheme|||||x|| remoteDeliverToOnePriority|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnBridgeTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - MsgVpnBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeResponse response = api.replaceMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Remote Message VPN object. - * - * Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| clientUsername|||||x|| compressedDataEnabled|||||x|| egressFlowWindowSize|||||x|| msgVpnName|x||x|||| password||||x|x||x remoteMsgVpnInterface|x||x|||| remoteMsgVpnLocation|x||x|||| remoteMsgVpnName|x||x|||| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnBridgeRemoteMsgVpnTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteMsgVpnName = null; - String remoteMsgVpnLocation = null; - String remoteMsgVpnInterface = null; - MsgVpnBridgeRemoteMsgVpn body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteMsgVpnResponse response = api.replaceMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Certificate Matching Rule object. - * - * Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnCertMatchingRuleTest() { - String msgVpnName = null; - String ruleName = null; - MsgVpnCertMatchingRule body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleResponse response = api.replaceMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Certificate Matching Rule Attribute Filter object. - * - * Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- filterName|x||x|||| msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnCertMatchingRuleAttributeFilterTest() { - String msgVpnName = null; - String ruleName = null; - String filterName = null; - MsgVpnCertMatchingRuleAttributeFilter body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleAttributeFilterResponse response = api.replaceMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Client Profile object. - * - * Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled||||||x| apiQueueManagementCopyFromOnCreateName||||||x| apiTopicEndpointManagementCopyFromOnCreateName||||||x| clientProfileName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnClientProfileTest() { - String msgVpnName = null; - String clientProfileName = null; - MsgVpnClientProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientProfileResponse response = api.replaceMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Client Username object. - * - * Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| clientProfileName|||||x|| clientUsername|x||x|||| msgVpnName|x||x|||| password||||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnClientUsernameTest() { - String msgVpnName = null; - String clientUsername = null; - MsgVpnClientUsername body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameResponse response = api.replaceMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Distributed Cache object. - * - * Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| cacheVirtualRouter||x||||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnDistributedCacheTest() { - String msgVpnName = null; - String cacheName = null; - MsgVpnDistributedCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheResponse response = api.replaceMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Cache Cluster object. - * - * Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnDistributedCacheClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - MsgVpnDistributedCacheCluster body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterResponse response = api.replaceMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Cache Instance object. - * - * Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| instanceName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnDistributedCacheClusterInstanceTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String instanceName = null; - MsgVpnDistributedCacheClusterInstance body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterInstanceResponse response = api.replaceMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a DMR Bridge object. - * - * Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| remoteNodeName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnDmrBridgeTest() { - String msgVpnName = null; - String remoteNodeName = null; - MsgVpnDmrBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnDmrBridgeResponse response = api.replaceMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a JNDI Connection Factory object. - * - * Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnJndiConnectionFactoryTest() { - String msgVpnName = null; - String connectionFactoryName = null; - MsgVpnJndiConnectionFactory body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiConnectionFactoryResponse response = api.replaceMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a JNDI Queue object. - * - * Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnJndiQueueTest() { - String msgVpnName = null; - String queueName = null; - MsgVpnJndiQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiQueueResponse response = api.replaceMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a JNDI Topic object. - * - * Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnJndiTopicTest() { - String msgVpnName = null; - String topicName = null; - MsgVpnJndiTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiTopicResponse response = api.replaceMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace an MQTT Retain Cache object. - * - * Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnMqttRetainCacheTest() { - String msgVpnName = null; - String cacheName = null; - MsgVpnMqttRetainCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttRetainCacheResponse response = api.replaceMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace an MQTT Session object. - * - * Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| owner|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnMqttSessionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - MsgVpnMqttSession body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionResponse response = api.replaceMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Subscription object. - * - * Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| subscriptionTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnMqttSessionSubscriptionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - String subscriptionTopic = null; - MsgVpnMqttSessionSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionSubscriptionResponse response = api.replaceMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Queue object. - * - * Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| queueName|x||x|||| respectMsgPriorityEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnQueueTest() { - String msgVpnName = null; - String queueName = null; - MsgVpnQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueResponse response = api.replaceMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Queue Template object. - * - * Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnQueueTemplateTest() { - String msgVpnName = null; - String queueTemplateName = null; - MsgVpnQueueTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueTemplateResponse response = api.replaceMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Replay Log object. - * - * Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replayLogName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnReplayLogTest() { - String msgVpnName = null; - String replayLogName = null; - MsgVpnReplayLog body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogResponse response = api.replaceMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Replicated Topic object. - * - * Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replicatedTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnReplicatedTopicTest() { - String msgVpnName = null; - String replicatedTopic = null; - MsgVpnReplicatedTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplicatedTopicResponse response = api.replaceMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a REST Delivery Point object. - * - * Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientProfileName|||||x|| msgVpnName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnRestDeliveryPointTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - MsgVpnRestDeliveryPoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointResponse response = api.replaceMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Queue Binding object. - * - * Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnRestDeliveryPointQueueBindingTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - MsgVpnRestDeliveryPointQueueBinding body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingResponse response = api.replaceMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Request Header object. - * - * Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A request header to be added to the HTTP request. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- headerName|x||x|||| msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnRestDeliveryPointQueueBindingRequestHeaderTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - String headerName = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse response = api.replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a REST Consumer object. - * - * Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey||||x|||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| authenticationHttpBasicPassword||||x|x||x authenticationHttpBasicUsername|||||x|| authenticationHttpHeaderValue||||x|||x authenticationOauthClientId|||||x|| authenticationOauthClientScope|||||x|| authenticationOauthClientSecret||||x|x||x authenticationOauthClientTokenEndpoint|||||x|| authenticationOauthJwtSecretKey||||x|x||x authenticationOauthJwtTokenEndpoint|||||x|| authenticationScheme|||||x|| msgVpnName|x||x|||| outgoingConnectionCount|||||x|| remoteHost|||||x|| remotePort|||||x|| restConsumerName|x||x|||| restDeliveryPointName|x||x|||| tlsCipherSuiteList|||||x|| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnRestDeliveryPointRestConsumerTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - MsgVpnRestDeliveryPointRestConsumer body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerResponse response = api.replaceMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Topic Endpoint object. - * - * Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| respectMsgPriorityEnabled|||||x|| topicEndpointName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnTopicEndpointTest() { - String msgVpnName = null; - String topicEndpointName = null; - MsgVpnTopicEndpoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointResponse response = api.replaceMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Topic Endpoint Template object. - * - * Replace a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicEndpointTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnTopicEndpointTemplateTest() { - String msgVpnName = null; - String topicEndpointTemplateName = null; - MsgVpnTopicEndpointTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointTemplateResponse response = api.replaceMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace an OAuth Profile object. - * - * Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: accessLevelGroupsClaimName|global/admin clientId|global/admin clientRedirectUri|global/admin clientRequiredType|global/admin clientScope|global/admin clientSecret|global/admin clientValidateTypeEnabled|global/admin defaultGlobalAccessLevel|global/admin displayName|global/admin enabled|global/admin endpointAuthorization|global/admin endpointDiscovery|global/admin endpointDiscoveryRefreshInterval|global/admin endpointIntrospection|global/admin endpointIntrospectionTimeout|global/admin endpointJwks|global/admin endpointJwksRefreshInterval|global/admin endpointToken|global/admin endpointTokenTimeout|global/admin endpointUserinfo|global/admin endpointUserinfoTimeout|global/admin interactiveEnabled|global/admin interactivePromptForExpiredSession|global/admin interactivePromptForNewSession|global/admin issuer|global/admin oauthRole|global/admin resourceServerParseAccessTokenEnabled|global/admin resourceServerRequiredAudience|global/admin resourceServerRequiredIssuer|global/admin resourceServerRequiredScope|global/admin resourceServerRequiredType|global/admin resourceServerValidateAudienceEnabled|global/admin resourceServerValidateIssuerEnabled|global/admin resourceServerValidateScopeEnabled|global/admin resourceServerValidateTypeEnabled|global/admin sempEnabled|global/admin usernameClaimName|global/admin This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceOauthProfileTest() { - String oauthProfileName = null; - OauthProfile body = null; - String opaquePassword = null; - List select = null; - OauthProfileResponse response = api.replaceOauthProfile(oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Group Access Level object. - * - * Replace a Group Access Level object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- groupName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceOauthProfileAccessLevelGroupTest() { - String oauthProfileName = null; - String groupName = null; - OauthProfileAccessLevelGroup body = null; - String opaquePassword = null; - List select = null; - OauthProfileAccessLevelGroupResponse response = api.replaceOauthProfileAccessLevelGroup(oauthProfileName, groupName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Message VPN Access-Level Exception object. - * - * Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- groupName|x||x|||| msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String groupName = null; - String msgVpnName = null; - OauthProfileAccessLevelGroupMsgVpnAccessLevelException body = null; - String opaquePassword = null; - List select = null; - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse response = api.replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace an Authorization Parameter object. - * - * Replace an Authorization Parameter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authorizationParameterName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceOauthProfileClientAuthorizationParameterTest() { - String oauthProfileName = null; - String authorizationParameterName = null; - OauthProfileClientAuthorizationParameter body = null; - String opaquePassword = null; - List select = null; - OauthProfileClientAuthorizationParameterResponse response = api.replaceOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Message VPN Access-Level Exception object. - * - * Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Default message VPN access-level exceptions. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceOauthProfileDefaultMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String msgVpnName = null; - OauthProfileDefaultMsgVpnAccessLevelException body = null; - String opaquePassword = null; - List select = null; - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse response = api.replaceOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Virtual Hostname object. - * - * Replace a Virtual Hostname object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- virtualHostname|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceVirtualHostnameTest() { - String virtualHostname = null; - VirtualHostname body = null; - String opaquePassword = null; - List select = null; - VirtualHostnameResponse response = api.replaceVirtualHostname(virtualHostname, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Broker object. - * - * Update a Broker object. Any attribute missing from the request will be left unchanged. This object contains global configuration for the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- serviceAmqpTlsListenPort||||x|| serviceHealthCheckListenPort||||x|| serviceMateLinkListenPort||||x|| serviceRedundancyFirstListenPort||||x|| serviceSempPlainTextListenPort||||x|| serviceSempTlsListenPort||||x|| serviceSmfCompressionListenPort||||x|| serviceSmfPlainTextListenPort||||x|| serviceSmfRoutingControlListenPort||||x|| serviceSmfTlsListenPort||||x|| serviceWebTransportPlainTextListenPort||||x|| serviceWebTransportTlsListenPort||||x|| serviceWebTransportWebUrlSuffix||||x|| tlsServerCertContent|||x|||x tlsServerCertPassword|||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- Broker|tlsServerCertPassword|tlsServerCertContent| EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: authClientCertRevocationCheckMode|global/admin configSyncAuthenticationClientCertMaxChainDepth|global/read-write configSyncAuthenticationClientCertValidateDateEnabled|global/read-write configSyncClientProfileTcpInitialCongestionWindow|global/read-write configSyncClientProfileTcpKeepaliveCount|global/read-write configSyncClientProfileTcpKeepaliveIdle|global/read-write configSyncClientProfileTcpKeepaliveInterval|global/read-write configSyncClientProfileTcpMaxWindow|global/read-write configSyncClientProfileTcpMss|global/read-write configSyncEnabled|global/read-write configSyncSynchronizeUsernameEnabled|global/read-write configSyncTlsEnabled|global/read-write guaranteedMsgingDefragmentationScheduleDayList|global/read-write guaranteedMsgingDefragmentationScheduleEnabled|global/read-write guaranteedMsgingDefragmentationScheduleTimeList|global/read-write guaranteedMsgingDefragmentationThresholdEnabled|global/read-write guaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-write guaranteedMsgingDefragmentationThresholdMinInterval|global/read-write guaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-write guaranteedMsgingEnabled|global/read-write guaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-write guaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-write guaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-write guaranteedMsgingEventCacheUsageThreshold.setValue|global/read-write guaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-write guaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-write guaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-write guaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-write guaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-write guaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-write guaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-write guaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-write guaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-write guaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-write guaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-write guaranteedMsgingEventEndpointCountThreshold.setValue|global/read-write guaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-write guaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-write guaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-write guaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-write guaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-write guaranteedMsgingEventMsgCountThreshold.setPercent|global/read-write guaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-write guaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-write guaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-write guaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-write guaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-write guaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-write guaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-write guaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-write guaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-write guaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-write guaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-write guaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-write guaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-write guaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-write guaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-write guaranteedMsgingEventTransactionCountThreshold.setValue|global/read-write guaranteedMsgingMaxCacheUsage|global/read-write guaranteedMsgingMaxMsgSpoolUsage|global/read-write guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-write guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-write guaranteedMsgingTransactionReplicationCompatibilityMode|global/read-write oauthProfileDefault|global/admin serviceAmqpEnabled|global/read-write serviceAmqpTlsListenPort|global/read-write serviceEventConnectionCountThreshold.clearPercent|global/read-write serviceEventConnectionCountThreshold.clearValue|global/read-write serviceEventConnectionCountThreshold.setPercent|global/read-write serviceEventConnectionCountThreshold.setValue|global/read-write serviceHealthCheckEnabled|global/read-write serviceHealthCheckListenPort|global/read-write serviceMateLinkEnabled|global/read-write serviceMateLinkListenPort|global/read-write serviceMqttEnabled|global/read-write serviceMsgBackboneEnabled|global/read-write serviceRedundancyEnabled|global/read-write serviceRedundancyFirstListenPort|global/read-write serviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-write serviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-write serviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-write serviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-write serviceRestIncomingEnabled|global/read-write serviceRestOutgoingEnabled|global/read-write serviceSempCorsAllowAnyHostEnabled|global/read-write serviceSempLegacyTimeoutEnabled|global/read-write serviceSempPlainTextEnabled|global/read-write serviceSempPlainTextListenPort|global/read-write serviceSempSessionIdleTimeout|global/read-write serviceSempSessionMaxLifetime|global/read-write serviceSempTlsEnabled|global/read-write serviceSempTlsListenPort|global/read-write serviceSmfCompressionListenPort|global/read-write serviceSmfEnabled|global/read-write serviceSmfEventConnectionCountThreshold.clearPercent|global/read-write serviceSmfEventConnectionCountThreshold.clearValue|global/read-write serviceSmfEventConnectionCountThreshold.setPercent|global/read-write serviceSmfEventConnectionCountThreshold.setValue|global/read-write serviceSmfPlainTextListenPort|global/read-write serviceSmfRoutingControlListenPort|global/read-write serviceSmfTlsListenPort|global/read-write serviceTlsEventConnectionCountThreshold.clearPercent|global/read-write serviceTlsEventConnectionCountThreshold.clearValue|global/read-write serviceTlsEventConnectionCountThreshold.setPercent|global/read-write serviceTlsEventConnectionCountThreshold.setValue|global/read-write serviceWebTransportEnabled|global/read-write serviceWebTransportPlainTextListenPort|global/read-write serviceWebTransportTlsListenPort|global/read-write serviceWebTransportWebUrlSuffix|global/read-write tlsBlockVersion11Enabled|global/read-write tlsCipherSuiteManagementList|global/read-write tlsCipherSuiteMsgBackboneList|global/read-write tlsCipherSuiteSecureShellList|global/read-write tlsCrimeExploitProtectionEnabled|global/read-write tlsServerCertContent|global/read-write tlsServerCertPassword|global/read-write tlsStandardDomainCertificateAuthoritiesEnabled|global/read-write tlsTicketLifetime|global/read-write webManagerAllowUnencryptedWizardsEnabled|global/read-write webManagerCustomization|vpn/read-write webManagerRedirectHttpEnabled|global/read-write webManagerRedirectHttpOverrideTlsPort|global/read-write This has been available since 2.13. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateBrokerTest() { - Broker body = null; - String opaquePassword = null; - List select = null; - BrokerResponse response = api.updateBroker(body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Certificate Authority object. - * - * Update a Certificate Authority object. Any attribute missing from the request will be left unchanged. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||x| certContent|||||x| crlDayList|||||x| crlTimeList|||||x| crlUrl||||x|x| ocspNonResponderCertEnabled|||||x| ocspOverrideUrl|||||x| ocspTimeout|||||x| revocationCheckEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateCertAuthorityTest() { - String certAuthorityName = null; - CertAuthority body = null; - String opaquePassword = null; - List select = null; - CertAuthorityResponse response = api.updateCertAuthority(certAuthorityName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Client Certificate Authority object. - * - * Update a Client Certificate Authority object. Any attribute missing from the request will be left unchanged. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||| crlUrl||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateClientCertAuthorityTest() { - String certAuthorityName = null; - ClientCertAuthority body = null; - String opaquePassword = null; - List select = null; - ClientCertAuthorityResponse response = api.updateClientCertAuthority(certAuthorityName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Cluster object. - * - * Update a Cluster object. Any attribute missing from the request will be left unchanged. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword|||x|x||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| directOnlyEnabled||x|||| dmrClusterName|x|x|||| nodeName||x|||| tlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateDmrClusterTest() { - String dmrClusterName = null; - DmrCluster body = null; - String opaquePassword = null; - List select = null; - DmrClusterResponse response = api.updateDmrCluster(dmrClusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Certificate Matching Rule object. - * - * Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- dmrClusterName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateDmrClusterCertMatchingRuleTest() { - String dmrClusterName = null; - String ruleName = null; - DmrClusterCertMatchingRule body = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleResponse response = api.updateDmrClusterCertMatchingRule(dmrClusterName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Certificate Matching Rule Attribute Filter object. - * - * Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- dmrClusterName|x|x|||| filterName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateDmrClusterCertMatchingRuleAttributeFilterTest() { - String dmrClusterName = null; - String ruleName = null; - String filterName = null; - DmrClusterCertMatchingRuleAttributeFilter body = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleAttributeFilterResponse response = api.updateDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Link object. - * - * Update a Link object. Any attribute missing from the request will be left unchanged. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword|||x|x||x authenticationScheme||||x|| dmrClusterName|x|x|||| egressFlowWindowSize||||x|| initiator||||x|| remoteNodeName|x|x|||| span||||x|| transportCompressedEnabled||||x|| transportTlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateDmrClusterLinkTest() { - String dmrClusterName = null; - String remoteNodeName = null; - DmrClusterLink body = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkResponse response = api.updateDmrClusterLink(dmrClusterName, remoteNodeName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Domain Certificate Authority object. - * - * Update a Domain Certificate Authority object. Any attribute missing from the request will be left unchanged. Certificate Authorities trusted for domain verification. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateDomainCertAuthorityTest() { - String certAuthorityName = null; - DomainCertAuthority body = null; - String opaquePassword = null; - List select = null; - DomainCertAuthorityResponse response = api.updateDomainCertAuthority(certAuthorityName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Message VPN object. - * - * Update a Message VPN object. Any attribute missing from the request will be left unchanged. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationOauthDefaultProviderName|||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| distributedCacheManagementEnabled|||||x| msgVpnName|x|x|||| replicationBridgeAuthenticationBasicPassword|||x|||x replicationBridgeAuthenticationClientCertContent|||x|||x replicationBridgeAuthenticationClientCertPassword|||x||| replicationEnabledQueueBehavior|||x||| restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: alias|global/read-write authenticationBasicEnabled|global/read-write authenticationBasicProfileName|global/read-write authenticationBasicRadiusDomain|global/read-write authenticationBasicType|global/read-write authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write authenticationClientCertCertificateMatchingRulesEnabled|global/read-write authenticationClientCertEnabled|global/read-write authenticationClientCertMaxChainDepth|global/read-write authenticationClientCertRevocationCheckMode|global/read-write authenticationClientCertUsernameSource|global/read-write authenticationClientCertValidateDateEnabled|global/read-write authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write authenticationKerberosEnabled|global/read-write authenticationOauthEnabled|global/read-write bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write bridgingTlsServerCertMaxChainDepth|global/read-write bridgingTlsServerCertValidateDateEnabled|global/read-write bridgingTlsServerCertValidateNameEnabled|global/read-write dmrEnabled|global/read-write exportSubscriptionsEnabled|global/read-write maxConnectionCount|global/read-write maxEgressFlowCount|global/read-write maxEndpointCount|global/read-write maxIngressFlowCount|global/read-write maxMsgSpoolUsage|global/read-write maxSubscriptionCount|global/read-write maxTransactedSessionCount|global/read-write maxTransactionCount|global/read-write mqttRetainMaxMemory|global/read-write replicationBridgeAuthenticationBasicClientUsername|global/read-write replicationBridgeAuthenticationBasicPassword|global/read-write replicationBridgeAuthenticationClientCertContent|global/read-write replicationBridgeAuthenticationClientCertPassword|global/read-write replicationBridgeAuthenticationScheme|global/read-write replicationBridgeCompressedDataEnabled|global/read-write replicationBridgeEgressFlowWindowSize|global/read-write replicationBridgeRetryDelay|global/read-write replicationBridgeTlsEnabled|global/read-write replicationBridgeUnidirectionalClientProfileName|global/read-write replicationEnabled|global/read-write replicationEnabledQueueBehavior|global/read-write replicationQueueMaxMsgSpoolUsage|global/read-write replicationRole|global/read-write restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write restTlsServerCertMaxChainDepth|global/read-write restTlsServerCertValidateDateEnabled|global/read-write restTlsServerCertValidateNameEnabled|global/read-write sempOverMsgBusAdminClientEnabled|global/read-write sempOverMsgBusAdminDistributedCacheEnabled|global/read-write sempOverMsgBusAdminEnabled|global/read-write sempOverMsgBusEnabled|global/read-write sempOverMsgBusShowEnabled|global/read-write serviceAmqpMaxConnectionCount|global/read-write serviceAmqpPlainTextListenPort|global/read-write serviceAmqpTlsListenPort|global/read-write serviceMqttMaxConnectionCount|global/read-write serviceMqttPlainTextListenPort|global/read-write serviceMqttTlsListenPort|global/read-write serviceMqttTlsWebSocketListenPort|global/read-write serviceMqttWebSocketListenPort|global/read-write serviceRestIncomingMaxConnectionCount|global/read-write serviceRestIncomingPlainTextListenPort|global/read-write serviceRestIncomingTlsListenPort|global/read-write serviceRestOutgoingMaxConnectionCount|global/read-write serviceSmfMaxConnectionCount|global/read-write serviceWebMaxConnectionCount|global/read-write This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnTest() { - String msgVpnName = null; - MsgVpn body = null; - String opaquePassword = null; - List select = null; - MsgVpnResponse response = api.updateMsgVpn(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an ACL Profile object. - * - * Update an ACL Profile object. Any attribute missing from the request will be left unchanged. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnAclProfileTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileResponse response = api.updateMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an OAuth Profile object. - * - * Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnAuthenticationOauthProfileTest() { - String msgVpnName = null; - String oauthProfileName = null; - MsgVpnAuthenticationOauthProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResponse response = api.updateMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an OAuth Provider object. - * - * Update an OAuth Provider object. Any attribute missing from the request will be left unchanged. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x|x|||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword|||x||x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnAuthenticationOauthProviderTest() { - String msgVpnName = null; - String oauthProviderName = null; - MsgVpnAuthenticationOauthProvider body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProviderResponse response = api.updateMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an Authorization Group object. - * - * Update an Authorization Group object. Any attribute missing from the request will be left unchanged. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| authorizationGroupName|x|x|||| clientProfileName||||x|| msgVpnName|x|x|||| orderAfterAuthorizationGroupName|||x||| orderBeforeAuthorizationGroupName|||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnAuthorizationGroupTest() { - String msgVpnName = null; - String authorizationGroupName = null; - MsgVpnAuthorizationGroup body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthorizationGroupResponse response = api.updateMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Bridge object. - * - * Update a Bridge object. Any attribute missing from the request will be left unchanged. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| maxTtl||||x|| msgVpnName|x|x|||| remoteAuthenticationBasicClientUsername||||x|| remoteAuthenticationBasicPassword|||x|x||x remoteAuthenticationClientCertContent|||x|x||x remoteAuthenticationClientCertPassword|||x|x|| remoteAuthenticationScheme||||x|| remoteDeliverToOnePriority||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnBridgeTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - MsgVpnBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeResponse response = api.updateMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Remote Message VPN object. - * - * Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| clientUsername||||x|| compressedDataEnabled||||x|| egressFlowWindowSize||||x|| msgVpnName|x|x|||| password|||x|x||x remoteMsgVpnInterface|x|x|||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnBridgeRemoteMsgVpnTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteMsgVpnName = null; - String remoteMsgVpnLocation = null; - String remoteMsgVpnInterface = null; - MsgVpnBridgeRemoteMsgVpn body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteMsgVpnResponse response = api.updateMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Certificate Matching Rule object. - * - * Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnCertMatchingRuleTest() { - String msgVpnName = null; - String ruleName = null; - MsgVpnCertMatchingRule body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleResponse response = api.updateMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Certificate Matching Rule Attribute Filter object. - * - * Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- filterName|x|x|||| msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnCertMatchingRuleAttributeFilterTest() { - String msgVpnName = null; - String ruleName = null; - String filterName = null; - MsgVpnCertMatchingRuleAttributeFilter body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleAttributeFilterResponse response = api.updateMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Client Profile object. - * - * Update a Client Profile object. Any attribute missing from the request will be left unchanged. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnClientProfileTest() { - String msgVpnName = null; - String clientProfileName = null; - MsgVpnClientProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientProfileResponse response = api.updateMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Client Username object. - * - * Update a Client Username object. Any attribute missing from the request will be left unchanged. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| clientProfileName||||x|| clientUsername|x|x|||| msgVpnName|x|x|||| password|||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnClientUsernameTest() { - String msgVpnName = null; - String clientUsername = null; - MsgVpnClientUsername body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameResponse response = api.updateMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Distributed Cache object. - * - * Update a Distributed Cache object. Any attribute missing from the request will be left unchanged. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| cacheVirtualRouter||x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnDistributedCacheTest() { - String msgVpnName = null; - String cacheName = null; - MsgVpnDistributedCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheResponse response = api.updateMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Cache Cluster object. - * - * Update a Cache Cluster object. Any attribute missing from the request will be left unchanged. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnDistributedCacheClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - MsgVpnDistributedCacheCluster body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterResponse response = api.updateMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Cache Instance object. - * - * Update a Cache Instance object. Any attribute missing from the request will be left unchanged. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| instanceName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnDistributedCacheClusterInstanceTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String instanceName = null; - MsgVpnDistributedCacheClusterInstance body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterInstanceResponse response = api.updateMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a DMR Bridge object. - * - * Update a DMR Bridge object. Any attribute missing from the request will be left unchanged. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnDmrBridgeTest() { - String msgVpnName = null; - String remoteNodeName = null; - MsgVpnDmrBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnDmrBridgeResponse response = api.updateMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a JNDI Connection Factory object. - * - * Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnJndiConnectionFactoryTest() { - String msgVpnName = null; - String connectionFactoryName = null; - MsgVpnJndiConnectionFactory body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiConnectionFactoryResponse response = api.updateMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a JNDI Queue object. - * - * Update a JNDI Queue object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnJndiQueueTest() { - String msgVpnName = null; - String queueName = null; - MsgVpnJndiQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiQueueResponse response = api.updateMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a JNDI Topic object. - * - * Update a JNDI Topic object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnJndiTopicTest() { - String msgVpnName = null; - String topicName = null; - MsgVpnJndiTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiTopicResponse response = api.updateMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an MQTT Retain Cache object. - * - * Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnMqttRetainCacheTest() { - String msgVpnName = null; - String cacheName = null; - MsgVpnMqttRetainCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttRetainCacheResponse response = api.updateMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an MQTT Session object. - * - * Update an MQTT Session object. Any attribute missing from the request will be left unchanged. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| owner||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnMqttSessionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - MsgVpnMqttSession body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionResponse response = api.updateMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Subscription object. - * - * Update a Subscription object. Any attribute missing from the request will be left unchanged. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnMqttSessionSubscriptionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - String subscriptionTopic = null; - MsgVpnMqttSessionSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionSubscriptionResponse response = api.updateMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Queue object. - * - * Update a Queue object. Any attribute missing from the request will be left unchanged. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| queueName|x|x|||| respectMsgPriorityEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnQueueTest() { - String msgVpnName = null; - String queueName = null; - MsgVpnQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueResponse response = api.updateMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Queue Template object. - * - * Update a Queue Template object. Any attribute missing from the request will be left unchanged. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnQueueTemplateTest() { - String msgVpnName = null; - String queueTemplateName = null; - MsgVpnQueueTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueTemplateResponse response = api.updateMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Replay Log object. - * - * Update a Replay Log object. Any attribute missing from the request will be left unchanged. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnReplayLogTest() { - String msgVpnName = null; - String replayLogName = null; - MsgVpnReplayLog body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogResponse response = api.updateMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Replicated Topic object. - * - * Update a Replicated Topic object. Any attribute missing from the request will be left unchanged. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnReplicatedTopicTest() { - String msgVpnName = null; - String replicatedTopic = null; - MsgVpnReplicatedTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplicatedTopicResponse response = api.updateMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a REST Delivery Point object. - * - * Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientProfileName||||x|| msgVpnName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnRestDeliveryPointTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - MsgVpnRestDeliveryPoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointResponse response = api.updateMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Queue Binding object. - * - * Update a Queue Binding object. Any attribute missing from the request will be left unchanged. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnRestDeliveryPointQueueBindingTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - MsgVpnRestDeliveryPointQueueBinding body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingResponse response = api.updateMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Request Header object. - * - * Update a Request Header object. Any attribute missing from the request will be left unchanged. A request header to be added to the HTTP request. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- headerName|x|x|||| msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnRestDeliveryPointQueueBindingRequestHeaderTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - String headerName = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse response = api.updateMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a REST Consumer object. - * - * Update a REST Consumer object. Any attribute missing from the request will be left unchanged. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey|||x|||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| authenticationHttpBasicPassword|||x|x||x authenticationHttpBasicUsername||||x|| authenticationHttpHeaderValue|||x|||x authenticationOauthClientId||||x|| authenticationOauthClientScope||||x|| authenticationOauthClientSecret|||x|x||x authenticationOauthClientTokenEndpoint||||x|| authenticationOauthJwtSecretKey|||x|x||x authenticationOauthJwtTokenEndpoint||||x|| authenticationScheme||||x|| msgVpnName|x|x|||| outgoingConnectionCount||||x|| remoteHost||||x|| remotePort||||x|| restConsumerName|x|x|||| restDeliveryPointName|x|x|||| tlsCipherSuiteList||||x|| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnRestDeliveryPointRestConsumerTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - MsgVpnRestDeliveryPointRestConsumer body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerResponse response = api.updateMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Topic Endpoint object. - * - * Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| respectMsgPriorityEnabled||||x|| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnTopicEndpointTest() { - String msgVpnName = null; - String topicEndpointName = null; - MsgVpnTopicEndpoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointResponse response = api.updateMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Topic Endpoint Template object. - * - * Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnTopicEndpointTemplateTest() { - String msgVpnName = null; - String topicEndpointTemplateName = null; - MsgVpnTopicEndpointTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointTemplateResponse response = api.updateMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an OAuth Profile object. - * - * Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: accessLevelGroupsClaimName|global/admin clientId|global/admin clientRedirectUri|global/admin clientRequiredType|global/admin clientScope|global/admin clientSecret|global/admin clientValidateTypeEnabled|global/admin defaultGlobalAccessLevel|global/admin displayName|global/admin enabled|global/admin endpointAuthorization|global/admin endpointDiscovery|global/admin endpointDiscoveryRefreshInterval|global/admin endpointIntrospection|global/admin endpointIntrospectionTimeout|global/admin endpointJwks|global/admin endpointJwksRefreshInterval|global/admin endpointToken|global/admin endpointTokenTimeout|global/admin endpointUserinfo|global/admin endpointUserinfoTimeout|global/admin interactiveEnabled|global/admin interactivePromptForExpiredSession|global/admin interactivePromptForNewSession|global/admin issuer|global/admin oauthRole|global/admin resourceServerParseAccessTokenEnabled|global/admin resourceServerRequiredAudience|global/admin resourceServerRequiredIssuer|global/admin resourceServerRequiredScope|global/admin resourceServerRequiredType|global/admin resourceServerValidateAudienceEnabled|global/admin resourceServerValidateIssuerEnabled|global/admin resourceServerValidateScopeEnabled|global/admin resourceServerValidateTypeEnabled|global/admin sempEnabled|global/admin usernameClaimName|global/admin This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateOauthProfileTest() { - String oauthProfileName = null; - OauthProfile body = null; - String opaquePassword = null; - List select = null; - OauthProfileResponse response = api.updateOauthProfile(oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Group Access Level object. - * - * Update a Group Access Level object. Any attribute missing from the request will be left unchanged. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- groupName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateOauthProfileAccessLevelGroupTest() { - String oauthProfileName = null; - String groupName = null; - OauthProfileAccessLevelGroup body = null; - String opaquePassword = null; - List select = null; - OauthProfileAccessLevelGroupResponse response = api.updateOauthProfileAccessLevelGroup(oauthProfileName, groupName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Message VPN Access-Level Exception object. - * - * Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- groupName|x|x|||| msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String groupName = null; - String msgVpnName = null; - OauthProfileAccessLevelGroupMsgVpnAccessLevelException body = null; - String opaquePassword = null; - List select = null; - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse response = api.updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an Authorization Parameter object. - * - * Update an Authorization Parameter object. Any attribute missing from the request will be left unchanged. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authorizationParameterName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateOauthProfileClientAuthorizationParameterTest() { - String oauthProfileName = null; - String authorizationParameterName = null; - OauthProfileClientAuthorizationParameter body = null; - String opaquePassword = null; - List select = null; - OauthProfileClientAuthorizationParameterResponse response = api.updateOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Message VPN Access-Level Exception object. - * - * Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. Default message VPN access-level exceptions. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateOauthProfileDefaultMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String msgVpnName = null; - OauthProfileDefaultMsgVpnAccessLevelException body = null; - String opaquePassword = null; - List select = null; - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse response = api.updateOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Virtual Hostname object. - * - * Update a Virtual Hostname object. Any attribute missing from the request will be left unchanged. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- virtualHostname|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateVirtualHostnameTest() { - String virtualHostname = null; - VirtualHostname body = null; - String opaquePassword = null; - List select = null; - VirtualHostnameResponse response = api.updateVirtualHostname(virtualHostname, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthenticationOauthProfileApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthenticationOauthProfileApiTest.java deleted file mode 100644 index dc7f3b77b..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthenticationOauthProfileApiTest.java +++ /dev/null @@ -1,321 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for AuthenticationOauthProfileApi - */ -@Ignore -public class AuthenticationOauthProfileApiTest { - - private final AuthenticationOauthProfileApi api = new AuthenticationOauthProfileApi(); - - - /** - * Create an OAuth Profile object. - * - * Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x msgVpnName|x||x||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAuthenticationOauthProfileTest() { - String msgVpnName = null; - MsgVpnAuthenticationOauthProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResponse response = api.createMsgVpnAuthenticationOauthProfile(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Required Claim object. - * - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| msgVpnName|x||x||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAuthenticationOauthProfileClientRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - MsgVpnAuthenticationOauthProfileClientRequiredClaim body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse response = api.createMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Required Claim object. - * - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse response = api.createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete an OAuth Profile object. - * - * Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAuthenticationOauthProfileTest() { - String msgVpnName = null; - String oauthProfileName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName); - - // TODO: test validations - } - - /** - * Delete a Required Claim object. - * - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAuthenticationOauthProfileClientRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - String clientRequiredClaimName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName); - - // TODO: test validations - } - - /** - * Delete a Required Claim object. - * - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - String resourceServerRequiredClaimName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName); - - // TODO: test validations - } - - /** - * Get an OAuth Profile object. - * - * Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfileTest() { - String msgVpnName = null; - String oauthProfileName = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResponse response = api.getMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Required Claim object. - * - * Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfileClientRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - String clientRequiredClaimName = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse response = api.getMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Required Claim objects. - * - * Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfileClientRequiredClaimsTest() { - String msgVpnName = null; - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse response = api.getMsgVpnAuthenticationOauthProfileClientRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Required Claim object. - * - * Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - String resourceServerRequiredClaimName = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse response = api.getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Required Claim objects. - * - * Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsTest() { - String msgVpnName = null; - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse response = api.getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of OAuth Profile objects. - * - * Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfilesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAuthenticationOauthProfilesResponse response = api.getMsgVpnAuthenticationOauthProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace an OAuth Profile object. - * - * Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnAuthenticationOauthProfileTest() { - String msgVpnName = null; - String oauthProfileName = null; - MsgVpnAuthenticationOauthProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResponse response = api.replaceMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an OAuth Profile object. - * - * Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnAuthenticationOauthProfileTest() { - String msgVpnName = null; - String oauthProfileName = null; - MsgVpnAuthenticationOauthProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResponse response = api.updateMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthenticationOauthProviderApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthenticationOauthProviderApiTest.java deleted file mode 100644 index 5262f7100..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthenticationOauthProviderApiTest.java +++ /dev/null @@ -1,155 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProvider; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProviderResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProvidersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for AuthenticationOauthProviderApi - */ -@Ignore -public class AuthenticationOauthProviderApiTest { - - private final AuthenticationOauthProviderApi api = new AuthenticationOauthProviderApi(); - - - /** - * Create an OAuth Provider object. - * - * Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x||x||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword||||x|x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAuthenticationOauthProviderTest() { - String msgVpnName = null; - MsgVpnAuthenticationOauthProvider body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProviderResponse response = api.createMsgVpnAuthenticationOauthProvider(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete an OAuth Provider object. - * - * Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAuthenticationOauthProviderTest() { - String msgVpnName = null; - String oauthProviderName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName); - - // TODO: test validations - } - - /** - * Get an OAuth Provider object. - * - * Get an OAuth Provider object. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProviderTest() { - String msgVpnName = null; - String oauthProviderName = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProviderResponse response = api.getMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of OAuth Provider objects. - * - * Get a list of OAuth Provider objects. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProvidersTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAuthenticationOauthProvidersResponse response = api.getMsgVpnAuthenticationOauthProviders(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace an OAuth Provider object. - * - * Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- audienceClaimName||||||x| audienceClaimSource||||||x| audienceClaimValue||||||x| audienceValidationEnabled||||||x| authorizationGroupClaimName||||||x| authorizationGroupClaimSource||||||x| authorizationGroupEnabled||||||x| disconnectOnTokenExpirationEnabled||||||x| enabled||||||x| jwksRefreshInterval||||||x| jwksUri||||||x| msgVpnName|x||x|||x| oauthProviderName|x||x|||x| tokenIgnoreTimeLimitsEnabled||||||x| tokenIntrospectionParameterName||||||x| tokenIntrospectionPassword||||x||x|x tokenIntrospectionTimeout||||||x| tokenIntrospectionUri||||||x| tokenIntrospectionUsername||||||x| usernameClaimName||||||x| usernameClaimSource||||||x| usernameValidateEnabled||||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnAuthenticationOauthProviderTest() { - String msgVpnName = null; - String oauthProviderName = null; - MsgVpnAuthenticationOauthProvider body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProviderResponse response = api.replaceMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an OAuth Provider object. - * - * Update an OAuth Provider object. Any attribute missing from the request will be left unchanged. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x|x|||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword|||x||x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnAuthenticationOauthProviderTest() { - String msgVpnName = null; - String oauthProviderName = null; - MsgVpnAuthenticationOauthProvider body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProviderResponse response = api.updateMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthorizationGroupApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthorizationGroupApiTest.java deleted file mode 100644 index 01f61f331..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/AuthorizationGroupApiTest.java +++ /dev/null @@ -1,155 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroupResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroupsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for AuthorizationGroupApi - */ -@Ignore -public class AuthorizationGroupApiTest { - - private final AuthorizationGroupApi api = new AuthorizationGroupApi(); - - - /** - * Create an Authorization Group object. - * - * Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationGroupName|x|x|||| msgVpnName|x||x||| orderAfterAuthorizationGroupName||||x|| orderBeforeAuthorizationGroupName||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAuthorizationGroupTest() { - String msgVpnName = null; - MsgVpnAuthorizationGroup body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthorizationGroupResponse response = api.createMsgVpnAuthorizationGroup(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete an Authorization Group object. - * - * Delete an Authorization Group object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAuthorizationGroupTest() { - String msgVpnName = null; - String authorizationGroupName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName); - - // TODO: test validations - } - - /** - * Get an Authorization Group object. - * - * Get an Authorization Group object. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthorizationGroupTest() { - String msgVpnName = null; - String authorizationGroupName = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthorizationGroupResponse response = api.getMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Authorization Group objects. - * - * Get a list of Authorization Group objects. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthorizationGroupsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAuthorizationGroupsResponse response = api.getMsgVpnAuthorizationGroups(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace an Authorization Group object. - * - * Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| authorizationGroupName|x||x|||| clientProfileName|||||x|| msgVpnName|x||x|||| orderAfterAuthorizationGroupName||||x||| orderBeforeAuthorizationGroupName||||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnAuthorizationGroupTest() { - String msgVpnName = null; - String authorizationGroupName = null; - MsgVpnAuthorizationGroup body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthorizationGroupResponse response = api.replaceMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an Authorization Group object. - * - * Update an Authorization Group object. Any attribute missing from the request will be left unchanged. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| authorizationGroupName|x|x|||| clientProfileName||||x|| msgVpnName|x|x|||| orderAfterAuthorizationGroupName|||x||| orderBeforeAuthorizationGroupName|||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnAuthorizationGroupTest() { - String msgVpnName = null; - String authorizationGroupName = null; - MsgVpnAuthorizationGroup body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthorizationGroupResponse response = api.updateMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/BridgeApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/BridgeApiTest.java deleted file mode 100644 index 9b8cbe225..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/BridgeApiTest.java +++ /dev/null @@ -1,468 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpnResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpnsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for BridgeApi - */ -@Ignore -public class BridgeApiTest { - - private final BridgeApi api = new BridgeApi(); - - - /** - * Create a Bridge object. - * - * Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| msgVpnName|x||x||| remoteAuthenticationBasicPassword||||x||x remoteAuthenticationClientCertContent||||x||x remoteAuthenticationClientCertPassword||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnBridgeTest() { - String msgVpnName = null; - MsgVpnBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeResponse response = api.createMsgVpnBridge(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Remote Message VPN object. - * - * Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| msgVpnName|x||x||| password||||x||x remoteMsgVpnInterface|x||||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnBridgeRemoteMsgVpnTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - MsgVpnBridgeRemoteMsgVpn body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteMsgVpnResponse response = api.createMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Remote Subscription object. - * - * Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| deliverAlwaysEnabled||x|||| msgVpnName|x||x||| remoteSubscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnBridgeRemoteSubscriptionTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - MsgVpnBridgeRemoteSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteSubscriptionResponse response = api.createMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Trusted Common Name object. - * - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||x| bridgeVirtualRouter|x||x||x| msgVpnName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnBridgeTlsTrustedCommonNameTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - MsgVpnBridgeTlsTrustedCommonName body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeTlsTrustedCommonNameResponse response = api.createMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Bridge object. - * - * Delete a Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnBridgeTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - SempMetaOnlyResponse response = api.deleteMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter); - - // TODO: test validations - } - - /** - * Delete a Remote Message VPN object. - * - * Delete a Remote Message VPN object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnBridgeRemoteMsgVpnTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteMsgVpnName = null; - String remoteMsgVpnLocation = null; - String remoteMsgVpnInterface = null; - SempMetaOnlyResponse response = api.deleteMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface); - - // TODO: test validations - } - - /** - * Delete a Remote Subscription object. - * - * Delete a Remote Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnBridgeRemoteSubscriptionTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteSubscriptionTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic); - - // TODO: test validations - } - - /** - * Delete a Trusted Common Name object. - * - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnBridgeTlsTrustedCommonNameTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String tlsTrustedCommonName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName); - - // TODO: test validations - } - - /** - * Get a Bridge object. - * - * Get a Bridge object. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeResponse response = api.getMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Remote Message VPN object. - * - * Get a Remote Message VPN object. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeRemoteMsgVpnTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteMsgVpnName = null; - String remoteMsgVpnLocation = null; - String remoteMsgVpnInterface = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteMsgVpnResponse response = api.getMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Remote Message VPN objects. - * - * Get a list of Remote Message VPN objects. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeRemoteMsgVpnsTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnBridgeRemoteMsgVpnsResponse response = api.getMsgVpnBridgeRemoteMsgVpns(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Remote Subscription object. - * - * Get a Remote Subscription object. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeRemoteSubscriptionTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteSubscriptionTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteSubscriptionResponse response = api.getMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Remote Subscription objects. - * - * Get a list of Remote Subscription objects. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeRemoteSubscriptionsTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnBridgeRemoteSubscriptionsResponse response = api.getMsgVpnBridgeRemoteSubscriptions(msgVpnName, bridgeName, bridgeVirtualRouter, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Trusted Common Name object. - * - * Get a Trusted Common Name object. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeTlsTrustedCommonNameTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String tlsTrustedCommonName = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeTlsTrustedCommonNameResponse response = api.getMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Trusted Common Name objects. - * - * Get a list of Trusted Common Name objects. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeTlsTrustedCommonNamesTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnBridgeTlsTrustedCommonNamesResponse response = api.getMsgVpnBridgeTlsTrustedCommonNames(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Bridge objects. - * - * Get a list of Bridge objects. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnBridgesResponse response = api.getMsgVpnBridges(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Bridge object. - * - * Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| maxTtl|||||x|| msgVpnName|x||x|||| remoteAuthenticationBasicClientUsername|||||x|| remoteAuthenticationBasicPassword||||x|x||x remoteAuthenticationClientCertContent||||x|x||x remoteAuthenticationClientCertPassword||||x|x|| remoteAuthenticationScheme|||||x|| remoteDeliverToOnePriority|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnBridgeTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - MsgVpnBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeResponse response = api.replaceMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Remote Message VPN object. - * - * Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| clientUsername|||||x|| compressedDataEnabled|||||x|| egressFlowWindowSize|||||x|| msgVpnName|x||x|||| password||||x|x||x remoteMsgVpnInterface|x||x|||| remoteMsgVpnLocation|x||x|||| remoteMsgVpnName|x||x|||| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnBridgeRemoteMsgVpnTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteMsgVpnName = null; - String remoteMsgVpnLocation = null; - String remoteMsgVpnInterface = null; - MsgVpnBridgeRemoteMsgVpn body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteMsgVpnResponse response = api.replaceMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Bridge object. - * - * Update a Bridge object. Any attribute missing from the request will be left unchanged. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| maxTtl||||x|| msgVpnName|x|x|||| remoteAuthenticationBasicClientUsername||||x|| remoteAuthenticationBasicPassword|||x|x||x remoteAuthenticationClientCertContent|||x|x||x remoteAuthenticationClientCertPassword|||x|x|| remoteAuthenticationScheme||||x|| remoteDeliverToOnePriority||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnBridgeTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - MsgVpnBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeResponse response = api.updateMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Remote Message VPN object. - * - * Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| clientUsername||||x|| compressedDataEnabled||||x|| egressFlowWindowSize||||x|| msgVpnName|x|x|||| password|||x|x||x remoteMsgVpnInterface|x|x|||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnBridgeRemoteMsgVpnTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteMsgVpnName = null; - String remoteMsgVpnLocation = null; - String remoteMsgVpnInterface = null; - MsgVpnBridgeRemoteMsgVpn body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteMsgVpnResponse response = api.updateMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/CertAuthorityApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/CertAuthorityApiTest.java deleted file mode 100644 index 97f6eece9..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/CertAuthorityApiTest.java +++ /dev/null @@ -1,226 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthoritiesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for CertAuthorityApi - */ -@Ignore -public class CertAuthorityApiTest { - - private final CertAuthorityApi api = new CertAuthorityApi(); - - - /** - * Create a Certificate Authority object. - * - * Create a Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||x| certContent|||||x| crlDayList|||||x| crlTimeList|||||x| crlUrl|||||x| ocspNonResponderCertEnabled|||||x| ocspOverrideUrl|||||x| ocspTimeout|||||x| revocationCheckEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createCertAuthorityTest() { - CertAuthority body = null; - String opaquePassword = null; - List select = null; - CertAuthorityResponse response = api.createCertAuthority(body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an OCSP Responder Trusted Common Name object. - * - * Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x||x||x| ocspTlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createCertAuthorityOcspTlsTrustedCommonNameTest() { - String certAuthorityName = null; - CertAuthorityOcspTlsTrustedCommonName body = null; - String opaquePassword = null; - List select = null; - CertAuthorityOcspTlsTrustedCommonNameResponse response = api.createCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Certificate Authority object. - * - * Delete a Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteCertAuthorityTest() { - String certAuthorityName = null; - SempMetaOnlyResponse response = api.deleteCertAuthority(certAuthorityName); - - // TODO: test validations - } - - /** - * Delete an OCSP Responder Trusted Common Name object. - * - * Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteCertAuthorityOcspTlsTrustedCommonNameTest() { - String certAuthorityName = null; - String ocspTlsTrustedCommonName = null; - SempMetaOnlyResponse response = api.deleteCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName); - - // TODO: test validations - } - - /** - * Get a list of Certificate Authority objects. - * - * Get a list of Certificate Authority objects. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| certContent|||x| crlDayList|||x| crlTimeList|||x| crlUrl|||x| ocspNonResponderCertEnabled|||x| ocspOverrideUrl|||x| ocspTimeout|||x| revocationCheckEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getCertAuthoritiesTest() { - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - CertAuthoritiesResponse response = api.getCertAuthorities(count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Certificate Authority object. - * - * Get a Certificate Authority object. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| certContent|||x| crlDayList|||x| crlTimeList|||x| crlUrl|||x| ocspNonResponderCertEnabled|||x| ocspOverrideUrl|||x| ocspTimeout|||x| revocationCheckEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getCertAuthorityTest() { - String certAuthorityName = null; - String opaquePassword = null; - List select = null; - CertAuthorityResponse response = api.getCertAuthority(certAuthorityName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get an OCSP Responder Trusted Common Name object. - * - * Get an OCSP Responder Trusted Common Name object. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| ocspTlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getCertAuthorityOcspTlsTrustedCommonNameTest() { - String certAuthorityName = null; - String ocspTlsTrustedCommonName = null; - String opaquePassword = null; - List select = null; - CertAuthorityOcspTlsTrustedCommonNameResponse response = api.getCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of OCSP Responder Trusted Common Name objects. - * - * Get a list of OCSP Responder Trusted Common Name objects. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||x| ocspTlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getCertAuthorityOcspTlsTrustedCommonNamesTest() { - String certAuthorityName = null; - String opaquePassword = null; - List where = null; - List select = null; - CertAuthorityOcspTlsTrustedCommonNamesResponse response = api.getCertAuthorityOcspTlsTrustedCommonNames(certAuthorityName, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Certificate Authority object. - * - * Replace a Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||x| certContent||||||x| crlDayList||||||x| crlTimeList||||||x| crlUrl|||||x|x| ocspNonResponderCertEnabled||||||x| ocspOverrideUrl||||||x| ocspTimeout||||||x| revocationCheckEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceCertAuthorityTest() { - String certAuthorityName = null; - CertAuthority body = null; - String opaquePassword = null; - List select = null; - CertAuthorityResponse response = api.replaceCertAuthority(certAuthorityName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Certificate Authority object. - * - * Update a Certificate Authority object. Any attribute missing from the request will be left unchanged. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||x| certContent|||||x| crlDayList|||||x| crlTimeList|||||x| crlUrl||||x|x| ocspNonResponderCertEnabled|||||x| ocspOverrideUrl|||||x| ocspTimeout|||||x| revocationCheckEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- CertAuthority|crlDayList|crlTimeList| CertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateCertAuthorityTest() { - String certAuthorityName = null; - CertAuthority body = null; - String opaquePassword = null; - List select = null; - CertAuthorityResponse response = api.updateCertAuthority(certAuthorityName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/CertMatchingRuleApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/CertMatchingRuleApiTest.java deleted file mode 100644 index a9ff93dd2..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/CertMatchingRuleApiTest.java +++ /dev/null @@ -1,363 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFiltersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleConditionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleConditionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRulesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for CertMatchingRuleApi - */ -@Ignore -public class CertMatchingRuleApiTest { - - private final CertMatchingRuleApi api = new CertMatchingRuleApi(); - - - /** - * Create a Certificate Matching Rule object. - * - * Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnCertMatchingRuleTest() { - String msgVpnName = null; - MsgVpnCertMatchingRule body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleResponse response = api.createMsgVpnCertMatchingRule(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Certificate Matching Rule Attribute Filter object. - * - * Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: filterName|x|x|||| msgVpnName|x||x||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnCertMatchingRuleAttributeFilterTest() { - String msgVpnName = null; - String ruleName = null; - MsgVpnCertMatchingRuleAttributeFilter body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleAttributeFilterResponse response = api.createMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Certificate Matching Rule Condition object. - * - * Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnCertMatchingRuleConditionTest() { - String msgVpnName = null; - String ruleName = null; - MsgVpnCertMatchingRuleCondition body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleConditionResponse response = api.createMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Certificate Matching Rule object. - * - * Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnCertMatchingRuleTest() { - String msgVpnName = null; - String ruleName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnCertMatchingRule(msgVpnName, ruleName); - - // TODO: test validations - } - - /** - * Delete a Certificate Matching Rule Attribute Filter object. - * - * Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnCertMatchingRuleAttributeFilterTest() { - String msgVpnName = null; - String ruleName = null; - String filterName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName); - - // TODO: test validations - } - - /** - * Delete a Certificate Matching Rule Condition object. - * - * Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnCertMatchingRuleConditionTest() { - String msgVpnName = null; - String ruleName = null; - String source = null; - SempMetaOnlyResponse response = api.deleteMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source); - - // TODO: test validations - } - - /** - * Get a Certificate Matching Rule object. - * - * Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRuleTest() { - String msgVpnName = null; - String ruleName = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleResponse response = api.getMsgVpnCertMatchingRule(msgVpnName, ruleName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Certificate Matching Rule Attribute Filter object. - * - * Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRuleAttributeFilterTest() { - String msgVpnName = null; - String ruleName = null; - String filterName = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleAttributeFilterResponse response = api.getMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Certificate Matching Rule Attribute Filter objects. - * - * Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRuleAttributeFiltersTest() { - String msgVpnName = null; - String ruleName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnCertMatchingRuleAttributeFiltersResponse response = api.getMsgVpnCertMatchingRuleAttributeFilters(msgVpnName, ruleName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Certificate Matching Rule Condition object. - * - * Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRuleConditionTest() { - String msgVpnName = null; - String ruleName = null; - String source = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleConditionResponse response = api.getMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Certificate Matching Rule Condition objects. - * - * Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRuleConditionsTest() { - String msgVpnName = null; - String ruleName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnCertMatchingRuleConditionsResponse response = api.getMsgVpnCertMatchingRuleConditions(msgVpnName, ruleName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Certificate Matching Rule objects. - * - * Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRulesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnCertMatchingRulesResponse response = api.getMsgVpnCertMatchingRules(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Certificate Matching Rule object. - * - * Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnCertMatchingRuleTest() { - String msgVpnName = null; - String ruleName = null; - MsgVpnCertMatchingRule body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleResponse response = api.replaceMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Certificate Matching Rule Attribute Filter object. - * - * Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- filterName|x||x|||| msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnCertMatchingRuleAttributeFilterTest() { - String msgVpnName = null; - String ruleName = null; - String filterName = null; - MsgVpnCertMatchingRuleAttributeFilter body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleAttributeFilterResponse response = api.replaceMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Certificate Matching Rule object. - * - * Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnCertMatchingRuleTest() { - String msgVpnName = null; - String ruleName = null; - MsgVpnCertMatchingRule body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleResponse response = api.updateMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Certificate Matching Rule Attribute Filter object. - * - * Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- filterName|x|x|||| msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnCertMatchingRuleAttributeFilterTest() { - String msgVpnName = null; - String ruleName = null; - String filterName = null; - MsgVpnCertMatchingRuleAttributeFilter body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleAttributeFilterResponse response = api.updateMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientCertAuthorityApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientCertAuthorityApiTest.java deleted file mode 100644 index b344c9086..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientCertAuthorityApiTest.java +++ /dev/null @@ -1,226 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthoritiesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for ClientCertAuthorityApi - */ -@Ignore -public class ClientCertAuthorityApiTest { - - private final ClientCertAuthorityApi api = new ClientCertAuthorityApi(); - - - /** - * Create a Client Certificate Authority object. - * - * Create a Client Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createClientCertAuthorityTest() { - ClientCertAuthority body = null; - String opaquePassword = null; - List select = null; - ClientCertAuthorityResponse response = api.createClientCertAuthority(body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an OCSP Responder Trusted Common Name object. - * - * Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x||x||| ocspTlsTrustedCommonName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createClientCertAuthorityOcspTlsTrustedCommonNameTest() { - String certAuthorityName = null; - ClientCertAuthorityOcspTlsTrustedCommonName body = null; - String opaquePassword = null; - List select = null; - ClientCertAuthorityOcspTlsTrustedCommonNameResponse response = api.createClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Client Certificate Authority object. - * - * Delete a Client Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteClientCertAuthorityTest() { - String certAuthorityName = null; - SempMetaOnlyResponse response = api.deleteClientCertAuthority(certAuthorityName); - - // TODO: test validations - } - - /** - * Delete an OCSP Responder Trusted Common Name object. - * - * Delete an OCSP Responder Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteClientCertAuthorityOcspTlsTrustedCommonNameTest() { - String certAuthorityName = null; - String ocspTlsTrustedCommonName = null; - SempMetaOnlyResponse response = api.deleteClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName); - - // TODO: test validations - } - - /** - * Get a list of Client Certificate Authority objects. - * - * Get a list of Client Certificate Authority objects. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getClientCertAuthoritiesTest() { - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - ClientCertAuthoritiesResponse response = api.getClientCertAuthorities(count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Client Certificate Authority object. - * - * Get a Client Certificate Authority object. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getClientCertAuthorityTest() { - String certAuthorityName = null; - String opaquePassword = null; - List select = null; - ClientCertAuthorityResponse response = api.getClientCertAuthority(certAuthorityName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get an OCSP Responder Trusted Common Name object. - * - * Get an OCSP Responder Trusted Common Name object. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| ocspTlsTrustedCommonName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getClientCertAuthorityOcspTlsTrustedCommonNameTest() { - String certAuthorityName = null; - String ocspTlsTrustedCommonName = null; - String opaquePassword = null; - List select = null; - ClientCertAuthorityOcspTlsTrustedCommonNameResponse response = api.getClientCertAuthorityOcspTlsTrustedCommonName(certAuthorityName, ocspTlsTrustedCommonName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of OCSP Responder Trusted Common Name objects. - * - * Get a list of OCSP Responder Trusted Common Name objects. When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| ocspTlsTrustedCommonName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getClientCertAuthorityOcspTlsTrustedCommonNamesTest() { - String certAuthorityName = null; - String opaquePassword = null; - List where = null; - List select = null; - ClientCertAuthorityOcspTlsTrustedCommonNamesResponse response = api.getClientCertAuthorityOcspTlsTrustedCommonNames(certAuthorityName, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Client Certificate Authority object. - * - * Replace a Client Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||| crlUrl|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceClientCertAuthorityTest() { - String certAuthorityName = null; - ClientCertAuthority body = null; - String opaquePassword = null; - List select = null; - ClientCertAuthorityResponse response = api.replaceClientCertAuthority(certAuthorityName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Client Certificate Authority object. - * - * Update a Client Certificate Authority object. Any attribute missing from the request will be left unchanged. Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||| crlUrl||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- ClientCertAuthority|crlDayList|crlTimeList| ClientCertAuthority|crlTimeList|crlDayList| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateClientCertAuthorityTest() { - String certAuthorityName = null; - ClientCertAuthority body = null; - String opaquePassword = null; - List select = null; - ClientCertAuthorityResponse response = api.updateClientCertAuthority(certAuthorityName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientProfileApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientProfileApiTest.java deleted file mode 100644 index 1b7becd47..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientProfileApiTest.java +++ /dev/null @@ -1,155 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for ClientProfileApi - */ -@Ignore -public class ClientProfileApiTest { - - private final ClientProfileApi api = new ClientProfileApi(); - - - /** - * Create a Client Profile object. - * - * Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnClientProfileTest() { - String msgVpnName = null; - MsgVpnClientProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientProfileResponse response = api.createMsgVpnClientProfile(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Client Profile object. - * - * Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnClientProfileTest() { - String msgVpnName = null; - String clientProfileName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnClientProfile(msgVpnName, clientProfileName); - - // TODO: test validations - } - - /** - * Get a Client Profile object. - * - * Get a Client Profile object. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientProfileTest() { - String msgVpnName = null; - String clientProfileName = null; - String opaquePassword = null; - List select = null; - MsgVpnClientProfileResponse response = api.getMsgVpnClientProfile(msgVpnName, clientProfileName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Client Profile objects. - * - * Get a list of Client Profile objects. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientProfilesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnClientProfilesResponse response = api.getMsgVpnClientProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Client Profile object. - * - * Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled||||||x| apiQueueManagementCopyFromOnCreateName||||||x| apiTopicEndpointManagementCopyFromOnCreateName||||||x| clientProfileName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnClientProfileTest() { - String msgVpnName = null; - String clientProfileName = null; - MsgVpnClientProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientProfileResponse response = api.replaceMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Client Profile object. - * - * Update a Client Profile object. Any attribute missing from the request will be left unchanged. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnClientProfileTest() { - String msgVpnName = null; - String clientProfileName = null; - MsgVpnClientProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientProfileResponse response = api.updateMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientUsernameApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientUsernameApiTest.java deleted file mode 100644 index 629ef66ef..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ClientUsernameApiTest.java +++ /dev/null @@ -1,240 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsername; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttributeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttributesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for ClientUsernameApi - */ -@Ignore -public class ClientUsernameApiTest { - - private final ClientUsernameApi api = new ClientUsernameApi(); - - - /** - * Create a Client Username object. - * - * Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientUsername|x|x|||| msgVpnName|x||x||| password||||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnClientUsernameTest() { - String msgVpnName = null; - MsgVpnClientUsername body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameResponse response = api.createMsgVpnClientUsername(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Client Username Attribute object. - * - * Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| clientUsername|x||x||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnClientUsernameAttributeTest() { - String msgVpnName = null; - String clientUsername = null; - MsgVpnClientUsernameAttribute body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameAttributeResponse response = api.createMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Client Username object. - * - * Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnClientUsernameTest() { - String msgVpnName = null; - String clientUsername = null; - SempMetaOnlyResponse response = api.deleteMsgVpnClientUsername(msgVpnName, clientUsername); - - // TODO: test validations - } - - /** - * Delete a Client Username Attribute object. - * - * Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnClientUsernameAttributeTest() { - String msgVpnName = null; - String clientUsername = null; - String attributeName = null; - String attributeValue = null; - SempMetaOnlyResponse response = api.deleteMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue); - - // TODO: test validations - } - - /** - * Get a Client Username object. - * - * Get a Client Username object. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientUsernameTest() { - String msgVpnName = null; - String clientUsername = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameResponse response = api.getMsgVpnClientUsername(msgVpnName, clientUsername, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Client Username Attribute object. - * - * Get a Client Username Attribute object. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientUsernameAttributeTest() { - String msgVpnName = null; - String clientUsername = null; - String attributeName = null; - String attributeValue = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameAttributeResponse response = api.getMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Client Username Attribute objects. - * - * Get a list of Client Username Attribute objects. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientUsernameAttributesTest() { - String msgVpnName = null; - String clientUsername = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnClientUsernameAttributesResponse response = api.getMsgVpnClientUsernameAttributes(msgVpnName, clientUsername, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Client Username objects. - * - * Get a list of Client Username objects. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientUsernamesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnClientUsernamesResponse response = api.getMsgVpnClientUsernames(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Client Username object. - * - * Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| clientProfileName|||||x|| clientUsername|x||x|||| msgVpnName|x||x|||| password||||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnClientUsernameTest() { - String msgVpnName = null; - String clientUsername = null; - MsgVpnClientUsername body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameResponse response = api.replaceMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Client Username object. - * - * Update a Client Username object. Any attribute missing from the request will be left unchanged. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| clientProfileName||||x|| clientUsername|x|x|||| msgVpnName|x|x|||| password|||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnClientUsernameTest() { - String msgVpnName = null; - String clientUsername = null; - MsgVpnClientUsername body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameResponse response = api.updateMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DistributedCacheApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DistributedCacheApiTest.java deleted file mode 100644 index 6bfd0b51c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DistributedCacheApiTest.java +++ /dev/null @@ -1,676 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstance; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstanceResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstancesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClustersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCachesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for DistributedCacheApi - */ -@Ignore -public class DistributedCacheApiTest { - - private final DistributedCacheApi api = new DistributedCacheApi(); - - - /** - * Create a Distributed Cache object. - * - * Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheTest() { - String msgVpnName = null; - MsgVpnDistributedCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheResponse response = api.createMsgVpnDistributedCache(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Cache Cluster object. - * - * Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheClusterTest() { - String msgVpnName = null; - String cacheName = null; - MsgVpnDistributedCacheCluster body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterResponse response = api.createMsgVpnDistributedCacheCluster(msgVpnName, cacheName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Home Cache Cluster object. - * - * Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeCluster body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse response = api.createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Topic Prefix object. - * - * Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x||x||| msgVpnName|x||x||| topicPrefix|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse response = api.createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Cache Instance object. - * - * Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| instanceName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheClusterInstanceTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - MsgVpnDistributedCacheClusterInstance body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterInstanceResponse response = api.createMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Topic object. - * - * Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| msgVpnName|x||x||| topic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheClusterTopicTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - MsgVpnDistributedCacheClusterTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterTopicResponse response = api.createMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Distributed Cache object. - * - * Delete a Distributed Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheTest() { - String msgVpnName = null; - String cacheName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCache(msgVpnName, cacheName); - - // TODO: test validations - } - - /** - * Delete a Cache Cluster object. - * - * Delete a Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName); - - // TODO: test validations - } - - /** - * Delete a Home Cache Cluster object. - * - * Delete a Home Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName); - - // TODO: test validations - } - - /** - * Delete a Topic Prefix object. - * - * Delete a Topic Prefix object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - String topicPrefix = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix); - - // TODO: test validations - } - - /** - * Delete a Cache Instance object. - * - * Delete a Cache Instance object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheClusterInstanceTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String instanceName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName); - - // TODO: test validations - } - - /** - * Delete a Topic object. - * - * Delete a Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheClusterTopicTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String topic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic); - - // TODO: test validations - } - - /** - * Get a Distributed Cache object. - * - * Get a Distributed Cache object. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheTest() { - String msgVpnName = null; - String cacheName = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheResponse response = api.getMsgVpnDistributedCache(msgVpnName, cacheName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Cache Cluster object. - * - * Get a Cache Cluster object. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterResponse response = api.getMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Home Cache Cluster object. - * - * Get a Home Cache Cluster object. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse response = api.getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Topic Prefix object. - * - * Get a Topic Prefix object. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - String topicPrefix = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse response = api.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Topic Prefix objects. - * - * Get a list of Topic Prefix objects. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse response = api.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes(msgVpnName, cacheName, clusterName, homeClusterName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Home Cache Cluster objects. - * - * Get a list of Home Cache Cluster objects. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterGlobalCachingHomeClustersTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse response = api.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Cache Instance object. - * - * Get a Cache Instance object. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterInstanceTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String instanceName = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterInstanceResponse response = api.getMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Cache Instance objects. - * - * Get a list of Cache Instance objects. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterInstancesTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCacheClusterInstancesResponse response = api.getMsgVpnDistributedCacheClusterInstances(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Topic object. - * - * Get a Topic object. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterTopicTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String topic = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterTopicResponse response = api.getMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Topic objects. - * - * Get a list of Topic objects. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterTopicsTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCacheClusterTopicsResponse response = api.getMsgVpnDistributedCacheClusterTopics(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Cache Cluster objects. - * - * Get a list of Cache Cluster objects. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClustersTest() { - String msgVpnName = null; - String cacheName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCacheClustersResponse response = api.getMsgVpnDistributedCacheClusters(msgVpnName, cacheName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Distributed Cache objects. - * - * Get a list of Distributed Cache objects. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCachesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCachesResponse response = api.getMsgVpnDistributedCaches(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Distributed Cache object. - * - * Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| cacheVirtualRouter||x||||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnDistributedCacheTest() { - String msgVpnName = null; - String cacheName = null; - MsgVpnDistributedCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheResponse response = api.replaceMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Cache Cluster object. - * - * Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnDistributedCacheClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - MsgVpnDistributedCacheCluster body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterResponse response = api.replaceMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Cache Instance object. - * - * Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| instanceName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnDistributedCacheClusterInstanceTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String instanceName = null; - MsgVpnDistributedCacheClusterInstance body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterInstanceResponse response = api.replaceMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Distributed Cache object. - * - * Update a Distributed Cache object. Any attribute missing from the request will be left unchanged. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| cacheVirtualRouter||x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnDistributedCacheTest() { - String msgVpnName = null; - String cacheName = null; - MsgVpnDistributedCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheResponse response = api.updateMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Cache Cluster object. - * - * Update a Cache Cluster object. Any attribute missing from the request will be left unchanged. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnDistributedCacheClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - MsgVpnDistributedCacheCluster body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterResponse response = api.updateMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Cache Instance object. - * - * Update a Cache Instance object. Any attribute missing from the request will be left unchanged. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| instanceName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnDistributedCacheClusterInstanceTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String instanceName = null; - MsgVpnDistributedCacheClusterInstance body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterInstanceResponse response = api.updateMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DmrBridgeApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DmrBridgeApiTest.java deleted file mode 100644 index 2f31731f2..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DmrBridgeApiTest.java +++ /dev/null @@ -1,155 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridgeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridgesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for DmrBridgeApi - */ -@Ignore -public class DmrBridgeApiTest { - - private final DmrBridgeApi api = new DmrBridgeApi(); - - - /** - * Create a DMR Bridge object. - * - * Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDmrBridgeTest() { - String msgVpnName = null; - MsgVpnDmrBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnDmrBridgeResponse response = api.createMsgVpnDmrBridge(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a DMR Bridge object. - * - * Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDmrBridgeTest() { - String msgVpnName = null; - String remoteNodeName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDmrBridge(msgVpnName, remoteNodeName); - - // TODO: test validations - } - - /** - * Get a DMR Bridge object. - * - * Get a DMR Bridge object. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDmrBridgeTest() { - String msgVpnName = null; - String remoteNodeName = null; - String opaquePassword = null; - List select = null; - MsgVpnDmrBridgeResponse response = api.getMsgVpnDmrBridge(msgVpnName, remoteNodeName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of DMR Bridge objects. - * - * Get a list of DMR Bridge objects. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDmrBridgesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDmrBridgesResponse response = api.getMsgVpnDmrBridges(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a DMR Bridge object. - * - * Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| remoteNodeName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnDmrBridgeTest() { - String msgVpnName = null; - String remoteNodeName = null; - MsgVpnDmrBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnDmrBridgeResponse response = api.replaceMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a DMR Bridge object. - * - * Update a DMR Bridge object. Any attribute missing from the request will be left unchanged. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnDmrBridgeTest() { - String msgVpnName = null; - String remoteNodeName = null; - MsgVpnDmrBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnDmrBridgeResponse response = api.updateMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DmrClusterApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DmrClusterApiTest.java deleted file mode 100644 index fbcc37e96..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DmrClusterApiTest.java +++ /dev/null @@ -1,842 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFilterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFiltersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleConditionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleConditionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRulesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLink; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttributeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttributesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddress; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddressResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddressesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinksResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClustersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for DmrClusterApi - */ -@Ignore -public class DmrClusterApiTest { - - private final DmrClusterApi api = new DmrClusterApi(); - - - /** - * Create a Cluster object. - * - * Create a Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationBasicPassword||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| dmrClusterName|x|x|||| nodeName|||x||| tlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDmrClusterTest() { - DmrCluster body = null; - String opaquePassword = null; - List select = null; - DmrClusterResponse response = api.createDmrCluster(body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Certificate Matching Rule object. - * - * Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDmrClusterCertMatchingRuleTest() { - String dmrClusterName = null; - DmrClusterCertMatchingRule body = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleResponse response = api.createDmrClusterCertMatchingRule(dmrClusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Certificate Matching Rule Attribute Filter object. - * - * Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| filterName|x|x|||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDmrClusterCertMatchingRuleAttributeFilterTest() { - String dmrClusterName = null; - String ruleName = null; - DmrClusterCertMatchingRuleAttributeFilter body = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleAttributeFilterResponse response = api.createDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Certificate Matching Rule Condition object. - * - * Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDmrClusterCertMatchingRuleConditionTest() { - String dmrClusterName = null; - String ruleName = null; - DmrClusterCertMatchingRuleCondition body = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleConditionResponse response = api.createDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Link object. - * - * Create a Link object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationBasicPassword||||x||x dmrClusterName|x||x||| remoteNodeName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDmrClusterLinkTest() { - String dmrClusterName = null; - DmrClusterLink body = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkResponse response = api.createDmrClusterLink(dmrClusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Link Attribute object. - * - * Create a Link Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| dmrClusterName|x||x||| remoteNodeName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDmrClusterLinkAttributeTest() { - String dmrClusterName = null; - String remoteNodeName = null; - DmrClusterLinkAttribute body = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkAttributeResponse response = api.createDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Remote Address object. - * - * Create a Remote Address object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||| remoteAddress|x|x|||| remoteNodeName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDmrClusterLinkRemoteAddressTest() { - String dmrClusterName = null; - String remoteNodeName = null; - DmrClusterLinkRemoteAddress body = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkRemoteAddressResponse response = api.createDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Trusted Common Name object. - * - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: dmrClusterName|x||x||x| remoteNodeName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDmrClusterLinkTlsTrustedCommonNameTest() { - String dmrClusterName = null; - String remoteNodeName = null; - DmrClusterLinkTlsTrustedCommonName body = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkTlsTrustedCommonNameResponse response = api.createDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Cluster object. - * - * Delete a Cluster object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDmrClusterTest() { - String dmrClusterName = null; - SempMetaOnlyResponse response = api.deleteDmrCluster(dmrClusterName); - - // TODO: test validations - } - - /** - * Delete a Certificate Matching Rule object. - * - * Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDmrClusterCertMatchingRuleTest() { - String dmrClusterName = null; - String ruleName = null; - SempMetaOnlyResponse response = api.deleteDmrClusterCertMatchingRule(dmrClusterName, ruleName); - - // TODO: test validations - } - - /** - * Delete a Certificate Matching Rule Attribute Filter object. - * - * Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Attribute Filter compares a link attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDmrClusterCertMatchingRuleAttributeFilterTest() { - String dmrClusterName = null; - String ruleName = null; - String filterName = null; - SempMetaOnlyResponse response = api.deleteDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName); - - // TODO: test validations - } - - /** - * Delete a Certificate Matching Rule Condition object. - * - * Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDmrClusterCertMatchingRuleConditionTest() { - String dmrClusterName = null; - String ruleName = null; - String source = null; - SempMetaOnlyResponse response = api.deleteDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, source); - - // TODO: test validations - } - - /** - * Delete a Link object. - * - * Delete a Link object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDmrClusterLinkTest() { - String dmrClusterName = null; - String remoteNodeName = null; - SempMetaOnlyResponse response = api.deleteDmrClusterLink(dmrClusterName, remoteNodeName); - - // TODO: test validations - } - - /** - * Delete a Link Attribute object. - * - * Delete a Link Attribute object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDmrClusterLinkAttributeTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String attributeName = null; - String attributeValue = null; - SempMetaOnlyResponse response = api.deleteDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, attributeName, attributeValue); - - // TODO: test validations - } - - /** - * Delete a Remote Address object. - * - * Delete a Remote Address object. The deletion of instances of this object are synchronized to HA mates via config-sync. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDmrClusterLinkRemoteAddressTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String remoteAddress = null; - SempMetaOnlyResponse response = api.deleteDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, remoteAddress); - - // TODO: test validations - } - - /** - * Delete a Trusted Common Name object. - * - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates via config-sync. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDmrClusterLinkTlsTrustedCommonNameTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String tlsTrustedCommonName = null; - SempMetaOnlyResponse response = api.deleteDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, tlsTrustedCommonName); - - // TODO: test validations - } - - /** - * Get a Cluster object. - * - * Get a Cluster object. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| dmrClusterName|x||| tlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterTest() { - String dmrClusterName = null; - String opaquePassword = null; - List select = null; - DmrClusterResponse response = api.getDmrCluster(dmrClusterName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Certificate Matching Rule object. - * - * Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterCertMatchingRuleTest() { - String dmrClusterName = null; - String ruleName = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleResponse response = api.getDmrClusterCertMatchingRule(dmrClusterName, ruleName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Certificate Matching Rule Attribute Filter object. - * - * Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| filterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterCertMatchingRuleAttributeFilterTest() { - String dmrClusterName = null; - String ruleName = null; - String filterName = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleAttributeFilterResponse response = api.getDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Certificate Matching Rule Attribute Filter objects. - * - * Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| filterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterCertMatchingRuleAttributeFiltersTest() { - String dmrClusterName = null; - String ruleName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - DmrClusterCertMatchingRuleAttributeFiltersResponse response = api.getDmrClusterCertMatchingRuleAttributeFilters(dmrClusterName, ruleName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Certificate Matching Rule Condition object. - * - * Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterCertMatchingRuleConditionTest() { - String dmrClusterName = null; - String ruleName = null; - String source = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleConditionResponse response = api.getDmrClusterCertMatchingRuleCondition(dmrClusterName, ruleName, source, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Certificate Matching Rule Condition objects. - * - * Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterCertMatchingRuleConditionsTest() { - String dmrClusterName = null; - String ruleName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - DmrClusterCertMatchingRuleConditionsResponse response = api.getDmrClusterCertMatchingRuleConditions(dmrClusterName, ruleName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Certificate Matching Rule objects. - * - * Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterCertMatchingRulesTest() { - String dmrClusterName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - DmrClusterCertMatchingRulesResponse response = api.getDmrClusterCertMatchingRules(dmrClusterName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Link object. - * - * Get a Link object. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterLinkTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkResponse response = api.getDmrClusterLink(dmrClusterName, remoteNodeName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Link Attribute object. - * - * Get a Link Attribute object. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterLinkAttributeTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String attributeName = null; - String attributeValue = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkAttributeResponse response = api.getDmrClusterLinkAttribute(dmrClusterName, remoteNodeName, attributeName, attributeValue, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Link Attribute objects. - * - * Get a list of Link Attribute objects. A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterLinkAttributesTest() { - String dmrClusterName = null; - String remoteNodeName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - DmrClusterLinkAttributesResponse response = api.getDmrClusterLinkAttributes(dmrClusterName, remoteNodeName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Remote Address object. - * - * Get a Remote Address object. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| remoteAddress|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterLinkRemoteAddressTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String remoteAddress = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkRemoteAddressResponse response = api.getDmrClusterLinkRemoteAddress(dmrClusterName, remoteNodeName, remoteAddress, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Remote Address objects. - * - * Get a list of Remote Address objects. Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||| remoteAddress|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterLinkRemoteAddressesTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String opaquePassword = null; - List where = null; - List select = null; - DmrClusterLinkRemoteAddressesResponse response = api.getDmrClusterLinkRemoteAddresses(dmrClusterName, remoteNodeName, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Trusted Common Name object. - * - * Get a Trusted Common Name object. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||x| remoteNodeName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterLinkTlsTrustedCommonNameTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String tlsTrustedCommonName = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkTlsTrustedCommonNameResponse response = api.getDmrClusterLinkTlsTrustedCommonName(dmrClusterName, remoteNodeName, tlsTrustedCommonName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Trusted Common Name objects. - * - * Get a list of Trusted Common Name objects. The Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: dmrClusterName|x||x| remoteNodeName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterLinkTlsTrustedCommonNamesTest() { - String dmrClusterName = null; - String remoteNodeName = null; - String opaquePassword = null; - List where = null; - List select = null; - DmrClusterLinkTlsTrustedCommonNamesResponse response = api.getDmrClusterLinkTlsTrustedCommonNames(dmrClusterName, remoteNodeName, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Link objects. - * - * Get a list of Link objects. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x dmrClusterName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClusterLinksTest() { - String dmrClusterName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - DmrClusterLinksResponse response = api.getDmrClusterLinks(dmrClusterName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Cluster objects. - * - * Get a list of Cluster objects. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationBasicPassword||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| dmrClusterName|x||| tlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDmrClustersTest() { - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - DmrClustersResponse response = api.getDmrClusters(count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Cluster object. - * - * Replace a Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword||||x|x||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| directOnlyEnabled||x||||| dmrClusterName|x||x|||| nodeName|||x|||| tlsServerCertEnforceTrustedCommonNameEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceDmrClusterTest() { - String dmrClusterName = null; - DmrCluster body = null; - String opaquePassword = null; - List select = null; - DmrClusterResponse response = api.replaceDmrCluster(dmrClusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Certificate Matching Rule object. - * - * Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- dmrClusterName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceDmrClusterCertMatchingRuleTest() { - String dmrClusterName = null; - String ruleName = null; - DmrClusterCertMatchingRule body = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleResponse response = api.replaceDmrClusterCertMatchingRule(dmrClusterName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Certificate Matching Rule Attribute Filter object. - * - * Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- dmrClusterName|x||x|||| filterName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceDmrClusterCertMatchingRuleAttributeFilterTest() { - String dmrClusterName = null; - String ruleName = null; - String filterName = null; - DmrClusterCertMatchingRuleAttributeFilter body = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleAttributeFilterResponse response = api.replaceDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Link object. - * - * Replace a Link object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword||||x|x||x authenticationScheme|||||x|| dmrClusterName|x||x|||| egressFlowWindowSize|||||x|| initiator|||||x|| remoteNodeName|x||x|||| span|||||x|| transportCompressedEnabled|||||x|| transportTlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceDmrClusterLinkTest() { - String dmrClusterName = null; - String remoteNodeName = null; - DmrClusterLink body = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkResponse response = api.replaceDmrClusterLink(dmrClusterName, remoteNodeName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Cluster object. - * - * Update a Cluster object. Any attribute missing from the request will be left unchanged. A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword|||x|x||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| directOnlyEnabled||x|||| dmrClusterName|x|x|||| nodeName||x|||| tlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- DmrCluster|authenticationClientCertPassword|authenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateDmrClusterTest() { - String dmrClusterName = null; - DmrCluster body = null; - String opaquePassword = null; - List select = null; - DmrClusterResponse response = api.updateDmrCluster(dmrClusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Certificate Matching Rule object. - * - * Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- dmrClusterName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateDmrClusterCertMatchingRuleTest() { - String dmrClusterName = null; - String ruleName = null; - DmrClusterCertMatchingRule body = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleResponse response = api.updateDmrClusterCertMatchingRule(dmrClusterName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Certificate Matching Rule Attribute Filter object. - * - * Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a link attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- dmrClusterName|x|x|||| filterName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateDmrClusterCertMatchingRuleAttributeFilterTest() { - String dmrClusterName = null; - String ruleName = null; - String filterName = null; - DmrClusterCertMatchingRuleAttributeFilter body = null; - String opaquePassword = null; - List select = null; - DmrClusterCertMatchingRuleAttributeFilterResponse response = api.updateDmrClusterCertMatchingRuleAttributeFilter(dmrClusterName, ruleName, filterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Link object. - * - * Update a Link object. Any attribute missing from the request will be left unchanged. A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationBasicPassword|||x|x||x authenticationScheme||||x|| dmrClusterName|x|x|||| egressFlowWindowSize||||x|| initiator||||x|| remoteNodeName|x|x|||| span||||x|| transportCompressedEnabled||||x|| transportTlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateDmrClusterLinkTest() { - String dmrClusterName = null; - String remoteNodeName = null; - DmrClusterLink body = null; - String opaquePassword = null; - List select = null; - DmrClusterLinkResponse response = api.updateDmrClusterLink(dmrClusterName, remoteNodeName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DomainCertAuthorityApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DomainCertAuthorityApiTest.java deleted file mode 100644 index b1c800fb0..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/DomainCertAuthorityApiTest.java +++ /dev/null @@ -1,149 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthoritiesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthorityResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for DomainCertAuthorityApi - */ -@Ignore -public class DomainCertAuthorityApiTest { - - private final DomainCertAuthorityApi api = new DomainCertAuthorityApi(); - - - /** - * Create a Domain Certificate Authority object. - * - * Create a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Certificate Authorities trusted for domain verification. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: certAuthorityName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createDomainCertAuthorityTest() { - DomainCertAuthority body = null; - String opaquePassword = null; - List select = null; - DomainCertAuthorityResponse response = api.createDomainCertAuthority(body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Domain Certificate Authority object. - * - * Delete a Domain Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync. Certificate Authorities trusted for domain verification. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteDomainCertAuthorityTest() { - String certAuthorityName = null; - SempMetaOnlyResponse response = api.deleteDomainCertAuthority(certAuthorityName); - - // TODO: test validations - } - - /** - * Get a list of Domain Certificate Authority objects. - * - * Get a list of Domain Certificate Authority objects. Certificate Authorities trusted for domain verification. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDomainCertAuthoritiesTest() { - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - DomainCertAuthoritiesResponse response = api.getDomainCertAuthorities(count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Domain Certificate Authority object. - * - * Get a Domain Certificate Authority object. Certificate Authorities trusted for domain verification. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: certAuthorityName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getDomainCertAuthorityTest() { - String certAuthorityName = null; - String opaquePassword = null; - List select = null; - DomainCertAuthorityResponse response = api.getDomainCertAuthority(certAuthorityName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Domain Certificate Authority object. - * - * Replace a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Certificate Authorities trusted for domain verification. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- certAuthorityName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceDomainCertAuthorityTest() { - String certAuthorityName = null; - DomainCertAuthority body = null; - String opaquePassword = null; - List select = null; - DomainCertAuthorityResponse response = api.replaceDomainCertAuthority(certAuthorityName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Domain Certificate Authority object. - * - * Update a Domain Certificate Authority object. Any attribute missing from the request will be left unchanged. Certificate Authorities trusted for domain verification. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- certAuthorityName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.19. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateDomainCertAuthorityTest() { - String certAuthorityName = null; - DomainCertAuthority body = null; - String opaquePassword = null; - List select = null; - DomainCertAuthorityResponse response = api.updateDomainCertAuthority(certAuthorityName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/JndiApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/JndiApiTest.java deleted file mode 100644 index cec5699e4..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/JndiApiTest.java +++ /dev/null @@ -1,393 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactoriesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactory; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactoryResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueueResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueuesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for JndiApi - */ -@Ignore -public class JndiApiTest { - - private final JndiApi api = new JndiApi(); - - - /** - * Create a JNDI Connection Factory object. - * - * Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: connectionFactoryName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnJndiConnectionFactoryTest() { - String msgVpnName = null; - MsgVpnJndiConnectionFactory body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiConnectionFactoryResponse response = api.createMsgVpnJndiConnectionFactory(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a JNDI Queue object. - * - * Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnJndiQueueTest() { - String msgVpnName = null; - MsgVpnJndiQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiQueueResponse response = api.createMsgVpnJndiQueue(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a JNDI Topic object. - * - * Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnJndiTopicTest() { - String msgVpnName = null; - MsgVpnJndiTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiTopicResponse response = api.createMsgVpnJndiTopic(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a JNDI Connection Factory object. - * - * Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnJndiConnectionFactoryTest() { - String msgVpnName = null; - String connectionFactoryName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName); - - // TODO: test validations - } - - /** - * Delete a JNDI Queue object. - * - * Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnJndiQueueTest() { - String msgVpnName = null; - String queueName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnJndiQueue(msgVpnName, queueName); - - // TODO: test validations - } - - /** - * Delete a JNDI Topic object. - * - * Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnJndiTopicTest() { - String msgVpnName = null; - String topicName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnJndiTopic(msgVpnName, topicName); - - // TODO: test validations - } - - /** - * Get a list of JNDI Connection Factory objects. - * - * Get a list of JNDI Connection Factory objects. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiConnectionFactoriesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnJndiConnectionFactoriesResponse response = api.getMsgVpnJndiConnectionFactories(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a JNDI Connection Factory object. - * - * Get a JNDI Connection Factory object. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiConnectionFactoryTest() { - String msgVpnName = null; - String connectionFactoryName = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiConnectionFactoryResponse response = api.getMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a JNDI Queue object. - * - * Get a JNDI Queue object. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiQueueTest() { - String msgVpnName = null; - String queueName = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiQueueResponse response = api.getMsgVpnJndiQueue(msgVpnName, queueName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of JNDI Queue objects. - * - * Get a list of JNDI Queue objects. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiQueuesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnJndiQueuesResponse response = api.getMsgVpnJndiQueues(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a JNDI Topic object. - * - * Get a JNDI Topic object. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiTopicTest() { - String msgVpnName = null; - String topicName = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiTopicResponse response = api.getMsgVpnJndiTopic(msgVpnName, topicName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of JNDI Topic objects. - * - * Get a list of JNDI Topic objects. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiTopicsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnJndiTopicsResponse response = api.getMsgVpnJndiTopics(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a JNDI Connection Factory object. - * - * Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnJndiConnectionFactoryTest() { - String msgVpnName = null; - String connectionFactoryName = null; - MsgVpnJndiConnectionFactory body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiConnectionFactoryResponse response = api.replaceMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a JNDI Queue object. - * - * Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnJndiQueueTest() { - String msgVpnName = null; - String queueName = null; - MsgVpnJndiQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiQueueResponse response = api.replaceMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a JNDI Topic object. - * - * Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnJndiTopicTest() { - String msgVpnName = null; - String topicName = null; - MsgVpnJndiTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiTopicResponse response = api.replaceMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a JNDI Connection Factory object. - * - * Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnJndiConnectionFactoryTest() { - String msgVpnName = null; - String connectionFactoryName = null; - MsgVpnJndiConnectionFactory body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiConnectionFactoryResponse response = api.updateMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a JNDI Queue object. - * - * Update a JNDI Queue object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnJndiQueueTest() { - String msgVpnName = null; - String queueName = null; - MsgVpnJndiQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiQueueResponse response = api.updateMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a JNDI Topic object. - * - * Update a JNDI Topic object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnJndiTopicTest() { - String msgVpnName = null; - String topicName = null; - MsgVpnJndiTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiTopicResponse response = api.updateMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MqttRetainCacheApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MqttRetainCacheApiTest.java deleted file mode 100644 index 387c1e06f..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MqttRetainCacheApiTest.java +++ /dev/null @@ -1,155 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCacheResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCachesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for MqttRetainCacheApi - */ -@Ignore -public class MqttRetainCacheApiTest { - - private final MqttRetainCacheApi api = new MqttRetainCacheApi(); - - - /** - * Create an MQTT Retain Cache object. - * - * Create an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnMqttRetainCacheTest() { - String msgVpnName = null; - MsgVpnMqttRetainCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttRetainCacheResponse response = api.createMsgVpnMqttRetainCache(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete an MQTT Retain Cache object. - * - * Delete an MQTT Retain Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnMqttRetainCacheTest() { - String msgVpnName = null; - String cacheName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnMqttRetainCache(msgVpnName, cacheName); - - // TODO: test validations - } - - /** - * Get an MQTT Retain Cache object. - * - * Get an MQTT Retain Cache object. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttRetainCacheTest() { - String msgVpnName = null; - String cacheName = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttRetainCacheResponse response = api.getMsgVpnMqttRetainCache(msgVpnName, cacheName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of MQTT Retain Cache objects. - * - * Get a list of MQTT Retain Cache objects. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttRetainCachesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnMqttRetainCachesResponse response = api.getMsgVpnMqttRetainCaches(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace an MQTT Retain Cache object. - * - * Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnMqttRetainCacheTest() { - String msgVpnName = null; - String cacheName = null; - MsgVpnMqttRetainCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttRetainCacheResponse response = api.replaceMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an MQTT Retain Cache object. - * - * Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnMqttRetainCacheTest() { - String msgVpnName = null; - String cacheName = null; - MsgVpnMqttRetainCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttRetainCacheResponse response = api.updateMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MqttSessionApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MqttSessionApiTest.java deleted file mode 100644 index f3e3ccc41..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MqttSessionApiTest.java +++ /dev/null @@ -1,290 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSession; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for MqttSessionApi - */ -@Ignore -public class MqttSessionApiTest { - - private final MqttSessionApi api = new MqttSessionApi(); - - - /** - * Create an MQTT Session object. - * - * Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnMqttSessionTest() { - String msgVpnName = null; - MsgVpnMqttSession body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionResponse response = api.createMsgVpnMqttSession(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Subscription object. - * - * Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x||x||| mqttSessionVirtualRouter|x||x||| msgVpnName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnMqttSessionSubscriptionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - MsgVpnMqttSessionSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionSubscriptionResponse response = api.createMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete an MQTT Session object. - * - * Delete an MQTT Session object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnMqttSessionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - SempMetaOnlyResponse response = api.deleteMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter); - - // TODO: test validations - } - - /** - * Delete a Subscription object. - * - * Delete a Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnMqttSessionSubscriptionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - String subscriptionTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic); - - // TODO: test validations - } - - /** - * Get an MQTT Session object. - * - * Get an MQTT Session object. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttSessionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionResponse response = api.getMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Subscription object. - * - * Get a Subscription object. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttSessionSubscriptionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - String subscriptionTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionSubscriptionResponse response = api.getMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Subscription objects. - * - * Get a list of Subscription objects. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttSessionSubscriptionsTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnMqttSessionSubscriptionsResponse response = api.getMsgVpnMqttSessionSubscriptions(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of MQTT Session objects. - * - * Get a list of MQTT Session objects. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttSessionsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnMqttSessionsResponse response = api.getMsgVpnMqttSessions(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace an MQTT Session object. - * - * Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| owner|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnMqttSessionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - MsgVpnMqttSession body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionResponse response = api.replaceMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Subscription object. - * - * Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| subscriptionTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnMqttSessionSubscriptionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - String subscriptionTopic = null; - MsgVpnMqttSessionSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionSubscriptionResponse response = api.replaceMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an MQTT Session object. - * - * Update an MQTT Session object. Any attribute missing from the request will be left unchanged. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| owner||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnMqttSessionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - MsgVpnMqttSession body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionResponse response = api.updateMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Subscription object. - * - * Update a Subscription object. Any attribute missing from the request will be left unchanged. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnMqttSessionSubscriptionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - String subscriptionTopic = null; - MsgVpnMqttSessionSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionSubscriptionResponse response = api.updateMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MsgVpnApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MsgVpnApiTest.java deleted file mode 100644 index 3c32464d8..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/MsgVpnApiTest.java +++ /dev/null @@ -1,5501 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProvider; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProviderResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProvidersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroupResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroupsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpnResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpnsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFiltersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleConditionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleConditionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRulesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsername; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttributeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttributesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstance; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstanceResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstancesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClustersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCachesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridgeResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridgesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactoriesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactory; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactoryResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueueResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueuesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCacheResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCachesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSession; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplateResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplatesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueuesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLog; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBinding; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeader; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumer; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplateResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplatesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for MsgVpnApi - */ -@Ignore -public class MsgVpnApiTest { - - private final MsgVpnApi api = new MsgVpnApi(); - - - /** - * Create a Message VPN object. - * - * Create a Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| distributedCacheManagementEnabled|||||x| msgVpnName|x|x|||| replicationBridgeAuthenticationBasicPassword||||x||x replicationBridgeAuthenticationClientCertContent||||x||x replicationBridgeAuthenticationClientCertPassword||||x|| replicationEnabledQueueBehavior||||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnTest() { - MsgVpn body = null; - String opaquePassword = null; - List select = null; - MsgVpnResponse response = api.createMsgVpn(body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an ACL Profile object. - * - * Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfileTest() { - String msgVpnName = null; - MsgVpnAclProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileResponse response = api.createMsgVpnAclProfile(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Client Connect Exception object. - * - * Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| clientConnectExceptionAddress|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfileClientConnectExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfileClientConnectException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileClientConnectExceptionResponse response = api.createMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Publish Topic Exception object. - * - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| publishExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfilePublishExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfilePublishException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfilePublishExceptionResponse response = api.createMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Publish Topic Exception object. - * - * Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| publishTopicException|x|x|||| publishTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfilePublishTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfilePublishTopicException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfilePublishTopicExceptionResponse response = api.createMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Subscribe Topic Exception object. - * - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||x| msgVpnName|x||x||x| subscribeExceptionTopic|x|x|||x| topicSyntax|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfileSubscribeExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfileSubscribeException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeExceptionResponse response = api.createMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Subscribe Share Name Exception object. - * - * Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeShareNameException|x|x|||| subscribeShareNameExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfileSubscribeShareNameExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfileSubscribeShareNameException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeShareNameExceptionResponse response = api.createMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Subscribe Topic Exception object. - * - * Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: aclProfileName|x||x||| msgVpnName|x||x||| subscribeTopicException|x|x|||| subscribeTopicExceptionSyntax|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAclProfileSubscribeTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfileSubscribeTopicException body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeTopicExceptionResponse response = api.createMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an OAuth Profile object. - * - * Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x msgVpnName|x||x||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAuthenticationOauthProfileTest() { - String msgVpnName = null; - MsgVpnAuthenticationOauthProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResponse response = api.createMsgVpnAuthenticationOauthProfile(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Required Claim object. - * - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| msgVpnName|x||x||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAuthenticationOauthProfileClientRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - MsgVpnAuthenticationOauthProfileClientRequiredClaim body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse response = api.createMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Required Claim object. - * - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse response = api.createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an OAuth Provider object. - * - * Create an OAuth Provider object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x||x||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword||||x|x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAuthenticationOauthProviderTest() { - String msgVpnName = null; - MsgVpnAuthenticationOauthProvider body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProviderResponse response = api.createMsgVpnAuthenticationOauthProvider(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an Authorization Group object. - * - * Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationGroupName|x|x|||| msgVpnName|x||x||| orderAfterAuthorizationGroupName||||x|| orderBeforeAuthorizationGroupName||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnAuthorizationGroupTest() { - String msgVpnName = null; - MsgVpnAuthorizationGroup body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthorizationGroupResponse response = api.createMsgVpnAuthorizationGroup(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Bridge object. - * - * Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| msgVpnName|x||x||| remoteAuthenticationBasicPassword||||x||x remoteAuthenticationClientCertContent||||x||x remoteAuthenticationClientCertPassword||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnBridgeTest() { - String msgVpnName = null; - MsgVpnBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeResponse response = api.createMsgVpnBridge(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Remote Message VPN object. - * - * Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| msgVpnName|x||x||| password||||x||x remoteMsgVpnInterface|x||||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnBridgeRemoteMsgVpnTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - MsgVpnBridgeRemoteMsgVpn body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteMsgVpnResponse response = api.createMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Remote Subscription object. - * - * Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||| bridgeVirtualRouter|x||x||| deliverAlwaysEnabled||x|||| msgVpnName|x||x||| remoteSubscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnBridgeRemoteSubscriptionTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - MsgVpnBridgeRemoteSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteSubscriptionResponse response = api.createMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Trusted Common Name object. - * - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: bridgeName|x||x||x| bridgeVirtualRouter|x||x||x| msgVpnName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnBridgeTlsTrustedCommonNameTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - MsgVpnBridgeTlsTrustedCommonName body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeTlsTrustedCommonNameResponse response = api.createMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Certificate Matching Rule object. - * - * Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnCertMatchingRuleTest() { - String msgVpnName = null; - MsgVpnCertMatchingRule body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleResponse response = api.createMsgVpnCertMatchingRule(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Certificate Matching Rule Attribute Filter object. - * - * Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: filterName|x|x|||| msgVpnName|x||x||| ruleName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnCertMatchingRuleAttributeFilterTest() { - String msgVpnName = null; - String ruleName = null; - MsgVpnCertMatchingRuleAttributeFilter body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleAttributeFilterResponse response = api.createMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Certificate Matching Rule Condition object. - * - * Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| ruleName|x||x||| source|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnCertMatchingRuleConditionTest() { - String msgVpnName = null; - String ruleName = null; - MsgVpnCertMatchingRuleCondition body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleConditionResponse response = api.createMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Client Profile object. - * - * Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnClientProfileTest() { - String msgVpnName = null; - MsgVpnClientProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientProfileResponse response = api.createMsgVpnClientProfile(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Client Username object. - * - * Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientUsername|x|x|||| msgVpnName|x||x||| password||||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnClientUsernameTest() { - String msgVpnName = null; - MsgVpnClientUsername body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameResponse response = api.createMsgVpnClientUsername(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Client Username Attribute object. - * - * Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: attributeName|x|x|||| attributeValue|x|x|||| clientUsername|x||x||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnClientUsernameAttributeTest() { - String msgVpnName = null; - String clientUsername = null; - MsgVpnClientUsernameAttribute body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameAttributeResponse response = api.createMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Distributed Cache object. - * - * Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheTest() { - String msgVpnName = null; - MsgVpnDistributedCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheResponse response = api.createMsgVpnDistributedCache(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Cache Cluster object. - * - * Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheClusterTest() { - String msgVpnName = null; - String cacheName = null; - MsgVpnDistributedCacheCluster body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterResponse response = api.createMsgVpnDistributedCacheCluster(msgVpnName, cacheName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Home Cache Cluster object. - * - * Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeCluster body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse response = api.createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Topic Prefix object. - * - * Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| homeClusterName|x||x||| msgVpnName|x||x||| topicPrefix|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse response = api.createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Cache Instance object. - * - * Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| instanceName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheClusterInstanceTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - MsgVpnDistributedCacheClusterInstance body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterInstanceResponse response = api.createMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Topic object. - * - * Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x||x||| clusterName|x||x||| msgVpnName|x||x||| topic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDistributedCacheClusterTopicTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - MsgVpnDistributedCacheClusterTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterTopicResponse response = api.createMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a DMR Bridge object. - * - * Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnDmrBridgeTest() { - String msgVpnName = null; - MsgVpnDmrBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnDmrBridgeResponse response = api.createMsgVpnDmrBridge(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a JNDI Connection Factory object. - * - * Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: connectionFactoryName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnJndiConnectionFactoryTest() { - String msgVpnName = null; - MsgVpnJndiConnectionFactory body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiConnectionFactoryResponse response = api.createMsgVpnJndiConnectionFactory(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a JNDI Queue object. - * - * Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnJndiQueueTest() { - String msgVpnName = null; - MsgVpnJndiQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiQueueResponse response = api.createMsgVpnJndiQueue(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a JNDI Topic object. - * - * Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnJndiTopicTest() { - String msgVpnName = null; - MsgVpnJndiTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiTopicResponse response = api.createMsgVpnJndiTopic(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an MQTT Retain Cache object. - * - * Create an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: cacheName|x|x|||| msgVpnName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnMqttRetainCacheTest() { - String msgVpnName = null; - MsgVpnMqttRetainCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttRetainCacheResponse response = api.createMsgVpnMqttRetainCache(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an MQTT Session object. - * - * Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnMqttSessionTest() { - String msgVpnName = null; - MsgVpnMqttSession body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionResponse response = api.createMsgVpnMqttSession(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Subscription object. - * - * Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: mqttSessionClientId|x||x||| mqttSessionVirtualRouter|x||x||| msgVpnName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnMqttSessionSubscriptionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - MsgVpnMqttSessionSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionSubscriptionResponse response = api.createMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Queue object. - * - * Create a Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnQueueTest() { - String msgVpnName = null; - MsgVpnQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueResponse response = api.createMsgVpnQueue(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Queue Subscription object. - * - * Create a Queue Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnQueueSubscriptionTest() { - String msgVpnName = null; - String queueName = null; - MsgVpnQueueSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueSubscriptionResponse response = api.createMsgVpnQueueSubscription(msgVpnName, queueName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Queue Template object. - * - * Create a Queue Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnQueueTemplateTest() { - String msgVpnName = null; - MsgVpnQueueTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueTemplateResponse response = api.createMsgVpnQueueTemplate(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Replay Log object. - * - * Create a Replay Log object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnReplayLogTest() { - String msgVpnName = null; - MsgVpnReplayLog body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogResponse response = api.createMsgVpnReplayLog(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Topic Filter Subscription object. - * - * Create a Topic Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x||x||| topicFilterSubscription|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnReplayLogTopicFilterSubscriptionTest() { - String msgVpnName = null; - String replayLogName = null; - MsgVpnReplayLogTopicFilterSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogTopicFilterSubscriptionResponse response = api.createMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Replicated Topic object. - * - * Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnReplicatedTopicTest() { - String msgVpnName = null; - MsgVpnReplicatedTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplicatedTopicResponse response = api.createMsgVpnReplicatedTopic(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a REST Delivery Point object. - * - * Create a REST Delivery Point object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointTest() { - String msgVpnName = null; - MsgVpnRestDeliveryPoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointResponse response = api.createMsgVpnRestDeliveryPoint(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Queue Binding object. - * - * Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueBindingName|x|x|||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointQueueBindingTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - MsgVpnRestDeliveryPointQueueBinding body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingResponse response = api.createMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Request Header object. - * - * Create a Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: headerName|x|x|||| msgVpnName|x||x||| queueBindingName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointQueueBindingRequestHeaderTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse response = api.createMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a REST Consumer object. - * - * Create a REST Consumer object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| authenticationHttpBasicPassword||||x||x authenticationHttpHeaderValue||||x||x authenticationOauthClientSecret||||x||x authenticationOauthJwtSecretKey||||x||x msgVpnName|x||x||| restConsumerName|x|x|||| restDeliveryPointName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointRestConsumerTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - MsgVpnRestDeliveryPointRestConsumer body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerResponse response = api.createMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Claim object. - * - * Create a Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthJwtClaimName|x|x|||| oauthJwtClaimValue||x|||| restConsumerName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse response = api.createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Trusted Common Name object. - * - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||x| restConsumerName|x||x||x| restDeliveryPointName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse response = api.createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Sequenced Topic object. - * - * Create a Sequenced Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| sequencedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnSequencedTopicTest() { - String msgVpnName = null; - MsgVpnSequencedTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnSequencedTopicResponse response = api.createMsgVpnSequencedTopic(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Topic Endpoint object. - * - * Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnTopicEndpointTest() { - String msgVpnName = null; - MsgVpnTopicEndpoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointResponse response = api.createMsgVpnTopicEndpoint(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Topic Endpoint Template object. - * - * Create a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnTopicEndpointTemplateTest() { - String msgVpnName = null; - MsgVpnTopicEndpointTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointTemplateResponse response = api.createMsgVpnTopicEndpointTemplate(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Message VPN object. - * - * Delete a Message VPN object. The deletion of instances of this object are synchronized to HA mates via config-sync. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnTest() { - String msgVpnName = null; - SempMetaOnlyResponse response = api.deleteMsgVpn(msgVpnName); - - // TODO: test validations - } - - /** - * Delete an ACL Profile object. - * - * Delete an ACL Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfileTest() { - String msgVpnName = null; - String aclProfileName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfile(msgVpnName, aclProfileName); - - // TODO: test validations - } - - /** - * Delete a Client Connect Exception object. - * - * Delete a Client Connect Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfileClientConnectExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String clientConnectExceptionAddress = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress); - - // TODO: test validations - } - - /** - * Delete a Publish Topic Exception object. - * - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfilePublishExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String topicSyntax = null; - String publishExceptionTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic); - - // TODO: test validations - } - - /** - * Delete a Publish Topic Exception object. - * - * Delete a Publish Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfilePublishTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String publishTopicExceptionSyntax = null; - String publishTopicException = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException); - - // TODO: test validations - } - - /** - * Delete a Subscribe Topic Exception object. - * - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfileSubscribeExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String topicSyntax = null; - String subscribeExceptionTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic); - - // TODO: test validations - } - - /** - * Delete a Subscribe Share Name Exception object. - * - * Delete a Subscribe Share Name Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfileSubscribeShareNameExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String subscribeShareNameExceptionSyntax = null; - String subscribeShareNameException = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException); - - // TODO: test validations - } - - /** - * Delete a Subscribe Topic Exception object. - * - * Delete a Subscribe Topic Exception object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAclProfileSubscribeTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String subscribeTopicExceptionSyntax = null; - String subscribeTopicException = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException); - - // TODO: test validations - } - - /** - * Delete an OAuth Profile object. - * - * Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAuthenticationOauthProfileTest() { - String msgVpnName = null; - String oauthProfileName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName); - - // TODO: test validations - } - - /** - * Delete a Required Claim object. - * - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAuthenticationOauthProfileClientRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - String clientRequiredClaimName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName); - - // TODO: test validations - } - - /** - * Delete a Required Claim object. - * - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - String resourceServerRequiredClaimName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName); - - // TODO: test validations - } - - /** - * Delete an OAuth Provider object. - * - * Delete an OAuth Provider object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAuthenticationOauthProviderTest() { - String msgVpnName = null; - String oauthProviderName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName); - - // TODO: test validations - } - - /** - * Delete an Authorization Group object. - * - * Delete an Authorization Group object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnAuthorizationGroupTest() { - String msgVpnName = null; - String authorizationGroupName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName); - - // TODO: test validations - } - - /** - * Delete a Bridge object. - * - * Delete a Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnBridgeTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - SempMetaOnlyResponse response = api.deleteMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter); - - // TODO: test validations - } - - /** - * Delete a Remote Message VPN object. - * - * Delete a Remote Message VPN object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Remote Message VPN is the Message VPN that the Bridge connects to. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnBridgeRemoteMsgVpnTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteMsgVpnName = null; - String remoteMsgVpnLocation = null; - String remoteMsgVpnInterface = null; - SempMetaOnlyResponse response = api.deleteMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface); - - // TODO: test validations - } - - /** - * Delete a Remote Subscription object. - * - * Delete a Remote Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnBridgeRemoteSubscriptionTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteSubscriptionTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic); - - // TODO: test validations - } - - /** - * Delete a Trusted Common Name object. - * - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnBridgeTlsTrustedCommonNameTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String tlsTrustedCommonName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName); - - // TODO: test validations - } - - /** - * Delete a Certificate Matching Rule object. - * - * Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnCertMatchingRuleTest() { - String msgVpnName = null; - String ruleName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnCertMatchingRule(msgVpnName, ruleName); - - // TODO: test validations - } - - /** - * Delete a Certificate Matching Rule Attribute Filter object. - * - * Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Attribute Filter compares a username attribute to a string. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnCertMatchingRuleAttributeFilterTest() { - String msgVpnName = null; - String ruleName = null; - String filterName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName); - - // TODO: test validations - } - - /** - * Delete a Certificate Matching Rule Condition object. - * - * Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnCertMatchingRuleConditionTest() { - String msgVpnName = null; - String ruleName = null; - String source = null; - SempMetaOnlyResponse response = api.deleteMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source); - - // TODO: test validations - } - - /** - * Delete a Client Profile object. - * - * Delete a Client Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnClientProfileTest() { - String msgVpnName = null; - String clientProfileName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnClientProfile(msgVpnName, clientProfileName); - - // TODO: test validations - } - - /** - * Delete a Client Username object. - * - * Delete a Client Username object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnClientUsernameTest() { - String msgVpnName = null; - String clientUsername = null; - SempMetaOnlyResponse response = api.deleteMsgVpnClientUsername(msgVpnName, clientUsername); - - // TODO: test validations - } - - /** - * Delete a Client Username Attribute object. - * - * Delete a Client Username Attribute object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnClientUsernameAttributeTest() { - String msgVpnName = null; - String clientUsername = null; - String attributeName = null; - String attributeValue = null; - SempMetaOnlyResponse response = api.deleteMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue); - - // TODO: test validations - } - - /** - * Delete a Distributed Cache object. - * - * Delete a Distributed Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheTest() { - String msgVpnName = null; - String cacheName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCache(msgVpnName, cacheName); - - // TODO: test validations - } - - /** - * Delete a Cache Cluster object. - * - * Delete a Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName); - - // TODO: test validations - } - - /** - * Delete a Home Cache Cluster object. - * - * Delete a Home Cache Cluster object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName); - - // TODO: test validations - } - - /** - * Delete a Topic Prefix object. - * - * Delete a Topic Prefix object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - String topicPrefix = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix); - - // TODO: test validations - } - - /** - * Delete a Cache Instance object. - * - * Delete a Cache Instance object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheClusterInstanceTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String instanceName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName); - - // TODO: test validations - } - - /** - * Delete a Topic object. - * - * Delete a Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDistributedCacheClusterTopicTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String topic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic); - - // TODO: test validations - } - - /** - * Delete a DMR Bridge object. - * - * Delete a DMR Bridge object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnDmrBridgeTest() { - String msgVpnName = null; - String remoteNodeName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnDmrBridge(msgVpnName, remoteNodeName); - - // TODO: test validations - } - - /** - * Delete a JNDI Connection Factory object. - * - * Delete a JNDI Connection Factory object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnJndiConnectionFactoryTest() { - String msgVpnName = null; - String connectionFactoryName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName); - - // TODO: test validations - } - - /** - * Delete a JNDI Queue object. - * - * Delete a JNDI Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnJndiQueueTest() { - String msgVpnName = null; - String queueName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnJndiQueue(msgVpnName, queueName); - - // TODO: test validations - } - - /** - * Delete a JNDI Topic object. - * - * Delete a JNDI Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnJndiTopicTest() { - String msgVpnName = null; - String topicName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnJndiTopic(msgVpnName, topicName); - - // TODO: test validations - } - - /** - * Delete an MQTT Retain Cache object. - * - * Delete an MQTT Retain Cache object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnMqttRetainCacheTest() { - String msgVpnName = null; - String cacheName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnMqttRetainCache(msgVpnName, cacheName); - - // TODO: test validations - } - - /** - * Delete an MQTT Session object. - * - * Delete an MQTT Session object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnMqttSessionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - SempMetaOnlyResponse response = api.deleteMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter); - - // TODO: test validations - } - - /** - * Delete a Subscription object. - * - * Delete a Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnMqttSessionSubscriptionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - String subscriptionTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic); - - // TODO: test validations - } - - /** - * Delete a Queue object. - * - * Delete a Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnQueueTest() { - String msgVpnName = null; - String queueName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnQueue(msgVpnName, queueName); - - // TODO: test validations - } - - /** - * Delete a Queue Subscription object. - * - * Delete a Queue Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnQueueSubscriptionTest() { - String msgVpnName = null; - String queueName = null; - String subscriptionTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic); - - // TODO: test validations - } - - /** - * Delete a Queue Template object. - * - * Delete a Queue Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnQueueTemplateTest() { - String msgVpnName = null; - String queueTemplateName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnQueueTemplate(msgVpnName, queueTemplateName); - - // TODO: test validations - } - - /** - * Delete a Replay Log object. - * - * Delete a Replay Log object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnReplayLogTest() { - String msgVpnName = null; - String replayLogName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnReplayLog(msgVpnName, replayLogName); - - // TODO: test validations - } - - /** - * Delete a Topic Filter Subscription object. - * - * Delete a Topic Filter Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnReplayLogTopicFilterSubscriptionTest() { - String msgVpnName = null; - String replayLogName = null; - String topicFilterSubscription = null; - SempMetaOnlyResponse response = api.deleteMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription); - - // TODO: test validations - } - - /** - * Delete a Replicated Topic object. - * - * Delete a Replicated Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnReplicatedTopicTest() { - String msgVpnName = null; - String replicatedTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnReplicatedTopic(msgVpnName, replicatedTopic); - - // TODO: test validations - } - - /** - * Delete a REST Delivery Point object. - * - * Delete a REST Delivery Point object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName); - - // TODO: test validations - } - - /** - * Delete a Queue Binding object. - * - * Delete a Queue Binding object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointQueueBindingTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName); - - // TODO: test validations - } - - /** - * Delete a Request Header object. - * - * Delete a Request Header object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointQueueBindingRequestHeaderTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - String headerName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName); - - // TODO: test validations - } - - /** - * Delete a REST Consumer object. - * - * Delete a REST Consumer object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointRestConsumerTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName); - - // TODO: test validations - } - - /** - * Delete a Claim object. - * - * Delete a Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String oauthJwtClaimName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName); - - // TODO: test validations - } - - /** - * Delete a Trusted Common Name object. - * - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String tlsTrustedCommonName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName); - - // TODO: test validations - } - - /** - * Delete a Sequenced Topic object. - * - * Delete a Sequenced Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnSequencedTopicTest() { - String msgVpnName = null; - String sequencedTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnSequencedTopic(msgVpnName, sequencedTopic); - - // TODO: test validations - } - - /** - * Delete a Topic Endpoint object. - * - * Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnTopicEndpointTest() { - String msgVpnName = null; - String topicEndpointName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnTopicEndpoint(msgVpnName, topicEndpointName); - - // TODO: test validations - } - - /** - * Delete a Topic Endpoint Template object. - * - * Delete a Topic Endpoint Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnTopicEndpointTemplateTest() { - String msgVpnName = null; - String topicEndpointTemplateName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName); - - // TODO: test validations - } - - /** - * Get a Message VPN object. - * - * Get a Message VPN object. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| distributedCacheManagementEnabled|||x| msgVpnName|x||| replicationBridgeAuthenticationBasicPassword||x||x replicationBridgeAuthenticationClientCertContent||x||x replicationBridgeAuthenticationClientCertPassword||x|| replicationEnabledQueueBehavior||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnTest() { - String msgVpnName = null; - String opaquePassword = null; - List select = null; - MsgVpnResponse response = api.getMsgVpn(msgVpnName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get an ACL Profile object. - * - * Get an ACL Profile object. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileTest() { - String msgVpnName = null; - String aclProfileName = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileResponse response = api.getMsgVpnAclProfile(msgVpnName, aclProfileName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Client Connect Exception object. - * - * Get a Client Connect Exception object. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileClientConnectExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String clientConnectExceptionAddress = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileClientConnectExceptionResponse response = api.getMsgVpnAclProfileClientConnectException(msgVpnName, aclProfileName, clientConnectExceptionAddress, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Client Connect Exception objects. - * - * Get a list of Client Connect Exception objects. A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| clientConnectExceptionAddress|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileClientConnectExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfileClientConnectExceptionsResponse response = api.getMsgVpnAclProfileClientConnectExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Publish Topic Exception object. - * - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfilePublishExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String topicSyntax = null; - String publishExceptionTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfilePublishExceptionResponse response = api.getMsgVpnAclProfilePublishException(msgVpnName, aclProfileName, topicSyntax, publishExceptionTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Publish Topic Exception objects. - * - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| publishExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by publishTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfilePublishExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfilePublishExceptionsResponse response = api.getMsgVpnAclProfilePublishExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Publish Topic Exception object. - * - * Get a Publish Topic Exception object. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfilePublishTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String publishTopicExceptionSyntax = null; - String publishTopicException = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfilePublishTopicExceptionResponse response = api.getMsgVpnAclProfilePublishTopicException(msgVpnName, aclProfileName, publishTopicExceptionSyntax, publishTopicException, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Publish Topic Exception objects. - * - * Get a list of Publish Topic Exception objects. A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| publishTopicException|x||| publishTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfilePublishTopicExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfilePublishTopicExceptionsResponse response = api.getMsgVpnAclProfilePublishTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Subscribe Topic Exception object. - * - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String topicSyntax = null; - String subscribeExceptionTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeExceptionResponse response = api.getMsgVpnAclProfileSubscribeException(msgVpnName, aclProfileName, topicSyntax, subscribeExceptionTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Subscribe Topic Exception objects. - * - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||x| msgVpnName|x||x| subscribeExceptionTopic|x||x| topicSyntax|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.14. Replaced by subscribeTopicExceptions. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfileSubscribeExceptionsResponse response = api.getMsgVpnAclProfileSubscribeExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Subscribe Share Name Exception object. - * - * Get a Subscribe Share Name Exception object. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeShareNameExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String subscribeShareNameExceptionSyntax = null; - String subscribeShareNameException = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeShareNameExceptionResponse response = api.getMsgVpnAclProfileSubscribeShareNameException(msgVpnName, aclProfileName, subscribeShareNameExceptionSyntax, subscribeShareNameException, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Subscribe Share Name Exception objects. - * - * Get a list of Subscribe Share Name Exception objects. A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeShareNameException|x||| subscribeShareNameExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeShareNameExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfileSubscribeShareNameExceptionsResponse response = api.getMsgVpnAclProfileSubscribeShareNameExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Subscribe Topic Exception object. - * - * Get a Subscribe Topic Exception object. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeTopicExceptionTest() { - String msgVpnName = null; - String aclProfileName = null; - String subscribeTopicExceptionSyntax = null; - String subscribeTopicException = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileSubscribeTopicExceptionResponse response = api.getMsgVpnAclProfileSubscribeTopicException(msgVpnName, aclProfileName, subscribeTopicExceptionSyntax, subscribeTopicException, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Subscribe Topic Exception objects. - * - * Get a list of Subscribe Topic Exception objects. A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| subscribeTopicException|x||| subscribeTopicExceptionSyntax|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfileSubscribeTopicExceptionsTest() { - String msgVpnName = null; - String aclProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfileSubscribeTopicExceptionsResponse response = api.getMsgVpnAclProfileSubscribeTopicExceptions(msgVpnName, aclProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of ACL Profile objects. - * - * Get a list of ACL Profile objects. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: aclProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAclProfilesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAclProfilesResponse response = api.getMsgVpnAclProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get an OAuth Profile object. - * - * Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfileTest() { - String msgVpnName = null; - String oauthProfileName = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResponse response = api.getMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Required Claim object. - * - * Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfileClientRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - String clientRequiredClaimName = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse response = api.getMsgVpnAuthenticationOauthProfileClientRequiredClaim(msgVpnName, oauthProfileName, clientRequiredClaimName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Required Claim objects. - * - * Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfileClientRequiredClaimsTest() { - String msgVpnName = null; - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse response = api.getMsgVpnAuthenticationOauthProfileClientRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Required Claim object. - * - * Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimTest() { - String msgVpnName = null; - String oauthProfileName = null; - String resourceServerRequiredClaimName = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse response = api.getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(msgVpnName, oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Required Claim objects. - * - * Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsTest() { - String msgVpnName = null; - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse response = api.getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims(msgVpnName, oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of OAuth Profile objects. - * - * Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProfilesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAuthenticationOauthProfilesResponse response = api.getMsgVpnAuthenticationOauthProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get an OAuth Provider object. - * - * Get an OAuth Provider object. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProviderTest() { - String msgVpnName = null; - String oauthProviderName = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProviderResponse response = api.getMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of OAuth Provider objects. - * - * Get a list of OAuth Provider objects. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: audienceClaimName|||x| audienceClaimSource|||x| audienceClaimValue|||x| audienceValidationEnabled|||x| authorizationGroupClaimName|||x| authorizationGroupClaimSource|||x| authorizationGroupEnabled|||x| disconnectOnTokenExpirationEnabled|||x| enabled|||x| jwksRefreshInterval|||x| jwksUri|||x| msgVpnName|x||x| oauthProviderName|x||x| tokenIgnoreTimeLimitsEnabled|||x| tokenIntrospectionParameterName|||x| tokenIntrospectionPassword||x|x|x tokenIntrospectionTimeout|||x| tokenIntrospectionUri|||x| tokenIntrospectionUsername|||x| usernameClaimName|||x| usernameClaimSource|||x| usernameValidateEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthenticationOauthProvidersTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAuthenticationOauthProvidersResponse response = api.getMsgVpnAuthenticationOauthProviders(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get an Authorization Group object. - * - * Get an Authorization Group object. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthorizationGroupTest() { - String msgVpnName = null; - String authorizationGroupName = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthorizationGroupResponse response = api.getMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Authorization Group objects. - * - * Get a list of Authorization Group objects. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationGroupName|x||| msgVpnName|x||| orderAfterAuthorizationGroupName||x|| orderBeforeAuthorizationGroupName||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnAuthorizationGroupsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnAuthorizationGroupsResponse response = api.getMsgVpnAuthorizationGroups(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Bridge object. - * - * Get a Bridge object. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeResponse response = api.getMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Remote Message VPN object. - * - * Get a Remote Message VPN object. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeRemoteMsgVpnTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteMsgVpnName = null; - String remoteMsgVpnLocation = null; - String remoteMsgVpnInterface = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteMsgVpnResponse response = api.getMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Remote Message VPN objects. - * - * Get a list of Remote Message VPN objects. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| password||x||x remoteMsgVpnInterface|x||| remoteMsgVpnLocation|x||| remoteMsgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeRemoteMsgVpnsTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnBridgeRemoteMsgVpnsResponse response = api.getMsgVpnBridgeRemoteMsgVpns(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Remote Subscription object. - * - * Get a Remote Subscription object. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeRemoteSubscriptionTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteSubscriptionTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteSubscriptionResponse response = api.getMsgVpnBridgeRemoteSubscription(msgVpnName, bridgeName, bridgeVirtualRouter, remoteSubscriptionTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Remote Subscription objects. - * - * Get a list of Remote Subscription objects. A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteSubscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeRemoteSubscriptionsTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnBridgeRemoteSubscriptionsResponse response = api.getMsgVpnBridgeRemoteSubscriptions(msgVpnName, bridgeName, bridgeVirtualRouter, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Trusted Common Name object. - * - * Get a Trusted Common Name object. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeTlsTrustedCommonNameTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String tlsTrustedCommonName = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeTlsTrustedCommonNameResponse response = api.getMsgVpnBridgeTlsTrustedCommonName(msgVpnName, bridgeName, bridgeVirtualRouter, tlsTrustedCommonName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Trusted Common Name objects. - * - * Get a list of Trusted Common Name objects. The Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||x| bridgeVirtualRouter|x||x| msgVpnName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgeTlsTrustedCommonNamesTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnBridgeTlsTrustedCommonNamesResponse response = api.getMsgVpnBridgeTlsTrustedCommonNames(msgVpnName, bridgeName, bridgeVirtualRouter, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Bridge objects. - * - * Get a list of Bridge objects. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: bridgeName|x||| bridgeVirtualRouter|x||| msgVpnName|x||| remoteAuthenticationBasicPassword||x||x remoteAuthenticationClientCertContent||x||x remoteAuthenticationClientCertPassword||x|| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnBridgesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnBridgesResponse response = api.getMsgVpnBridges(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Certificate Matching Rule object. - * - * Get a Certificate Matching Rule object. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRuleTest() { - String msgVpnName = null; - String ruleName = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleResponse response = api.getMsgVpnCertMatchingRule(msgVpnName, ruleName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Certificate Matching Rule Attribute Filter object. - * - * Get a Certificate Matching Rule Attribute Filter object. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRuleAttributeFilterTest() { - String msgVpnName = null; - String ruleName = null; - String filterName = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleAttributeFilterResponse response = api.getMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Certificate Matching Rule Attribute Filter objects. - * - * Get a list of Certificate Matching Rule Attribute Filter objects. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: filterName|x||| msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRuleAttributeFiltersTest() { - String msgVpnName = null; - String ruleName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnCertMatchingRuleAttributeFiltersResponse response = api.getMsgVpnCertMatchingRuleAttributeFilters(msgVpnName, ruleName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Certificate Matching Rule Condition object. - * - * Get a Certificate Matching Rule Condition object. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRuleConditionTest() { - String msgVpnName = null; - String ruleName = null; - String source = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleConditionResponse response = api.getMsgVpnCertMatchingRuleCondition(msgVpnName, ruleName, source, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Certificate Matching Rule Condition objects. - * - * Get a list of Certificate Matching Rule Condition objects. A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| source|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRuleConditionsTest() { - String msgVpnName = null; - String ruleName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnCertMatchingRuleConditionsResponse response = api.getMsgVpnCertMatchingRuleConditions(msgVpnName, ruleName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Certificate Matching Rule objects. - * - * Get a list of Certificate Matching Rule objects. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| ruleName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnCertMatchingRulesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnCertMatchingRulesResponse response = api.getMsgVpnCertMatchingRules(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Client Profile object. - * - * Get a Client Profile object. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientProfileTest() { - String msgVpnName = null; - String clientProfileName = null; - String opaquePassword = null; - List select = null; - MsgVpnClientProfileResponse response = api.getMsgVpnClientProfile(msgVpnName, clientProfileName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Client Profile objects. - * - * Get a list of Client Profile objects. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowCutThroughForwardingEnabled|||x| apiQueueManagementCopyFromOnCreateName|||x| apiTopicEndpointManagementCopyFromOnCreateName|||x| clientProfileName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientProfilesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnClientProfilesResponse response = api.getMsgVpnClientProfiles(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Client Username object. - * - * Get a Client Username object. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientUsernameTest() { - String msgVpnName = null; - String clientUsername = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameResponse response = api.getMsgVpnClientUsername(msgVpnName, clientUsername, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Client Username Attribute object. - * - * Get a Client Username Attribute object. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientUsernameAttributeTest() { - String msgVpnName = null; - String clientUsername = null; - String attributeName = null; - String attributeValue = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameAttributeResponse response = api.getMsgVpnClientUsernameAttribute(msgVpnName, clientUsername, attributeName, attributeValue, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Client Username Attribute objects. - * - * Get a list of Client Username Attribute objects. A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: attributeName|x||| attributeValue|x||| clientUsername|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientUsernameAttributesTest() { - String msgVpnName = null; - String clientUsername = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnClientUsernameAttributesResponse response = api.getMsgVpnClientUsernameAttributes(msgVpnName, clientUsername, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Client Username objects. - * - * Get a list of Client Username objects. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientUsername|x||| msgVpnName|x||| password||x||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnClientUsernamesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnClientUsernamesResponse response = api.getMsgVpnClientUsernames(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Distributed Cache object. - * - * Get a Distributed Cache object. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheTest() { - String msgVpnName = null; - String cacheName = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheResponse response = api.getMsgVpnDistributedCache(msgVpnName, cacheName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Cache Cluster object. - * - * Get a Cache Cluster object. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterResponse response = api.getMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Home Cache Cluster object. - * - * Get a Home Cache Cluster object. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse response = api.getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster(msgVpnName, cacheName, clusterName, homeClusterName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Topic Prefix object. - * - * Get a Topic Prefix object. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - String topicPrefix = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse response = api.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(msgVpnName, cacheName, clusterName, homeClusterName, topicPrefix, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Topic Prefix objects. - * - * Get a list of Topic Prefix objects. A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| topicPrefix|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String homeClusterName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse response = api.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes(msgVpnName, cacheName, clusterName, homeClusterName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Home Cache Cluster objects. - * - * Get a list of Home Cache Cluster objects. A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| homeClusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterGlobalCachingHomeClustersTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse response = api.getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Cache Instance object. - * - * Get a Cache Instance object. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterInstanceTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String instanceName = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterInstanceResponse response = api.getMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Cache Instance objects. - * - * Get a list of Cache Instance objects. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| instanceName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterInstancesTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCacheClusterInstancesResponse response = api.getMsgVpnDistributedCacheClusterInstances(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Topic object. - * - * Get a Topic object. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterTopicTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String topic = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterTopicResponse response = api.getMsgVpnDistributedCacheClusterTopic(msgVpnName, cacheName, clusterName, topic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Topic objects. - * - * Get a list of Topic objects. The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| topic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClusterTopicsTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCacheClusterTopicsResponse response = api.getMsgVpnDistributedCacheClusterTopics(msgVpnName, cacheName, clusterName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Cache Cluster objects. - * - * Get a list of Cache Cluster objects. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| clusterName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCacheClustersTest() { - String msgVpnName = null; - String cacheName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCacheClustersResponse response = api.getMsgVpnDistributedCacheClusters(msgVpnName, cacheName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Distributed Cache objects. - * - * Get a list of Distributed Cache objects. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDistributedCachesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDistributedCachesResponse response = api.getMsgVpnDistributedCaches(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a DMR Bridge object. - * - * Get a DMR Bridge object. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDmrBridgeTest() { - String msgVpnName = null; - String remoteNodeName = null; - String opaquePassword = null; - List select = null; - MsgVpnDmrBridgeResponse response = api.getMsgVpnDmrBridge(msgVpnName, remoteNodeName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of DMR Bridge objects. - * - * Get a list of DMR Bridge objects. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| remoteNodeName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnDmrBridgesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnDmrBridgesResponse response = api.getMsgVpnDmrBridges(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of JNDI Connection Factory objects. - * - * Get a list of JNDI Connection Factory objects. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiConnectionFactoriesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnJndiConnectionFactoriesResponse response = api.getMsgVpnJndiConnectionFactories(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a JNDI Connection Factory object. - * - * Get a JNDI Connection Factory object. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: connectionFactoryName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiConnectionFactoryTest() { - String msgVpnName = null; - String connectionFactoryName = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiConnectionFactoryResponse response = api.getMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a JNDI Queue object. - * - * Get a JNDI Queue object. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiQueueTest() { - String msgVpnName = null; - String queueName = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiQueueResponse response = api.getMsgVpnJndiQueue(msgVpnName, queueName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of JNDI Queue objects. - * - * Get a list of JNDI Queue objects. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiQueuesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnJndiQueuesResponse response = api.getMsgVpnJndiQueues(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a JNDI Topic object. - * - * Get a JNDI Topic object. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiTopicTest() { - String msgVpnName = null; - String topicName = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiTopicResponse response = api.getMsgVpnJndiTopic(msgVpnName, topicName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of JNDI Topic objects. - * - * Get a list of JNDI Topic objects. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnJndiTopicsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnJndiTopicsResponse response = api.getMsgVpnJndiTopics(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get an MQTT Retain Cache object. - * - * Get an MQTT Retain Cache object. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttRetainCacheTest() { - String msgVpnName = null; - String cacheName = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttRetainCacheResponse response = api.getMsgVpnMqttRetainCache(msgVpnName, cacheName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of MQTT Retain Cache objects. - * - * Get a list of MQTT Retain Cache objects. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: cacheName|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttRetainCachesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnMqttRetainCachesResponse response = api.getMsgVpnMqttRetainCaches(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get an MQTT Session object. - * - * Get an MQTT Session object. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttSessionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionResponse response = api.getMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Subscription object. - * - * Get a Subscription object. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttSessionSubscriptionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - String subscriptionTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionSubscriptionResponse response = api.getMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Subscription objects. - * - * Get a list of Subscription objects. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttSessionSubscriptionsTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnMqttSessionSubscriptionsResponse response = api.getMsgVpnMqttSessionSubscriptions(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of MQTT Session objects. - * - * Get a list of MQTT Session objects. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: mqttSessionClientId|x||| mqttSessionVirtualRouter|x||| msgVpnName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnMqttSessionsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnMqttSessionsResponse response = api.getMsgVpnMqttSessions(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Queue object. - * - * Get a Queue object. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueueTest() { - String msgVpnName = null; - String queueName = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueResponse response = api.getMsgVpnQueue(msgVpnName, queueName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Queue Subscription object. - * - * Get a Queue Subscription object. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueueSubscriptionTest() { - String msgVpnName = null; - String queueName = null; - String subscriptionTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueSubscriptionResponse response = api.getMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Queue Subscription objects. - * - * Get a list of Queue Subscription objects. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueueSubscriptionsTest() { - String msgVpnName = null; - String queueName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnQueueSubscriptionsResponse response = api.getMsgVpnQueueSubscriptions(msgVpnName, queueName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Queue Template object. - * - * Get a Queue Template object. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueueTemplateTest() { - String msgVpnName = null; - String queueTemplateName = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueTemplateResponse response = api.getMsgVpnQueueTemplate(msgVpnName, queueTemplateName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Queue Template objects. - * - * Get a list of Queue Template objects. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueueTemplatesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnQueueTemplatesResponse response = api.getMsgVpnQueueTemplates(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Queue objects. - * - * Get a list of Queue objects. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueuesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnQueuesResponse response = api.getMsgVpnQueues(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Replay Log object. - * - * Get a Replay Log object. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplayLogTest() { - String msgVpnName = null; - String replayLogName = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogResponse response = api.getMsgVpnReplayLog(msgVpnName, replayLogName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Topic Filter Subscription object. - * - * Get a Topic Filter Subscription object. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplayLogTopicFilterSubscriptionTest() { - String msgVpnName = null; - String replayLogName = null; - String topicFilterSubscription = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogTopicFilterSubscriptionResponse response = api.getMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Topic Filter Subscription objects. - * - * Get a list of Topic Filter Subscription objects. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplayLogTopicFilterSubscriptionsTest() { - String msgVpnName = null; - String replayLogName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnReplayLogTopicFilterSubscriptionsResponse response = api.getMsgVpnReplayLogTopicFilterSubscriptions(msgVpnName, replayLogName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Replay Log objects. - * - * Get a list of Replay Log objects. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplayLogsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnReplayLogsResponse response = api.getMsgVpnReplayLogs(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Replicated Topic object. - * - * Get a Replicated Topic object. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplicatedTopicTest() { - String msgVpnName = null; - String replicatedTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnReplicatedTopicResponse response = api.getMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Replicated Topic objects. - * - * Get a list of Replicated Topic objects. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplicatedTopicsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnReplicatedTopicsResponse response = api.getMsgVpnReplicatedTopics(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a REST Delivery Point object. - * - * Get a REST Delivery Point object. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointResponse response = api.getMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Queue Binding object. - * - * Get a Queue Binding object. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointQueueBindingTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingResponse response = api.getMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Request Header object. - * - * Get a Request Header object. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointQueueBindingRequestHeaderTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - String headerName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse response = api.getMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Request Header objects. - * - * Get a list of Request Header objects. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointQueueBindingRequestHeadersTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse response = api.getMsgVpnRestDeliveryPointQueueBindingRequestHeaders(msgVpnName, restDeliveryPointName, queueBindingName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Queue Binding objects. - * - * Get a list of Queue Binding objects. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointQueueBindingsTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingsResponse response = api.getMsgVpnRestDeliveryPointQueueBindings(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a REST Consumer object. - * - * Get a REST Consumer object. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumerTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerResponse response = api.getMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Claim object. - * - * Get a Claim object. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String oauthJwtClaimName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse response = api.getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Claim objects. - * - * Get a list of Claim objects. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse response = api.getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims(msgVpnName, restDeliveryPointName, restConsumerName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Trusted Common Name object. - * - * Get a Trusted Common Name object. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String tlsTrustedCommonName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse response = api.getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Trusted Common Name objects. - * - * Get a list of Trusted Common Name objects. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse response = api.getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of REST Consumer objects. - * - * Get a list of REST Consumer objects. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumersTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumersResponse response = api.getMsgVpnRestDeliveryPointRestConsumers(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of REST Delivery Point objects. - * - * Get a list of REST Delivery Point objects. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointsResponse response = api.getMsgVpnRestDeliveryPoints(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Sequenced Topic object. - * - * Get a Sequenced Topic object. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| sequencedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnSequencedTopicTest() { - String msgVpnName = null; - String sequencedTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnSequencedTopicResponse response = api.getMsgVpnSequencedTopic(msgVpnName, sequencedTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Sequenced Topic objects. - * - * Get a list of Sequenced Topic objects. A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| sequencedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnSequencedTopicsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnSequencedTopicsResponse response = api.getMsgVpnSequencedTopics(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Topic Endpoint object. - * - * Get a Topic Endpoint object. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnTopicEndpointTest() { - String msgVpnName = null; - String topicEndpointName = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointResponse response = api.getMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Topic Endpoint Template object. - * - * Get a Topic Endpoint Template object. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnTopicEndpointTemplateTest() { - String msgVpnName = null; - String topicEndpointTemplateName = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointTemplateResponse response = api.getMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Topic Endpoint Template objects. - * - * Get a list of Topic Endpoint Template objects. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnTopicEndpointTemplatesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnTopicEndpointTemplatesResponse response = api.getMsgVpnTopicEndpointTemplates(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Topic Endpoint objects. - * - * Get a list of Topic Endpoint objects. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnTopicEndpointsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnTopicEndpointsResponse response = api.getMsgVpnTopicEndpoints(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Message VPN objects. - * - * Get a list of Message VPN objects. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationOauthDefaultProviderName|||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||x| distributedCacheManagementEnabled|||x| msgVpnName|x||| replicationBridgeAuthenticationBasicPassword||x||x replicationBridgeAuthenticationClientCertContent||x||x replicationBridgeAuthenticationClientCertPassword||x|| replicationEnabledQueueBehavior||x|| restTlsServerCertEnforceTrustedCommonNameEnabled|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnsTest() { - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnsResponse response = api.getMsgVpns(count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Message VPN object. - * - * Replace a Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationOauthDefaultProviderName||||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled||||||x| distributedCacheManagementEnabled||||||x| msgVpnName|x||x|||| replicationBridgeAuthenticationBasicPassword||||x|||x replicationBridgeAuthenticationClientCertContent||||x|||x replicationBridgeAuthenticationClientCertPassword||||x||| replicationEnabledQueueBehavior||||x||| restTlsServerCertEnforceTrustedCommonNameEnabled||||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: alias|global/read-write authenticationBasicEnabled|global/read-write authenticationBasicProfileName|global/read-write authenticationBasicRadiusDomain|global/read-write authenticationBasicType|global/read-write authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write authenticationClientCertCertificateMatchingRulesEnabled|global/read-write authenticationClientCertEnabled|global/read-write authenticationClientCertMaxChainDepth|global/read-write authenticationClientCertRevocationCheckMode|global/read-write authenticationClientCertUsernameSource|global/read-write authenticationClientCertValidateDateEnabled|global/read-write authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write authenticationKerberosEnabled|global/read-write authenticationOauthEnabled|global/read-write bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write bridgingTlsServerCertMaxChainDepth|global/read-write bridgingTlsServerCertValidateDateEnabled|global/read-write bridgingTlsServerCertValidateNameEnabled|global/read-write dmrEnabled|global/read-write exportSubscriptionsEnabled|global/read-write maxConnectionCount|global/read-write maxEgressFlowCount|global/read-write maxEndpointCount|global/read-write maxIngressFlowCount|global/read-write maxMsgSpoolUsage|global/read-write maxSubscriptionCount|global/read-write maxTransactedSessionCount|global/read-write maxTransactionCount|global/read-write mqttRetainMaxMemory|global/read-write replicationBridgeAuthenticationBasicClientUsername|global/read-write replicationBridgeAuthenticationBasicPassword|global/read-write replicationBridgeAuthenticationClientCertContent|global/read-write replicationBridgeAuthenticationClientCertPassword|global/read-write replicationBridgeAuthenticationScheme|global/read-write replicationBridgeCompressedDataEnabled|global/read-write replicationBridgeEgressFlowWindowSize|global/read-write replicationBridgeRetryDelay|global/read-write replicationBridgeTlsEnabled|global/read-write replicationBridgeUnidirectionalClientProfileName|global/read-write replicationEnabled|global/read-write replicationEnabledQueueBehavior|global/read-write replicationQueueMaxMsgSpoolUsage|global/read-write replicationRole|global/read-write restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write restTlsServerCertMaxChainDepth|global/read-write restTlsServerCertValidateDateEnabled|global/read-write restTlsServerCertValidateNameEnabled|global/read-write sempOverMsgBusAdminClientEnabled|global/read-write sempOverMsgBusAdminDistributedCacheEnabled|global/read-write sempOverMsgBusAdminEnabled|global/read-write sempOverMsgBusEnabled|global/read-write sempOverMsgBusShowEnabled|global/read-write serviceAmqpMaxConnectionCount|global/read-write serviceAmqpPlainTextListenPort|global/read-write serviceAmqpTlsListenPort|global/read-write serviceMqttMaxConnectionCount|global/read-write serviceMqttPlainTextListenPort|global/read-write serviceMqttTlsListenPort|global/read-write serviceMqttTlsWebSocketListenPort|global/read-write serviceMqttWebSocketListenPort|global/read-write serviceRestIncomingMaxConnectionCount|global/read-write serviceRestIncomingPlainTextListenPort|global/read-write serviceRestIncomingTlsListenPort|global/read-write serviceRestOutgoingMaxConnectionCount|global/read-write serviceSmfMaxConnectionCount|global/read-write serviceWebMaxConnectionCount|global/read-write This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnTest() { - String msgVpnName = null; - MsgVpn body = null; - String opaquePassword = null; - List select = null; - MsgVpnResponse response = api.replaceMsgVpn(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace an ACL Profile object. - * - * Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnAclProfileTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileResponse response = api.replaceMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace an OAuth Profile object. - * - * Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnAuthenticationOauthProfileTest() { - String msgVpnName = null; - String oauthProfileName = null; - MsgVpnAuthenticationOauthProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResponse response = api.replaceMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace an OAuth Provider object. - * - * Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- audienceClaimName||||||x| audienceClaimSource||||||x| audienceClaimValue||||||x| audienceValidationEnabled||||||x| authorizationGroupClaimName||||||x| authorizationGroupClaimSource||||||x| authorizationGroupEnabled||||||x| disconnectOnTokenExpirationEnabled||||||x| enabled||||||x| jwksRefreshInterval||||||x| jwksUri||||||x| msgVpnName|x||x|||x| oauthProviderName|x||x|||x| tokenIgnoreTimeLimitsEnabled||||||x| tokenIntrospectionParameterName||||||x| tokenIntrospectionPassword||||x||x|x tokenIntrospectionTimeout||||||x| tokenIntrospectionUri||||||x| tokenIntrospectionUsername||||||x| usernameClaimName||||||x| usernameClaimSource||||||x| usernameValidateEnabled||||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnAuthenticationOauthProviderTest() { - String msgVpnName = null; - String oauthProviderName = null; - MsgVpnAuthenticationOauthProvider body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProviderResponse response = api.replaceMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace an Authorization Group object. - * - * Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| authorizationGroupName|x||x|||| clientProfileName|||||x|| msgVpnName|x||x|||| orderAfterAuthorizationGroupName||||x||| orderBeforeAuthorizationGroupName||||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnAuthorizationGroupTest() { - String msgVpnName = null; - String authorizationGroupName = null; - MsgVpnAuthorizationGroup body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthorizationGroupResponse response = api.replaceMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Bridge object. - * - * Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| maxTtl|||||x|| msgVpnName|x||x|||| remoteAuthenticationBasicClientUsername|||||x|| remoteAuthenticationBasicPassword||||x|x||x remoteAuthenticationClientCertContent||||x|x||x remoteAuthenticationClientCertPassword||||x|x|| remoteAuthenticationScheme|||||x|| remoteDeliverToOnePriority|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnBridgeTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - MsgVpnBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeResponse response = api.replaceMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Remote Message VPN object. - * - * Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- bridgeName|x||x|||| bridgeVirtualRouter|x||x|||| clientUsername|||||x|| compressedDataEnabled|||||x|| egressFlowWindowSize|||||x|| msgVpnName|x||x|||| password||||x|x||x remoteMsgVpnInterface|x||x|||| remoteMsgVpnLocation|x||x|||| remoteMsgVpnName|x||x|||| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnBridgeRemoteMsgVpnTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteMsgVpnName = null; - String remoteMsgVpnLocation = null; - String remoteMsgVpnInterface = null; - MsgVpnBridgeRemoteMsgVpn body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteMsgVpnResponse response = api.replaceMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Certificate Matching Rule object. - * - * Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnCertMatchingRuleTest() { - String msgVpnName = null; - String ruleName = null; - MsgVpnCertMatchingRule body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleResponse response = api.replaceMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Certificate Matching Rule Attribute Filter object. - * - * Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- filterName|x||x|||| msgVpnName|x||x|||| ruleName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnCertMatchingRuleAttributeFilterTest() { - String msgVpnName = null; - String ruleName = null; - String filterName = null; - MsgVpnCertMatchingRuleAttributeFilter body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleAttributeFilterResponse response = api.replaceMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Client Profile object. - * - * Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled||||||x| apiQueueManagementCopyFromOnCreateName||||||x| apiTopicEndpointManagementCopyFromOnCreateName||||||x| clientProfileName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnClientProfileTest() { - String msgVpnName = null; - String clientProfileName = null; - MsgVpnClientProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientProfileResponse response = api.replaceMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Client Username object. - * - * Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- aclProfileName|||||x|| clientProfileName|||||x|| clientUsername|x||x|||| msgVpnName|x||x|||| password||||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnClientUsernameTest() { - String msgVpnName = null; - String clientUsername = null; - MsgVpnClientUsername body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameResponse response = api.replaceMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Distributed Cache object. - * - * Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| cacheVirtualRouter||x||||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnDistributedCacheTest() { - String msgVpnName = null; - String cacheName = null; - MsgVpnDistributedCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheResponse response = api.replaceMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Cache Cluster object. - * - * Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| msgVpnName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnDistributedCacheClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - MsgVpnDistributedCacheCluster body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterResponse response = api.replaceMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Cache Instance object. - * - * Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| clusterName|x||x|||| instanceName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnDistributedCacheClusterInstanceTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String instanceName = null; - MsgVpnDistributedCacheClusterInstance body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterInstanceResponse response = api.replaceMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a DMR Bridge object. - * - * Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| remoteNodeName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnDmrBridgeTest() { - String msgVpnName = null; - String remoteNodeName = null; - MsgVpnDmrBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnDmrBridgeResponse response = api.replaceMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a JNDI Connection Factory object. - * - * Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnJndiConnectionFactoryTest() { - String msgVpnName = null; - String connectionFactoryName = null; - MsgVpnJndiConnectionFactory body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiConnectionFactoryResponse response = api.replaceMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a JNDI Queue object. - * - * Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnJndiQueueTest() { - String msgVpnName = null; - String queueName = null; - MsgVpnJndiQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiQueueResponse response = api.replaceMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a JNDI Topic object. - * - * Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnJndiTopicTest() { - String msgVpnName = null; - String topicName = null; - MsgVpnJndiTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiTopicResponse response = api.replaceMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace an MQTT Retain Cache object. - * - * Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- cacheName|x||x|||| msgVpnName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnMqttRetainCacheTest() { - String msgVpnName = null; - String cacheName = null; - MsgVpnMqttRetainCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttRetainCacheResponse response = api.replaceMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace an MQTT Session object. - * - * Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| owner|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnMqttSessionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - MsgVpnMqttSession body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionResponse response = api.replaceMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Subscription object. - * - * Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x||x|||| mqttSessionVirtualRouter|x||x|||| msgVpnName|x||x|||| subscriptionTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnMqttSessionSubscriptionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - String subscriptionTopic = null; - MsgVpnMqttSessionSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionSubscriptionResponse response = api.replaceMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Queue object. - * - * Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| queueName|x||x|||| respectMsgPriorityEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnQueueTest() { - String msgVpnName = null; - String queueName = null; - MsgVpnQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueResponse response = api.replaceMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Queue Template object. - * - * Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnQueueTemplateTest() { - String msgVpnName = null; - String queueTemplateName = null; - MsgVpnQueueTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueTemplateResponse response = api.replaceMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Replay Log object. - * - * Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replayLogName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnReplayLogTest() { - String msgVpnName = null; - String replayLogName = null; - MsgVpnReplayLog body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogResponse response = api.replaceMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Replicated Topic object. - * - * Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replicatedTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnReplicatedTopicTest() { - String msgVpnName = null; - String replicatedTopic = null; - MsgVpnReplicatedTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplicatedTopicResponse response = api.replaceMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a REST Delivery Point object. - * - * Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientProfileName|||||x|| msgVpnName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnRestDeliveryPointTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - MsgVpnRestDeliveryPoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointResponse response = api.replaceMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Queue Binding object. - * - * Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnRestDeliveryPointQueueBindingTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - MsgVpnRestDeliveryPointQueueBinding body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingResponse response = api.replaceMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Request Header object. - * - * Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A request header to be added to the HTTP request. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- headerName|x||x|||| msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnRestDeliveryPointQueueBindingRequestHeaderTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - String headerName = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse response = api.replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a REST Consumer object. - * - * Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey||||x|||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| authenticationHttpBasicPassword||||x|x||x authenticationHttpBasicUsername|||||x|| authenticationHttpHeaderValue||||x|||x authenticationOauthClientId|||||x|| authenticationOauthClientScope|||||x|| authenticationOauthClientSecret||||x|x||x authenticationOauthClientTokenEndpoint|||||x|| authenticationOauthJwtSecretKey||||x|x||x authenticationOauthJwtTokenEndpoint|||||x|| authenticationScheme|||||x|| msgVpnName|x||x|||| outgoingConnectionCount|||||x|| remoteHost|||||x|| remotePort|||||x|| restConsumerName|x||x|||| restDeliveryPointName|x||x|||| tlsCipherSuiteList|||||x|| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnRestDeliveryPointRestConsumerTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - MsgVpnRestDeliveryPointRestConsumer body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerResponse response = api.replaceMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Topic Endpoint object. - * - * Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| respectMsgPriorityEnabled|||||x|| topicEndpointName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnTopicEndpointTest() { - String msgVpnName = null; - String topicEndpointName = null; - MsgVpnTopicEndpoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointResponse response = api.replaceMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Topic Endpoint Template object. - * - * Replace a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicEndpointTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnTopicEndpointTemplateTest() { - String msgVpnName = null; - String topicEndpointTemplateName = null; - MsgVpnTopicEndpointTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointTemplateResponse response = api.replaceMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Message VPN object. - * - * Update a Message VPN object. Any attribute missing from the request will be left unchanged. Message VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationOauthDefaultProviderName|||||x| bridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x| distributedCacheManagementEnabled|||||x| msgVpnName|x|x|||| replicationBridgeAuthenticationBasicPassword|||x|||x replicationBridgeAuthenticationClientCertContent|||x|||x replicationBridgeAuthenticationClientCertPassword|||x||| replicationEnabledQueueBehavior|||x||| restTlsServerCertEnforceTrustedCommonNameEnabled|||||x| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| MsgVpn|authenticationBasicProfileName|authenticationBasicType| MsgVpn|authorizationProfileName|authorizationType| MsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled| MsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled| MsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword| MsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername| MsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent| MsgVpn|replicationEnabledQueueBehavior|replicationEnabled| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: alias|global/read-write authenticationBasicEnabled|global/read-write authenticationBasicProfileName|global/read-write authenticationBasicRadiusDomain|global/read-write authenticationBasicType|global/read-write authenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write authenticationClientCertCertificateMatchingRulesEnabled|global/read-write authenticationClientCertEnabled|global/read-write authenticationClientCertMaxChainDepth|global/read-write authenticationClientCertRevocationCheckMode|global/read-write authenticationClientCertUsernameSource|global/read-write authenticationClientCertValidateDateEnabled|global/read-write authenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write authenticationKerberosEnabled|global/read-write authenticationOauthEnabled|global/read-write bridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write bridgingTlsServerCertMaxChainDepth|global/read-write bridgingTlsServerCertValidateDateEnabled|global/read-write bridgingTlsServerCertValidateNameEnabled|global/read-write dmrEnabled|global/read-write exportSubscriptionsEnabled|global/read-write maxConnectionCount|global/read-write maxEgressFlowCount|global/read-write maxEndpointCount|global/read-write maxIngressFlowCount|global/read-write maxMsgSpoolUsage|global/read-write maxSubscriptionCount|global/read-write maxTransactedSessionCount|global/read-write maxTransactionCount|global/read-write mqttRetainMaxMemory|global/read-write replicationBridgeAuthenticationBasicClientUsername|global/read-write replicationBridgeAuthenticationBasicPassword|global/read-write replicationBridgeAuthenticationClientCertContent|global/read-write replicationBridgeAuthenticationClientCertPassword|global/read-write replicationBridgeAuthenticationScheme|global/read-write replicationBridgeCompressedDataEnabled|global/read-write replicationBridgeEgressFlowWindowSize|global/read-write replicationBridgeRetryDelay|global/read-write replicationBridgeTlsEnabled|global/read-write replicationBridgeUnidirectionalClientProfileName|global/read-write replicationEnabled|global/read-write replicationEnabledQueueBehavior|global/read-write replicationQueueMaxMsgSpoolUsage|global/read-write replicationRole|global/read-write restTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write restTlsServerCertMaxChainDepth|global/read-write restTlsServerCertValidateDateEnabled|global/read-write restTlsServerCertValidateNameEnabled|global/read-write sempOverMsgBusAdminClientEnabled|global/read-write sempOverMsgBusAdminDistributedCacheEnabled|global/read-write sempOverMsgBusAdminEnabled|global/read-write sempOverMsgBusEnabled|global/read-write sempOverMsgBusShowEnabled|global/read-write serviceAmqpMaxConnectionCount|global/read-write serviceAmqpPlainTextListenPort|global/read-write serviceAmqpTlsListenPort|global/read-write serviceMqttMaxConnectionCount|global/read-write serviceMqttPlainTextListenPort|global/read-write serviceMqttTlsListenPort|global/read-write serviceMqttTlsWebSocketListenPort|global/read-write serviceMqttWebSocketListenPort|global/read-write serviceRestIncomingMaxConnectionCount|global/read-write serviceRestIncomingPlainTextListenPort|global/read-write serviceRestIncomingTlsListenPort|global/read-write serviceRestOutgoingMaxConnectionCount|global/read-write serviceSmfMaxConnectionCount|global/read-write serviceWebMaxConnectionCount|global/read-write This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnTest() { - String msgVpnName = null; - MsgVpn body = null; - String opaquePassword = null; - List select = null; - MsgVpnResponse response = api.updateMsgVpn(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an ACL Profile object. - * - * Update an ACL Profile object. Any attribute missing from the request will be left unchanged. An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnAclProfileTest() { - String msgVpnName = null; - String aclProfileName = null; - MsgVpnAclProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAclProfileResponse response = api.updateMsgVpnAclProfile(msgVpnName, aclProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an OAuth Profile object. - * - * Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.25. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnAuthenticationOauthProfileTest() { - String msgVpnName = null; - String oauthProfileName = null; - MsgVpnAuthenticationOauthProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProfileResponse response = api.updateMsgVpnAuthenticationOauthProfile(msgVpnName, oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an OAuth Provider object. - * - * Update an OAuth Provider object. Any attribute missing from the request will be left unchanged. OAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- audienceClaimName|||||x| audienceClaimSource|||||x| audienceClaimValue|||||x| audienceValidationEnabled|||||x| authorizationGroupClaimName|||||x| authorizationGroupClaimSource|||||x| authorizationGroupEnabled|||||x| disconnectOnTokenExpirationEnabled|||||x| enabled|||||x| jwksRefreshInterval|||||x| jwksUri|||||x| msgVpnName|x|x|||x| oauthProviderName|x|x|||x| tokenIgnoreTimeLimitsEnabled|||||x| tokenIntrospectionParameterName|||||x| tokenIntrospectionPassword|||x||x|x tokenIntrospectionTimeout|||||x| tokenIntrospectionUri|||||x| tokenIntrospectionUsername|||||x| usernameClaimName|||||x| usernameClaimSource|||||x| usernameValidateEnabled|||||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since 2.25. Replaced by authenticationOauthProfiles. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnAuthenticationOauthProviderTest() { - String msgVpnName = null; - String oauthProviderName = null; - MsgVpnAuthenticationOauthProvider body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthenticationOauthProviderResponse response = api.updateMsgVpnAuthenticationOauthProvider(msgVpnName, oauthProviderName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an Authorization Group object. - * - * Update an Authorization Group object. Any attribute missing from the request will be left unchanged. To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| authorizationGroupName|x|x|||| clientProfileName||||x|| msgVpnName|x|x|||| orderAfterAuthorizationGroupName|||x||| orderBeforeAuthorizationGroupName|||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName MsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnAuthorizationGroupTest() { - String msgVpnName = null; - String authorizationGroupName = null; - MsgVpnAuthorizationGroup body = null; - String opaquePassword = null; - List select = null; - MsgVpnAuthorizationGroupResponse response = api.updateMsgVpnAuthorizationGroup(msgVpnName, authorizationGroupName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Bridge object. - * - * Update a Bridge object. Any attribute missing from the request will be left unchanged. Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| maxTtl||||x|| msgVpnName|x|x|||| remoteAuthenticationBasicClientUsername||||x|| remoteAuthenticationBasicPassword|||x|x||x remoteAuthenticationClientCertContent|||x|x||x remoteAuthenticationClientCertPassword|||x|x|| remoteAuthenticationScheme||||x|| remoteDeliverToOnePriority||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword| MsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername| MsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnBridgeTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - MsgVpnBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeResponse response = api.updateMsgVpnBridge(msgVpnName, bridgeName, bridgeVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Remote Message VPN object. - * - * Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged. The Remote Message VPN is the Message VPN that the Bridge connects to. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- bridgeName|x|x|||| bridgeVirtualRouter|x|x|||| clientUsername||||x|| compressedDataEnabled||||x|| egressFlowWindowSize||||x|| msgVpnName|x|x|||| password|||x|x||x remoteMsgVpnInterface|x|x|||| remoteMsgVpnLocation|x|x|||| remoteMsgVpnName|x|x|||| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnBridgeRemoteMsgVpn|clientUsername|password| MsgVpnBridgeRemoteMsgVpn|password|clientUsername| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnBridgeRemoteMsgVpnTest() { - String msgVpnName = null; - String bridgeName = null; - String bridgeVirtualRouter = null; - String remoteMsgVpnName = null; - String remoteMsgVpnLocation = null; - String remoteMsgVpnInterface = null; - MsgVpnBridgeRemoteMsgVpn body = null; - String opaquePassword = null; - List select = null; - MsgVpnBridgeRemoteMsgVpnResponse response = api.updateMsgVpnBridgeRemoteMsgVpn(msgVpnName, bridgeName, bridgeVirtualRouter, remoteMsgVpnName, remoteMsgVpnLocation, remoteMsgVpnInterface, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Certificate Matching Rule object. - * - * Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnCertMatchingRuleTest() { - String msgVpnName = null; - String ruleName = null; - MsgVpnCertMatchingRule body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleResponse response = api.updateMsgVpnCertMatchingRule(msgVpnName, ruleName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Certificate Matching Rule Attribute Filter object. - * - * Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged. A Cert Matching Rule Attribute Filter compares a username attribute to a string. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- filterName|x|x|||| msgVpnName|x|x|||| ruleName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.28. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnCertMatchingRuleAttributeFilterTest() { - String msgVpnName = null; - String ruleName = null; - String filterName = null; - MsgVpnCertMatchingRuleAttributeFilter body = null; - String opaquePassword = null; - List select = null; - MsgVpnCertMatchingRuleAttributeFilterResponse response = api.updateMsgVpnCertMatchingRuleAttributeFilter(msgVpnName, ruleName, filterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Client Profile object. - * - * Update a Client Profile object. Any attribute missing from the request will be left unchanged. Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- allowCutThroughForwardingEnabled|||||x| apiQueueManagementCopyFromOnCreateName|||||x| apiTopicEndpointManagementCopyFromOnCreateName|||||x| clientProfileName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnClientProfileTest() { - String msgVpnName = null; - String clientProfileName = null; - MsgVpnClientProfile body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientProfileResponse response = api.updateMsgVpnClientProfile(msgVpnName, clientProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Client Username object. - * - * Update a Client Username object. Any attribute missing from the request will be left unchanged. A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- aclProfileName||||x|| clientProfileName||||x|| clientUsername|x|x|||| msgVpnName|x|x|||| password|||x|||x A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnClientUsernameTest() { - String msgVpnName = null; - String clientUsername = null; - MsgVpnClientUsername body = null; - String opaquePassword = null; - List select = null; - MsgVpnClientUsernameResponse response = api.updateMsgVpnClientUsername(msgVpnName, clientUsername, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Distributed Cache object. - * - * Update a Distributed Cache object. Any attribute missing from the request will be left unchanged. A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| cacheVirtualRouter||x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList| MsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnDistributedCacheTest() { - String msgVpnName = null; - String cacheName = null; - MsgVpnDistributedCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheResponse response = api.updateMsgVpnDistributedCache(msgVpnName, cacheName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Cache Cluster object. - * - * Update a Cache Cluster object. Any attribute missing from the request will be left unchanged. A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| msgVpnName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThresholdByPercent|clearPercent|setPercent| EventThresholdByPercent|setPercent|clearPercent| EventThresholdByValue|clearValue|setValue| EventThresholdByValue|setValue|clearValue| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnDistributedCacheClusterTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - MsgVpnDistributedCacheCluster body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterResponse response = api.updateMsgVpnDistributedCacheCluster(msgVpnName, cacheName, clusterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Cache Instance object. - * - * Update a Cache Instance object. Any attribute missing from the request will be left unchanged. A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| clusterName|x|x|||| instanceName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnDistributedCacheClusterInstanceTest() { - String msgVpnName = null; - String cacheName = null; - String clusterName = null; - String instanceName = null; - MsgVpnDistributedCacheClusterInstance body = null; - String opaquePassword = null; - List select = null; - MsgVpnDistributedCacheClusterInstanceResponse response = api.updateMsgVpnDistributedCacheClusterInstance(msgVpnName, cacheName, clusterName, instanceName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a DMR Bridge object. - * - * Update a DMR Bridge object. Any attribute missing from the request will be left unchanged. A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| remoteNodeName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnDmrBridgeTest() { - String msgVpnName = null; - String remoteNodeName = null; - MsgVpnDmrBridge body = null; - String opaquePassword = null; - List select = null; - MsgVpnDmrBridgeResponse response = api.updateMsgVpnDmrBridge(msgVpnName, remoteNodeName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a JNDI Connection Factory object. - * - * Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- connectionFactoryName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnJndiConnectionFactoryTest() { - String msgVpnName = null; - String connectionFactoryName = null; - MsgVpnJndiConnectionFactory body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiConnectionFactoryResponse response = api.updateMsgVpnJndiConnectionFactory(msgVpnName, connectionFactoryName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a JNDI Queue object. - * - * Update a JNDI Queue object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnJndiQueueTest() { - String msgVpnName = null; - String queueName = null; - MsgVpnJndiQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiQueueResponse response = api.updateMsgVpnJndiQueue(msgVpnName, queueName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a JNDI Topic object. - * - * Update a JNDI Topic object. Any attribute missing from the request will be left unchanged. The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.2. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnJndiTopicTest() { - String msgVpnName = null; - String topicName = null; - MsgVpnJndiTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnJndiTopicResponse response = api.updateMsgVpnJndiTopic(msgVpnName, topicName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an MQTT Retain Cache object. - * - * Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged. Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- cacheName|x|x|||| msgVpnName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.11. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnMqttRetainCacheTest() { - String msgVpnName = null; - String cacheName = null; - MsgVpnMqttRetainCache body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttRetainCacheResponse response = api.updateMsgVpnMqttRetainCache(msgVpnName, cacheName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an MQTT Session object. - * - * Update an MQTT Session object. Any attribute missing from the request will be left unchanged. An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| owner||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnMqttSessionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - MsgVpnMqttSession body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionResponse response = api.updateMsgVpnMqttSession(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Subscription object. - * - * Update a Subscription object. Any attribute missing from the request will be left unchanged. An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- mqttSessionClientId|x|x|||| mqttSessionVirtualRouter|x|x|||| msgVpnName|x|x|||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnMqttSessionSubscriptionTest() { - String msgVpnName = null; - String mqttSessionClientId = null; - String mqttSessionVirtualRouter = null; - String subscriptionTopic = null; - MsgVpnMqttSessionSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnMqttSessionSubscriptionResponse response = api.updateMsgVpnMqttSessionSubscription(msgVpnName, mqttSessionClientId, mqttSessionVirtualRouter, subscriptionTopic, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Queue object. - * - * Update a Queue object. Any attribute missing from the request will be left unchanged. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| queueName|x|x|||| respectMsgPriorityEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnQueueTest() { - String msgVpnName = null; - String queueName = null; - MsgVpnQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueResponse response = api.updateMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Queue Template object. - * - * Update a Queue Template object. Any attribute missing from the request will be left unchanged. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnQueueTemplateTest() { - String msgVpnName = null; - String queueTemplateName = null; - MsgVpnQueueTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueTemplateResponse response = api.updateMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Replay Log object. - * - * Update a Replay Log object. Any attribute missing from the request will be left unchanged. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnReplayLogTest() { - String msgVpnName = null; - String replayLogName = null; - MsgVpnReplayLog body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogResponse response = api.updateMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Replicated Topic object. - * - * Update a Replicated Topic object. Any attribute missing from the request will be left unchanged. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnReplicatedTopicTest() { - String msgVpnName = null; - String replicatedTopic = null; - MsgVpnReplicatedTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplicatedTopicResponse response = api.updateMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a REST Delivery Point object. - * - * Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientProfileName||||x|| msgVpnName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnRestDeliveryPointTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - MsgVpnRestDeliveryPoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointResponse response = api.updateMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Queue Binding object. - * - * Update a Queue Binding object. Any attribute missing from the request will be left unchanged. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnRestDeliveryPointQueueBindingTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - MsgVpnRestDeliveryPointQueueBinding body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingResponse response = api.updateMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Request Header object. - * - * Update a Request Header object. Any attribute missing from the request will be left unchanged. A request header to be added to the HTTP request. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- headerName|x|x|||| msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnRestDeliveryPointQueueBindingRequestHeaderTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - String headerName = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse response = api.updateMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a REST Consumer object. - * - * Update a REST Consumer object. Any attribute missing from the request will be left unchanged. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey|||x|||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| authenticationHttpBasicPassword|||x|x||x authenticationHttpBasicUsername||||x|| authenticationHttpHeaderValue|||x|||x authenticationOauthClientId||||x|| authenticationOauthClientScope||||x|| authenticationOauthClientSecret|||x|x||x authenticationOauthClientTokenEndpoint||||x|| authenticationOauthJwtSecretKey|||x|x||x authenticationOauthJwtTokenEndpoint||||x|| authenticationScheme||||x|| msgVpnName|x|x|||| outgoingConnectionCount||||x|| remoteHost||||x|| remotePort||||x|| restConsumerName|x|x|||| restDeliveryPointName|x|x|||| tlsCipherSuiteList||||x|| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnRestDeliveryPointRestConsumerTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - MsgVpnRestDeliveryPointRestConsumer body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerResponse response = api.updateMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Topic Endpoint object. - * - * Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| respectMsgPriorityEnabled||||x|| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnTopicEndpointTest() { - String msgVpnName = null; - String topicEndpointName = null; - MsgVpnTopicEndpoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointResponse response = api.updateMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Topic Endpoint Template object. - * - * Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnTopicEndpointTemplateTest() { - String msgVpnName = null; - String topicEndpointTemplateName = null; - MsgVpnTopicEndpointTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointTemplateResponse response = api.updateMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/OauthProfileApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/OauthProfileApiTest.java deleted file mode 100644 index 366b3c3d9..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/OauthProfileApiTest.java +++ /dev/null @@ -1,868 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHost; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHostResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHostsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParameter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParameterResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParametersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelExceptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfilesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for OauthProfileApi - */ -@Ignore -public class OauthProfileApiTest { - - private final OauthProfileApi api = new OauthProfileApi(); - - - /** - * Create an OAuth Profile object. - * - * Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientSecret||||x||x oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createOauthProfileTest() { - OauthProfile body = null; - String opaquePassword = null; - List select = null; - OauthProfileResponse response = api.createOauthProfile(body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Group Access Level object. - * - * Create a Group Access Level object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: groupName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createOauthProfileAccessLevelGroupTest() { - String oauthProfileName = null; - OauthProfileAccessLevelGroup body = null; - String opaquePassword = null; - List select = null; - OauthProfileAccessLevelGroupResponse response = api.createOauthProfileAccessLevelGroup(oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Message VPN Access-Level Exception object. - * - * Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: groupName|x||x||| msgVpnName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String groupName = null; - OauthProfileAccessLevelGroupMsgVpnAccessLevelException body = null; - String opaquePassword = null; - List select = null; - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse response = api.createOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an Allowed Host Value object. - * - * Create an Allowed Host Value object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: allowedHost|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createOauthProfileClientAllowedHostTest() { - String oauthProfileName = null; - OauthProfileClientAllowedHost body = null; - String opaquePassword = null; - List select = null; - OauthProfileClientAllowedHostResponse response = api.createOauthProfileClientAllowedHost(oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create an Authorization Parameter object. - * - * Create an Authorization Parameter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authorizationParameterName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createOauthProfileClientAuthorizationParameterTest() { - String oauthProfileName = null; - OauthProfileClientAuthorizationParameter body = null; - String opaquePassword = null; - List select = null; - OauthProfileClientAuthorizationParameterResponse response = api.createOauthProfileClientAuthorizationParameter(oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Required Claim object. - * - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the ID token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: clientRequiredClaimName|x|x|||| clientRequiredClaimValue||x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createOauthProfileClientRequiredClaimTest() { - String oauthProfileName = null; - OauthProfileClientRequiredClaim body = null; - String opaquePassword = null; - List select = null; - OauthProfileClientRequiredClaimResponse response = api.createOauthProfileClientRequiredClaim(oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Message VPN Access-Level Exception object. - * - * Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Default message VPN access-level exceptions. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x|x|||| oauthProfileName|x||x||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createOauthProfileDefaultMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - OauthProfileDefaultMsgVpnAccessLevelException body = null; - String opaquePassword = null; - List select = null; - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse response = api.createOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Required Claim object. - * - * Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the access token. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: oauthProfileName|x||x||| resourceServerRequiredClaimName|x|x|||| resourceServerRequiredClaimValue||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createOauthProfileResourceServerRequiredClaimTest() { - String oauthProfileName = null; - OauthProfileResourceServerRequiredClaim body = null; - String opaquePassword = null; - List select = null; - OauthProfileResourceServerRequiredClaimResponse response = api.createOauthProfileResourceServerRequiredClaim(oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete an OAuth Profile object. - * - * Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates via config-sync. OAuth profiles specify how to securely authenticate to an OAuth provider. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteOauthProfileTest() { - String oauthProfileName = null; - SempMetaOnlyResponse response = api.deleteOauthProfile(oauthProfileName); - - // TODO: test validations - } - - /** - * Delete a Group Access Level object. - * - * Delete a Group Access Level object. The deletion of instances of this object are synchronized to HA mates via config-sync. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteOauthProfileAccessLevelGroupTest() { - String oauthProfileName = null; - String groupName = null; - SempMetaOnlyResponse response = api.deleteOauthProfileAccessLevelGroup(oauthProfileName, groupName); - - // TODO: test validations - } - - /** - * Delete a Message VPN Access-Level Exception object. - * - * Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. Message VPN access-level exceptions for members of this group. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String groupName = null; - String msgVpnName = null; - SempMetaOnlyResponse response = api.deleteOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName); - - // TODO: test validations - } - - /** - * Delete an Allowed Host Value object. - * - * Delete an Allowed Host Value object. The deletion of instances of this object are synchronized to HA mates via config-sync. A valid hostname for this broker in OAuth redirects. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteOauthProfileClientAllowedHostTest() { - String oauthProfileName = null; - String allowedHost = null; - SempMetaOnlyResponse response = api.deleteOauthProfileClientAllowedHost(oauthProfileName, allowedHost); - - // TODO: test validations - } - - /** - * Delete an Authorization Parameter object. - * - * Delete an Authorization Parameter object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional parameters to be passed to the OAuth authorization endpoint. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteOauthProfileClientAuthorizationParameterTest() { - String oauthProfileName = null; - String authorizationParameterName = null; - SempMetaOnlyResponse response = api.deleteOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName); - - // TODO: test validations - } - - /** - * Delete a Required Claim object. - * - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the ID token. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteOauthProfileClientRequiredClaimTest() { - String oauthProfileName = null; - String clientRequiredClaimName = null; - SempMetaOnlyResponse response = api.deleteOauthProfileClientRequiredClaim(oauthProfileName, clientRequiredClaimName); - - // TODO: test validations - } - - /** - * Delete a Message VPN Access-Level Exception object. - * - * Delete a Message VPN Access-Level Exception object. The deletion of instances of this object are synchronized to HA mates via config-sync. Default message VPN access-level exceptions. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteOauthProfileDefaultMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String msgVpnName = null; - SempMetaOnlyResponse response = api.deleteOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName); - - // TODO: test validations - } - - /** - * Delete a Required Claim object. - * - * Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates via config-sync. Additional claims to be verified in the access token. A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteOauthProfileResourceServerRequiredClaimTest() { - String oauthProfileName = null; - String resourceServerRequiredClaimName = null; - SempMetaOnlyResponse response = api.deleteOauthProfileResourceServerRequiredClaim(oauthProfileName, resourceServerRequiredClaimName); - - // TODO: test validations - } - - /** - * Get an OAuth Profile object. - * - * Get an OAuth Profile object. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileTest() { - String oauthProfileName = null; - String opaquePassword = null; - List select = null; - OauthProfileResponse response = api.getOauthProfile(oauthProfileName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Group Access Level object. - * - * Get a Group Access Level object. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileAccessLevelGroupTest() { - String oauthProfileName = null; - String groupName = null; - String opaquePassword = null; - List select = null; - OauthProfileAccessLevelGroupResponse response = api.getOauthProfileAccessLevelGroup(oauthProfileName, groupName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Message VPN Access-Level Exception object. - * - * Get a Message VPN Access-Level Exception object. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String groupName = null; - String msgVpnName = null; - String opaquePassword = null; - List select = null; - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse response = api.getOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Message VPN Access-Level Exception objects. - * - * Get a list of Message VPN Access-Level Exception objects. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsTest() { - String oauthProfileName = null; - String groupName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse response = api.getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions(oauthProfileName, groupName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Group Access Level objects. - * - * Get a list of Group Access Level objects. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: groupName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileAccessLevelGroupsTest() { - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - OauthProfileAccessLevelGroupsResponse response = api.getOauthProfileAccessLevelGroups(oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get an Allowed Host Value object. - * - * Get an Allowed Host Value object. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowedHost|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileClientAllowedHostTest() { - String oauthProfileName = null; - String allowedHost = null; - String opaquePassword = null; - List select = null; - OauthProfileClientAllowedHostResponse response = api.getOauthProfileClientAllowedHost(oauthProfileName, allowedHost, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Allowed Host Value objects. - * - * Get a list of Allowed Host Value objects. A valid hostname for this broker in OAuth redirects. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: allowedHost|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileClientAllowedHostsTest() { - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - OauthProfileClientAllowedHostsResponse response = api.getOauthProfileClientAllowedHosts(oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get an Authorization Parameter object. - * - * Get an Authorization Parameter object. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationParameterName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileClientAuthorizationParameterTest() { - String oauthProfileName = null; - String authorizationParameterName = null; - String opaquePassword = null; - List select = null; - OauthProfileClientAuthorizationParameterResponse response = api.getOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Authorization Parameter objects. - * - * Get a list of Authorization Parameter objects. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authorizationParameterName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileClientAuthorizationParametersTest() { - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - OauthProfileClientAuthorizationParametersResponse response = api.getOauthProfileClientAuthorizationParameters(oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Required Claim object. - * - * Get a Required Claim object. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileClientRequiredClaimTest() { - String oauthProfileName = null; - String clientRequiredClaimName = null; - String opaquePassword = null; - List select = null; - OauthProfileClientRequiredClaimResponse response = api.getOauthProfileClientRequiredClaim(oauthProfileName, clientRequiredClaimName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Required Claim objects. - * - * Get a list of Required Claim objects. Additional claims to be verified in the ID token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientRequiredClaimName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileClientRequiredClaimsTest() { - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - OauthProfileClientRequiredClaimsResponse response = api.getOauthProfileClientRequiredClaims(oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Message VPN Access-Level Exception object. - * - * Get a Message VPN Access-Level Exception object. Default message VPN access-level exceptions. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileDefaultMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String msgVpnName = null; - String opaquePassword = null; - List select = null; - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse response = api.getOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Message VPN Access-Level Exception objects. - * - * Get a list of Message VPN Access-Level Exception objects. Default message VPN access-level exceptions. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileDefaultMsgVpnAccessLevelExceptionsTest() { - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse response = api.getOauthProfileDefaultMsgVpnAccessLevelExceptions(oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Required Claim object. - * - * Get a Required Claim object. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileResourceServerRequiredClaimTest() { - String oauthProfileName = null; - String resourceServerRequiredClaimName = null; - String opaquePassword = null; - List select = null; - OauthProfileResourceServerRequiredClaimResponse response = api.getOauthProfileResourceServerRequiredClaim(oauthProfileName, resourceServerRequiredClaimName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Required Claim objects. - * - * Get a list of Required Claim objects. Additional claims to be verified in the access token. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: oauthProfileName|x||| resourceServerRequiredClaimName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfileResourceServerRequiredClaimsTest() { - String oauthProfileName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - OauthProfileResourceServerRequiredClaimsResponse response = api.getOauthProfileResourceServerRequiredClaims(oauthProfileName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of OAuth Profile objects. - * - * Get a list of OAuth Profile objects. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: clientSecret||x||x oauthProfileName|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getOauthProfilesTest() { - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - OauthProfilesResponse response = api.getOauthProfiles(count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace an OAuth Profile object. - * - * Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientSecret||||x|||x oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: accessLevelGroupsClaimName|global/admin clientId|global/admin clientRedirectUri|global/admin clientRequiredType|global/admin clientScope|global/admin clientSecret|global/admin clientValidateTypeEnabled|global/admin defaultGlobalAccessLevel|global/admin displayName|global/admin enabled|global/admin endpointAuthorization|global/admin endpointDiscovery|global/admin endpointDiscoveryRefreshInterval|global/admin endpointIntrospection|global/admin endpointIntrospectionTimeout|global/admin endpointJwks|global/admin endpointJwksRefreshInterval|global/admin endpointToken|global/admin endpointTokenTimeout|global/admin endpointUserinfo|global/admin endpointUserinfoTimeout|global/admin interactiveEnabled|global/admin interactivePromptForExpiredSession|global/admin interactivePromptForNewSession|global/admin issuer|global/admin oauthRole|global/admin resourceServerParseAccessTokenEnabled|global/admin resourceServerRequiredAudience|global/admin resourceServerRequiredIssuer|global/admin resourceServerRequiredScope|global/admin resourceServerRequiredType|global/admin resourceServerValidateAudienceEnabled|global/admin resourceServerValidateIssuerEnabled|global/admin resourceServerValidateScopeEnabled|global/admin resourceServerValidateTypeEnabled|global/admin sempEnabled|global/admin usernameClaimName|global/admin This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceOauthProfileTest() { - String oauthProfileName = null; - OauthProfile body = null; - String opaquePassword = null; - List select = null; - OauthProfileResponse response = api.replaceOauthProfile(oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Group Access Level object. - * - * Replace a Group Access Level object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- groupName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceOauthProfileAccessLevelGroupTest() { - String oauthProfileName = null; - String groupName = null; - OauthProfileAccessLevelGroup body = null; - String opaquePassword = null; - List select = null; - OauthProfileAccessLevelGroupResponse response = api.replaceOauthProfileAccessLevelGroup(oauthProfileName, groupName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Message VPN Access-Level Exception object. - * - * Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- groupName|x||x|||| msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String groupName = null; - String msgVpnName = null; - OauthProfileAccessLevelGroupMsgVpnAccessLevelException body = null; - String opaquePassword = null; - List select = null; - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse response = api.replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace an Authorization Parameter object. - * - * Replace an Authorization Parameter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authorizationParameterName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceOauthProfileClientAuthorizationParameterTest() { - String oauthProfileName = null; - String authorizationParameterName = null; - OauthProfileClientAuthorizationParameter body = null; - String opaquePassword = null; - List select = null; - OauthProfileClientAuthorizationParameterResponse response = api.replaceOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Message VPN Access-Level Exception object. - * - * Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. Default message VPN access-level exceptions. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| oauthProfileName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceOauthProfileDefaultMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String msgVpnName = null; - OauthProfileDefaultMsgVpnAccessLevelException body = null; - String opaquePassword = null; - List select = null; - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse response = api.replaceOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an OAuth Profile object. - * - * Update an OAuth Profile object. Any attribute missing from the request will be left unchanged. OAuth profiles specify how to securely authenticate to an OAuth provider. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientSecret|||x|||x oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: accessLevelGroupsClaimName|global/admin clientId|global/admin clientRedirectUri|global/admin clientRequiredType|global/admin clientScope|global/admin clientSecret|global/admin clientValidateTypeEnabled|global/admin defaultGlobalAccessLevel|global/admin displayName|global/admin enabled|global/admin endpointAuthorization|global/admin endpointDiscovery|global/admin endpointDiscoveryRefreshInterval|global/admin endpointIntrospection|global/admin endpointIntrospectionTimeout|global/admin endpointJwks|global/admin endpointJwksRefreshInterval|global/admin endpointToken|global/admin endpointTokenTimeout|global/admin endpointUserinfo|global/admin endpointUserinfoTimeout|global/admin interactiveEnabled|global/admin interactivePromptForExpiredSession|global/admin interactivePromptForNewSession|global/admin issuer|global/admin oauthRole|global/admin resourceServerParseAccessTokenEnabled|global/admin resourceServerRequiredAudience|global/admin resourceServerRequiredIssuer|global/admin resourceServerRequiredScope|global/admin resourceServerRequiredType|global/admin resourceServerValidateAudienceEnabled|global/admin resourceServerValidateIssuerEnabled|global/admin resourceServerValidateScopeEnabled|global/admin resourceServerValidateTypeEnabled|global/admin sempEnabled|global/admin usernameClaimName|global/admin This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateOauthProfileTest() { - String oauthProfileName = null; - OauthProfile body = null; - String opaquePassword = null; - List select = null; - OauthProfileResponse response = api.updateOauthProfile(oauthProfileName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Group Access Level object. - * - * Update a Group Access Level object. Any attribute missing from the request will be left unchanged. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- groupName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level: Attribute|Access Scope/Level :---|:---: globalAccessLevel|global/admin This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateOauthProfileAccessLevelGroupTest() { - String oauthProfileName = null; - String groupName = null; - OauthProfileAccessLevelGroup body = null; - String opaquePassword = null; - List select = null; - OauthProfileAccessLevelGroupResponse response = api.updateOauthProfileAccessLevelGroup(oauthProfileName, groupName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Message VPN Access-Level Exception object. - * - * Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. Message VPN access-level exceptions for members of this group. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- groupName|x|x|||| msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String groupName = null; - String msgVpnName = null; - OauthProfileAccessLevelGroupMsgVpnAccessLevelException body = null; - String opaquePassword = null; - List select = null; - OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse response = api.updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException(oauthProfileName, groupName, msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update an Authorization Parameter object. - * - * Update an Authorization Parameter object. Any attribute missing from the request will be left unchanged. Additional parameters to be passed to the OAuth authorization endpoint. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authorizationParameterName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateOauthProfileClientAuthorizationParameterTest() { - String oauthProfileName = null; - String authorizationParameterName = null; - OauthProfileClientAuthorizationParameter body = null; - String opaquePassword = null; - List select = null; - OauthProfileClientAuthorizationParameterResponse response = api.updateOauthProfileClientAuthorizationParameter(oauthProfileName, authorizationParameterName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Message VPN Access-Level Exception object. - * - * Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged. Default message VPN access-level exceptions. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| oauthProfileName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.24. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateOauthProfileDefaultMsgVpnAccessLevelExceptionTest() { - String oauthProfileName = null; - String msgVpnName = null; - OauthProfileDefaultMsgVpnAccessLevelException body = null; - String opaquePassword = null; - List select = null; - OauthProfileDefaultMsgVpnAccessLevelExceptionResponse response = api.updateOauthProfileDefaultMsgVpnAccessLevelException(oauthProfileName, msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/QueueApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/QueueApiTest.java deleted file mode 100644 index 4a644e2bb..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/QueueApiTest.java +++ /dev/null @@ -1,238 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueuesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for QueueApi - */ -@Ignore -public class QueueApiTest { - - private final QueueApi api = new QueueApi(); - - - /** - * Create a Queue object. - * - * Create a Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnQueueTest() { - String msgVpnName = null; - MsgVpnQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueResponse response = api.createMsgVpnQueue(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Queue Subscription object. - * - * Create a Queue Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueName|x||x||| subscriptionTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnQueueSubscriptionTest() { - String msgVpnName = null; - String queueName = null; - MsgVpnQueueSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueSubscriptionResponse response = api.createMsgVpnQueueSubscription(msgVpnName, queueName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Queue object. - * - * Delete a Queue object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnQueueTest() { - String msgVpnName = null; - String queueName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnQueue(msgVpnName, queueName); - - // TODO: test validations - } - - /** - * Delete a Queue Subscription object. - * - * Delete a Queue Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnQueueSubscriptionTest() { - String msgVpnName = null; - String queueName = null; - String subscriptionTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic); - - // TODO: test validations - } - - /** - * Get a Queue object. - * - * Get a Queue object. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueueTest() { - String msgVpnName = null; - String queueName = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueResponse response = api.getMsgVpnQueue(msgVpnName, queueName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Queue Subscription object. - * - * Get a Queue Subscription object. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueueSubscriptionTest() { - String msgVpnName = null; - String queueName = null; - String subscriptionTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueSubscriptionResponse response = api.getMsgVpnQueueSubscription(msgVpnName, queueName, subscriptionTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Queue Subscription objects. - * - * Get a list of Queue Subscription objects. One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| subscriptionTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueueSubscriptionsTest() { - String msgVpnName = null; - String queueName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnQueueSubscriptionsResponse response = api.getMsgVpnQueueSubscriptions(msgVpnName, queueName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Queue objects. - * - * Get a list of Queue objects. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueuesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnQueuesResponse response = api.getMsgVpnQueues(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Queue object. - * - * Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| queueName|x||x|||| respectMsgPriorityEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnQueueTest() { - String msgVpnName = null; - String queueName = null; - MsgVpnQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueResponse response = api.replaceMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Queue object. - * - * Update a Queue object. Any attribute missing from the request will be left unchanged. A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| queueName|x|x|||| respectMsgPriorityEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnQueueTest() { - String msgVpnName = null; - String queueName = null; - MsgVpnQueue body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueResponse response = api.updateMsgVpnQueue(msgVpnName, queueName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/QueueTemplateApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/QueueTemplateApiTest.java deleted file mode 100644 index 82d37fa6d..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/QueueTemplateApiTest.java +++ /dev/null @@ -1,155 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplateResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplatesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for QueueTemplateApi - */ -@Ignore -public class QueueTemplateApiTest { - - private final QueueTemplateApi api = new QueueTemplateApi(); - - - /** - * Create a Queue Template object. - * - * Create a Queue Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnQueueTemplateTest() { - String msgVpnName = null; - MsgVpnQueueTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueTemplateResponse response = api.createMsgVpnQueueTemplate(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Queue Template object. - * - * Delete a Queue Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Template provides a mechanism for specifying the initial state for client created queues. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnQueueTemplateTest() { - String msgVpnName = null; - String queueTemplateName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnQueueTemplate(msgVpnName, queueTemplateName); - - // TODO: test validations - } - - /** - * Get a Queue Template object. - * - * Get a Queue Template object. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueueTemplateTest() { - String msgVpnName = null; - String queueTemplateName = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueTemplateResponse response = api.getMsgVpnQueueTemplate(msgVpnName, queueTemplateName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Queue Template objects. - * - * Get a list of Queue Template objects. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnQueueTemplatesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnQueueTemplatesResponse response = api.getMsgVpnQueueTemplates(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Queue Template object. - * - * Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnQueueTemplateTest() { - String msgVpnName = null; - String queueTemplateName = null; - MsgVpnQueueTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueTemplateResponse response = api.replaceMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Queue Template object. - * - * Update a Queue Template object. Any attribute missing from the request will be left unchanged. A Queue Template provides a mechanism for specifying the initial state for client created queues. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnQueueTemplateTest() { - String msgVpnName = null; - String queueTemplateName = null; - MsgVpnQueueTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnQueueTemplateResponse response = api.updateMsgVpnQueueTemplate(msgVpnName, queueTemplateName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ReplayLogApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ReplayLogApiTest.java deleted file mode 100644 index 69010f3c4..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ReplayLogApiTest.java +++ /dev/null @@ -1,238 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLog; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscriptionResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscriptionsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for ReplayLogApi - */ -@Ignore -public class ReplayLogApiTest { - - private final ReplayLogApi api = new ReplayLogApi(); - - - /** - * Create a Replay Log object. - * - * Create a Replay Log object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnReplayLogTest() { - String msgVpnName = null; - MsgVpnReplayLog body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogResponse response = api.createMsgVpnReplayLog(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Topic Filter Subscription object. - * - * Create a Topic Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replayLogName|x||x||| topicFilterSubscription|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnReplayLogTopicFilterSubscriptionTest() { - String msgVpnName = null; - String replayLogName = null; - MsgVpnReplayLogTopicFilterSubscription body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogTopicFilterSubscriptionResponse response = api.createMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Replay Log object. - * - * Delete a Replay Log object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnReplayLogTest() { - String msgVpnName = null; - String replayLogName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnReplayLog(msgVpnName, replayLogName); - - // TODO: test validations - } - - /** - * Delete a Topic Filter Subscription object. - * - * Delete a Topic Filter Subscription object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnReplayLogTopicFilterSubscriptionTest() { - String msgVpnName = null; - String replayLogName = null; - String topicFilterSubscription = null; - SempMetaOnlyResponse response = api.deleteMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription); - - // TODO: test validations - } - - /** - * Get a Replay Log object. - * - * Get a Replay Log object. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplayLogTest() { - String msgVpnName = null; - String replayLogName = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogResponse response = api.getMsgVpnReplayLog(msgVpnName, replayLogName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Topic Filter Subscription object. - * - * Get a Topic Filter Subscription object. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplayLogTopicFilterSubscriptionTest() { - String msgVpnName = null; - String replayLogName = null; - String topicFilterSubscription = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogTopicFilterSubscriptionResponse response = api.getMsgVpnReplayLogTopicFilterSubscription(msgVpnName, replayLogName, topicFilterSubscription, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Topic Filter Subscription objects. - * - * Get a list of Topic Filter Subscription objects. One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| topicFilterSubscription|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.27. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplayLogTopicFilterSubscriptionsTest() { - String msgVpnName = null; - String replayLogName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnReplayLogTopicFilterSubscriptionsResponse response = api.getMsgVpnReplayLogTopicFilterSubscriptions(msgVpnName, replayLogName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Replay Log objects. - * - * Get a list of Replay Log objects. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replayLogName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplayLogsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnReplayLogsResponse response = api.getMsgVpnReplayLogs(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Replay Log object. - * - * Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replayLogName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnReplayLogTest() { - String msgVpnName = null; - String replayLogName = null; - MsgVpnReplayLog body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogResponse response = api.replaceMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Replay Log object. - * - * Update a Replay Log object. Any attribute missing from the request will be left unchanged. When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replayLogName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.10. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnReplayLogTest() { - String msgVpnName = null; - String replayLogName = null; - MsgVpnReplayLog body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplayLogResponse response = api.updateMsgVpnReplayLog(msgVpnName, replayLogName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ReplicatedTopicApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ReplicatedTopicApiTest.java deleted file mode 100644 index 9d0d1b393..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/ReplicatedTopicApiTest.java +++ /dev/null @@ -1,155 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopicResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopicsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for ReplicatedTopicApi - */ -@Ignore -public class ReplicatedTopicApiTest { - - private final ReplicatedTopicApi api = new ReplicatedTopicApi(); - - - /** - * Create a Replicated Topic object. - * - * Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnReplicatedTopicTest() { - String msgVpnName = null; - MsgVpnReplicatedTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplicatedTopicResponse response = api.createMsgVpnReplicatedTopic(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Replicated Topic object. - * - * Delete a Replicated Topic object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnReplicatedTopicTest() { - String msgVpnName = null; - String replicatedTopic = null; - SempMetaOnlyResponse response = api.deleteMsgVpnReplicatedTopic(msgVpnName, replicatedTopic); - - // TODO: test validations - } - - /** - * Get a Replicated Topic object. - * - * Get a Replicated Topic object. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplicatedTopicTest() { - String msgVpnName = null; - String replicatedTopic = null; - String opaquePassword = null; - List select = null; - MsgVpnReplicatedTopicResponse response = api.getMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Replicated Topic objects. - * - * Get a list of Replicated Topic objects. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| replicatedTopic|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnReplicatedTopicsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnReplicatedTopicsResponse response = api.getMsgVpnReplicatedTopics(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Replicated Topic object. - * - * Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| replicatedTopic|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnReplicatedTopicTest() { - String msgVpnName = null; - String replicatedTopic = null; - MsgVpnReplicatedTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplicatedTopicResponse response = api.replaceMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Replicated Topic object. - * - * Update a Replicated Topic object. Any attribute missing from the request will be left unchanged. To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| replicatedTopic|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnReplicatedTopicTest() { - String msgVpnName = null; - String replicatedTopic = null; - MsgVpnReplicatedTopic body = null; - String opaquePassword = null; - List select = null; - MsgVpnReplicatedTopicResponse response = api.updateMsgVpnReplicatedTopic(msgVpnName, replicatedTopic, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/RestDeliveryPointApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/RestDeliveryPointApiTest.java deleted file mode 100644 index 74ddcb44c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/RestDeliveryPointApiTest.java +++ /dev/null @@ -1,708 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBinding; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeader; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumer; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumersResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for RestDeliveryPointApi - */ -@Ignore -public class RestDeliveryPointApiTest { - - private final RestDeliveryPointApi api = new RestDeliveryPointApi(); - - - /** - * Create a REST Delivery Point object. - * - * Create a REST Delivery Point object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointTest() { - String msgVpnName = null; - MsgVpnRestDeliveryPoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointResponse response = api.createMsgVpnRestDeliveryPoint(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Queue Binding object. - * - * Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| queueBindingName|x|x|||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointQueueBindingTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - MsgVpnRestDeliveryPointQueueBinding body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingResponse response = api.createMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Request Header object. - * - * Create a Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: headerName|x|x|||| msgVpnName|x||x||| queueBindingName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointQueueBindingRequestHeaderTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse response = api.createMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a REST Consumer object. - * - * Create a REST Consumer object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||||x||x authenticationClientCertContent||||x||x authenticationClientCertPassword||||x|| authenticationHttpBasicPassword||||x||x authenticationHttpHeaderValue||||x||x authenticationOauthClientSecret||||x||x authenticationOauthJwtSecretKey||||x||x msgVpnName|x||x||| restConsumerName|x|x|||| restDeliveryPointName|x||x||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointRestConsumerTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - MsgVpnRestDeliveryPointRestConsumer body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerResponse response = api.createMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Claim object. - * - * Create a Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| oauthJwtClaimName|x|x|||| oauthJwtClaimValue||x|||| restConsumerName|x||x||| restDeliveryPointName|x||x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse response = api.createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Create a Trusted Common Name object. - * - * Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||x| restConsumerName|x||x||x| restDeliveryPointName|x||x||x| tlsTrustedCommonName|x|x|||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse response = api.createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a REST Delivery Point object. - * - * Delete a REST Delivery Point object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName); - - // TODO: test validations - } - - /** - * Delete a Queue Binding object. - * - * Delete a Queue Binding object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointQueueBindingTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName); - - // TODO: test validations - } - - /** - * Delete a Request Header object. - * - * Delete a Request Header object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A request header to be added to the HTTP request. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointQueueBindingRequestHeaderTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - String headerName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName); - - // TODO: test validations - } - - /** - * Delete a REST Consumer object. - * - * Delete a REST Consumer object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointRestConsumerTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName); - - // TODO: test validations - } - - /** - * Delete a Claim object. - * - * Delete a Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Claim is added to the JWT sent to the OAuth token request endpoint. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.21. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String oauthJwtClaimName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName); - - // TODO: test validations - } - - /** - * Delete a Trusted Common Name object. - * - * Delete a Trusted Common Name object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String tlsTrustedCommonName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName); - - // TODO: test validations - } - - /** - * Get a REST Delivery Point object. - * - * Get a REST Delivery Point object. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointResponse response = api.getMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Queue Binding object. - * - * Get a Queue Binding object. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointQueueBindingTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingResponse response = api.getMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Request Header object. - * - * Get a Request Header object. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointQueueBindingRequestHeaderTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - String headerName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse response = api.getMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Request Header objects. - * - * Get a list of Request Header objects. A request header to be added to the HTTP request. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: headerName|x||| msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointQueueBindingRequestHeadersTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse response = api.getMsgVpnRestDeliveryPointQueueBindingRequestHeaders(msgVpnName, restDeliveryPointName, queueBindingName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of Queue Binding objects. - * - * Get a list of Queue Binding objects. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| queueBindingName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointQueueBindingsTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingsResponse response = api.getMsgVpnRestDeliveryPointQueueBindings(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a REST Consumer object. - * - * Get a REST Consumer object. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumerTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerResponse response = api.getMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a Claim object. - * - * Get a Claim object. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String oauthJwtClaimName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse response = api.getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(msgVpnName, restDeliveryPointName, restConsumerName, oauthJwtClaimName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Claim objects. - * - * Get a list of Claim objects. A Claim is added to the JWT sent to the OAuth token request endpoint. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| oauthJwtClaimName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.21. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse response = api.getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims(msgVpnName, restDeliveryPointName, restConsumerName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a Trusted Common Name object. - * - * Get a Trusted Common Name object. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String tlsTrustedCommonName = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse response = api.getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(msgVpnName, restDeliveryPointName, restConsumerName, tlsTrustedCommonName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Trusted Common Name objects. - * - * Get a list of Trusted Common Name objects. The Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||x| restConsumerName|x||x| restDeliveryPointName|x||x| tlsTrustedCommonName|x||x| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been deprecated since (will be deprecated in next SEMP version). Common Name validation has been replaced by Server Certificate Name validation. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse response = api.getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames(msgVpnName, restDeliveryPointName, restConsumerName, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of REST Consumer objects. - * - * Get a list of REST Consumer objects. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: authenticationAwsSecretAccessKey||x||x authenticationClientCertContent||x||x authenticationClientCertPassword||x|| authenticationHttpBasicPassword||x||x authenticationHttpHeaderValue||x||x authenticationOauthClientSecret||x||x authenticationOauthJwtSecretKey||x||x msgVpnName|x||| restConsumerName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointRestConsumersTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumersResponse response = api.getMsgVpnRestDeliveryPointRestConsumers(msgVpnName, restDeliveryPointName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Get a list of REST Delivery Point objects. - * - * Get a list of REST Delivery Point objects. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| restDeliveryPointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnRestDeliveryPointsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnRestDeliveryPointsResponse response = api.getMsgVpnRestDeliveryPoints(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a REST Delivery Point object. - * - * Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- clientProfileName|||||x|| msgVpnName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnRestDeliveryPointTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - MsgVpnRestDeliveryPoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointResponse response = api.replaceMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Queue Binding object. - * - * Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnRestDeliveryPointQueueBindingTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - MsgVpnRestDeliveryPointQueueBinding body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingResponse response = api.replaceMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a Request Header object. - * - * Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A request header to be added to the HTTP request. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- headerName|x||x|||| msgVpnName|x||x|||| queueBindingName|x||x|||| restDeliveryPointName|x||x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnRestDeliveryPointQueueBindingRequestHeaderTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - String headerName = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse response = api.replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Replace a REST Consumer object. - * - * Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey||||x|||x authenticationClientCertContent||||x|x||x authenticationClientCertPassword||||x|x|| authenticationHttpBasicPassword||||x|x||x authenticationHttpBasicUsername|||||x|| authenticationHttpHeaderValue||||x|||x authenticationOauthClientId|||||x|| authenticationOauthClientScope|||||x|| authenticationOauthClientSecret||||x|x||x authenticationOauthClientTokenEndpoint|||||x|| authenticationOauthJwtSecretKey||||x|x||x authenticationOauthJwtTokenEndpoint|||||x|| authenticationScheme|||||x|| msgVpnName|x||x|||| outgoingConnectionCount|||||x|| remoteHost|||||x|| remotePort|||||x|| restConsumerName|x||x|||| restDeliveryPointName|x||x|||| tlsCipherSuiteList|||||x|| tlsEnabled|||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnRestDeliveryPointRestConsumerTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - MsgVpnRestDeliveryPointRestConsumer body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerResponse response = api.replaceMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a REST Delivery Point object. - * - * Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged. A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- clientProfileName||||x|| msgVpnName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnRestDeliveryPointTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - MsgVpnRestDeliveryPoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointResponse response = api.updateMsgVpnRestDeliveryPoint(msgVpnName, restDeliveryPointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Queue Binding object. - * - * Update a Queue Binding object. Any attribute missing from the request will be left unchanged. A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnRestDeliveryPointQueueBindingTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - MsgVpnRestDeliveryPointQueueBinding body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingResponse response = api.updateMsgVpnRestDeliveryPointQueueBinding(msgVpnName, restDeliveryPointName, queueBindingName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Request Header object. - * - * Update a Request Header object. Any attribute missing from the request will be left unchanged. A request header to be added to the HTTP request. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- headerName|x|x|||| msgVpnName|x|x|||| queueBindingName|x|x|||| restDeliveryPointName|x|x|||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.23. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnRestDeliveryPointQueueBindingRequestHeaderTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String queueBindingName = null; - String headerName = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeader body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse response = api.updateMsgVpnRestDeliveryPointQueueBindingRequestHeader(msgVpnName, restDeliveryPointName, queueBindingName, headerName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a REST Consumer object. - * - * Update a REST Consumer object. Any attribute missing from the request will be left unchanged. REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- authenticationAwsSecretAccessKey|||x|||x authenticationClientCertContent|||x|x||x authenticationClientCertPassword|||x|x|| authenticationHttpBasicPassword|||x|x||x authenticationHttpBasicUsername||||x|| authenticationHttpHeaderValue|||x|||x authenticationOauthClientId||||x|| authenticationOauthClientScope||||x|| authenticationOauthClientSecret|||x|x||x authenticationOauthClientTokenEndpoint||||x|| authenticationOauthJwtSecretKey|||x|x||x authenticationOauthJwtTokenEndpoint||||x|| authenticationScheme||||x|| msgVpnName|x|x|||| outgoingConnectionCount||||x|| remoteHost||||x|| remotePort||||x|| restConsumerName|x|x|||| restDeliveryPointName|x|x|||| tlsCipherSuiteList||||x|| tlsEnabled||||x|| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- MsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername| MsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword| MsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled| MsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort| A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.0. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnRestDeliveryPointRestConsumerTest() { - String msgVpnName = null; - String restDeliveryPointName = null; - String restConsumerName = null; - MsgVpnRestDeliveryPointRestConsumer body = null; - String opaquePassword = null; - List select = null; - MsgVpnRestDeliveryPointRestConsumerResponse response = api.updateMsgVpnRestDeliveryPointRestConsumer(msgVpnName, restDeliveryPointName, restConsumerName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/SystemInformationApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/SystemInformationApiTest.java deleted file mode 100644 index 241890a29..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/SystemInformationApiTest.java +++ /dev/null @@ -1,54 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SystemInformationResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for SystemInformationApi - */ -@Ignore -public class SystemInformationApiTest { - - private final SystemInformationApi api = new SystemInformationApi(); - - - /** - * Get a System Information object. - * - * Get a System Information object. The System Information object provides metadata about the SEMP API. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: platform|||x| sempVersion|||x| A SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. This has been deprecated since 2.2. /systemInformation was replaced by /about/api. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getSystemInformationTest() { - String opaquePassword = null; - List select = null; - SystemInformationResponse response = api.getSystemInformation(opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/TopicEndpointApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/TopicEndpointApiTest.java deleted file mode 100644 index 698c14f9c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/TopicEndpointApiTest.java +++ /dev/null @@ -1,155 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointsResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for TopicEndpointApi - */ -@Ignore -public class TopicEndpointApiTest { - - private final TopicEndpointApi api = new TopicEndpointApi(); - - - /** - * Create a Topic Endpoint object. - * - * Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnTopicEndpointTest() { - String msgVpnName = null; - MsgVpnTopicEndpoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointResponse response = api.createMsgVpnTopicEndpoint(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Topic Endpoint object. - * - * Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnTopicEndpointTest() { - String msgVpnName = null; - String topicEndpointName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnTopicEndpoint(msgVpnName, topicEndpointName); - - // TODO: test validations - } - - /** - * Get a Topic Endpoint object. - * - * Get a Topic Endpoint object. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnTopicEndpointTest() { - String msgVpnName = null; - String topicEndpointName = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointResponse response = api.getMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Topic Endpoint objects. - * - * Get a list of Topic Endpoint objects. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnTopicEndpointsTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnTopicEndpointsResponse response = api.getMsgVpnTopicEndpoints(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Topic Endpoint object. - * - * Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- accessType|||||x|| msgVpnName|x||x|||| owner|||||x|| permission|||||x|| respectMsgPriorityEnabled|||||x|| topicEndpointName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnTopicEndpointTest() { - String msgVpnName = null; - String topicEndpointName = null; - MsgVpnTopicEndpoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointResponse response = api.replaceMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Topic Endpoint object. - * - * Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged. A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- accessType||||x|| msgVpnName|x|x|||| owner||||x|| permission||||x|| respectMsgPriorityEnabled||||x|| topicEndpointName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.1. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnTopicEndpointTest() { - String msgVpnName = null; - String topicEndpointName = null; - MsgVpnTopicEndpoint body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointResponse response = api.updateMsgVpnTopicEndpoint(msgVpnName, topicEndpointName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/TopicEndpointTemplateApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/TopicEndpointTemplateApiTest.java deleted file mode 100644 index 5c76933a0..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/TopicEndpointTemplateApiTest.java +++ /dev/null @@ -1,155 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplateResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplatesResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for TopicEndpointTemplateApi - */ -@Ignore -public class TopicEndpointTemplateApiTest { - - private final TopicEndpointTemplateApi api = new TopicEndpointTemplateApi(); - - - /** - * Create a Topic Endpoint Template object. - * - * Create a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: msgVpnName|x||x||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createMsgVpnTopicEndpointTemplateTest() { - String msgVpnName = null; - MsgVpnTopicEndpointTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointTemplateResponse response = api.createMsgVpnTopicEndpointTemplate(msgVpnName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Topic Endpoint Template object. - * - * Delete a Topic Endpoint Template object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteMsgVpnTopicEndpointTemplateTest() { - String msgVpnName = null; - String topicEndpointTemplateName = null; - SempMetaOnlyResponse response = api.deleteMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName); - - // TODO: test validations - } - - /** - * Get a Topic Endpoint Template object. - * - * Get a Topic Endpoint Template object. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnTopicEndpointTemplateTest() { - String msgVpnName = null; - String topicEndpointTemplateName = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointTemplateResponse response = api.getMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Topic Endpoint Template objects. - * - * Get a list of Topic Endpoint Template objects. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: msgVpnName|x||| topicEndpointTemplateName|x||| A SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getMsgVpnTopicEndpointTemplatesTest() { - String msgVpnName = null; - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - MsgVpnTopicEndpointTemplatesResponse response = api.getMsgVpnTopicEndpointTemplates(msgVpnName, count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Topic Endpoint Template object. - * - * Replace a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- msgVpnName|x||x|||| topicEndpointTemplateName|x||x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceMsgVpnTopicEndpointTemplateTest() { - String msgVpnName = null; - String topicEndpointTemplateName = null; - MsgVpnTopicEndpointTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointTemplateResponse response = api.replaceMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Topic Endpoint Template object. - * - * Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged. A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- msgVpnName|x|x|||| topicEndpointTemplateName|x|x|||| The following attributes in the request may only be provided in certain combinations with other attributes: Class|Attribute|Requires|Conflicts :---|:---|:---|:--- EventThreshold|clearPercent|setPercent|clearValue, setValue EventThreshold|clearValue|setValue|clearPercent, setPercent EventThreshold|setPercent|clearPercent|clearValue, setValue EventThreshold|setValue|clearValue|clearPercent, setPercent A SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. This has been available since 2.14. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateMsgVpnTopicEndpointTemplateTest() { - String msgVpnName = null; - String topicEndpointTemplateName = null; - MsgVpnTopicEndpointTemplate body = null; - String opaquePassword = null; - List select = null; - MsgVpnTopicEndpointTemplateResponse response = api.updateMsgVpnTopicEndpointTemplate(msgVpnName, topicEndpointTemplateName, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/VirtualHostnameApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/VirtualHostnameApiTest.java deleted file mode 100644 index cb76bc216..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/VirtualHostnameApiTest.java +++ /dev/null @@ -1,149 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp; - -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMetaOnlyResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostname; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostnameResponse; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostnamesResponse; -import org.junit.Test; -import org.junit.Ignore; - -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for VirtualHostnameApi - */ -@Ignore -public class VirtualHostnameApiTest { - - private final VirtualHostnameApi api = new VirtualHostnameApi(); - - - /** - * Create a Virtual Hostname object. - * - * Create a Virtual Hostname object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Required|Read-Only|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---:|:---:|:---: virtualHostname|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createVirtualHostnameTest() { - VirtualHostname body = null; - String opaquePassword = null; - List select = null; - VirtualHostnameResponse response = api.createVirtualHostname(body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Delete a Virtual Hostname object. - * - * Delete a Virtual Hostname object. The deletion of instances of this object are synchronized to HA mates via config-sync. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void deleteVirtualHostnameTest() { - String virtualHostname = null; - SempMetaOnlyResponse response = api.deleteVirtualHostname(virtualHostname); - - // TODO: test validations - } - - /** - * Get a Virtual Hostname object. - * - * Get a Virtual Hostname object. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: virtualHostname|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.17. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getVirtualHostnameTest() { - String virtualHostname = null; - String opaquePassword = null; - List select = null; - VirtualHostnameResponse response = api.getVirtualHostname(virtualHostname, opaquePassword, select); - - // TODO: test validations - } - - /** - * Get a list of Virtual Hostname objects. - * - * Get a list of Virtual Hostname objects. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Write-Only|Deprecated|Opaque :---|:---:|:---:|:---:|:---: virtualHostname|x||| A SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation. This has been available since 2.17. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getVirtualHostnamesTest() { - Integer count = null; - String cursor = null; - String opaquePassword = null; - List where = null; - List select = null; - VirtualHostnamesResponse response = api.getVirtualHostnames(count, cursor, opaquePassword, where, select); - - // TODO: test validations - } - - /** - * Replace a Virtual Hostname object. - * - * Replace a Virtual Hostname object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:---|:--- virtualHostname|x||x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void replaceVirtualHostnameTest() { - String virtualHostname = null; - VirtualHostname body = null; - String opaquePassword = null; - List select = null; - VirtualHostnameResponse response = api.replaceVirtualHostname(virtualHostname, body, opaquePassword, select); - - // TODO: test validations - } - - /** - * Update a Virtual Hostname object. - * - * Update a Virtual Hostname object. Any attribute missing from the request will be left unchanged. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. Attribute|Identifying|Read-Only|Write-Only|Requires-Disable|Deprecated|Opaque :---|:---|:---|:---|:---|:---|:--- virtualHostname|x|x|||| A SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. This has been available since 2.17. - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateVirtualHostnameTest() { - String virtualHostname = null; - VirtualHostname body = null; - String opaquePassword = null; - List select = null; - VirtualHostnameResponse response = api.updateVirtualHostname(virtualHostname, body, opaquePassword, select); - - // TODO: test validations - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiLinksTest.java deleted file mode 100644 index e3bb53b8f..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for AboutApiLinks - */ -public class AboutApiLinksTest { - private final AboutApiLinks model = new AboutApiLinks(); - - /** - * Model tests for AboutApiLinks - */ - @Test - public void testAboutApiLinks() { - // TODO: test AboutApiLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiResponseTest.java deleted file mode 100644 index 4f150b7f8..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutApi; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutApiLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for AboutApiResponse - */ -public class AboutApiResponseTest { - private final AboutApiResponse model = new AboutApiResponse(); - - /** - * Model tests for AboutApiResponse - */ - @Test - public void testAboutApiResponse() { - // TODO: test AboutApiResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiTest.java deleted file mode 100644 index 4406238ef..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutApiTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for AboutApi - */ -public class AboutApiTest { - private final AboutApi model = new AboutApi(); - - /** - * Model tests for AboutApi - */ - @Test - public void testAboutApi() { - // TODO: test AboutApi - } - - /** - * Test the property 'platform' - */ - @Test - public void platformTest() { - // TODO: test platform - } - - /** - * Test the property 'sempVersion' - */ - @Test - public void sempVersionTest() { - // TODO: test sempVersion - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutLinksTest.java deleted file mode 100644 index d0a6bb8ce..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutLinksTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for AboutLinks - */ -public class AboutLinksTest { - private final AboutLinks model = new AboutLinks(); - - /** - * Model tests for AboutLinks - */ - @Test - public void testAboutLinks() { - // TODO: test AboutLinks - } - - /** - * Test the property 'apiUri' - */ - @Test - public void apiUriTest() { - // TODO: test apiUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - - /** - * Test the property 'userUri' - */ - @Test - public void userUriTest() { - // TODO: test userUri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutResponseTest.java deleted file mode 100644 index 20e57adcf..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutResponseTest.java +++ /dev/null @@ -1,66 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for AboutResponse - */ -public class AboutResponseTest { - private final AboutResponse model = new AboutResponse(); - - /** - * Model tests for AboutResponse - */ - @Test - public void testAboutResponse() { - // TODO: test AboutResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserLinksTest.java deleted file mode 100644 index 59bbd1bab..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserLinksTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for AboutUserLinks - */ -public class AboutUserLinksTest { - private final AboutUserLinks model = new AboutUserLinks(); - - /** - * Model tests for AboutUserLinks - */ - @Test - public void testAboutUserLinks() { - // TODO: test AboutUserLinks - } - - /** - * Test the property 'msgVpnsUri' - */ - @Test - public void msgVpnsUriTest() { - // TODO: test msgVpnsUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnLinksTest.java deleted file mode 100644 index 7d2fe261a..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for AboutUserMsgVpnLinks - */ -public class AboutUserMsgVpnLinksTest { - private final AboutUserMsgVpnLinks model = new AboutUserMsgVpnLinks(); - - /** - * Model tests for AboutUserMsgVpnLinks - */ - @Test - public void testAboutUserMsgVpnLinks() { - // TODO: test AboutUserMsgVpnLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnResponseTest.java deleted file mode 100644 index fcd30f345..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserMsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserMsgVpnLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for AboutUserMsgVpnResponse - */ -public class AboutUserMsgVpnResponseTest { - private final AboutUserMsgVpnResponse model = new AboutUserMsgVpnResponse(); - - /** - * Model tests for AboutUserMsgVpnResponse - */ - @Test - public void testAboutUserMsgVpnResponse() { - // TODO: test AboutUserMsgVpnResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnTest.java deleted file mode 100644 index 000e742d7..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for AboutUserMsgVpn - */ -public class AboutUserMsgVpnTest { - private final AboutUserMsgVpn model = new AboutUserMsgVpn(); - - /** - * Model tests for AboutUserMsgVpn - */ - @Test - public void testAboutUserMsgVpn() { - // TODO: test AboutUserMsgVpn - } - - /** - * Test the property 'accessLevel' - */ - @Test - public void accessLevelTest() { - // TODO: test accessLevel - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnsResponseTest.java deleted file mode 100644 index 605c91dcd..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserMsgVpnsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserMsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserMsgVpnLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for AboutUserMsgVpnsResponse - */ -public class AboutUserMsgVpnsResponseTest { - private final AboutUserMsgVpnsResponse model = new AboutUserMsgVpnsResponse(); - - /** - * Model tests for AboutUserMsgVpnsResponse - */ - @Test - public void testAboutUserMsgVpnsResponse() { - // TODO: test AboutUserMsgVpnsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserResponseTest.java deleted file mode 100644 index 93c9e1fce..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUser; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.AboutUserLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for AboutUserResponse - */ -public class AboutUserResponseTest { - private final AboutUserResponse model = new AboutUserResponse(); - - /** - * Model tests for AboutUserResponse - */ - @Test - public void testAboutUserResponse() { - // TODO: test AboutUserResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserTest.java deleted file mode 100644 index 82619891c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/AboutUserTest.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for AboutUser - */ -public class AboutUserTest { - private final AboutUser model = new AboutUser(); - - /** - * Model tests for AboutUser - */ - @Test - public void testAboutUser() { - // TODO: test AboutUser - } - - /** - * Test the property 'globalAccessLevel' - */ - @Test - public void globalAccessLevelTest() { - // TODO: test globalAccessLevel - } - - /** - * Test the property 'sessionActive' - */ - @Test - public void sessionActiveTest() { - // TODO: test sessionActive - } - - /** - * Test the property 'sessionCreateTime' - */ - @Test - public void sessionCreateTimeTest() { - // TODO: test sessionCreateTime - } - - /** - * Test the property 'sessionCurrentTime' - */ - @Test - public void sessionCurrentTimeTest() { - // TODO: test sessionCurrentTime - } - - /** - * Test the property 'sessionHardExpiryTime' - */ - @Test - public void sessionHardExpiryTimeTest() { - // TODO: test sessionHardExpiryTime - } - - /** - * Test the property 'sessionId' - */ - @Test - public void sessionIdTest() { - // TODO: test sessionId - } - - /** - * Test the property 'sessionIdleExpiryTime' - */ - @Test - public void sessionIdleExpiryTimeTest() { - // TODO: test sessionIdleExpiryTime - } - - /** - * Test the property 'username' - */ - @Test - public void usernameTest() { - // TODO: test username - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerLinksTest.java deleted file mode 100644 index 33cfc5266..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerLinksTest.java +++ /dev/null @@ -1,120 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for BrokerLinks - */ -public class BrokerLinksTest { - private final BrokerLinks model = new BrokerLinks(); - - /** - * Model tests for BrokerLinks - */ - @Test - public void testBrokerLinks() { - // TODO: test BrokerLinks - } - - /** - * Test the property 'aboutUri' - */ - @Test - public void aboutUriTest() { - // TODO: test aboutUri - } - - /** - * Test the property 'certAuthoritiesUri' - */ - @Test - public void certAuthoritiesUriTest() { - // TODO: test certAuthoritiesUri - } - - /** - * Test the property 'clientCertAuthoritiesUri' - */ - @Test - public void clientCertAuthoritiesUriTest() { - // TODO: test clientCertAuthoritiesUri - } - - /** - * Test the property 'dmrClustersUri' - */ - @Test - public void dmrClustersUriTest() { - // TODO: test dmrClustersUri - } - - /** - * Test the property 'domainCertAuthoritiesUri' - */ - @Test - public void domainCertAuthoritiesUriTest() { - // TODO: test domainCertAuthoritiesUri - } - - /** - * Test the property 'msgVpnsUri' - */ - @Test - public void msgVpnsUriTest() { - // TODO: test msgVpnsUri - } - - /** - * Test the property 'oauthProfilesUri' - */ - @Test - public void oauthProfilesUriTest() { - // TODO: test oauthProfilesUri - } - - /** - * Test the property 'systemInformationUri' - */ - @Test - public void systemInformationUriTest() { - // TODO: test systemInformationUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - - /** - * Test the property 'virtualHostnamesUri' - */ - @Test - public void virtualHostnamesUriTest() { - // TODO: test virtualHostnamesUri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerResponseTest.java deleted file mode 100644 index 1115edc37..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.Broker; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.BrokerLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for BrokerResponse - */ -public class BrokerResponseTest { - private final BrokerResponse model = new BrokerResponse(); - - /** - * Model tests for BrokerResponse - */ - @Test - public void testBrokerResponse() { - // TODO: test BrokerResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerTest.java deleted file mode 100644 index d242f08fe..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/BrokerTest.java +++ /dev/null @@ -1,714 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThresholdByPercent; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for Broker - */ -public class BrokerTest { - private final Broker model = new Broker(); - - /** - * Model tests for Broker - */ - @Test - public void testBroker() { - // TODO: test Broker - } - - /** - * Test the property 'authClientCertRevocationCheckMode' - */ - @Test - public void authClientCertRevocationCheckModeTest() { - // TODO: test authClientCertRevocationCheckMode - } - - /** - * Test the property 'configSyncAuthenticationClientCertMaxChainDepth' - */ - @Test - public void configSyncAuthenticationClientCertMaxChainDepthTest() { - // TODO: test configSyncAuthenticationClientCertMaxChainDepth - } - - /** - * Test the property 'configSyncAuthenticationClientCertValidateDateEnabled' - */ - @Test - public void configSyncAuthenticationClientCertValidateDateEnabledTest() { - // TODO: test configSyncAuthenticationClientCertValidateDateEnabled - } - - /** - * Test the property 'configSyncClientProfileTcpInitialCongestionWindow' - */ - @Test - public void configSyncClientProfileTcpInitialCongestionWindowTest() { - // TODO: test configSyncClientProfileTcpInitialCongestionWindow - } - - /** - * Test the property 'configSyncClientProfileTcpKeepaliveCount' - */ - @Test - public void configSyncClientProfileTcpKeepaliveCountTest() { - // TODO: test configSyncClientProfileTcpKeepaliveCount - } - - /** - * Test the property 'configSyncClientProfileTcpKeepaliveIdle' - */ - @Test - public void configSyncClientProfileTcpKeepaliveIdleTest() { - // TODO: test configSyncClientProfileTcpKeepaliveIdle - } - - /** - * Test the property 'configSyncClientProfileTcpKeepaliveInterval' - */ - @Test - public void configSyncClientProfileTcpKeepaliveIntervalTest() { - // TODO: test configSyncClientProfileTcpKeepaliveInterval - } - - /** - * Test the property 'configSyncClientProfileTcpMaxWindow' - */ - @Test - public void configSyncClientProfileTcpMaxWindowTest() { - // TODO: test configSyncClientProfileTcpMaxWindow - } - - /** - * Test the property 'configSyncClientProfileTcpMss' - */ - @Test - public void configSyncClientProfileTcpMssTest() { - // TODO: test configSyncClientProfileTcpMss - } - - /** - * Test the property 'configSyncEnabled' - */ - @Test - public void configSyncEnabledTest() { - // TODO: test configSyncEnabled - } - - /** - * Test the property 'configSyncSynchronizeUsernameEnabled' - */ - @Test - public void configSyncSynchronizeUsernameEnabledTest() { - // TODO: test configSyncSynchronizeUsernameEnabled - } - - /** - * Test the property 'configSyncTlsEnabled' - */ - @Test - public void configSyncTlsEnabledTest() { - // TODO: test configSyncTlsEnabled - } - - /** - * Test the property 'guaranteedMsgingDefragmentationScheduleDayList' - */ - @Test - public void guaranteedMsgingDefragmentationScheduleDayListTest() { - // TODO: test guaranteedMsgingDefragmentationScheduleDayList - } - - /** - * Test the property 'guaranteedMsgingDefragmentationScheduleEnabled' - */ - @Test - public void guaranteedMsgingDefragmentationScheduleEnabledTest() { - // TODO: test guaranteedMsgingDefragmentationScheduleEnabled - } - - /** - * Test the property 'guaranteedMsgingDefragmentationScheduleTimeList' - */ - @Test - public void guaranteedMsgingDefragmentationScheduleTimeListTest() { - // TODO: test guaranteedMsgingDefragmentationScheduleTimeList - } - - /** - * Test the property 'guaranteedMsgingDefragmentationThresholdEnabled' - */ - @Test - public void guaranteedMsgingDefragmentationThresholdEnabledTest() { - // TODO: test guaranteedMsgingDefragmentationThresholdEnabled - } - - /** - * Test the property 'guaranteedMsgingDefragmentationThresholdFragmentationPercentage' - */ - @Test - public void guaranteedMsgingDefragmentationThresholdFragmentationPercentageTest() { - // TODO: test guaranteedMsgingDefragmentationThresholdFragmentationPercentage - } - - /** - * Test the property 'guaranteedMsgingDefragmentationThresholdMinInterval' - */ - @Test - public void guaranteedMsgingDefragmentationThresholdMinIntervalTest() { - // TODO: test guaranteedMsgingDefragmentationThresholdMinInterval - } - - /** - * Test the property 'guaranteedMsgingDefragmentationThresholdUsagePercentage' - */ - @Test - public void guaranteedMsgingDefragmentationThresholdUsagePercentageTest() { - // TODO: test guaranteedMsgingDefragmentationThresholdUsagePercentage - } - - /** - * Test the property 'guaranteedMsgingEnabled' - */ - @Test - public void guaranteedMsgingEnabledTest() { - // TODO: test guaranteedMsgingEnabled - } - - /** - * Test the property 'guaranteedMsgingEventCacheUsageThreshold' - */ - @Test - public void guaranteedMsgingEventCacheUsageThresholdTest() { - // TODO: test guaranteedMsgingEventCacheUsageThreshold - } - - /** - * Test the property 'guaranteedMsgingEventDeliveredUnackedThreshold' - */ - @Test - public void guaranteedMsgingEventDeliveredUnackedThresholdTest() { - // TODO: test guaranteedMsgingEventDeliveredUnackedThreshold - } - - /** - * Test the property 'guaranteedMsgingEventDiskUsageThreshold' - */ - @Test - public void guaranteedMsgingEventDiskUsageThresholdTest() { - // TODO: test guaranteedMsgingEventDiskUsageThreshold - } - - /** - * Test the property 'guaranteedMsgingEventEgressFlowCountThreshold' - */ - @Test - public void guaranteedMsgingEventEgressFlowCountThresholdTest() { - // TODO: test guaranteedMsgingEventEgressFlowCountThreshold - } - - /** - * Test the property 'guaranteedMsgingEventEndpointCountThreshold' - */ - @Test - public void guaranteedMsgingEventEndpointCountThresholdTest() { - // TODO: test guaranteedMsgingEventEndpointCountThreshold - } - - /** - * Test the property 'guaranteedMsgingEventIngressFlowCountThreshold' - */ - @Test - public void guaranteedMsgingEventIngressFlowCountThresholdTest() { - // TODO: test guaranteedMsgingEventIngressFlowCountThreshold - } - - /** - * Test the property 'guaranteedMsgingEventMsgCountThreshold' - */ - @Test - public void guaranteedMsgingEventMsgCountThresholdTest() { - // TODO: test guaranteedMsgingEventMsgCountThreshold - } - - /** - * Test the property 'guaranteedMsgingEventMsgSpoolFileCountThreshold' - */ - @Test - public void guaranteedMsgingEventMsgSpoolFileCountThresholdTest() { - // TODO: test guaranteedMsgingEventMsgSpoolFileCountThreshold - } - - /** - * Test the property 'guaranteedMsgingEventMsgSpoolUsageThreshold' - */ - @Test - public void guaranteedMsgingEventMsgSpoolUsageThresholdTest() { - // TODO: test guaranteedMsgingEventMsgSpoolUsageThreshold - } - - /** - * Test the property 'guaranteedMsgingEventTransactedSessionCountThreshold' - */ - @Test - public void guaranteedMsgingEventTransactedSessionCountThresholdTest() { - // TODO: test guaranteedMsgingEventTransactedSessionCountThreshold - } - - /** - * Test the property 'guaranteedMsgingEventTransactedSessionResourceCountThreshold' - */ - @Test - public void guaranteedMsgingEventTransactedSessionResourceCountThresholdTest() { - // TODO: test guaranteedMsgingEventTransactedSessionResourceCountThreshold - } - - /** - * Test the property 'guaranteedMsgingEventTransactionCountThreshold' - */ - @Test - public void guaranteedMsgingEventTransactionCountThresholdTest() { - // TODO: test guaranteedMsgingEventTransactionCountThreshold - } - - /** - * Test the property 'guaranteedMsgingMaxCacheUsage' - */ - @Test - public void guaranteedMsgingMaxCacheUsageTest() { - // TODO: test guaranteedMsgingMaxCacheUsage - } - - /** - * Test the property 'guaranteedMsgingMaxMsgSpoolUsage' - */ - @Test - public void guaranteedMsgingMaxMsgSpoolUsageTest() { - // TODO: test guaranteedMsgingMaxMsgSpoolUsage - } - - /** - * Test the property 'guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout' - */ - @Test - public void guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeoutTest() { - // TODO: test guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout - } - - /** - * Test the property 'guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout' - */ - @Test - public void guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeoutTest() { - // TODO: test guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout - } - - /** - * Test the property 'guaranteedMsgingTransactionReplicationCompatibilityMode' - */ - @Test - public void guaranteedMsgingTransactionReplicationCompatibilityModeTest() { - // TODO: test guaranteedMsgingTransactionReplicationCompatibilityMode - } - - /** - * Test the property 'oauthProfileDefault' - */ - @Test - public void oauthProfileDefaultTest() { - // TODO: test oauthProfileDefault - } - - /** - * Test the property 'serviceAmqpEnabled' - */ - @Test - public void serviceAmqpEnabledTest() { - // TODO: test serviceAmqpEnabled - } - - /** - * Test the property 'serviceAmqpTlsListenPort' - */ - @Test - public void serviceAmqpTlsListenPortTest() { - // TODO: test serviceAmqpTlsListenPort - } - - /** - * Test the property 'serviceEventConnectionCountThreshold' - */ - @Test - public void serviceEventConnectionCountThresholdTest() { - // TODO: test serviceEventConnectionCountThreshold - } - - /** - * Test the property 'serviceHealthCheckEnabled' - */ - @Test - public void serviceHealthCheckEnabledTest() { - // TODO: test serviceHealthCheckEnabled - } - - /** - * Test the property 'serviceHealthCheckListenPort' - */ - @Test - public void serviceHealthCheckListenPortTest() { - // TODO: test serviceHealthCheckListenPort - } - - /** - * Test the property 'serviceMateLinkEnabled' - */ - @Test - public void serviceMateLinkEnabledTest() { - // TODO: test serviceMateLinkEnabled - } - - /** - * Test the property 'serviceMateLinkListenPort' - */ - @Test - public void serviceMateLinkListenPortTest() { - // TODO: test serviceMateLinkListenPort - } - - /** - * Test the property 'serviceMqttEnabled' - */ - @Test - public void serviceMqttEnabledTest() { - // TODO: test serviceMqttEnabled - } - - /** - * Test the property 'serviceMsgBackboneEnabled' - */ - @Test - public void serviceMsgBackboneEnabledTest() { - // TODO: test serviceMsgBackboneEnabled - } - - /** - * Test the property 'serviceRedundancyEnabled' - */ - @Test - public void serviceRedundancyEnabledTest() { - // TODO: test serviceRedundancyEnabled - } - - /** - * Test the property 'serviceRedundancyFirstListenPort' - */ - @Test - public void serviceRedundancyFirstListenPortTest() { - // TODO: test serviceRedundancyFirstListenPort - } - - /** - * Test the property 'serviceRestEventOutgoingConnectionCountThreshold' - */ - @Test - public void serviceRestEventOutgoingConnectionCountThresholdTest() { - // TODO: test serviceRestEventOutgoingConnectionCountThreshold - } - - /** - * Test the property 'serviceRestIncomingEnabled' - */ - @Test - public void serviceRestIncomingEnabledTest() { - // TODO: test serviceRestIncomingEnabled - } - - /** - * Test the property 'serviceRestOutgoingEnabled' - */ - @Test - public void serviceRestOutgoingEnabledTest() { - // TODO: test serviceRestOutgoingEnabled - } - - /** - * Test the property 'serviceSempCorsAllowAnyHostEnabled' - */ - @Test - public void serviceSempCorsAllowAnyHostEnabledTest() { - // TODO: test serviceSempCorsAllowAnyHostEnabled - } - - /** - * Test the property 'serviceSempLegacyTimeoutEnabled' - */ - @Test - public void serviceSempLegacyTimeoutEnabledTest() { - // TODO: test serviceSempLegacyTimeoutEnabled - } - - /** - * Test the property 'serviceSempPlainTextEnabled' - */ - @Test - public void serviceSempPlainTextEnabledTest() { - // TODO: test serviceSempPlainTextEnabled - } - - /** - * Test the property 'serviceSempPlainTextListenPort' - */ - @Test - public void serviceSempPlainTextListenPortTest() { - // TODO: test serviceSempPlainTextListenPort - } - - /** - * Test the property 'serviceSempSessionIdleTimeout' - */ - @Test - public void serviceSempSessionIdleTimeoutTest() { - // TODO: test serviceSempSessionIdleTimeout - } - - /** - * Test the property 'serviceSempSessionMaxLifetime' - */ - @Test - public void serviceSempSessionMaxLifetimeTest() { - // TODO: test serviceSempSessionMaxLifetime - } - - /** - * Test the property 'serviceSempTlsEnabled' - */ - @Test - public void serviceSempTlsEnabledTest() { - // TODO: test serviceSempTlsEnabled - } - - /** - * Test the property 'serviceSempTlsListenPort' - */ - @Test - public void serviceSempTlsListenPortTest() { - // TODO: test serviceSempTlsListenPort - } - - /** - * Test the property 'serviceSmfCompressionListenPort' - */ - @Test - public void serviceSmfCompressionListenPortTest() { - // TODO: test serviceSmfCompressionListenPort - } - - /** - * Test the property 'serviceSmfEnabled' - */ - @Test - public void serviceSmfEnabledTest() { - // TODO: test serviceSmfEnabled - } - - /** - * Test the property 'serviceSmfEventConnectionCountThreshold' - */ - @Test - public void serviceSmfEventConnectionCountThresholdTest() { - // TODO: test serviceSmfEventConnectionCountThreshold - } - - /** - * Test the property 'serviceSmfPlainTextListenPort' - */ - @Test - public void serviceSmfPlainTextListenPortTest() { - // TODO: test serviceSmfPlainTextListenPort - } - - /** - * Test the property 'serviceSmfRoutingControlListenPort' - */ - @Test - public void serviceSmfRoutingControlListenPortTest() { - // TODO: test serviceSmfRoutingControlListenPort - } - - /** - * Test the property 'serviceSmfTlsListenPort' - */ - @Test - public void serviceSmfTlsListenPortTest() { - // TODO: test serviceSmfTlsListenPort - } - - /** - * Test the property 'serviceTlsEventConnectionCountThreshold' - */ - @Test - public void serviceTlsEventConnectionCountThresholdTest() { - // TODO: test serviceTlsEventConnectionCountThreshold - } - - /** - * Test the property 'serviceWebTransportEnabled' - */ - @Test - public void serviceWebTransportEnabledTest() { - // TODO: test serviceWebTransportEnabled - } - - /** - * Test the property 'serviceWebTransportPlainTextListenPort' - */ - @Test - public void serviceWebTransportPlainTextListenPortTest() { - // TODO: test serviceWebTransportPlainTextListenPort - } - - /** - * Test the property 'serviceWebTransportTlsListenPort' - */ - @Test - public void serviceWebTransportTlsListenPortTest() { - // TODO: test serviceWebTransportTlsListenPort - } - - /** - * Test the property 'serviceWebTransportWebUrlSuffix' - */ - @Test - public void serviceWebTransportWebUrlSuffixTest() { - // TODO: test serviceWebTransportWebUrlSuffix - } - - /** - * Test the property 'tlsBlockVersion11Enabled' - */ - @Test - public void tlsBlockVersion11EnabledTest() { - // TODO: test tlsBlockVersion11Enabled - } - - /** - * Test the property 'tlsCipherSuiteManagementList' - */ - @Test - public void tlsCipherSuiteManagementListTest() { - // TODO: test tlsCipherSuiteManagementList - } - - /** - * Test the property 'tlsCipherSuiteMsgBackboneList' - */ - @Test - public void tlsCipherSuiteMsgBackboneListTest() { - // TODO: test tlsCipherSuiteMsgBackboneList - } - - /** - * Test the property 'tlsCipherSuiteSecureShellList' - */ - @Test - public void tlsCipherSuiteSecureShellListTest() { - // TODO: test tlsCipherSuiteSecureShellList - } - - /** - * Test the property 'tlsCrimeExploitProtectionEnabled' - */ - @Test - public void tlsCrimeExploitProtectionEnabledTest() { - // TODO: test tlsCrimeExploitProtectionEnabled - } - - /** - * Test the property 'tlsServerCertContent' - */ - @Test - public void tlsServerCertContentTest() { - // TODO: test tlsServerCertContent - } - - /** - * Test the property 'tlsServerCertPassword' - */ - @Test - public void tlsServerCertPasswordTest() { - // TODO: test tlsServerCertPassword - } - - /** - * Test the property 'tlsStandardDomainCertificateAuthoritiesEnabled' - */ - @Test - public void tlsStandardDomainCertificateAuthoritiesEnabledTest() { - // TODO: test tlsStandardDomainCertificateAuthoritiesEnabled - } - - /** - * Test the property 'tlsTicketLifetime' - */ - @Test - public void tlsTicketLifetimeTest() { - // TODO: test tlsTicketLifetime - } - - /** - * Test the property 'webManagerAllowUnencryptedWizardsEnabled' - */ - @Test - public void webManagerAllowUnencryptedWizardsEnabledTest() { - // TODO: test webManagerAllowUnencryptedWizardsEnabled - } - - /** - * Test the property 'webManagerCustomization' - */ - @Test - public void webManagerCustomizationTest() { - // TODO: test webManagerCustomization - } - - /** - * Test the property 'webManagerRedirectHttpEnabled' - */ - @Test - public void webManagerRedirectHttpEnabledTest() { - // TODO: test webManagerRedirectHttpEnabled - } - - /** - * Test the property 'webManagerRedirectHttpOverrideTlsPort' - */ - @Test - public void webManagerRedirectHttpOverrideTlsPortTest() { - // TODO: test webManagerRedirectHttpOverrideTlsPort - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthoritiesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthoritiesResponseTest.java deleted file mode 100644 index e03a4edae..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthoritiesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for CertAuthoritiesResponse - */ -public class CertAuthoritiesResponseTest { - private final CertAuthoritiesResponse model = new CertAuthoritiesResponse(); - - /** - * Model tests for CertAuthoritiesResponse - */ - @Test - public void testCertAuthoritiesResponse() { - // TODO: test CertAuthoritiesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityLinksTest.java deleted file mode 100644 index b48a5c347..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityLinksTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for CertAuthorityLinks - */ -public class CertAuthorityLinksTest { - private final CertAuthorityLinks model = new CertAuthorityLinks(); - - /** - * Model tests for CertAuthorityLinks - */ - @Test - public void testCertAuthorityLinks() { - // TODO: test CertAuthorityLinks - } - - /** - * Test the property 'ocspTlsTrustedCommonNamesUri' - */ - @Test - public void ocspTlsTrustedCommonNamesUriTest() { - // TODO: test ocspTlsTrustedCommonNamesUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameLinksTest.java deleted file mode 100644 index 8d467dd5c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for CertAuthorityOcspTlsTrustedCommonNameLinks - */ -public class CertAuthorityOcspTlsTrustedCommonNameLinksTest { - private final CertAuthorityOcspTlsTrustedCommonNameLinks model = new CertAuthorityOcspTlsTrustedCommonNameLinks(); - - /** - * Model tests for CertAuthorityOcspTlsTrustedCommonNameLinks - */ - @Test - public void testCertAuthorityOcspTlsTrustedCommonNameLinks() { - // TODO: test CertAuthorityOcspTlsTrustedCommonNameLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameResponseTest.java deleted file mode 100644 index 77f5ac8ee..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for CertAuthorityOcspTlsTrustedCommonNameResponse - */ -public class CertAuthorityOcspTlsTrustedCommonNameResponseTest { - private final CertAuthorityOcspTlsTrustedCommonNameResponse model = new CertAuthorityOcspTlsTrustedCommonNameResponse(); - - /** - * Model tests for CertAuthorityOcspTlsTrustedCommonNameResponse - */ - @Test - public void testCertAuthorityOcspTlsTrustedCommonNameResponse() { - // TODO: test CertAuthorityOcspTlsTrustedCommonNameResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameTest.java deleted file mode 100644 index 25846a30e..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNameTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for CertAuthorityOcspTlsTrustedCommonName - */ -public class CertAuthorityOcspTlsTrustedCommonNameTest { - private final CertAuthorityOcspTlsTrustedCommonName model = new CertAuthorityOcspTlsTrustedCommonName(); - - /** - * Model tests for CertAuthorityOcspTlsTrustedCommonName - */ - @Test - public void testCertAuthorityOcspTlsTrustedCommonName() { - // TODO: test CertAuthorityOcspTlsTrustedCommonName - } - - /** - * Test the property 'certAuthorityName' - */ - @Test - public void certAuthorityNameTest() { - // TODO: test certAuthorityName - } - - /** - * Test the property 'ocspTlsTrustedCommonName' - */ - @Test - public void ocspTlsTrustedCommonNameTest() { - // TODO: test ocspTlsTrustedCommonName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNamesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNamesResponseTest.java deleted file mode 100644 index 43c55269c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityOcspTlsTrustedCommonNamesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityOcspTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for CertAuthorityOcspTlsTrustedCommonNamesResponse - */ -public class CertAuthorityOcspTlsTrustedCommonNamesResponseTest { - private final CertAuthorityOcspTlsTrustedCommonNamesResponse model = new CertAuthorityOcspTlsTrustedCommonNamesResponse(); - - /** - * Model tests for CertAuthorityOcspTlsTrustedCommonNamesResponse - */ - @Test - public void testCertAuthorityOcspTlsTrustedCommonNamesResponse() { - // TODO: test CertAuthorityOcspTlsTrustedCommonNamesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityResponseTest.java deleted file mode 100644 index 3d462b731..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.CertAuthorityLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for CertAuthorityResponse - */ -public class CertAuthorityResponseTest { - private final CertAuthorityResponse model = new CertAuthorityResponse(); - - /** - * Model tests for CertAuthorityResponse - */ - @Test - public void testCertAuthorityResponse() { - // TODO: test CertAuthorityResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityTest.java deleted file mode 100644 index f3e360a11..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/CertAuthorityTest.java +++ /dev/null @@ -1,112 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for CertAuthority - */ -public class CertAuthorityTest { - private final CertAuthority model = new CertAuthority(); - - /** - * Model tests for CertAuthority - */ - @Test - public void testCertAuthority() { - // TODO: test CertAuthority - } - - /** - * Test the property 'certAuthorityName' - */ - @Test - public void certAuthorityNameTest() { - // TODO: test certAuthorityName - } - - /** - * Test the property 'certContent' - */ - @Test - public void certContentTest() { - // TODO: test certContent - } - - /** - * Test the property 'crlDayList' - */ - @Test - public void crlDayListTest() { - // TODO: test crlDayList - } - - /** - * Test the property 'crlTimeList' - */ - @Test - public void crlTimeListTest() { - // TODO: test crlTimeList - } - - /** - * Test the property 'crlUrl' - */ - @Test - public void crlUrlTest() { - // TODO: test crlUrl - } - - /** - * Test the property 'ocspNonResponderCertEnabled' - */ - @Test - public void ocspNonResponderCertEnabledTest() { - // TODO: test ocspNonResponderCertEnabled - } - - /** - * Test the property 'ocspOverrideUrl' - */ - @Test - public void ocspOverrideUrlTest() { - // TODO: test ocspOverrideUrl - } - - /** - * Test the property 'ocspTimeout' - */ - @Test - public void ocspTimeoutTest() { - // TODO: test ocspTimeout - } - - /** - * Test the property 'revocationCheckEnabled' - */ - @Test - public void revocationCheckEnabledTest() { - // TODO: test revocationCheckEnabled - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthoritiesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthoritiesResponseTest.java deleted file mode 100644 index f20331b0f..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthoritiesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for ClientCertAuthoritiesResponse - */ -public class ClientCertAuthoritiesResponseTest { - private final ClientCertAuthoritiesResponse model = new ClientCertAuthoritiesResponse(); - - /** - * Model tests for ClientCertAuthoritiesResponse - */ - @Test - public void testClientCertAuthoritiesResponse() { - // TODO: test ClientCertAuthoritiesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityLinksTest.java deleted file mode 100644 index 4031009f9..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityLinksTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for ClientCertAuthorityLinks - */ -public class ClientCertAuthorityLinksTest { - private final ClientCertAuthorityLinks model = new ClientCertAuthorityLinks(); - - /** - * Model tests for ClientCertAuthorityLinks - */ - @Test - public void testClientCertAuthorityLinks() { - // TODO: test ClientCertAuthorityLinks - } - - /** - * Test the property 'ocspTlsTrustedCommonNamesUri' - */ - @Test - public void ocspTlsTrustedCommonNamesUriTest() { - // TODO: test ocspTlsTrustedCommonNamesUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameLinksTest.java deleted file mode 100644 index 32e93dcd5..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for ClientCertAuthorityOcspTlsTrustedCommonNameLinks - */ -public class ClientCertAuthorityOcspTlsTrustedCommonNameLinksTest { - private final ClientCertAuthorityOcspTlsTrustedCommonNameLinks model = new ClientCertAuthorityOcspTlsTrustedCommonNameLinks(); - - /** - * Model tests for ClientCertAuthorityOcspTlsTrustedCommonNameLinks - */ - @Test - public void testClientCertAuthorityOcspTlsTrustedCommonNameLinks() { - // TODO: test ClientCertAuthorityOcspTlsTrustedCommonNameLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameResponseTest.java deleted file mode 100644 index 47f51c434..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for ClientCertAuthorityOcspTlsTrustedCommonNameResponse - */ -public class ClientCertAuthorityOcspTlsTrustedCommonNameResponseTest { - private final ClientCertAuthorityOcspTlsTrustedCommonNameResponse model = new ClientCertAuthorityOcspTlsTrustedCommonNameResponse(); - - /** - * Model tests for ClientCertAuthorityOcspTlsTrustedCommonNameResponse - */ - @Test - public void testClientCertAuthorityOcspTlsTrustedCommonNameResponse() { - // TODO: test ClientCertAuthorityOcspTlsTrustedCommonNameResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameTest.java deleted file mode 100644 index 1c01cc17c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNameTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for ClientCertAuthorityOcspTlsTrustedCommonName - */ -public class ClientCertAuthorityOcspTlsTrustedCommonNameTest { - private final ClientCertAuthorityOcspTlsTrustedCommonName model = new ClientCertAuthorityOcspTlsTrustedCommonName(); - - /** - * Model tests for ClientCertAuthorityOcspTlsTrustedCommonName - */ - @Test - public void testClientCertAuthorityOcspTlsTrustedCommonName() { - // TODO: test ClientCertAuthorityOcspTlsTrustedCommonName - } - - /** - * Test the property 'certAuthorityName' - */ - @Test - public void certAuthorityNameTest() { - // TODO: test certAuthorityName - } - - /** - * Test the property 'ocspTlsTrustedCommonName' - */ - @Test - public void ocspTlsTrustedCommonNameTest() { - // TODO: test ocspTlsTrustedCommonName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNamesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNamesResponseTest.java deleted file mode 100644 index 5bf2c99ae..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityOcspTlsTrustedCommonNamesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityOcspTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for ClientCertAuthorityOcspTlsTrustedCommonNamesResponse - */ -public class ClientCertAuthorityOcspTlsTrustedCommonNamesResponseTest { - private final ClientCertAuthorityOcspTlsTrustedCommonNamesResponse model = new ClientCertAuthorityOcspTlsTrustedCommonNamesResponse(); - - /** - * Model tests for ClientCertAuthorityOcspTlsTrustedCommonNamesResponse - */ - @Test - public void testClientCertAuthorityOcspTlsTrustedCommonNamesResponse() { - // TODO: test ClientCertAuthorityOcspTlsTrustedCommonNamesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityResponseTest.java deleted file mode 100644 index 73c7367e0..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.ClientCertAuthorityLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for ClientCertAuthorityResponse - */ -public class ClientCertAuthorityResponseTest { - private final ClientCertAuthorityResponse model = new ClientCertAuthorityResponse(); - - /** - * Model tests for ClientCertAuthorityResponse - */ - @Test - public void testClientCertAuthorityResponse() { - // TODO: test ClientCertAuthorityResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityTest.java deleted file mode 100644 index 932930155..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/ClientCertAuthorityTest.java +++ /dev/null @@ -1,112 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for ClientCertAuthority - */ -public class ClientCertAuthorityTest { - private final ClientCertAuthority model = new ClientCertAuthority(); - - /** - * Model tests for ClientCertAuthority - */ - @Test - public void testClientCertAuthority() { - // TODO: test ClientCertAuthority - } - - /** - * Test the property 'certAuthorityName' - */ - @Test - public void certAuthorityNameTest() { - // TODO: test certAuthorityName - } - - /** - * Test the property 'certContent' - */ - @Test - public void certContentTest() { - // TODO: test certContent - } - - /** - * Test the property 'crlDayList' - */ - @Test - public void crlDayListTest() { - // TODO: test crlDayList - } - - /** - * Test the property 'crlTimeList' - */ - @Test - public void crlTimeListTest() { - // TODO: test crlTimeList - } - - /** - * Test the property 'crlUrl' - */ - @Test - public void crlUrlTest() { - // TODO: test crlUrl - } - - /** - * Test the property 'ocspNonResponderCertEnabled' - */ - @Test - public void ocspNonResponderCertEnabledTest() { - // TODO: test ocspNonResponderCertEnabled - } - - /** - * Test the property 'ocspOverrideUrl' - */ - @Test - public void ocspOverrideUrlTest() { - // TODO: test ocspOverrideUrl - } - - /** - * Test the property 'ocspTimeout' - */ - @Test - public void ocspTimeoutTest() { - // TODO: test ocspTimeout - } - - /** - * Test the property 'revocationCheckEnabled' - */ - @Test - public void revocationCheckEnabledTest() { - // TODO: test revocationCheckEnabled - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterLinksTest.java deleted file mode 100644 index 940cf5adf..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterCertMatchingRuleAttributeFilterLinks - */ -public class DmrClusterCertMatchingRuleAttributeFilterLinksTest { - private final DmrClusterCertMatchingRuleAttributeFilterLinks model = new DmrClusterCertMatchingRuleAttributeFilterLinks(); - - /** - * Model tests for DmrClusterCertMatchingRuleAttributeFilterLinks - */ - @Test - public void testDmrClusterCertMatchingRuleAttributeFilterLinks() { - // TODO: test DmrClusterCertMatchingRuleAttributeFilterLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterResponseTest.java deleted file mode 100644 index 5d66d67a8..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFilterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterCertMatchingRuleAttributeFilterResponse - */ -public class DmrClusterCertMatchingRuleAttributeFilterResponseTest { - private final DmrClusterCertMatchingRuleAttributeFilterResponse model = new DmrClusterCertMatchingRuleAttributeFilterResponse(); - - /** - * Model tests for DmrClusterCertMatchingRuleAttributeFilterResponse - */ - @Test - public void testDmrClusterCertMatchingRuleAttributeFilterResponse() { - // TODO: test DmrClusterCertMatchingRuleAttributeFilterResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterTest.java deleted file mode 100644 index befd3fc6b..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFilterTest.java +++ /dev/null @@ -1,80 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterCertMatchingRuleAttributeFilter - */ -public class DmrClusterCertMatchingRuleAttributeFilterTest { - private final DmrClusterCertMatchingRuleAttributeFilter model = new DmrClusterCertMatchingRuleAttributeFilter(); - - /** - * Model tests for DmrClusterCertMatchingRuleAttributeFilter - */ - @Test - public void testDmrClusterCertMatchingRuleAttributeFilter() { - // TODO: test DmrClusterCertMatchingRuleAttributeFilter - } - - /** - * Test the property 'attributeName' - */ - @Test - public void attributeNameTest() { - // TODO: test attributeName - } - - /** - * Test the property 'attributeValue' - */ - @Test - public void attributeValueTest() { - // TODO: test attributeValue - } - - /** - * Test the property 'dmrClusterName' - */ - @Test - public void dmrClusterNameTest() { - // TODO: test dmrClusterName - } - - /** - * Test the property 'filterName' - */ - @Test - public void filterNameTest() { - // TODO: test filterName - } - - /** - * Test the property 'ruleName' - */ - @Test - public void ruleNameTest() { - // TODO: test ruleName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFiltersResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFiltersResponseTest.java deleted file mode 100644 index 4b60ba15a..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleAttributeFiltersResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleAttributeFilterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterCertMatchingRuleAttributeFiltersResponse - */ -public class DmrClusterCertMatchingRuleAttributeFiltersResponseTest { - private final DmrClusterCertMatchingRuleAttributeFiltersResponse model = new DmrClusterCertMatchingRuleAttributeFiltersResponse(); - - /** - * Model tests for DmrClusterCertMatchingRuleAttributeFiltersResponse - */ - @Test - public void testDmrClusterCertMatchingRuleAttributeFiltersResponse() { - // TODO: test DmrClusterCertMatchingRuleAttributeFiltersResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionLinksTest.java deleted file mode 100644 index 4ce755181..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterCertMatchingRuleConditionLinks - */ -public class DmrClusterCertMatchingRuleConditionLinksTest { - private final DmrClusterCertMatchingRuleConditionLinks model = new DmrClusterCertMatchingRuleConditionLinks(); - - /** - * Model tests for DmrClusterCertMatchingRuleConditionLinks - */ - @Test - public void testDmrClusterCertMatchingRuleConditionLinks() { - // TODO: test DmrClusterCertMatchingRuleConditionLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionResponseTest.java deleted file mode 100644 index e31f522c8..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleConditionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterCertMatchingRuleConditionResponse - */ -public class DmrClusterCertMatchingRuleConditionResponseTest { - private final DmrClusterCertMatchingRuleConditionResponse model = new DmrClusterCertMatchingRuleConditionResponse(); - - /** - * Model tests for DmrClusterCertMatchingRuleConditionResponse - */ - @Test - public void testDmrClusterCertMatchingRuleConditionResponse() { - // TODO: test DmrClusterCertMatchingRuleConditionResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionTest.java deleted file mode 100644 index 86c721b2c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionTest.java +++ /dev/null @@ -1,80 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterCertMatchingRuleCondition - */ -public class DmrClusterCertMatchingRuleConditionTest { - private final DmrClusterCertMatchingRuleCondition model = new DmrClusterCertMatchingRuleCondition(); - - /** - * Model tests for DmrClusterCertMatchingRuleCondition - */ - @Test - public void testDmrClusterCertMatchingRuleCondition() { - // TODO: test DmrClusterCertMatchingRuleCondition - } - - /** - * Test the property 'attribute' - */ - @Test - public void attributeTest() { - // TODO: test attribute - } - - /** - * Test the property 'dmrClusterName' - */ - @Test - public void dmrClusterNameTest() { - // TODO: test dmrClusterName - } - - /** - * Test the property 'expression' - */ - @Test - public void expressionTest() { - // TODO: test expression - } - - /** - * Test the property 'ruleName' - */ - @Test - public void ruleNameTest() { - // TODO: test ruleName - } - - /** - * Test the property 'source' - */ - @Test - public void sourceTest() { - // TODO: test source - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionsResponseTest.java deleted file mode 100644 index 5279b36f8..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleConditionsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleConditionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterCertMatchingRuleConditionsResponse - */ -public class DmrClusterCertMatchingRuleConditionsResponseTest { - private final DmrClusterCertMatchingRuleConditionsResponse model = new DmrClusterCertMatchingRuleConditionsResponse(); - - /** - * Model tests for DmrClusterCertMatchingRuleConditionsResponse - */ - @Test - public void testDmrClusterCertMatchingRuleConditionsResponse() { - // TODO: test DmrClusterCertMatchingRuleConditionsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleLinksTest.java deleted file mode 100644 index 8250b779b..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleLinksTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterCertMatchingRuleLinks - */ -public class DmrClusterCertMatchingRuleLinksTest { - private final DmrClusterCertMatchingRuleLinks model = new DmrClusterCertMatchingRuleLinks(); - - /** - * Model tests for DmrClusterCertMatchingRuleLinks - */ - @Test - public void testDmrClusterCertMatchingRuleLinks() { - // TODO: test DmrClusterCertMatchingRuleLinks - } - - /** - * Test the property 'attributeFiltersUri' - */ - @Test - public void attributeFiltersUriTest() { - // TODO: test attributeFiltersUri - } - - /** - * Test the property 'conditionsUri' - */ - @Test - public void conditionsUriTest() { - // TODO: test conditionsUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleResponseTest.java deleted file mode 100644 index 31074e9ee..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterCertMatchingRuleResponse - */ -public class DmrClusterCertMatchingRuleResponseTest { - private final DmrClusterCertMatchingRuleResponse model = new DmrClusterCertMatchingRuleResponse(); - - /** - * Model tests for DmrClusterCertMatchingRuleResponse - */ - @Test - public void testDmrClusterCertMatchingRuleResponse() { - // TODO: test DmrClusterCertMatchingRuleResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleTest.java deleted file mode 100644 index ab2b239ad..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRuleTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterCertMatchingRule - */ -public class DmrClusterCertMatchingRuleTest { - private final DmrClusterCertMatchingRule model = new DmrClusterCertMatchingRule(); - - /** - * Model tests for DmrClusterCertMatchingRule - */ - @Test - public void testDmrClusterCertMatchingRule() { - // TODO: test DmrClusterCertMatchingRule - } - - /** - * Test the property 'dmrClusterName' - */ - @Test - public void dmrClusterNameTest() { - // TODO: test dmrClusterName - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'ruleName' - */ - @Test - public void ruleNameTest() { - // TODO: test ruleName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRulesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRulesResponseTest.java deleted file mode 100644 index bf73b6e84..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterCertMatchingRulesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterCertMatchingRuleLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterCertMatchingRulesResponse - */ -public class DmrClusterCertMatchingRulesResponseTest { - private final DmrClusterCertMatchingRulesResponse model = new DmrClusterCertMatchingRulesResponse(); - - /** - * Model tests for DmrClusterCertMatchingRulesResponse - */ - @Test - public void testDmrClusterCertMatchingRulesResponse() { - // TODO: test DmrClusterCertMatchingRulesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeLinksTest.java deleted file mode 100644 index e28537e89..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLinkAttributeLinks - */ -public class DmrClusterLinkAttributeLinksTest { - private final DmrClusterLinkAttributeLinks model = new DmrClusterLinkAttributeLinks(); - - /** - * Model tests for DmrClusterLinkAttributeLinks - */ - @Test - public void testDmrClusterLinkAttributeLinks() { - // TODO: test DmrClusterLinkAttributeLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeResponseTest.java deleted file mode 100644 index 6fcbe2305..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttributeLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLinkAttributeResponse - */ -public class DmrClusterLinkAttributeResponseTest { - private final DmrClusterLinkAttributeResponse model = new DmrClusterLinkAttributeResponse(); - - /** - * Model tests for DmrClusterLinkAttributeResponse - */ - @Test - public void testDmrClusterLinkAttributeResponse() { - // TODO: test DmrClusterLinkAttributeResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeTest.java deleted file mode 100644 index 8f8675779..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributeTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLinkAttribute - */ -public class DmrClusterLinkAttributeTest { - private final DmrClusterLinkAttribute model = new DmrClusterLinkAttribute(); - - /** - * Model tests for DmrClusterLinkAttribute - */ - @Test - public void testDmrClusterLinkAttribute() { - // TODO: test DmrClusterLinkAttribute - } - - /** - * Test the property 'attributeName' - */ - @Test - public void attributeNameTest() { - // TODO: test attributeName - } - - /** - * Test the property 'attributeValue' - */ - @Test - public void attributeValueTest() { - // TODO: test attributeValue - } - - /** - * Test the property 'dmrClusterName' - */ - @Test - public void dmrClusterNameTest() { - // TODO: test dmrClusterName - } - - /** - * Test the property 'remoteNodeName' - */ - @Test - public void remoteNodeNameTest() { - // TODO: test remoteNodeName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributesResponseTest.java deleted file mode 100644 index f40677713..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkAttributesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkAttributeLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLinkAttributesResponse - */ -public class DmrClusterLinkAttributesResponseTest { - private final DmrClusterLinkAttributesResponse model = new DmrClusterLinkAttributesResponse(); - - /** - * Model tests for DmrClusterLinkAttributesResponse - */ - @Test - public void testDmrClusterLinkAttributesResponse() { - // TODO: test DmrClusterLinkAttributesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkLinksTest.java deleted file mode 100644 index 9524877c6..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkLinksTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLinkLinks - */ -public class DmrClusterLinkLinksTest { - private final DmrClusterLinkLinks model = new DmrClusterLinkLinks(); - - /** - * Model tests for DmrClusterLinkLinks - */ - @Test - public void testDmrClusterLinkLinks() { - // TODO: test DmrClusterLinkLinks - } - - /** - * Test the property 'attributesUri' - */ - @Test - public void attributesUriTest() { - // TODO: test attributesUri - } - - /** - * Test the property 'remoteAddressesUri' - */ - @Test - public void remoteAddressesUriTest() { - // TODO: test remoteAddressesUri - } - - /** - * Test the property 'tlsTrustedCommonNamesUri' - */ - @Test - public void tlsTrustedCommonNamesUriTest() { - // TODO: test tlsTrustedCommonNamesUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressLinksTest.java deleted file mode 100644 index 3308e1b98..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLinkRemoteAddressLinks - */ -public class DmrClusterLinkRemoteAddressLinksTest { - private final DmrClusterLinkRemoteAddressLinks model = new DmrClusterLinkRemoteAddressLinks(); - - /** - * Model tests for DmrClusterLinkRemoteAddressLinks - */ - @Test - public void testDmrClusterLinkRemoteAddressLinks() { - // TODO: test DmrClusterLinkRemoteAddressLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressResponseTest.java deleted file mode 100644 index c2768e11e..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddress; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddressLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLinkRemoteAddressResponse - */ -public class DmrClusterLinkRemoteAddressResponseTest { - private final DmrClusterLinkRemoteAddressResponse model = new DmrClusterLinkRemoteAddressResponse(); - - /** - * Model tests for DmrClusterLinkRemoteAddressResponse - */ - @Test - public void testDmrClusterLinkRemoteAddressResponse() { - // TODO: test DmrClusterLinkRemoteAddressResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressTest.java deleted file mode 100644 index 2c41457fb..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLinkRemoteAddress - */ -public class DmrClusterLinkRemoteAddressTest { - private final DmrClusterLinkRemoteAddress model = new DmrClusterLinkRemoteAddress(); - - /** - * Model tests for DmrClusterLinkRemoteAddress - */ - @Test - public void testDmrClusterLinkRemoteAddress() { - // TODO: test DmrClusterLinkRemoteAddress - } - - /** - * Test the property 'dmrClusterName' - */ - @Test - public void dmrClusterNameTest() { - // TODO: test dmrClusterName - } - - /** - * Test the property 'remoteAddress' - */ - @Test - public void remoteAddressTest() { - // TODO: test remoteAddress - } - - /** - * Test the property 'remoteNodeName' - */ - @Test - public void remoteNodeNameTest() { - // TODO: test remoteNodeName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressesResponseTest.java deleted file mode 100644 index 6cf3c1626..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkRemoteAddressesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddress; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkRemoteAddressLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLinkRemoteAddressesResponse - */ -public class DmrClusterLinkRemoteAddressesResponseTest { - private final DmrClusterLinkRemoteAddressesResponse model = new DmrClusterLinkRemoteAddressesResponse(); - - /** - * Model tests for DmrClusterLinkRemoteAddressesResponse - */ - @Test - public void testDmrClusterLinkRemoteAddressesResponse() { - // TODO: test DmrClusterLinkRemoteAddressesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkResponseTest.java deleted file mode 100644 index cfc48a32e..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLink; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLinkResponse - */ -public class DmrClusterLinkResponseTest { - private final DmrClusterLinkResponse model = new DmrClusterLinkResponse(); - - /** - * Model tests for DmrClusterLinkResponse - */ - @Test - public void testDmrClusterLinkResponse() { - // TODO: test DmrClusterLinkResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTest.java deleted file mode 100644 index 76e47dd43..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTest.java +++ /dev/null @@ -1,313 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLink - */ -public class DmrClusterLinkTest { - private final DmrClusterLink model = new DmrClusterLink(); - - /** - * Model tests for DmrClusterLink - */ - @Test - public void testDmrClusterLink() { - // TODO: test DmrClusterLink - } - - /** - * Test the property 'authenticationBasicPassword' - */ - @Test - public void authenticationBasicPasswordTest() { - // TODO: test authenticationBasicPassword - } - - /** - * Test the property 'authenticationScheme' - */ - @Test - public void authenticationSchemeTest() { - // TODO: test authenticationScheme - } - - /** - * Test the property 'clientProfileQueueControl1MaxDepth' - */ - @Test - public void clientProfileQueueControl1MaxDepthTest() { - // TODO: test clientProfileQueueControl1MaxDepth - } - - /** - * Test the property 'clientProfileQueueControl1MinMsgBurst' - */ - @Test - public void clientProfileQueueControl1MinMsgBurstTest() { - // TODO: test clientProfileQueueControl1MinMsgBurst - } - - /** - * Test the property 'clientProfileQueueDirect1MaxDepth' - */ - @Test - public void clientProfileQueueDirect1MaxDepthTest() { - // TODO: test clientProfileQueueDirect1MaxDepth - } - - /** - * Test the property 'clientProfileQueueDirect1MinMsgBurst' - */ - @Test - public void clientProfileQueueDirect1MinMsgBurstTest() { - // TODO: test clientProfileQueueDirect1MinMsgBurst - } - - /** - * Test the property 'clientProfileQueueDirect2MaxDepth' - */ - @Test - public void clientProfileQueueDirect2MaxDepthTest() { - // TODO: test clientProfileQueueDirect2MaxDepth - } - - /** - * Test the property 'clientProfileQueueDirect2MinMsgBurst' - */ - @Test - public void clientProfileQueueDirect2MinMsgBurstTest() { - // TODO: test clientProfileQueueDirect2MinMsgBurst - } - - /** - * Test the property 'clientProfileQueueDirect3MaxDepth' - */ - @Test - public void clientProfileQueueDirect3MaxDepthTest() { - // TODO: test clientProfileQueueDirect3MaxDepth - } - - /** - * Test the property 'clientProfileQueueDirect3MinMsgBurst' - */ - @Test - public void clientProfileQueueDirect3MinMsgBurstTest() { - // TODO: test clientProfileQueueDirect3MinMsgBurst - } - - /** - * Test the property 'clientProfileQueueGuaranteed1MaxDepth' - */ - @Test - public void clientProfileQueueGuaranteed1MaxDepthTest() { - // TODO: test clientProfileQueueGuaranteed1MaxDepth - } - - /** - * Test the property 'clientProfileQueueGuaranteed1MinMsgBurst' - */ - @Test - public void clientProfileQueueGuaranteed1MinMsgBurstTest() { - // TODO: test clientProfileQueueGuaranteed1MinMsgBurst - } - - /** - * Test the property 'clientProfileTcpCongestionWindowSize' - */ - @Test - public void clientProfileTcpCongestionWindowSizeTest() { - // TODO: test clientProfileTcpCongestionWindowSize - } - - /** - * Test the property 'clientProfileTcpKeepaliveCount' - */ - @Test - public void clientProfileTcpKeepaliveCountTest() { - // TODO: test clientProfileTcpKeepaliveCount - } - - /** - * Test the property 'clientProfileTcpKeepaliveIdleTime' - */ - @Test - public void clientProfileTcpKeepaliveIdleTimeTest() { - // TODO: test clientProfileTcpKeepaliveIdleTime - } - - /** - * Test the property 'clientProfileTcpKeepaliveInterval' - */ - @Test - public void clientProfileTcpKeepaliveIntervalTest() { - // TODO: test clientProfileTcpKeepaliveInterval - } - - /** - * Test the property 'clientProfileTcpMaxSegmentSize' - */ - @Test - public void clientProfileTcpMaxSegmentSizeTest() { - // TODO: test clientProfileTcpMaxSegmentSize - } - - /** - * Test the property 'clientProfileTcpMaxWindowSize' - */ - @Test - public void clientProfileTcpMaxWindowSizeTest() { - // TODO: test clientProfileTcpMaxWindowSize - } - - /** - * Test the property 'dmrClusterName' - */ - @Test - public void dmrClusterNameTest() { - // TODO: test dmrClusterName - } - - /** - * Test the property 'egressFlowWindowSize' - */ - @Test - public void egressFlowWindowSizeTest() { - // TODO: test egressFlowWindowSize - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'initiator' - */ - @Test - public void initiatorTest() { - // TODO: test initiator - } - - /** - * Test the property 'queueDeadMsgQueue' - */ - @Test - public void queueDeadMsgQueueTest() { - // TODO: test queueDeadMsgQueue - } - - /** - * Test the property 'queueEventSpoolUsageThreshold' - */ - @Test - public void queueEventSpoolUsageThresholdTest() { - // TODO: test queueEventSpoolUsageThreshold - } - - /** - * Test the property 'queueMaxDeliveredUnackedMsgsPerFlow' - */ - @Test - public void queueMaxDeliveredUnackedMsgsPerFlowTest() { - // TODO: test queueMaxDeliveredUnackedMsgsPerFlow - } - - /** - * Test the property 'queueMaxMsgSpoolUsage' - */ - @Test - public void queueMaxMsgSpoolUsageTest() { - // TODO: test queueMaxMsgSpoolUsage - } - - /** - * Test the property 'queueMaxRedeliveryCount' - */ - @Test - public void queueMaxRedeliveryCountTest() { - // TODO: test queueMaxRedeliveryCount - } - - /** - * Test the property 'queueMaxTtl' - */ - @Test - public void queueMaxTtlTest() { - // TODO: test queueMaxTtl - } - - /** - * Test the property 'queueRejectMsgToSenderOnDiscardBehavior' - */ - @Test - public void queueRejectMsgToSenderOnDiscardBehaviorTest() { - // TODO: test queueRejectMsgToSenderOnDiscardBehavior - } - - /** - * Test the property 'queueRespectTtlEnabled' - */ - @Test - public void queueRespectTtlEnabledTest() { - // TODO: test queueRespectTtlEnabled - } - - /** - * Test the property 'remoteNodeName' - */ - @Test - public void remoteNodeNameTest() { - // TODO: test remoteNodeName - } - - /** - * Test the property 'span' - */ - @Test - public void spanTest() { - // TODO: test span - } - - /** - * Test the property 'transportCompressedEnabled' - */ - @Test - public void transportCompressedEnabledTest() { - // TODO: test transportCompressedEnabled - } - - /** - * Test the property 'transportTlsEnabled' - */ - @Test - public void transportTlsEnabledTest() { - // TODO: test transportTlsEnabled - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameLinksTest.java deleted file mode 100644 index b4c016b67..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLinkTlsTrustedCommonNameLinks - */ -public class DmrClusterLinkTlsTrustedCommonNameLinksTest { - private final DmrClusterLinkTlsTrustedCommonNameLinks model = new DmrClusterLinkTlsTrustedCommonNameLinks(); - - /** - * Model tests for DmrClusterLinkTlsTrustedCommonNameLinks - */ - @Test - public void testDmrClusterLinkTlsTrustedCommonNameLinks() { - // TODO: test DmrClusterLinkTlsTrustedCommonNameLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameResponseTest.java deleted file mode 100644 index 2e743e16e..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLinkTlsTrustedCommonNameResponse - */ -public class DmrClusterLinkTlsTrustedCommonNameResponseTest { - private final DmrClusterLinkTlsTrustedCommonNameResponse model = new DmrClusterLinkTlsTrustedCommonNameResponse(); - - /** - * Model tests for DmrClusterLinkTlsTrustedCommonNameResponse - */ - @Test - public void testDmrClusterLinkTlsTrustedCommonNameResponse() { - // TODO: test DmrClusterLinkTlsTrustedCommonNameResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameTest.java deleted file mode 100644 index 3ac8d469c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNameTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLinkTlsTrustedCommonName - */ -public class DmrClusterLinkTlsTrustedCommonNameTest { - private final DmrClusterLinkTlsTrustedCommonName model = new DmrClusterLinkTlsTrustedCommonName(); - - /** - * Model tests for DmrClusterLinkTlsTrustedCommonName - */ - @Test - public void testDmrClusterLinkTlsTrustedCommonName() { - // TODO: test DmrClusterLinkTlsTrustedCommonName - } - - /** - * Test the property 'dmrClusterName' - */ - @Test - public void dmrClusterNameTest() { - // TODO: test dmrClusterName - } - - /** - * Test the property 'remoteNodeName' - */ - @Test - public void remoteNodeNameTest() { - // TODO: test remoteNodeName - } - - /** - * Test the property 'tlsTrustedCommonName' - */ - @Test - public void tlsTrustedCommonNameTest() { - // TODO: test tlsTrustedCommonName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNamesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNamesResponseTest.java deleted file mode 100644 index 885265360..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinkTlsTrustedCommonNamesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLinkTlsTrustedCommonNamesResponse - */ -public class DmrClusterLinkTlsTrustedCommonNamesResponseTest { - private final DmrClusterLinkTlsTrustedCommonNamesResponse model = new DmrClusterLinkTlsTrustedCommonNamesResponse(); - - /** - * Model tests for DmrClusterLinkTlsTrustedCommonNamesResponse - */ - @Test - public void testDmrClusterLinkTlsTrustedCommonNamesResponse() { - // TODO: test DmrClusterLinkTlsTrustedCommonNamesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinksResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinksResponseTest.java deleted file mode 100644 index 99ac152a3..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinksResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLink; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinkLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLinksResponse - */ -public class DmrClusterLinksResponseTest { - private final DmrClusterLinksResponse model = new DmrClusterLinksResponse(); - - /** - * Model tests for DmrClusterLinksResponse - */ - @Test - public void testDmrClusterLinksResponse() { - // TODO: test DmrClusterLinksResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinksTest.java deleted file mode 100644 index bd4148ce0..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterLinksTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterLinks - */ -public class DmrClusterLinksTest { - private final DmrClusterLinks model = new DmrClusterLinks(); - - /** - * Model tests for DmrClusterLinks - */ - @Test - public void testDmrClusterLinks() { - // TODO: test DmrClusterLinks - } - - /** - * Test the property 'certMatchingRulesUri' - */ - @Test - public void certMatchingRulesUriTest() { - // TODO: test certMatchingRulesUri - } - - /** - * Test the property 'linksUri' - */ - @Test - public void linksUriTest() { - // TODO: test linksUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterResponseTest.java deleted file mode 100644 index e012f3bf1..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClusterResponse - */ -public class DmrClusterResponseTest { - private final DmrClusterResponse model = new DmrClusterResponse(); - - /** - * Model tests for DmrClusterResponse - */ - @Test - public void testDmrClusterResponse() { - // TODO: test DmrClusterResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterTest.java deleted file mode 100644 index a296c6f10..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClusterTest.java +++ /dev/null @@ -1,152 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrCluster - */ -public class DmrClusterTest { - private final DmrCluster model = new DmrCluster(); - - /** - * Model tests for DmrCluster - */ - @Test - public void testDmrCluster() { - // TODO: test DmrCluster - } - - /** - * Test the property 'authenticationBasicEnabled' - */ - @Test - public void authenticationBasicEnabledTest() { - // TODO: test authenticationBasicEnabled - } - - /** - * Test the property 'authenticationBasicPassword' - */ - @Test - public void authenticationBasicPasswordTest() { - // TODO: test authenticationBasicPassword - } - - /** - * Test the property 'authenticationBasicType' - */ - @Test - public void authenticationBasicTypeTest() { - // TODO: test authenticationBasicType - } - - /** - * Test the property 'authenticationClientCertContent' - */ - @Test - public void authenticationClientCertContentTest() { - // TODO: test authenticationClientCertContent - } - - /** - * Test the property 'authenticationClientCertEnabled' - */ - @Test - public void authenticationClientCertEnabledTest() { - // TODO: test authenticationClientCertEnabled - } - - /** - * Test the property 'authenticationClientCertPassword' - */ - @Test - public void authenticationClientCertPasswordTest() { - // TODO: test authenticationClientCertPassword - } - - /** - * Test the property 'directOnlyEnabled' - */ - @Test - public void directOnlyEnabledTest() { - // TODO: test directOnlyEnabled - } - - /** - * Test the property 'dmrClusterName' - */ - @Test - public void dmrClusterNameTest() { - // TODO: test dmrClusterName - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'nodeName' - */ - @Test - public void nodeNameTest() { - // TODO: test nodeName - } - - /** - * Test the property 'tlsServerCertEnforceTrustedCommonNameEnabled' - */ - @Test - public void tlsServerCertEnforceTrustedCommonNameEnabledTest() { - // TODO: test tlsServerCertEnforceTrustedCommonNameEnabled - } - - /** - * Test the property 'tlsServerCertMaxChainDepth' - */ - @Test - public void tlsServerCertMaxChainDepthTest() { - // TODO: test tlsServerCertMaxChainDepth - } - - /** - * Test the property 'tlsServerCertValidateDateEnabled' - */ - @Test - public void tlsServerCertValidateDateEnabledTest() { - // TODO: test tlsServerCertValidateDateEnabled - } - - /** - * Test the property 'tlsServerCertValidateNameEnabled' - */ - @Test - public void tlsServerCertValidateNameEnabledTest() { - // TODO: test tlsServerCertValidateNameEnabled - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClustersResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClustersResponseTest.java deleted file mode 100644 index 8c13efb8b..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DmrClustersResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DmrClusterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DmrClustersResponse - */ -public class DmrClustersResponseTest { - private final DmrClustersResponse model = new DmrClustersResponse(); - - /** - * Model tests for DmrClustersResponse - */ - @Test - public void testDmrClustersResponse() { - // TODO: test DmrClustersResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthoritiesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthoritiesResponseTest.java deleted file mode 100644 index 3d5368c92..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthoritiesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthorityLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DomainCertAuthoritiesResponse - */ -public class DomainCertAuthoritiesResponseTest { - private final DomainCertAuthoritiesResponse model = new DomainCertAuthoritiesResponse(); - - /** - * Model tests for DomainCertAuthoritiesResponse - */ - @Test - public void testDomainCertAuthoritiesResponse() { - // TODO: test DomainCertAuthoritiesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityLinksTest.java deleted file mode 100644 index 3073de1b5..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DomainCertAuthorityLinks - */ -public class DomainCertAuthorityLinksTest { - private final DomainCertAuthorityLinks model = new DomainCertAuthorityLinks(); - - /** - * Model tests for DomainCertAuthorityLinks - */ - @Test - public void testDomainCertAuthorityLinks() { - // TODO: test DomainCertAuthorityLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityResponseTest.java deleted file mode 100644 index cd2beb45e..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthority; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.DomainCertAuthorityLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DomainCertAuthorityResponse - */ -public class DomainCertAuthorityResponseTest { - private final DomainCertAuthorityResponse model = new DomainCertAuthorityResponse(); - - /** - * Model tests for DomainCertAuthorityResponse - */ - @Test - public void testDomainCertAuthorityResponse() { - // TODO: test DomainCertAuthorityResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityTest.java deleted file mode 100644 index c6889d953..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/DomainCertAuthorityTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for DomainCertAuthority - */ -public class DomainCertAuthorityTest { - private final DomainCertAuthority model = new DomainCertAuthority(); - - /** - * Model tests for DomainCertAuthority - */ - @Test - public void testDomainCertAuthority() { - // TODO: test DomainCertAuthority - } - - /** - * Test the property 'certAuthorityName' - */ - @Test - public void certAuthorityNameTest() { - // TODO: test certAuthorityName - } - - /** - * Test the property 'certContent' - */ - @Test - public void certContentTest() { - // TODO: test certContent - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdByPercentTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdByPercentTest.java deleted file mode 100644 index cbe8f5d21..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdByPercentTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for EventThresholdByPercent - */ -public class EventThresholdByPercentTest { - private final EventThresholdByPercent model = new EventThresholdByPercent(); - - /** - * Model tests for EventThresholdByPercent - */ - @Test - public void testEventThresholdByPercent() { - // TODO: test EventThresholdByPercent - } - - /** - * Test the property 'clearPercent' - */ - @Test - public void clearPercentTest() { - // TODO: test clearPercent - } - - /** - * Test the property 'setPercent' - */ - @Test - public void setPercentTest() { - // TODO: test setPercent - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdByValueTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdByValueTest.java deleted file mode 100644 index 66b0476ed..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdByValueTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for EventThresholdByValue - */ -public class EventThresholdByValueTest { - private final EventThresholdByValue model = new EventThresholdByValue(); - - /** - * Model tests for EventThresholdByValue - */ - @Test - public void testEventThresholdByValue() { - // TODO: test EventThresholdByValue - } - - /** - * Test the property 'clearValue' - */ - @Test - public void clearValueTest() { - // TODO: test clearValue - } - - /** - * Test the property 'setValue' - */ - @Test - public void setValueTest() { - // TODO: test setValue - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdTest.java deleted file mode 100644 index d1715b4b4..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/EventThresholdTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for EventThreshold - */ -public class EventThresholdTest { - private final EventThreshold model = new EventThreshold(); - - /** - * Model tests for EventThreshold - */ - @Test - public void testEventThreshold() { - // TODO: test EventThreshold - } - - /** - * Test the property 'clearPercent' - */ - @Test - public void clearPercentTest() { - // TODO: test clearPercent - } - - /** - * Test the property 'clearValue' - */ - @Test - public void clearValueTest() { - // TODO: test clearValue - } - - /** - * Test the property 'setPercent' - */ - @Test - public void setPercentTest() { - // TODO: test setPercent - } - - /** - * Test the property 'setValue' - */ - @Test - public void setValueTest() { - // TODO: test setValue - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionLinksTest.java deleted file mode 100644 index 55b3acfd4..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileClientConnectExceptionLinks - */ -public class MsgVpnAclProfileClientConnectExceptionLinksTest { - private final MsgVpnAclProfileClientConnectExceptionLinks model = new MsgVpnAclProfileClientConnectExceptionLinks(); - - /** - * Model tests for MsgVpnAclProfileClientConnectExceptionLinks - */ - @Test - public void testMsgVpnAclProfileClientConnectExceptionLinks() { - // TODO: test MsgVpnAclProfileClientConnectExceptionLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionResponseTest.java deleted file mode 100644 index e81b9a6cb..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileClientConnectExceptionResponse - */ -public class MsgVpnAclProfileClientConnectExceptionResponseTest { - private final MsgVpnAclProfileClientConnectExceptionResponse model = new MsgVpnAclProfileClientConnectExceptionResponse(); - - /** - * Model tests for MsgVpnAclProfileClientConnectExceptionResponse - */ - @Test - public void testMsgVpnAclProfileClientConnectExceptionResponse() { - // TODO: test MsgVpnAclProfileClientConnectExceptionResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionTest.java deleted file mode 100644 index ab83eaf0d..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileClientConnectException - */ -public class MsgVpnAclProfileClientConnectExceptionTest { - private final MsgVpnAclProfileClientConnectException model = new MsgVpnAclProfileClientConnectException(); - - /** - * Model tests for MsgVpnAclProfileClientConnectException - */ - @Test - public void testMsgVpnAclProfileClientConnectException() { - // TODO: test MsgVpnAclProfileClientConnectException - } - - /** - * Test the property 'aclProfileName' - */ - @Test - public void aclProfileNameTest() { - // TODO: test aclProfileName - } - - /** - * Test the property 'clientConnectExceptionAddress' - */ - @Test - public void clientConnectExceptionAddressTest() { - // TODO: test clientConnectExceptionAddress - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionsResponseTest.java deleted file mode 100644 index 956660f37..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileClientConnectExceptionsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileClientConnectExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileClientConnectExceptionsResponse - */ -public class MsgVpnAclProfileClientConnectExceptionsResponseTest { - private final MsgVpnAclProfileClientConnectExceptionsResponse model = new MsgVpnAclProfileClientConnectExceptionsResponse(); - - /** - * Model tests for MsgVpnAclProfileClientConnectExceptionsResponse - */ - @Test - public void testMsgVpnAclProfileClientConnectExceptionsResponse() { - // TODO: test MsgVpnAclProfileClientConnectExceptionsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileLinksTest.java deleted file mode 100644 index 4e2107c16..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileLinksTest.java +++ /dev/null @@ -1,96 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileLinks - */ -public class MsgVpnAclProfileLinksTest { - private final MsgVpnAclProfileLinks model = new MsgVpnAclProfileLinks(); - - /** - * Model tests for MsgVpnAclProfileLinks - */ - @Test - public void testMsgVpnAclProfileLinks() { - // TODO: test MsgVpnAclProfileLinks - } - - /** - * Test the property 'clientConnectExceptionsUri' - */ - @Test - public void clientConnectExceptionsUriTest() { - // TODO: test clientConnectExceptionsUri - } - - /** - * Test the property 'publishExceptionsUri' - */ - @Test - public void publishExceptionsUriTest() { - // TODO: test publishExceptionsUri - } - - /** - * Test the property 'publishTopicExceptionsUri' - */ - @Test - public void publishTopicExceptionsUriTest() { - // TODO: test publishTopicExceptionsUri - } - - /** - * Test the property 'subscribeExceptionsUri' - */ - @Test - public void subscribeExceptionsUriTest() { - // TODO: test subscribeExceptionsUri - } - - /** - * Test the property 'subscribeShareNameExceptionsUri' - */ - @Test - public void subscribeShareNameExceptionsUriTest() { - // TODO: test subscribeShareNameExceptionsUri - } - - /** - * Test the property 'subscribeTopicExceptionsUri' - */ - @Test - public void subscribeTopicExceptionsUriTest() { - // TODO: test subscribeTopicExceptionsUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionLinksTest.java deleted file mode 100644 index 0ddcf32de..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfilePublishExceptionLinks - */ -public class MsgVpnAclProfilePublishExceptionLinksTest { - private final MsgVpnAclProfilePublishExceptionLinks model = new MsgVpnAclProfilePublishExceptionLinks(); - - /** - * Model tests for MsgVpnAclProfilePublishExceptionLinks - */ - @Test - public void testMsgVpnAclProfilePublishExceptionLinks() { - // TODO: test MsgVpnAclProfilePublishExceptionLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionResponseTest.java deleted file mode 100644 index 922fd9348..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfilePublishExceptionResponse - */ -public class MsgVpnAclProfilePublishExceptionResponseTest { - private final MsgVpnAclProfilePublishExceptionResponse model = new MsgVpnAclProfilePublishExceptionResponse(); - - /** - * Model tests for MsgVpnAclProfilePublishExceptionResponse - */ - @Test - public void testMsgVpnAclProfilePublishExceptionResponse() { - // TODO: test MsgVpnAclProfilePublishExceptionResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionTest.java deleted file mode 100644 index 516648995..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfilePublishException - */ -public class MsgVpnAclProfilePublishExceptionTest { - private final MsgVpnAclProfilePublishException model = new MsgVpnAclProfilePublishException(); - - /** - * Model tests for MsgVpnAclProfilePublishException - */ - @Test - public void testMsgVpnAclProfilePublishException() { - // TODO: test MsgVpnAclProfilePublishException - } - - /** - * Test the property 'aclProfileName' - */ - @Test - public void aclProfileNameTest() { - // TODO: test aclProfileName - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'publishExceptionTopic' - */ - @Test - public void publishExceptionTopicTest() { - // TODO: test publishExceptionTopic - } - - /** - * Test the property 'topicSyntax' - */ - @Test - public void topicSyntaxTest() { - // TODO: test topicSyntax - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionsResponseTest.java deleted file mode 100644 index 3f73b02c6..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishExceptionsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfilePublishExceptionsResponse - */ -public class MsgVpnAclProfilePublishExceptionsResponseTest { - private final MsgVpnAclProfilePublishExceptionsResponse model = new MsgVpnAclProfilePublishExceptionsResponse(); - - /** - * Model tests for MsgVpnAclProfilePublishExceptionsResponse - */ - @Test - public void testMsgVpnAclProfilePublishExceptionsResponse() { - // TODO: test MsgVpnAclProfilePublishExceptionsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionLinksTest.java deleted file mode 100644 index 76d6d3571..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfilePublishTopicExceptionLinks - */ -public class MsgVpnAclProfilePublishTopicExceptionLinksTest { - private final MsgVpnAclProfilePublishTopicExceptionLinks model = new MsgVpnAclProfilePublishTopicExceptionLinks(); - - /** - * Model tests for MsgVpnAclProfilePublishTopicExceptionLinks - */ - @Test - public void testMsgVpnAclProfilePublishTopicExceptionLinks() { - // TODO: test MsgVpnAclProfilePublishTopicExceptionLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionResponseTest.java deleted file mode 100644 index b16340f3c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfilePublishTopicExceptionResponse - */ -public class MsgVpnAclProfilePublishTopicExceptionResponseTest { - private final MsgVpnAclProfilePublishTopicExceptionResponse model = new MsgVpnAclProfilePublishTopicExceptionResponse(); - - /** - * Model tests for MsgVpnAclProfilePublishTopicExceptionResponse - */ - @Test - public void testMsgVpnAclProfilePublishTopicExceptionResponse() { - // TODO: test MsgVpnAclProfilePublishTopicExceptionResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionTest.java deleted file mode 100644 index 1b0e538a5..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfilePublishTopicException - */ -public class MsgVpnAclProfilePublishTopicExceptionTest { - private final MsgVpnAclProfilePublishTopicException model = new MsgVpnAclProfilePublishTopicException(); - - /** - * Model tests for MsgVpnAclProfilePublishTopicException - */ - @Test - public void testMsgVpnAclProfilePublishTopicException() { - // TODO: test MsgVpnAclProfilePublishTopicException - } - - /** - * Test the property 'aclProfileName' - */ - @Test - public void aclProfileNameTest() { - // TODO: test aclProfileName - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'publishTopicException' - */ - @Test - public void publishTopicExceptionTest() { - // TODO: test publishTopicException - } - - /** - * Test the property 'publishTopicExceptionSyntax' - */ - @Test - public void publishTopicExceptionSyntaxTest() { - // TODO: test publishTopicExceptionSyntax - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionsResponseTest.java deleted file mode 100644 index 572f31e65..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilePublishTopicExceptionsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfilePublishTopicExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfilePublishTopicExceptionsResponse - */ -public class MsgVpnAclProfilePublishTopicExceptionsResponseTest { - private final MsgVpnAclProfilePublishTopicExceptionsResponse model = new MsgVpnAclProfilePublishTopicExceptionsResponse(); - - /** - * Model tests for MsgVpnAclProfilePublishTopicExceptionsResponse - */ - @Test - public void testMsgVpnAclProfilePublishTopicExceptionsResponse() { - // TODO: test MsgVpnAclProfilePublishTopicExceptionsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileResponseTest.java deleted file mode 100644 index 32f1b680f..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileResponse - */ -public class MsgVpnAclProfileResponseTest { - private final MsgVpnAclProfileResponse model = new MsgVpnAclProfileResponse(); - - /** - * Model tests for MsgVpnAclProfileResponse - */ - @Test - public void testMsgVpnAclProfileResponse() { - // TODO: test MsgVpnAclProfileResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionLinksTest.java deleted file mode 100644 index 0c3ac8189..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileSubscribeExceptionLinks - */ -public class MsgVpnAclProfileSubscribeExceptionLinksTest { - private final MsgVpnAclProfileSubscribeExceptionLinks model = new MsgVpnAclProfileSubscribeExceptionLinks(); - - /** - * Model tests for MsgVpnAclProfileSubscribeExceptionLinks - */ - @Test - public void testMsgVpnAclProfileSubscribeExceptionLinks() { - // TODO: test MsgVpnAclProfileSubscribeExceptionLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionResponseTest.java deleted file mode 100644 index ba6e8fafa..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileSubscribeExceptionResponse - */ -public class MsgVpnAclProfileSubscribeExceptionResponseTest { - private final MsgVpnAclProfileSubscribeExceptionResponse model = new MsgVpnAclProfileSubscribeExceptionResponse(); - - /** - * Model tests for MsgVpnAclProfileSubscribeExceptionResponse - */ - @Test - public void testMsgVpnAclProfileSubscribeExceptionResponse() { - // TODO: test MsgVpnAclProfileSubscribeExceptionResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionTest.java deleted file mode 100644 index 3a9128ac3..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileSubscribeException - */ -public class MsgVpnAclProfileSubscribeExceptionTest { - private final MsgVpnAclProfileSubscribeException model = new MsgVpnAclProfileSubscribeException(); - - /** - * Model tests for MsgVpnAclProfileSubscribeException - */ - @Test - public void testMsgVpnAclProfileSubscribeException() { - // TODO: test MsgVpnAclProfileSubscribeException - } - - /** - * Test the property 'aclProfileName' - */ - @Test - public void aclProfileNameTest() { - // TODO: test aclProfileName - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'subscribeExceptionTopic' - */ - @Test - public void subscribeExceptionTopicTest() { - // TODO: test subscribeExceptionTopic - } - - /** - * Test the property 'topicSyntax' - */ - @Test - public void topicSyntaxTest() { - // TODO: test topicSyntax - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionsResponseTest.java deleted file mode 100644 index 0604c5860..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeExceptionsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileSubscribeExceptionsResponse - */ -public class MsgVpnAclProfileSubscribeExceptionsResponseTest { - private final MsgVpnAclProfileSubscribeExceptionsResponse model = new MsgVpnAclProfileSubscribeExceptionsResponse(); - - /** - * Model tests for MsgVpnAclProfileSubscribeExceptionsResponse - */ - @Test - public void testMsgVpnAclProfileSubscribeExceptionsResponse() { - // TODO: test MsgVpnAclProfileSubscribeExceptionsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionLinksTest.java deleted file mode 100644 index 40677cea7..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileSubscribeShareNameExceptionLinks - */ -public class MsgVpnAclProfileSubscribeShareNameExceptionLinksTest { - private final MsgVpnAclProfileSubscribeShareNameExceptionLinks model = new MsgVpnAclProfileSubscribeShareNameExceptionLinks(); - - /** - * Model tests for MsgVpnAclProfileSubscribeShareNameExceptionLinks - */ - @Test - public void testMsgVpnAclProfileSubscribeShareNameExceptionLinks() { - // TODO: test MsgVpnAclProfileSubscribeShareNameExceptionLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionResponseTest.java deleted file mode 100644 index a81a1cc74..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileSubscribeShareNameExceptionResponse - */ -public class MsgVpnAclProfileSubscribeShareNameExceptionResponseTest { - private final MsgVpnAclProfileSubscribeShareNameExceptionResponse model = new MsgVpnAclProfileSubscribeShareNameExceptionResponse(); - - /** - * Model tests for MsgVpnAclProfileSubscribeShareNameExceptionResponse - */ - @Test - public void testMsgVpnAclProfileSubscribeShareNameExceptionResponse() { - // TODO: test MsgVpnAclProfileSubscribeShareNameExceptionResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionTest.java deleted file mode 100644 index f2a260595..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileSubscribeShareNameException - */ -public class MsgVpnAclProfileSubscribeShareNameExceptionTest { - private final MsgVpnAclProfileSubscribeShareNameException model = new MsgVpnAclProfileSubscribeShareNameException(); - - /** - * Model tests for MsgVpnAclProfileSubscribeShareNameException - */ - @Test - public void testMsgVpnAclProfileSubscribeShareNameException() { - // TODO: test MsgVpnAclProfileSubscribeShareNameException - } - - /** - * Test the property 'aclProfileName' - */ - @Test - public void aclProfileNameTest() { - // TODO: test aclProfileName - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'subscribeShareNameException' - */ - @Test - public void subscribeShareNameExceptionTest() { - // TODO: test subscribeShareNameException - } - - /** - * Test the property 'subscribeShareNameExceptionSyntax' - */ - @Test - public void subscribeShareNameExceptionSyntaxTest() { - // TODO: test subscribeShareNameExceptionSyntax - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionsResponseTest.java deleted file mode 100644 index 1364a8d5e..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeShareNameExceptionsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeShareNameExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileSubscribeShareNameExceptionsResponse - */ -public class MsgVpnAclProfileSubscribeShareNameExceptionsResponseTest { - private final MsgVpnAclProfileSubscribeShareNameExceptionsResponse model = new MsgVpnAclProfileSubscribeShareNameExceptionsResponse(); - - /** - * Model tests for MsgVpnAclProfileSubscribeShareNameExceptionsResponse - */ - @Test - public void testMsgVpnAclProfileSubscribeShareNameExceptionsResponse() { - // TODO: test MsgVpnAclProfileSubscribeShareNameExceptionsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionLinksTest.java deleted file mode 100644 index 4322e7806..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileSubscribeTopicExceptionLinks - */ -public class MsgVpnAclProfileSubscribeTopicExceptionLinksTest { - private final MsgVpnAclProfileSubscribeTopicExceptionLinks model = new MsgVpnAclProfileSubscribeTopicExceptionLinks(); - - /** - * Model tests for MsgVpnAclProfileSubscribeTopicExceptionLinks - */ - @Test - public void testMsgVpnAclProfileSubscribeTopicExceptionLinks() { - // TODO: test MsgVpnAclProfileSubscribeTopicExceptionLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionResponseTest.java deleted file mode 100644 index 5e38a8bd5..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileSubscribeTopicExceptionResponse - */ -public class MsgVpnAclProfileSubscribeTopicExceptionResponseTest { - private final MsgVpnAclProfileSubscribeTopicExceptionResponse model = new MsgVpnAclProfileSubscribeTopicExceptionResponse(); - - /** - * Model tests for MsgVpnAclProfileSubscribeTopicExceptionResponse - */ - @Test - public void testMsgVpnAclProfileSubscribeTopicExceptionResponse() { - // TODO: test MsgVpnAclProfileSubscribeTopicExceptionResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionTest.java deleted file mode 100644 index 39b9fc545..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileSubscribeTopicException - */ -public class MsgVpnAclProfileSubscribeTopicExceptionTest { - private final MsgVpnAclProfileSubscribeTopicException model = new MsgVpnAclProfileSubscribeTopicException(); - - /** - * Model tests for MsgVpnAclProfileSubscribeTopicException - */ - @Test - public void testMsgVpnAclProfileSubscribeTopicException() { - // TODO: test MsgVpnAclProfileSubscribeTopicException - } - - /** - * Test the property 'aclProfileName' - */ - @Test - public void aclProfileNameTest() { - // TODO: test aclProfileName - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'subscribeTopicException' - */ - @Test - public void subscribeTopicExceptionTest() { - // TODO: test subscribeTopicException - } - - /** - * Test the property 'subscribeTopicExceptionSyntax' - */ - @Test - public void subscribeTopicExceptionSyntaxTest() { - // TODO: test subscribeTopicExceptionSyntax - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionsResponseTest.java deleted file mode 100644 index 4a596dc7a..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileSubscribeTopicExceptionsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileSubscribeTopicExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfileSubscribeTopicExceptionsResponse - */ -public class MsgVpnAclProfileSubscribeTopicExceptionsResponseTest { - private final MsgVpnAclProfileSubscribeTopicExceptionsResponse model = new MsgVpnAclProfileSubscribeTopicExceptionsResponse(); - - /** - * Model tests for MsgVpnAclProfileSubscribeTopicExceptionsResponse - */ - @Test - public void testMsgVpnAclProfileSubscribeTopicExceptionsResponse() { - // TODO: test MsgVpnAclProfileSubscribeTopicExceptionsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileTest.java deleted file mode 100644 index 03d575768..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfileTest.java +++ /dev/null @@ -1,88 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfile - */ -public class MsgVpnAclProfileTest { - private final MsgVpnAclProfile model = new MsgVpnAclProfile(); - - /** - * Model tests for MsgVpnAclProfile - */ - @Test - public void testMsgVpnAclProfile() { - // TODO: test MsgVpnAclProfile - } - - /** - * Test the property 'aclProfileName' - */ - @Test - public void aclProfileNameTest() { - // TODO: test aclProfileName - } - - /** - * Test the property 'clientConnectDefaultAction' - */ - @Test - public void clientConnectDefaultActionTest() { - // TODO: test clientConnectDefaultAction - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'publishTopicDefaultAction' - */ - @Test - public void publishTopicDefaultActionTest() { - // TODO: test publishTopicDefaultAction - } - - /** - * Test the property 'subscribeShareNameDefaultAction' - */ - @Test - public void subscribeShareNameDefaultActionTest() { - // TODO: test subscribeShareNameDefaultAction - } - - /** - * Test the property 'subscribeTopicDefaultAction' - */ - @Test - public void subscribeTopicDefaultActionTest() { - // TODO: test subscribeTopicDefaultAction - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilesResponseTest.java deleted file mode 100644 index b9e2661aa..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAclProfilesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAclProfileLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAclProfilesResponse - */ -public class MsgVpnAclProfilesResponseTest { - private final MsgVpnAclProfilesResponse model = new MsgVpnAclProfilesResponse(); - - /** - * Model tests for MsgVpnAclProfilesResponse - */ - @Test - public void testMsgVpnAclProfilesResponse() { - // TODO: test MsgVpnAclProfilesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinksTest.java deleted file mode 100644 index c00b6caad..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks - */ -public class MsgVpnAuthenticationOauthProfileClientRequiredClaimLinksTest { - private final MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks model = new MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks(); - - /** - * Model tests for MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks - */ - @Test - public void testMsgVpnAuthenticationOauthProfileClientRequiredClaimLinks() { - // TODO: test MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponseTest.java deleted file mode 100644 index a1c7550ae..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse - */ -public class MsgVpnAuthenticationOauthProfileClientRequiredClaimResponseTest { - private final MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse model = new MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse(); - - /** - * Model tests for MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse - */ - @Test - public void testMsgVpnAuthenticationOauthProfileClientRequiredClaimResponse() { - // TODO: test MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimTest.java deleted file mode 100644 index 69a0c5f53..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthenticationOauthProfileClientRequiredClaim - */ -public class MsgVpnAuthenticationOauthProfileClientRequiredClaimTest { - private final MsgVpnAuthenticationOauthProfileClientRequiredClaim model = new MsgVpnAuthenticationOauthProfileClientRequiredClaim(); - - /** - * Model tests for MsgVpnAuthenticationOauthProfileClientRequiredClaim - */ - @Test - public void testMsgVpnAuthenticationOauthProfileClientRequiredClaim() { - // TODO: test MsgVpnAuthenticationOauthProfileClientRequiredClaim - } - - /** - * Test the property 'clientRequiredClaimName' - */ - @Test - public void clientRequiredClaimNameTest() { - // TODO: test clientRequiredClaimName - } - - /** - * Test the property 'clientRequiredClaimValue' - */ - @Test - public void clientRequiredClaimValueTest() { - // TODO: test clientRequiredClaimValue - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'oauthProfileName' - */ - @Test - public void oauthProfileNameTest() { - // TODO: test oauthProfileName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponseTest.java deleted file mode 100644 index c75f3188b..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileClientRequiredClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse - */ -public class MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponseTest { - private final MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse model = new MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse(); - - /** - * Model tests for MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse - */ - @Test - public void testMsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse() { - // TODO: test MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileLinksTest.java deleted file mode 100644 index b470d9b8a..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileLinksTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthenticationOauthProfileLinks - */ -public class MsgVpnAuthenticationOauthProfileLinksTest { - private final MsgVpnAuthenticationOauthProfileLinks model = new MsgVpnAuthenticationOauthProfileLinks(); - - /** - * Model tests for MsgVpnAuthenticationOauthProfileLinks - */ - @Test - public void testMsgVpnAuthenticationOauthProfileLinks() { - // TODO: test MsgVpnAuthenticationOauthProfileLinks - } - - /** - * Test the property 'clientRequiredClaimsUri' - */ - @Test - public void clientRequiredClaimsUriTest() { - // TODO: test clientRequiredClaimsUri - } - - /** - * Test the property 'resourceServerRequiredClaimsUri' - */ - @Test - public void resourceServerRequiredClaimsUriTest() { - // TODO: test resourceServerRequiredClaimsUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinksTest.java deleted file mode 100644 index bc75213a3..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks - */ -public class MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinksTest { - private final MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks model = new MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks(); - - /** - * Model tests for MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks - */ - @Test - public void testMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks() { - // TODO: test MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponseTest.java deleted file mode 100644 index 94ae60447..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse - */ -public class MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponseTest { - private final MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse model = new MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse(); - - /** - * Model tests for MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse - */ - @Test - public void testMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse() { - // TODO: test MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimTest.java deleted file mode 100644 index 74823333c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - */ -public class MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimTest { - private final MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim model = new MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim(); - - /** - * Model tests for MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - */ - @Test - public void testMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim() { - // TODO: test MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'oauthProfileName' - */ - @Test - public void oauthProfileNameTest() { - // TODO: test oauthProfileName - } - - /** - * Test the property 'resourceServerRequiredClaimName' - */ - @Test - public void resourceServerRequiredClaimNameTest() { - // TODO: test resourceServerRequiredClaimName - } - - /** - * Test the property 'resourceServerRequiredClaimValue' - */ - @Test - public void resourceServerRequiredClaimValueTest() { - // TODO: test resourceServerRequiredClaimValue - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponseTest.java deleted file mode 100644 index 4e02677c8..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse - */ -public class MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponseTest { - private final MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse model = new MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse(); - - /** - * Model tests for MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse - */ - @Test - public void testMsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse() { - // TODO: test MsgVpnAuthenticationOauthProfileResourceServerRequiredClaimsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResponseTest.java deleted file mode 100644 index 1b687b757..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthenticationOauthProfileResponse - */ -public class MsgVpnAuthenticationOauthProfileResponseTest { - private final MsgVpnAuthenticationOauthProfileResponse model = new MsgVpnAuthenticationOauthProfileResponse(); - - /** - * Model tests for MsgVpnAuthenticationOauthProfileResponse - */ - @Test - public void testMsgVpnAuthenticationOauthProfileResponse() { - // TODO: test MsgVpnAuthenticationOauthProfileResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileTest.java deleted file mode 100644 index 3b80d2155..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfileTest.java +++ /dev/null @@ -1,280 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthenticationOauthProfile - */ -public class MsgVpnAuthenticationOauthProfileTest { - private final MsgVpnAuthenticationOauthProfile model = new MsgVpnAuthenticationOauthProfile(); - - /** - * Model tests for MsgVpnAuthenticationOauthProfile - */ - @Test - public void testMsgVpnAuthenticationOauthProfile() { - // TODO: test MsgVpnAuthenticationOauthProfile - } - - /** - * Test the property 'authorizationGroupsClaimName' - */ - @Test - public void authorizationGroupsClaimNameTest() { - // TODO: test authorizationGroupsClaimName - } - - /** - * Test the property 'clientId' - */ - @Test - public void clientIdTest() { - // TODO: test clientId - } - - /** - * Test the property 'clientRequiredType' - */ - @Test - public void clientRequiredTypeTest() { - // TODO: test clientRequiredType - } - - /** - * Test the property 'clientSecret' - */ - @Test - public void clientSecretTest() { - // TODO: test clientSecret - } - - /** - * Test the property 'clientValidateTypeEnabled' - */ - @Test - public void clientValidateTypeEnabledTest() { - // TODO: test clientValidateTypeEnabled - } - - /** - * Test the property 'disconnectOnTokenExpirationEnabled' - */ - @Test - public void disconnectOnTokenExpirationEnabledTest() { - // TODO: test disconnectOnTokenExpirationEnabled - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'endpointDiscovery' - */ - @Test - public void endpointDiscoveryTest() { - // TODO: test endpointDiscovery - } - - /** - * Test the property 'endpointDiscoveryRefreshInterval' - */ - @Test - public void endpointDiscoveryRefreshIntervalTest() { - // TODO: test endpointDiscoveryRefreshInterval - } - - /** - * Test the property 'endpointIntrospection' - */ - @Test - public void endpointIntrospectionTest() { - // TODO: test endpointIntrospection - } - - /** - * Test the property 'endpointIntrospectionTimeout' - */ - @Test - public void endpointIntrospectionTimeoutTest() { - // TODO: test endpointIntrospectionTimeout - } - - /** - * Test the property 'endpointJwks' - */ - @Test - public void endpointJwksTest() { - // TODO: test endpointJwks - } - - /** - * Test the property 'endpointJwksRefreshInterval' - */ - @Test - public void endpointJwksRefreshIntervalTest() { - // TODO: test endpointJwksRefreshInterval - } - - /** - * Test the property 'endpointUserinfo' - */ - @Test - public void endpointUserinfoTest() { - // TODO: test endpointUserinfo - } - - /** - * Test the property 'endpointUserinfoTimeout' - */ - @Test - public void endpointUserinfoTimeoutTest() { - // TODO: test endpointUserinfoTimeout - } - - /** - * Test the property 'issuer' - */ - @Test - public void issuerTest() { - // TODO: test issuer - } - - /** - * Test the property 'mqttUsernameValidateEnabled' - */ - @Test - public void mqttUsernameValidateEnabledTest() { - // TODO: test mqttUsernameValidateEnabled - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'oauthProfileName' - */ - @Test - public void oauthProfileNameTest() { - // TODO: test oauthProfileName - } - - /** - * Test the property 'oauthRole' - */ - @Test - public void oauthRoleTest() { - // TODO: test oauthRole - } - - /** - * Test the property 'resourceServerParseAccessTokenEnabled' - */ - @Test - public void resourceServerParseAccessTokenEnabledTest() { - // TODO: test resourceServerParseAccessTokenEnabled - } - - /** - * Test the property 'resourceServerRequiredAudience' - */ - @Test - public void resourceServerRequiredAudienceTest() { - // TODO: test resourceServerRequiredAudience - } - - /** - * Test the property 'resourceServerRequiredIssuer' - */ - @Test - public void resourceServerRequiredIssuerTest() { - // TODO: test resourceServerRequiredIssuer - } - - /** - * Test the property 'resourceServerRequiredScope' - */ - @Test - public void resourceServerRequiredScopeTest() { - // TODO: test resourceServerRequiredScope - } - - /** - * Test the property 'resourceServerRequiredType' - */ - @Test - public void resourceServerRequiredTypeTest() { - // TODO: test resourceServerRequiredType - } - - /** - * Test the property 'resourceServerValidateAudienceEnabled' - */ - @Test - public void resourceServerValidateAudienceEnabledTest() { - // TODO: test resourceServerValidateAudienceEnabled - } - - /** - * Test the property 'resourceServerValidateIssuerEnabled' - */ - @Test - public void resourceServerValidateIssuerEnabledTest() { - // TODO: test resourceServerValidateIssuerEnabled - } - - /** - * Test the property 'resourceServerValidateScopeEnabled' - */ - @Test - public void resourceServerValidateScopeEnabledTest() { - // TODO: test resourceServerValidateScopeEnabled - } - - /** - * Test the property 'resourceServerValidateTypeEnabled' - */ - @Test - public void resourceServerValidateTypeEnabledTest() { - // TODO: test resourceServerValidateTypeEnabled - } - - /** - * Test the property 'usernameClaimName' - */ - @Test - public void usernameClaimNameTest() { - // TODO: test usernameClaimName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfilesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfilesResponseTest.java deleted file mode 100644 index f7f6a7978..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProfilesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProfileLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthenticationOauthProfilesResponse - */ -public class MsgVpnAuthenticationOauthProfilesResponseTest { - private final MsgVpnAuthenticationOauthProfilesResponse model = new MsgVpnAuthenticationOauthProfilesResponse(); - - /** - * Model tests for MsgVpnAuthenticationOauthProfilesResponse - */ - @Test - public void testMsgVpnAuthenticationOauthProfilesResponse() { - // TODO: test MsgVpnAuthenticationOauthProfilesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderLinksTest.java deleted file mode 100644 index 44fff34fe..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthenticationOauthProviderLinks - */ -public class MsgVpnAuthenticationOauthProviderLinksTest { - private final MsgVpnAuthenticationOauthProviderLinks model = new MsgVpnAuthenticationOauthProviderLinks(); - - /** - * Model tests for MsgVpnAuthenticationOauthProviderLinks - */ - @Test - public void testMsgVpnAuthenticationOauthProviderLinks() { - // TODO: test MsgVpnAuthenticationOauthProviderLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderResponseTest.java deleted file mode 100644 index 7157faa2d..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProvider; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProviderLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthenticationOauthProviderResponse - */ -public class MsgVpnAuthenticationOauthProviderResponseTest { - private final MsgVpnAuthenticationOauthProviderResponse model = new MsgVpnAuthenticationOauthProviderResponse(); - - /** - * Model tests for MsgVpnAuthenticationOauthProviderResponse - */ - @Test - public void testMsgVpnAuthenticationOauthProviderResponse() { - // TODO: test MsgVpnAuthenticationOauthProviderResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderTest.java deleted file mode 100644 index 2b745d822..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProviderTest.java +++ /dev/null @@ -1,216 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthenticationOauthProvider - */ -public class MsgVpnAuthenticationOauthProviderTest { - private final MsgVpnAuthenticationOauthProvider model = new MsgVpnAuthenticationOauthProvider(); - - /** - * Model tests for MsgVpnAuthenticationOauthProvider - */ - @Test - public void testMsgVpnAuthenticationOauthProvider() { - // TODO: test MsgVpnAuthenticationOauthProvider - } - - /** - * Test the property 'audienceClaimName' - */ - @Test - public void audienceClaimNameTest() { - // TODO: test audienceClaimName - } - - /** - * Test the property 'audienceClaimSource' - */ - @Test - public void audienceClaimSourceTest() { - // TODO: test audienceClaimSource - } - - /** - * Test the property 'audienceClaimValue' - */ - @Test - public void audienceClaimValueTest() { - // TODO: test audienceClaimValue - } - - /** - * Test the property 'audienceValidationEnabled' - */ - @Test - public void audienceValidationEnabledTest() { - // TODO: test audienceValidationEnabled - } - - /** - * Test the property 'authorizationGroupClaimName' - */ - @Test - public void authorizationGroupClaimNameTest() { - // TODO: test authorizationGroupClaimName - } - - /** - * Test the property 'authorizationGroupClaimSource' - */ - @Test - public void authorizationGroupClaimSourceTest() { - // TODO: test authorizationGroupClaimSource - } - - /** - * Test the property 'authorizationGroupEnabled' - */ - @Test - public void authorizationGroupEnabledTest() { - // TODO: test authorizationGroupEnabled - } - - /** - * Test the property 'disconnectOnTokenExpirationEnabled' - */ - @Test - public void disconnectOnTokenExpirationEnabledTest() { - // TODO: test disconnectOnTokenExpirationEnabled - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'jwksRefreshInterval' - */ - @Test - public void jwksRefreshIntervalTest() { - // TODO: test jwksRefreshInterval - } - - /** - * Test the property 'jwksUri' - */ - @Test - public void jwksUriTest() { - // TODO: test jwksUri - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'oauthProviderName' - */ - @Test - public void oauthProviderNameTest() { - // TODO: test oauthProviderName - } - - /** - * Test the property 'tokenIgnoreTimeLimitsEnabled' - */ - @Test - public void tokenIgnoreTimeLimitsEnabledTest() { - // TODO: test tokenIgnoreTimeLimitsEnabled - } - - /** - * Test the property 'tokenIntrospectionParameterName' - */ - @Test - public void tokenIntrospectionParameterNameTest() { - // TODO: test tokenIntrospectionParameterName - } - - /** - * Test the property 'tokenIntrospectionPassword' - */ - @Test - public void tokenIntrospectionPasswordTest() { - // TODO: test tokenIntrospectionPassword - } - - /** - * Test the property 'tokenIntrospectionTimeout' - */ - @Test - public void tokenIntrospectionTimeoutTest() { - // TODO: test tokenIntrospectionTimeout - } - - /** - * Test the property 'tokenIntrospectionUri' - */ - @Test - public void tokenIntrospectionUriTest() { - // TODO: test tokenIntrospectionUri - } - - /** - * Test the property 'tokenIntrospectionUsername' - */ - @Test - public void tokenIntrospectionUsernameTest() { - // TODO: test tokenIntrospectionUsername - } - - /** - * Test the property 'usernameClaimName' - */ - @Test - public void usernameClaimNameTest() { - // TODO: test usernameClaimName - } - - /** - * Test the property 'usernameClaimSource' - */ - @Test - public void usernameClaimSourceTest() { - // TODO: test usernameClaimSource - } - - /** - * Test the property 'usernameValidateEnabled' - */ - @Test - public void usernameValidateEnabledTest() { - // TODO: test usernameValidateEnabled - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProvidersResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProvidersResponseTest.java deleted file mode 100644 index 733c7dfcd..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthenticationOauthProvidersResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProvider; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthenticationOauthProviderLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthenticationOauthProvidersResponse - */ -public class MsgVpnAuthenticationOauthProvidersResponseTest { - private final MsgVpnAuthenticationOauthProvidersResponse model = new MsgVpnAuthenticationOauthProvidersResponse(); - - /** - * Model tests for MsgVpnAuthenticationOauthProvidersResponse - */ - @Test - public void testMsgVpnAuthenticationOauthProvidersResponse() { - // TODO: test MsgVpnAuthenticationOauthProvidersResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupLinksTest.java deleted file mode 100644 index 5801561f5..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthorizationGroupLinks - */ -public class MsgVpnAuthorizationGroupLinksTest { - private final MsgVpnAuthorizationGroupLinks model = new MsgVpnAuthorizationGroupLinks(); - - /** - * Model tests for MsgVpnAuthorizationGroupLinks - */ - @Test - public void testMsgVpnAuthorizationGroupLinks() { - // TODO: test MsgVpnAuthorizationGroupLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupResponseTest.java deleted file mode 100644 index 98c27992c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroupLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthorizationGroupResponse - */ -public class MsgVpnAuthorizationGroupResponseTest { - private final MsgVpnAuthorizationGroupResponse model = new MsgVpnAuthorizationGroupResponse(); - - /** - * Model tests for MsgVpnAuthorizationGroupResponse - */ - @Test - public void testMsgVpnAuthorizationGroupResponse() { - // TODO: test MsgVpnAuthorizationGroupResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupTest.java deleted file mode 100644 index 4e35dd8ae..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupTest.java +++ /dev/null @@ -1,96 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthorizationGroup - */ -public class MsgVpnAuthorizationGroupTest { - private final MsgVpnAuthorizationGroup model = new MsgVpnAuthorizationGroup(); - - /** - * Model tests for MsgVpnAuthorizationGroup - */ - @Test - public void testMsgVpnAuthorizationGroup() { - // TODO: test MsgVpnAuthorizationGroup - } - - /** - * Test the property 'aclProfileName' - */ - @Test - public void aclProfileNameTest() { - // TODO: test aclProfileName - } - - /** - * Test the property 'authorizationGroupName' - */ - @Test - public void authorizationGroupNameTest() { - // TODO: test authorizationGroupName - } - - /** - * Test the property 'clientProfileName' - */ - @Test - public void clientProfileNameTest() { - // TODO: test clientProfileName - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'orderAfterAuthorizationGroupName' - */ - @Test - public void orderAfterAuthorizationGroupNameTest() { - // TODO: test orderAfterAuthorizationGroupName - } - - /** - * Test the property 'orderBeforeAuthorizationGroupName' - */ - @Test - public void orderBeforeAuthorizationGroupNameTest() { - // TODO: test orderBeforeAuthorizationGroupName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupsResponseTest.java deleted file mode 100644 index 69226cfab..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnAuthorizationGroupsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnAuthorizationGroupLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnAuthorizationGroupsResponse - */ -public class MsgVpnAuthorizationGroupsResponseTest { - private final MsgVpnAuthorizationGroupsResponse model = new MsgVpnAuthorizationGroupsResponse(); - - /** - * Model tests for MsgVpnAuthorizationGroupsResponse - */ - @Test - public void testMsgVpnAuthorizationGroupsResponse() { - // TODO: test MsgVpnAuthorizationGroupsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeLinksTest.java deleted file mode 100644 index f9fdc120a..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeLinksTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnBridgeLinks - */ -public class MsgVpnBridgeLinksTest { - private final MsgVpnBridgeLinks model = new MsgVpnBridgeLinks(); - - /** - * Model tests for MsgVpnBridgeLinks - */ - @Test - public void testMsgVpnBridgeLinks() { - // TODO: test MsgVpnBridgeLinks - } - - /** - * Test the property 'remoteMsgVpnsUri' - */ - @Test - public void remoteMsgVpnsUriTest() { - // TODO: test remoteMsgVpnsUri - } - - /** - * Test the property 'remoteSubscriptionsUri' - */ - @Test - public void remoteSubscriptionsUriTest() { - // TODO: test remoteSubscriptionsUri - } - - /** - * Test the property 'tlsTrustedCommonNamesUri' - */ - @Test - public void tlsTrustedCommonNamesUriTest() { - // TODO: test tlsTrustedCommonNamesUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnLinksTest.java deleted file mode 100644 index 6f45560c5..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnBridgeRemoteMsgVpnLinks - */ -public class MsgVpnBridgeRemoteMsgVpnLinksTest { - private final MsgVpnBridgeRemoteMsgVpnLinks model = new MsgVpnBridgeRemoteMsgVpnLinks(); - - /** - * Model tests for MsgVpnBridgeRemoteMsgVpnLinks - */ - @Test - public void testMsgVpnBridgeRemoteMsgVpnLinks() { - // TODO: test MsgVpnBridgeRemoteMsgVpnLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnResponseTest.java deleted file mode 100644 index 28c458ba7..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpnLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnBridgeRemoteMsgVpnResponse - */ -public class MsgVpnBridgeRemoteMsgVpnResponseTest { - private final MsgVpnBridgeRemoteMsgVpnResponse model = new MsgVpnBridgeRemoteMsgVpnResponse(); - - /** - * Model tests for MsgVpnBridgeRemoteMsgVpnResponse - */ - @Test - public void testMsgVpnBridgeRemoteMsgVpnResponse() { - // TODO: test MsgVpnBridgeRemoteMsgVpnResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnTest.java deleted file mode 100644 index 0caf67c9e..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnTest.java +++ /dev/null @@ -1,160 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnBridgeRemoteMsgVpn - */ -public class MsgVpnBridgeRemoteMsgVpnTest { - private final MsgVpnBridgeRemoteMsgVpn model = new MsgVpnBridgeRemoteMsgVpn(); - - /** - * Model tests for MsgVpnBridgeRemoteMsgVpn - */ - @Test - public void testMsgVpnBridgeRemoteMsgVpn() { - // TODO: test MsgVpnBridgeRemoteMsgVpn - } - - /** - * Test the property 'bridgeName' - */ - @Test - public void bridgeNameTest() { - // TODO: test bridgeName - } - - /** - * Test the property 'bridgeVirtualRouter' - */ - @Test - public void bridgeVirtualRouterTest() { - // TODO: test bridgeVirtualRouter - } - - /** - * Test the property 'clientUsername' - */ - @Test - public void clientUsernameTest() { - // TODO: test clientUsername - } - - /** - * Test the property 'compressedDataEnabled' - */ - @Test - public void compressedDataEnabledTest() { - // TODO: test compressedDataEnabled - } - - /** - * Test the property 'connectOrder' - */ - @Test - public void connectOrderTest() { - // TODO: test connectOrder - } - - /** - * Test the property 'egressFlowWindowSize' - */ - @Test - public void egressFlowWindowSizeTest() { - // TODO: test egressFlowWindowSize - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'password' - */ - @Test - public void passwordTest() { - // TODO: test password - } - - /** - * Test the property 'queueBinding' - */ - @Test - public void queueBindingTest() { - // TODO: test queueBinding - } - - /** - * Test the property 'remoteMsgVpnInterface' - */ - @Test - public void remoteMsgVpnInterfaceTest() { - // TODO: test remoteMsgVpnInterface - } - - /** - * Test the property 'remoteMsgVpnLocation' - */ - @Test - public void remoteMsgVpnLocationTest() { - // TODO: test remoteMsgVpnLocation - } - - /** - * Test the property 'remoteMsgVpnName' - */ - @Test - public void remoteMsgVpnNameTest() { - // TODO: test remoteMsgVpnName - } - - /** - * Test the property 'tlsEnabled' - */ - @Test - public void tlsEnabledTest() { - // TODO: test tlsEnabled - } - - /** - * Test the property 'unidirectionalClientProfile' - */ - @Test - public void unidirectionalClientProfileTest() { - // TODO: test unidirectionalClientProfile - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnsResponseTest.java deleted file mode 100644 index 36b201426..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteMsgVpnsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteMsgVpnLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnBridgeRemoteMsgVpnsResponse - */ -public class MsgVpnBridgeRemoteMsgVpnsResponseTest { - private final MsgVpnBridgeRemoteMsgVpnsResponse model = new MsgVpnBridgeRemoteMsgVpnsResponse(); - - /** - * Model tests for MsgVpnBridgeRemoteMsgVpnsResponse - */ - @Test - public void testMsgVpnBridgeRemoteMsgVpnsResponse() { - // TODO: test MsgVpnBridgeRemoteMsgVpnsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionLinksTest.java deleted file mode 100644 index 0afa9690d..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnBridgeRemoteSubscriptionLinks - */ -public class MsgVpnBridgeRemoteSubscriptionLinksTest { - private final MsgVpnBridgeRemoteSubscriptionLinks model = new MsgVpnBridgeRemoteSubscriptionLinks(); - - /** - * Model tests for MsgVpnBridgeRemoteSubscriptionLinks - */ - @Test - public void testMsgVpnBridgeRemoteSubscriptionLinks() { - // TODO: test MsgVpnBridgeRemoteSubscriptionLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionResponseTest.java deleted file mode 100644 index b3d2fbb5a..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscriptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnBridgeRemoteSubscriptionResponse - */ -public class MsgVpnBridgeRemoteSubscriptionResponseTest { - private final MsgVpnBridgeRemoteSubscriptionResponse model = new MsgVpnBridgeRemoteSubscriptionResponse(); - - /** - * Model tests for MsgVpnBridgeRemoteSubscriptionResponse - */ - @Test - public void testMsgVpnBridgeRemoteSubscriptionResponse() { - // TODO: test MsgVpnBridgeRemoteSubscriptionResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionTest.java deleted file mode 100644 index ffc1c2527..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionTest.java +++ /dev/null @@ -1,80 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnBridgeRemoteSubscription - */ -public class MsgVpnBridgeRemoteSubscriptionTest { - private final MsgVpnBridgeRemoteSubscription model = new MsgVpnBridgeRemoteSubscription(); - - /** - * Model tests for MsgVpnBridgeRemoteSubscription - */ - @Test - public void testMsgVpnBridgeRemoteSubscription() { - // TODO: test MsgVpnBridgeRemoteSubscription - } - - /** - * Test the property 'bridgeName' - */ - @Test - public void bridgeNameTest() { - // TODO: test bridgeName - } - - /** - * Test the property 'bridgeVirtualRouter' - */ - @Test - public void bridgeVirtualRouterTest() { - // TODO: test bridgeVirtualRouter - } - - /** - * Test the property 'deliverAlwaysEnabled' - */ - @Test - public void deliverAlwaysEnabledTest() { - // TODO: test deliverAlwaysEnabled - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'remoteSubscriptionTopic' - */ - @Test - public void remoteSubscriptionTopicTest() { - // TODO: test remoteSubscriptionTopic - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionsResponseTest.java deleted file mode 100644 index 320ba6365..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeRemoteSubscriptionsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeRemoteSubscriptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnBridgeRemoteSubscriptionsResponse - */ -public class MsgVpnBridgeRemoteSubscriptionsResponseTest { - private final MsgVpnBridgeRemoteSubscriptionsResponse model = new MsgVpnBridgeRemoteSubscriptionsResponse(); - - /** - * Model tests for MsgVpnBridgeRemoteSubscriptionsResponse - */ - @Test - public void testMsgVpnBridgeRemoteSubscriptionsResponse() { - // TODO: test MsgVpnBridgeRemoteSubscriptionsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeResponseTest.java deleted file mode 100644 index 5446cc74f..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnBridgeResponse - */ -public class MsgVpnBridgeResponseTest { - private final MsgVpnBridgeResponse model = new MsgVpnBridgeResponse(); - - /** - * Model tests for MsgVpnBridgeResponse - */ - @Test - public void testMsgVpnBridgeResponse() { - // TODO: test MsgVpnBridgeResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTest.java deleted file mode 100644 index 092828287..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTest.java +++ /dev/null @@ -1,152 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnBridge - */ -public class MsgVpnBridgeTest { - private final MsgVpnBridge model = new MsgVpnBridge(); - - /** - * Model tests for MsgVpnBridge - */ - @Test - public void testMsgVpnBridge() { - // TODO: test MsgVpnBridge - } - - /** - * Test the property 'bridgeName' - */ - @Test - public void bridgeNameTest() { - // TODO: test bridgeName - } - - /** - * Test the property 'bridgeVirtualRouter' - */ - @Test - public void bridgeVirtualRouterTest() { - // TODO: test bridgeVirtualRouter - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'maxTtl' - */ - @Test - public void maxTtlTest() { - // TODO: test maxTtl - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'remoteAuthenticationBasicClientUsername' - */ - @Test - public void remoteAuthenticationBasicClientUsernameTest() { - // TODO: test remoteAuthenticationBasicClientUsername - } - - /** - * Test the property 'remoteAuthenticationBasicPassword' - */ - @Test - public void remoteAuthenticationBasicPasswordTest() { - // TODO: test remoteAuthenticationBasicPassword - } - - /** - * Test the property 'remoteAuthenticationClientCertContent' - */ - @Test - public void remoteAuthenticationClientCertContentTest() { - // TODO: test remoteAuthenticationClientCertContent - } - - /** - * Test the property 'remoteAuthenticationClientCertPassword' - */ - @Test - public void remoteAuthenticationClientCertPasswordTest() { - // TODO: test remoteAuthenticationClientCertPassword - } - - /** - * Test the property 'remoteAuthenticationScheme' - */ - @Test - public void remoteAuthenticationSchemeTest() { - // TODO: test remoteAuthenticationScheme - } - - /** - * Test the property 'remoteConnectionRetryCount' - */ - @Test - public void remoteConnectionRetryCountTest() { - // TODO: test remoteConnectionRetryCount - } - - /** - * Test the property 'remoteConnectionRetryDelay' - */ - @Test - public void remoteConnectionRetryDelayTest() { - // TODO: test remoteConnectionRetryDelay - } - - /** - * Test the property 'remoteDeliverToOnePriority' - */ - @Test - public void remoteDeliverToOnePriorityTest() { - // TODO: test remoteDeliverToOnePriority - } - - /** - * Test the property 'tlsCipherSuiteList' - */ - @Test - public void tlsCipherSuiteListTest() { - // TODO: test tlsCipherSuiteList - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameLinksTest.java deleted file mode 100644 index 020ff1be7..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnBridgeTlsTrustedCommonNameLinks - */ -public class MsgVpnBridgeTlsTrustedCommonNameLinksTest { - private final MsgVpnBridgeTlsTrustedCommonNameLinks model = new MsgVpnBridgeTlsTrustedCommonNameLinks(); - - /** - * Model tests for MsgVpnBridgeTlsTrustedCommonNameLinks - */ - @Test - public void testMsgVpnBridgeTlsTrustedCommonNameLinks() { - // TODO: test MsgVpnBridgeTlsTrustedCommonNameLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameResponseTest.java deleted file mode 100644 index d339f9c15..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnBridgeTlsTrustedCommonNameResponse - */ -public class MsgVpnBridgeTlsTrustedCommonNameResponseTest { - private final MsgVpnBridgeTlsTrustedCommonNameResponse model = new MsgVpnBridgeTlsTrustedCommonNameResponse(); - - /** - * Model tests for MsgVpnBridgeTlsTrustedCommonNameResponse - */ - @Test - public void testMsgVpnBridgeTlsTrustedCommonNameResponse() { - // TODO: test MsgVpnBridgeTlsTrustedCommonNameResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameTest.java deleted file mode 100644 index 813f6c94d..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNameTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnBridgeTlsTrustedCommonName - */ -public class MsgVpnBridgeTlsTrustedCommonNameTest { - private final MsgVpnBridgeTlsTrustedCommonName model = new MsgVpnBridgeTlsTrustedCommonName(); - - /** - * Model tests for MsgVpnBridgeTlsTrustedCommonName - */ - @Test - public void testMsgVpnBridgeTlsTrustedCommonName() { - // TODO: test MsgVpnBridgeTlsTrustedCommonName - } - - /** - * Test the property 'bridgeName' - */ - @Test - public void bridgeNameTest() { - // TODO: test bridgeName - } - - /** - * Test the property 'bridgeVirtualRouter' - */ - @Test - public void bridgeVirtualRouterTest() { - // TODO: test bridgeVirtualRouter - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'tlsTrustedCommonName' - */ - @Test - public void tlsTrustedCommonNameTest() { - // TODO: test tlsTrustedCommonName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNamesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNamesResponseTest.java deleted file mode 100644 index ebd28f3ed..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgeTlsTrustedCommonNamesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnBridgeTlsTrustedCommonNamesResponse - */ -public class MsgVpnBridgeTlsTrustedCommonNamesResponseTest { - private final MsgVpnBridgeTlsTrustedCommonNamesResponse model = new MsgVpnBridgeTlsTrustedCommonNamesResponse(); - - /** - * Model tests for MsgVpnBridgeTlsTrustedCommonNamesResponse - */ - @Test - public void testMsgVpnBridgeTlsTrustedCommonNamesResponse() { - // TODO: test MsgVpnBridgeTlsTrustedCommonNamesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgesResponseTest.java deleted file mode 100644 index 5dac45a7c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnBridgesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnBridgeLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnBridgesResponse - */ -public class MsgVpnBridgesResponseTest { - private final MsgVpnBridgesResponse model = new MsgVpnBridgesResponse(); - - /** - * Model tests for MsgVpnBridgesResponse - */ - @Test - public void testMsgVpnBridgesResponse() { - // TODO: test MsgVpnBridgesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterLinksTest.java deleted file mode 100644 index 005636e3f..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnCertMatchingRuleAttributeFilterLinks - */ -public class MsgVpnCertMatchingRuleAttributeFilterLinksTest { - private final MsgVpnCertMatchingRuleAttributeFilterLinks model = new MsgVpnCertMatchingRuleAttributeFilterLinks(); - - /** - * Model tests for MsgVpnCertMatchingRuleAttributeFilterLinks - */ - @Test - public void testMsgVpnCertMatchingRuleAttributeFilterLinks() { - // TODO: test MsgVpnCertMatchingRuleAttributeFilterLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterResponseTest.java deleted file mode 100644 index 8e0c978f0..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnCertMatchingRuleAttributeFilterResponse - */ -public class MsgVpnCertMatchingRuleAttributeFilterResponseTest { - private final MsgVpnCertMatchingRuleAttributeFilterResponse model = new MsgVpnCertMatchingRuleAttributeFilterResponse(); - - /** - * Model tests for MsgVpnCertMatchingRuleAttributeFilterResponse - */ - @Test - public void testMsgVpnCertMatchingRuleAttributeFilterResponse() { - // TODO: test MsgVpnCertMatchingRuleAttributeFilterResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterTest.java deleted file mode 100644 index 77cacf80c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFilterTest.java +++ /dev/null @@ -1,80 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnCertMatchingRuleAttributeFilter - */ -public class MsgVpnCertMatchingRuleAttributeFilterTest { - private final MsgVpnCertMatchingRuleAttributeFilter model = new MsgVpnCertMatchingRuleAttributeFilter(); - - /** - * Model tests for MsgVpnCertMatchingRuleAttributeFilter - */ - @Test - public void testMsgVpnCertMatchingRuleAttributeFilter() { - // TODO: test MsgVpnCertMatchingRuleAttributeFilter - } - - /** - * Test the property 'attributeName' - */ - @Test - public void attributeNameTest() { - // TODO: test attributeName - } - - /** - * Test the property 'attributeValue' - */ - @Test - public void attributeValueTest() { - // TODO: test attributeValue - } - - /** - * Test the property 'filterName' - */ - @Test - public void filterNameTest() { - // TODO: test filterName - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'ruleName' - */ - @Test - public void ruleNameTest() { - // TODO: test ruleName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFiltersResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFiltersResponseTest.java deleted file mode 100644 index 9515083ed..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleAttributeFiltersResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleAttributeFilterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnCertMatchingRuleAttributeFiltersResponse - */ -public class MsgVpnCertMatchingRuleAttributeFiltersResponseTest { - private final MsgVpnCertMatchingRuleAttributeFiltersResponse model = new MsgVpnCertMatchingRuleAttributeFiltersResponse(); - - /** - * Model tests for MsgVpnCertMatchingRuleAttributeFiltersResponse - */ - @Test - public void testMsgVpnCertMatchingRuleAttributeFiltersResponse() { - // TODO: test MsgVpnCertMatchingRuleAttributeFiltersResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionLinksTest.java deleted file mode 100644 index b505c7629..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnCertMatchingRuleConditionLinks - */ -public class MsgVpnCertMatchingRuleConditionLinksTest { - private final MsgVpnCertMatchingRuleConditionLinks model = new MsgVpnCertMatchingRuleConditionLinks(); - - /** - * Model tests for MsgVpnCertMatchingRuleConditionLinks - */ - @Test - public void testMsgVpnCertMatchingRuleConditionLinks() { - // TODO: test MsgVpnCertMatchingRuleConditionLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionResponseTest.java deleted file mode 100644 index 6f43383cc..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleConditionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnCertMatchingRuleConditionResponse - */ -public class MsgVpnCertMatchingRuleConditionResponseTest { - private final MsgVpnCertMatchingRuleConditionResponse model = new MsgVpnCertMatchingRuleConditionResponse(); - - /** - * Model tests for MsgVpnCertMatchingRuleConditionResponse - */ - @Test - public void testMsgVpnCertMatchingRuleConditionResponse() { - // TODO: test MsgVpnCertMatchingRuleConditionResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionTest.java deleted file mode 100644 index e8015b8ac..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionTest.java +++ /dev/null @@ -1,80 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnCertMatchingRuleCondition - */ -public class MsgVpnCertMatchingRuleConditionTest { - private final MsgVpnCertMatchingRuleCondition model = new MsgVpnCertMatchingRuleCondition(); - - /** - * Model tests for MsgVpnCertMatchingRuleCondition - */ - @Test - public void testMsgVpnCertMatchingRuleCondition() { - // TODO: test MsgVpnCertMatchingRuleCondition - } - - /** - * Test the property 'attribute' - */ - @Test - public void attributeTest() { - // TODO: test attribute - } - - /** - * Test the property 'expression' - */ - @Test - public void expressionTest() { - // TODO: test expression - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'ruleName' - */ - @Test - public void ruleNameTest() { - // TODO: test ruleName - } - - /** - * Test the property 'source' - */ - @Test - public void sourceTest() { - // TODO: test source - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionsResponseTest.java deleted file mode 100644 index 3606d0843..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleConditionsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleCondition; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleConditionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnCertMatchingRuleConditionsResponse - */ -public class MsgVpnCertMatchingRuleConditionsResponseTest { - private final MsgVpnCertMatchingRuleConditionsResponse model = new MsgVpnCertMatchingRuleConditionsResponse(); - - /** - * Model tests for MsgVpnCertMatchingRuleConditionsResponse - */ - @Test - public void testMsgVpnCertMatchingRuleConditionsResponse() { - // TODO: test MsgVpnCertMatchingRuleConditionsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleLinksTest.java deleted file mode 100644 index 980215829..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleLinksTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnCertMatchingRuleLinks - */ -public class MsgVpnCertMatchingRuleLinksTest { - private final MsgVpnCertMatchingRuleLinks model = new MsgVpnCertMatchingRuleLinks(); - - /** - * Model tests for MsgVpnCertMatchingRuleLinks - */ - @Test - public void testMsgVpnCertMatchingRuleLinks() { - // TODO: test MsgVpnCertMatchingRuleLinks - } - - /** - * Test the property 'attributeFiltersUri' - */ - @Test - public void attributeFiltersUriTest() { - // TODO: test attributeFiltersUri - } - - /** - * Test the property 'conditionsUri' - */ - @Test - public void conditionsUriTest() { - // TODO: test conditionsUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleResponseTest.java deleted file mode 100644 index 8041242e2..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnCertMatchingRuleResponse - */ -public class MsgVpnCertMatchingRuleResponseTest { - private final MsgVpnCertMatchingRuleResponse model = new MsgVpnCertMatchingRuleResponse(); - - /** - * Model tests for MsgVpnCertMatchingRuleResponse - */ - @Test - public void testMsgVpnCertMatchingRuleResponse() { - // TODO: test MsgVpnCertMatchingRuleResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleTest.java deleted file mode 100644 index 4b18ef941..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRuleTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnCertMatchingRule - */ -public class MsgVpnCertMatchingRuleTest { - private final MsgVpnCertMatchingRule model = new MsgVpnCertMatchingRule(); - - /** - * Model tests for MsgVpnCertMatchingRule - */ - @Test - public void testMsgVpnCertMatchingRule() { - // TODO: test MsgVpnCertMatchingRule - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'ruleName' - */ - @Test - public void ruleNameTest() { - // TODO: test ruleName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRulesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRulesResponseTest.java deleted file mode 100644 index 7b76ef904..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnCertMatchingRulesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRule; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnCertMatchingRuleLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnCertMatchingRulesResponse - */ -public class MsgVpnCertMatchingRulesResponseTest { - private final MsgVpnCertMatchingRulesResponse model = new MsgVpnCertMatchingRulesResponse(); - - /** - * Model tests for MsgVpnCertMatchingRulesResponse - */ - @Test - public void testMsgVpnCertMatchingRulesResponse() { - // TODO: test MsgVpnCertMatchingRulesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileLinksTest.java deleted file mode 100644 index 45ccdf330..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnClientProfileLinks - */ -public class MsgVpnClientProfileLinksTest { - private final MsgVpnClientProfileLinks model = new MsgVpnClientProfileLinks(); - - /** - * Model tests for MsgVpnClientProfileLinks - */ - @Test - public void testMsgVpnClientProfileLinks() { - // TODO: test MsgVpnClientProfileLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileResponseTest.java deleted file mode 100644 index 4509dbfbb..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfileLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnClientProfileResponse - */ -public class MsgVpnClientProfileResponseTest { - private final MsgVpnClientProfileResponse model = new MsgVpnClientProfileResponse(); - - /** - * Model tests for MsgVpnClientProfileResponse - */ - @Test - public void testMsgVpnClientProfileResponse() { - // TODO: test MsgVpnClientProfileResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileTest.java deleted file mode 100644 index 05952497b..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfileTest.java +++ /dev/null @@ -1,530 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThresholdByPercent; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnClientProfile - */ -public class MsgVpnClientProfileTest { - private final MsgVpnClientProfile model = new MsgVpnClientProfile(); - - /** - * Model tests for MsgVpnClientProfile - */ - @Test - public void testMsgVpnClientProfile() { - // TODO: test MsgVpnClientProfile - } - - /** - * Test the property 'allowBridgeConnectionsEnabled' - */ - @Test - public void allowBridgeConnectionsEnabledTest() { - // TODO: test allowBridgeConnectionsEnabled - } - - /** - * Test the property 'allowCutThroughForwardingEnabled' - */ - @Test - public void allowCutThroughForwardingEnabledTest() { - // TODO: test allowCutThroughForwardingEnabled - } - - /** - * Test the property 'allowGuaranteedEndpointCreateDurability' - */ - @Test - public void allowGuaranteedEndpointCreateDurabilityTest() { - // TODO: test allowGuaranteedEndpointCreateDurability - } - - /** - * Test the property 'allowGuaranteedEndpointCreateEnabled' - */ - @Test - public void allowGuaranteedEndpointCreateEnabledTest() { - // TODO: test allowGuaranteedEndpointCreateEnabled - } - - /** - * Test the property 'allowGuaranteedMsgReceiveEnabled' - */ - @Test - public void allowGuaranteedMsgReceiveEnabledTest() { - // TODO: test allowGuaranteedMsgReceiveEnabled - } - - /** - * Test the property 'allowGuaranteedMsgSendEnabled' - */ - @Test - public void allowGuaranteedMsgSendEnabledTest() { - // TODO: test allowGuaranteedMsgSendEnabled - } - - /** - * Test the property 'allowSharedSubscriptionsEnabled' - */ - @Test - public void allowSharedSubscriptionsEnabledTest() { - // TODO: test allowSharedSubscriptionsEnabled - } - - /** - * Test the property 'allowTransactedSessionsEnabled' - */ - @Test - public void allowTransactedSessionsEnabledTest() { - // TODO: test allowTransactedSessionsEnabled - } - - /** - * Test the property 'apiQueueManagementCopyFromOnCreateName' - */ - @Test - public void apiQueueManagementCopyFromOnCreateNameTest() { - // TODO: test apiQueueManagementCopyFromOnCreateName - } - - /** - * Test the property 'apiQueueManagementCopyFromOnCreateTemplateName' - */ - @Test - public void apiQueueManagementCopyFromOnCreateTemplateNameTest() { - // TODO: test apiQueueManagementCopyFromOnCreateTemplateName - } - - /** - * Test the property 'apiTopicEndpointManagementCopyFromOnCreateName' - */ - @Test - public void apiTopicEndpointManagementCopyFromOnCreateNameTest() { - // TODO: test apiTopicEndpointManagementCopyFromOnCreateName - } - - /** - * Test the property 'apiTopicEndpointManagementCopyFromOnCreateTemplateName' - */ - @Test - public void apiTopicEndpointManagementCopyFromOnCreateTemplateNameTest() { - // TODO: test apiTopicEndpointManagementCopyFromOnCreateTemplateName - } - - /** - * Test the property 'clientProfileName' - */ - @Test - public void clientProfileNameTest() { - // TODO: test clientProfileName - } - - /** - * Test the property 'compressionEnabled' - */ - @Test - public void compressionEnabledTest() { - // TODO: test compressionEnabled - } - - /** - * Test the property 'elidingDelay' - */ - @Test - public void elidingDelayTest() { - // TODO: test elidingDelay - } - - /** - * Test the property 'elidingEnabled' - */ - @Test - public void elidingEnabledTest() { - // TODO: test elidingEnabled - } - - /** - * Test the property 'elidingMaxTopicCount' - */ - @Test - public void elidingMaxTopicCountTest() { - // TODO: test elidingMaxTopicCount - } - - /** - * Test the property 'eventClientProvisionedEndpointSpoolUsageThreshold' - */ - @Test - public void eventClientProvisionedEndpointSpoolUsageThresholdTest() { - // TODO: test eventClientProvisionedEndpointSpoolUsageThreshold - } - - /** - * Test the property 'eventConnectionCountPerClientUsernameThreshold' - */ - @Test - public void eventConnectionCountPerClientUsernameThresholdTest() { - // TODO: test eventConnectionCountPerClientUsernameThreshold - } - - /** - * Test the property 'eventEgressFlowCountThreshold' - */ - @Test - public void eventEgressFlowCountThresholdTest() { - // TODO: test eventEgressFlowCountThreshold - } - - /** - * Test the property 'eventEndpointCountPerClientUsernameThreshold' - */ - @Test - public void eventEndpointCountPerClientUsernameThresholdTest() { - // TODO: test eventEndpointCountPerClientUsernameThreshold - } - - /** - * Test the property 'eventIngressFlowCountThreshold' - */ - @Test - public void eventIngressFlowCountThresholdTest() { - // TODO: test eventIngressFlowCountThreshold - } - - /** - * Test the property 'eventServiceSmfConnectionCountPerClientUsernameThreshold' - */ - @Test - public void eventServiceSmfConnectionCountPerClientUsernameThresholdTest() { - // TODO: test eventServiceSmfConnectionCountPerClientUsernameThreshold - } - - /** - * Test the property 'eventServiceWebConnectionCountPerClientUsernameThreshold' - */ - @Test - public void eventServiceWebConnectionCountPerClientUsernameThresholdTest() { - // TODO: test eventServiceWebConnectionCountPerClientUsernameThreshold - } - - /** - * Test the property 'eventSubscriptionCountThreshold' - */ - @Test - public void eventSubscriptionCountThresholdTest() { - // TODO: test eventSubscriptionCountThreshold - } - - /** - * Test the property 'eventTransactedSessionCountThreshold' - */ - @Test - public void eventTransactedSessionCountThresholdTest() { - // TODO: test eventTransactedSessionCountThreshold - } - - /** - * Test the property 'eventTransactionCountThreshold' - */ - @Test - public void eventTransactionCountThresholdTest() { - // TODO: test eventTransactionCountThreshold - } - - /** - * Test the property 'maxConnectionCountPerClientUsername' - */ - @Test - public void maxConnectionCountPerClientUsernameTest() { - // TODO: test maxConnectionCountPerClientUsername - } - - /** - * Test the property 'maxEgressFlowCount' - */ - @Test - public void maxEgressFlowCountTest() { - // TODO: test maxEgressFlowCount - } - - /** - * Test the property 'maxEndpointCountPerClientUsername' - */ - @Test - public void maxEndpointCountPerClientUsernameTest() { - // TODO: test maxEndpointCountPerClientUsername - } - - /** - * Test the property 'maxIngressFlowCount' - */ - @Test - public void maxIngressFlowCountTest() { - // TODO: test maxIngressFlowCount - } - - /** - * Test the property 'maxMsgsPerTransaction' - */ - @Test - public void maxMsgsPerTransactionTest() { - // TODO: test maxMsgsPerTransaction - } - - /** - * Test the property 'maxSubscriptionCount' - */ - @Test - public void maxSubscriptionCountTest() { - // TODO: test maxSubscriptionCount - } - - /** - * Test the property 'maxTransactedSessionCount' - */ - @Test - public void maxTransactedSessionCountTest() { - // TODO: test maxTransactedSessionCount - } - - /** - * Test the property 'maxTransactionCount' - */ - @Test - public void maxTransactionCountTest() { - // TODO: test maxTransactionCount - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'queueControl1MaxDepth' - */ - @Test - public void queueControl1MaxDepthTest() { - // TODO: test queueControl1MaxDepth - } - - /** - * Test the property 'queueControl1MinMsgBurst' - */ - @Test - public void queueControl1MinMsgBurstTest() { - // TODO: test queueControl1MinMsgBurst - } - - /** - * Test the property 'queueDirect1MaxDepth' - */ - @Test - public void queueDirect1MaxDepthTest() { - // TODO: test queueDirect1MaxDepth - } - - /** - * Test the property 'queueDirect1MinMsgBurst' - */ - @Test - public void queueDirect1MinMsgBurstTest() { - // TODO: test queueDirect1MinMsgBurst - } - - /** - * Test the property 'queueDirect2MaxDepth' - */ - @Test - public void queueDirect2MaxDepthTest() { - // TODO: test queueDirect2MaxDepth - } - - /** - * Test the property 'queueDirect2MinMsgBurst' - */ - @Test - public void queueDirect2MinMsgBurstTest() { - // TODO: test queueDirect2MinMsgBurst - } - - /** - * Test the property 'queueDirect3MaxDepth' - */ - @Test - public void queueDirect3MaxDepthTest() { - // TODO: test queueDirect3MaxDepth - } - - /** - * Test the property 'queueDirect3MinMsgBurst' - */ - @Test - public void queueDirect3MinMsgBurstTest() { - // TODO: test queueDirect3MinMsgBurst - } - - /** - * Test the property 'queueGuaranteed1MaxDepth' - */ - @Test - public void queueGuaranteed1MaxDepthTest() { - // TODO: test queueGuaranteed1MaxDepth - } - - /** - * Test the property 'queueGuaranteed1MinMsgBurst' - */ - @Test - public void queueGuaranteed1MinMsgBurstTest() { - // TODO: test queueGuaranteed1MinMsgBurst - } - - /** - * Test the property 'rejectMsgToSenderOnNoSubscriptionMatchEnabled' - */ - @Test - public void rejectMsgToSenderOnNoSubscriptionMatchEnabledTest() { - // TODO: test rejectMsgToSenderOnNoSubscriptionMatchEnabled - } - - /** - * Test the property 'replicationAllowClientConnectWhenStandbyEnabled' - */ - @Test - public void replicationAllowClientConnectWhenStandbyEnabledTest() { - // TODO: test replicationAllowClientConnectWhenStandbyEnabled - } - - /** - * Test the property 'serviceMinKeepaliveTimeout' - */ - @Test - public void serviceMinKeepaliveTimeoutTest() { - // TODO: test serviceMinKeepaliveTimeout - } - - /** - * Test the property 'serviceSmfMaxConnectionCountPerClientUsername' - */ - @Test - public void serviceSmfMaxConnectionCountPerClientUsernameTest() { - // TODO: test serviceSmfMaxConnectionCountPerClientUsername - } - - /** - * Test the property 'serviceSmfMinKeepaliveEnabled' - */ - @Test - public void serviceSmfMinKeepaliveEnabledTest() { - // TODO: test serviceSmfMinKeepaliveEnabled - } - - /** - * Test the property 'serviceWebInactiveTimeout' - */ - @Test - public void serviceWebInactiveTimeoutTest() { - // TODO: test serviceWebInactiveTimeout - } - - /** - * Test the property 'serviceWebMaxConnectionCountPerClientUsername' - */ - @Test - public void serviceWebMaxConnectionCountPerClientUsernameTest() { - // TODO: test serviceWebMaxConnectionCountPerClientUsername - } - - /** - * Test the property 'serviceWebMaxPayload' - */ - @Test - public void serviceWebMaxPayloadTest() { - // TODO: test serviceWebMaxPayload - } - - /** - * Test the property 'tcpCongestionWindowSize' - */ - @Test - public void tcpCongestionWindowSizeTest() { - // TODO: test tcpCongestionWindowSize - } - - /** - * Test the property 'tcpKeepaliveCount' - */ - @Test - public void tcpKeepaliveCountTest() { - // TODO: test tcpKeepaliveCount - } - - /** - * Test the property 'tcpKeepaliveIdleTime' - */ - @Test - public void tcpKeepaliveIdleTimeTest() { - // TODO: test tcpKeepaliveIdleTime - } - - /** - * Test the property 'tcpKeepaliveInterval' - */ - @Test - public void tcpKeepaliveIntervalTest() { - // TODO: test tcpKeepaliveInterval - } - - /** - * Test the property 'tcpMaxSegmentSize' - */ - @Test - public void tcpMaxSegmentSizeTest() { - // TODO: test tcpMaxSegmentSize - } - - /** - * Test the property 'tcpMaxWindowSize' - */ - @Test - public void tcpMaxWindowSizeTest() { - // TODO: test tcpMaxWindowSize - } - - /** - * Test the property 'tlsAllowDowngradeToPlainTextEnabled' - */ - @Test - public void tlsAllowDowngradeToPlainTextEnabledTest() { - // TODO: test tlsAllowDowngradeToPlainTextEnabled - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfilesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfilesResponseTest.java deleted file mode 100644 index 050497c93..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientProfilesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientProfileLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnClientProfilesResponse - */ -public class MsgVpnClientProfilesResponseTest { - private final MsgVpnClientProfilesResponse model = new MsgVpnClientProfilesResponse(); - - /** - * Model tests for MsgVpnClientProfilesResponse - */ - @Test - public void testMsgVpnClientProfilesResponse() { - // TODO: test MsgVpnClientProfilesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeLinksTest.java deleted file mode 100644 index 3c77a8946..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnClientUsernameAttributeLinks - */ -public class MsgVpnClientUsernameAttributeLinksTest { - private final MsgVpnClientUsernameAttributeLinks model = new MsgVpnClientUsernameAttributeLinks(); - - /** - * Model tests for MsgVpnClientUsernameAttributeLinks - */ - @Test - public void testMsgVpnClientUsernameAttributeLinks() { - // TODO: test MsgVpnClientUsernameAttributeLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeResponseTest.java deleted file mode 100644 index b8eeeb7b0..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttributeLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnClientUsernameAttributeResponse - */ -public class MsgVpnClientUsernameAttributeResponseTest { - private final MsgVpnClientUsernameAttributeResponse model = new MsgVpnClientUsernameAttributeResponse(); - - /** - * Model tests for MsgVpnClientUsernameAttributeResponse - */ - @Test - public void testMsgVpnClientUsernameAttributeResponse() { - // TODO: test MsgVpnClientUsernameAttributeResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeTest.java deleted file mode 100644 index 654614289..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributeTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnClientUsernameAttribute - */ -public class MsgVpnClientUsernameAttributeTest { - private final MsgVpnClientUsernameAttribute model = new MsgVpnClientUsernameAttribute(); - - /** - * Model tests for MsgVpnClientUsernameAttribute - */ - @Test - public void testMsgVpnClientUsernameAttribute() { - // TODO: test MsgVpnClientUsernameAttribute - } - - /** - * Test the property 'attributeName' - */ - @Test - public void attributeNameTest() { - // TODO: test attributeName - } - - /** - * Test the property 'attributeValue' - */ - @Test - public void attributeValueTest() { - // TODO: test attributeValue - } - - /** - * Test the property 'clientUsername' - */ - @Test - public void clientUsernameTest() { - // TODO: test clientUsername - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributesResponseTest.java deleted file mode 100644 index 166f8ef3d..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameAttributesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttribute; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameAttributeLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnClientUsernameAttributesResponse - */ -public class MsgVpnClientUsernameAttributesResponseTest { - private final MsgVpnClientUsernameAttributesResponse model = new MsgVpnClientUsernameAttributesResponse(); - - /** - * Model tests for MsgVpnClientUsernameAttributesResponse - */ - @Test - public void testMsgVpnClientUsernameAttributesResponse() { - // TODO: test MsgVpnClientUsernameAttributesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameLinksTest.java deleted file mode 100644 index 55ed7e66e..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameLinksTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnClientUsernameLinks - */ -public class MsgVpnClientUsernameLinksTest { - private final MsgVpnClientUsernameLinks model = new MsgVpnClientUsernameLinks(); - - /** - * Model tests for MsgVpnClientUsernameLinks - */ - @Test - public void testMsgVpnClientUsernameLinks() { - // TODO: test MsgVpnClientUsernameLinks - } - - /** - * Test the property 'attributesUri' - */ - @Test - public void attributesUriTest() { - // TODO: test attributesUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameResponseTest.java deleted file mode 100644 index f37451abd..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsername; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnClientUsernameResponse - */ -public class MsgVpnClientUsernameResponseTest { - private final MsgVpnClientUsernameResponse model = new MsgVpnClientUsernameResponse(); - - /** - * Model tests for MsgVpnClientUsernameResponse - */ - @Test - public void testMsgVpnClientUsernameResponse() { - // TODO: test MsgVpnClientUsernameResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameTest.java deleted file mode 100644 index e9a39288c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernameTest.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnClientUsername - */ -public class MsgVpnClientUsernameTest { - private final MsgVpnClientUsername model = new MsgVpnClientUsername(); - - /** - * Model tests for MsgVpnClientUsername - */ - @Test - public void testMsgVpnClientUsername() { - // TODO: test MsgVpnClientUsername - } - - /** - * Test the property 'aclProfileName' - */ - @Test - public void aclProfileNameTest() { - // TODO: test aclProfileName - } - - /** - * Test the property 'clientProfileName' - */ - @Test - public void clientProfileNameTest() { - // TODO: test clientProfileName - } - - /** - * Test the property 'clientUsername' - */ - @Test - public void clientUsernameTest() { - // TODO: test clientUsername - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'guaranteedEndpointPermissionOverrideEnabled' - */ - @Test - public void guaranteedEndpointPermissionOverrideEnabledTest() { - // TODO: test guaranteedEndpointPermissionOverrideEnabled - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'password' - */ - @Test - public void passwordTest() { - // TODO: test password - } - - /** - * Test the property 'subscriptionManagerEnabled' - */ - @Test - public void subscriptionManagerEnabledTest() { - // TODO: test subscriptionManagerEnabled - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernamesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernamesResponseTest.java deleted file mode 100644 index 99c34a0d5..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnClientUsernamesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsername; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnClientUsernameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnClientUsernamesResponse - */ -public class MsgVpnClientUsernamesResponseTest { - private final MsgVpnClientUsernamesResponse model = new MsgVpnClientUsernamesResponse(); - - /** - * Model tests for MsgVpnClientUsernamesResponse - */ - @Test - public void testMsgVpnClientUsernamesResponse() { - // TODO: test MsgVpnClientUsernamesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinksTest.java deleted file mode 100644 index c8d4ac332..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinksTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks - */ -public class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinksTest { - private final MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks model = new MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks(); - - /** - * Model tests for MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks - */ - @Test - public void testMsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks() { - // TODO: test MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks - } - - /** - * Test the property 'topicPrefixesUri' - */ - @Test - public void topicPrefixesUriTest() { - // TODO: test topicPrefixesUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponseTest.java deleted file mode 100644 index 4ccc894d7..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse - */ -public class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponseTest { - private final MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse model = new MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse(); - - /** - * Model tests for MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse - */ - @Test - public void testMsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse() { - // TODO: test MsgVpnDistributedCacheClusterGlobalCachingHomeClusterResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTest.java deleted file mode 100644 index 3346e347f..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterGlobalCachingHomeCluster - */ -public class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTest { - private final MsgVpnDistributedCacheClusterGlobalCachingHomeCluster model = new MsgVpnDistributedCacheClusterGlobalCachingHomeCluster(); - - /** - * Model tests for MsgVpnDistributedCacheClusterGlobalCachingHomeCluster - */ - @Test - public void testMsgVpnDistributedCacheClusterGlobalCachingHomeCluster() { - // TODO: test MsgVpnDistributedCacheClusterGlobalCachingHomeCluster - } - - /** - * Test the property 'cacheName' - */ - @Test - public void cacheNameTest() { - // TODO: test cacheName - } - - /** - * Test the property 'clusterName' - */ - @Test - public void clusterNameTest() { - // TODO: test clusterName - } - - /** - * Test the property 'homeClusterName' - */ - @Test - public void homeClusterNameTest() { - // TODO: test homeClusterName - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinksTest.java deleted file mode 100644 index ccd211b2f..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks - */ -public class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinksTest { - private final MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks model = new MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks(); - - /** - * Model tests for MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks - */ - @Test - public void testMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks() { - // TODO: test MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponseTest.java deleted file mode 100644 index 65becb3fd..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse - */ -public class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponseTest { - private final MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse model = new MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse(); - - /** - * Model tests for MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse - */ - @Test - public void testMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse() { - // TODO: test MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixTest.java deleted file mode 100644 index 4038a2fa2..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixTest.java +++ /dev/null @@ -1,80 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - */ -public class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixTest { - private final MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix model = new MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix(); - - /** - * Model tests for MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - */ - @Test - public void testMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix() { - // TODO: test MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix - } - - /** - * Test the property 'cacheName' - */ - @Test - public void cacheNameTest() { - // TODO: test cacheName - } - - /** - * Test the property 'clusterName' - */ - @Test - public void clusterNameTest() { - // TODO: test clusterName - } - - /** - * Test the property 'homeClusterName' - */ - @Test - public void homeClusterNameTest() { - // TODO: test homeClusterName - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'topicPrefix' - */ - @Test - public void topicPrefixTest() { - // TODO: test topicPrefix - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponseTest.java deleted file mode 100644 index 934887eb1..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse - */ -public class MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponseTest { - private final MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse model = new MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse(); - - /** - * Model tests for MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse - */ - @Test - public void testMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse() { - // TODO: test MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponseTest.java deleted file mode 100644 index 507b82180..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterGlobalCachingHomeClusterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse - */ -public class MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponseTest { - private final MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse model = new MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse(); - - /** - * Model tests for MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse - */ - @Test - public void testMsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse() { - // TODO: test MsgVpnDistributedCacheClusterGlobalCachingHomeClustersResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceLinksTest.java deleted file mode 100644 index 9536612e0..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterInstanceLinks - */ -public class MsgVpnDistributedCacheClusterInstanceLinksTest { - private final MsgVpnDistributedCacheClusterInstanceLinks model = new MsgVpnDistributedCacheClusterInstanceLinks(); - - /** - * Model tests for MsgVpnDistributedCacheClusterInstanceLinks - */ - @Test - public void testMsgVpnDistributedCacheClusterInstanceLinks() { - // TODO: test MsgVpnDistributedCacheClusterInstanceLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceResponseTest.java deleted file mode 100644 index 7a80c1c40..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstance; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstanceLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterInstanceResponse - */ -public class MsgVpnDistributedCacheClusterInstanceResponseTest { - private final MsgVpnDistributedCacheClusterInstanceResponse model = new MsgVpnDistributedCacheClusterInstanceResponse(); - - /** - * Model tests for MsgVpnDistributedCacheClusterInstanceResponse - */ - @Test - public void testMsgVpnDistributedCacheClusterInstanceResponse() { - // TODO: test MsgVpnDistributedCacheClusterInstanceResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceTest.java deleted file mode 100644 index c4df6d4fc..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstanceTest.java +++ /dev/null @@ -1,96 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterInstance - */ -public class MsgVpnDistributedCacheClusterInstanceTest { - private final MsgVpnDistributedCacheClusterInstance model = new MsgVpnDistributedCacheClusterInstance(); - - /** - * Model tests for MsgVpnDistributedCacheClusterInstance - */ - @Test - public void testMsgVpnDistributedCacheClusterInstance() { - // TODO: test MsgVpnDistributedCacheClusterInstance - } - - /** - * Test the property 'autoStartEnabled' - */ - @Test - public void autoStartEnabledTest() { - // TODO: test autoStartEnabled - } - - /** - * Test the property 'cacheName' - */ - @Test - public void cacheNameTest() { - // TODO: test cacheName - } - - /** - * Test the property 'clusterName' - */ - @Test - public void clusterNameTest() { - // TODO: test clusterName - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'instanceName' - */ - @Test - public void instanceNameTest() { - // TODO: test instanceName - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'stopOnLostMsgEnabled' - */ - @Test - public void stopOnLostMsgEnabledTest() { - // TODO: test stopOnLostMsgEnabled - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstancesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstancesResponseTest.java deleted file mode 100644 index 1cea4481b..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterInstancesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstance; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterInstanceLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterInstancesResponse - */ -public class MsgVpnDistributedCacheClusterInstancesResponseTest { - private final MsgVpnDistributedCacheClusterInstancesResponse model = new MsgVpnDistributedCacheClusterInstancesResponse(); - - /** - * Model tests for MsgVpnDistributedCacheClusterInstancesResponse - */ - @Test - public void testMsgVpnDistributedCacheClusterInstancesResponse() { - // TODO: test MsgVpnDistributedCacheClusterInstancesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterLinksTest.java deleted file mode 100644 index f6301b62c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterLinksTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterLinks - */ -public class MsgVpnDistributedCacheClusterLinksTest { - private final MsgVpnDistributedCacheClusterLinks model = new MsgVpnDistributedCacheClusterLinks(); - - /** - * Model tests for MsgVpnDistributedCacheClusterLinks - */ - @Test - public void testMsgVpnDistributedCacheClusterLinks() { - // TODO: test MsgVpnDistributedCacheClusterLinks - } - - /** - * Test the property 'globalCachingHomeClustersUri' - */ - @Test - public void globalCachingHomeClustersUriTest() { - // TODO: test globalCachingHomeClustersUri - } - - /** - * Test the property 'instancesUri' - */ - @Test - public void instancesUriTest() { - // TODO: test instancesUri - } - - /** - * Test the property 'topicsUri' - */ - @Test - public void topicsUriTest() { - // TODO: test topicsUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterResponseTest.java deleted file mode 100644 index 6390ae828..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterResponse - */ -public class MsgVpnDistributedCacheClusterResponseTest { - private final MsgVpnDistributedCacheClusterResponse model = new MsgVpnDistributedCacheClusterResponse(); - - /** - * Model tests for MsgVpnDistributedCacheClusterResponse - */ - @Test - public void testMsgVpnDistributedCacheClusterResponse() { - // TODO: test MsgVpnDistributedCacheClusterResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTest.java deleted file mode 100644 index 3d7624033..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTest.java +++ /dev/null @@ -1,210 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThresholdByPercent; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThresholdByValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheCluster - */ -public class MsgVpnDistributedCacheClusterTest { - private final MsgVpnDistributedCacheCluster model = new MsgVpnDistributedCacheCluster(); - - /** - * Model tests for MsgVpnDistributedCacheCluster - */ - @Test - public void testMsgVpnDistributedCacheCluster() { - // TODO: test MsgVpnDistributedCacheCluster - } - - /** - * Test the property 'cacheName' - */ - @Test - public void cacheNameTest() { - // TODO: test cacheName - } - - /** - * Test the property 'clusterName' - */ - @Test - public void clusterNameTest() { - // TODO: test clusterName - } - - /** - * Test the property 'deliverToOneOverrideEnabled' - */ - @Test - public void deliverToOneOverrideEnabledTest() { - // TODO: test deliverToOneOverrideEnabled - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'eventDataByteRateThreshold' - */ - @Test - public void eventDataByteRateThresholdTest() { - // TODO: test eventDataByteRateThreshold - } - - /** - * Test the property 'eventDataMsgRateThreshold' - */ - @Test - public void eventDataMsgRateThresholdTest() { - // TODO: test eventDataMsgRateThreshold - } - - /** - * Test the property 'eventMaxMemoryThreshold' - */ - @Test - public void eventMaxMemoryThresholdTest() { - // TODO: test eventMaxMemoryThreshold - } - - /** - * Test the property 'eventMaxTopicsThreshold' - */ - @Test - public void eventMaxTopicsThresholdTest() { - // TODO: test eventMaxTopicsThreshold - } - - /** - * Test the property 'eventRequestQueueDepthThreshold' - */ - @Test - public void eventRequestQueueDepthThresholdTest() { - // TODO: test eventRequestQueueDepthThreshold - } - - /** - * Test the property 'eventRequestRateThreshold' - */ - @Test - public void eventRequestRateThresholdTest() { - // TODO: test eventRequestRateThreshold - } - - /** - * Test the property 'eventResponseRateThreshold' - */ - @Test - public void eventResponseRateThresholdTest() { - // TODO: test eventResponseRateThreshold - } - - /** - * Test the property 'globalCachingEnabled' - */ - @Test - public void globalCachingEnabledTest() { - // TODO: test globalCachingEnabled - } - - /** - * Test the property 'globalCachingHeartbeat' - */ - @Test - public void globalCachingHeartbeatTest() { - // TODO: test globalCachingHeartbeat - } - - /** - * Test the property 'globalCachingTopicLifetime' - */ - @Test - public void globalCachingTopicLifetimeTest() { - // TODO: test globalCachingTopicLifetime - } - - /** - * Test the property 'maxMemory' - */ - @Test - public void maxMemoryTest() { - // TODO: test maxMemory - } - - /** - * Test the property 'maxMsgsPerTopic' - */ - @Test - public void maxMsgsPerTopicTest() { - // TODO: test maxMsgsPerTopic - } - - /** - * Test the property 'maxRequestQueueDepth' - */ - @Test - public void maxRequestQueueDepthTest() { - // TODO: test maxRequestQueueDepth - } - - /** - * Test the property 'maxTopicCount' - */ - @Test - public void maxTopicCountTest() { - // TODO: test maxTopicCount - } - - /** - * Test the property 'msgLifetime' - */ - @Test - public void msgLifetimeTest() { - // TODO: test msgLifetime - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'newTopicAdvertisementEnabled' - */ - @Test - public void newTopicAdvertisementEnabledTest() { - // TODO: test newTopicAdvertisementEnabled - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicLinksTest.java deleted file mode 100644 index cc43f6a3f..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterTopicLinks - */ -public class MsgVpnDistributedCacheClusterTopicLinksTest { - private final MsgVpnDistributedCacheClusterTopicLinks model = new MsgVpnDistributedCacheClusterTopicLinks(); - - /** - * Model tests for MsgVpnDistributedCacheClusterTopicLinks - */ - @Test - public void testMsgVpnDistributedCacheClusterTopicLinks() { - // TODO: test MsgVpnDistributedCacheClusterTopicLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicResponseTest.java deleted file mode 100644 index 9b9cfa0a2..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopicLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterTopicResponse - */ -public class MsgVpnDistributedCacheClusterTopicResponseTest { - private final MsgVpnDistributedCacheClusterTopicResponse model = new MsgVpnDistributedCacheClusterTopicResponse(); - - /** - * Model tests for MsgVpnDistributedCacheClusterTopicResponse - */ - @Test - public void testMsgVpnDistributedCacheClusterTopicResponse() { - // TODO: test MsgVpnDistributedCacheClusterTopicResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicTest.java deleted file mode 100644 index 853647e33..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterTopic - */ -public class MsgVpnDistributedCacheClusterTopicTest { - private final MsgVpnDistributedCacheClusterTopic model = new MsgVpnDistributedCacheClusterTopic(); - - /** - * Model tests for MsgVpnDistributedCacheClusterTopic - */ - @Test - public void testMsgVpnDistributedCacheClusterTopic() { - // TODO: test MsgVpnDistributedCacheClusterTopic - } - - /** - * Test the property 'cacheName' - */ - @Test - public void cacheNameTest() { - // TODO: test cacheName - } - - /** - * Test the property 'clusterName' - */ - @Test - public void clusterNameTest() { - // TODO: test clusterName - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'topic' - */ - @Test - public void topicTest() { - // TODO: test topic - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicsResponseTest.java deleted file mode 100644 index ebff13ff8..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClusterTopicsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterTopicLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClusterTopicsResponse - */ -public class MsgVpnDistributedCacheClusterTopicsResponseTest { - private final MsgVpnDistributedCacheClusterTopicsResponse model = new MsgVpnDistributedCacheClusterTopicsResponse(); - - /** - * Model tests for MsgVpnDistributedCacheClusterTopicsResponse - */ - @Test - public void testMsgVpnDistributedCacheClusterTopicsResponse() { - // TODO: test MsgVpnDistributedCacheClusterTopicsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClustersResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClustersResponseTest.java deleted file mode 100644 index 28bdb7394..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheClustersResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheCluster; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheClusterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheClustersResponse - */ -public class MsgVpnDistributedCacheClustersResponseTest { - private final MsgVpnDistributedCacheClustersResponse model = new MsgVpnDistributedCacheClustersResponse(); - - /** - * Model tests for MsgVpnDistributedCacheClustersResponse - */ - @Test - public void testMsgVpnDistributedCacheClustersResponse() { - // TODO: test MsgVpnDistributedCacheClustersResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheLinksTest.java deleted file mode 100644 index 0ba9d8200..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheLinksTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheLinks - */ -public class MsgVpnDistributedCacheLinksTest { - private final MsgVpnDistributedCacheLinks model = new MsgVpnDistributedCacheLinks(); - - /** - * Model tests for MsgVpnDistributedCacheLinks - */ - @Test - public void testMsgVpnDistributedCacheLinks() { - // TODO: test MsgVpnDistributedCacheLinks - } - - /** - * Test the property 'clustersUri' - */ - @Test - public void clustersUriTest() { - // TODO: test clustersUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheResponseTest.java deleted file mode 100644 index 1fa55d7c1..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCacheResponse - */ -public class MsgVpnDistributedCacheResponseTest { - private final MsgVpnDistributedCacheResponse model = new MsgVpnDistributedCacheResponse(); - - /** - * Model tests for MsgVpnDistributedCacheResponse - */ - @Test - public void testMsgVpnDistributedCacheResponse() { - // TODO: test MsgVpnDistributedCacheResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheTest.java deleted file mode 100644 index af2ec774a..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCacheTest.java +++ /dev/null @@ -1,96 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCache - */ -public class MsgVpnDistributedCacheTest { - private final MsgVpnDistributedCache model = new MsgVpnDistributedCache(); - - /** - * Model tests for MsgVpnDistributedCache - */ - @Test - public void testMsgVpnDistributedCache() { - // TODO: test MsgVpnDistributedCache - } - - /** - * Test the property 'cacheName' - */ - @Test - public void cacheNameTest() { - // TODO: test cacheName - } - - /** - * Test the property 'cacheVirtualRouter' - */ - @Test - public void cacheVirtualRouterTest() { - // TODO: test cacheVirtualRouter - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'heartbeat' - */ - @Test - public void heartbeatTest() { - // TODO: test heartbeat - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'scheduledDeleteMsgDayList' - */ - @Test - public void scheduledDeleteMsgDayListTest() { - // TODO: test scheduledDeleteMsgDayList - } - - /** - * Test the property 'scheduledDeleteMsgTimeList' - */ - @Test - public void scheduledDeleteMsgTimeListTest() { - // TODO: test scheduledDeleteMsgTimeList - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCachesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCachesResponseTest.java deleted file mode 100644 index fed47aaff..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDistributedCachesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDistributedCacheLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDistributedCachesResponse - */ -public class MsgVpnDistributedCachesResponseTest { - private final MsgVpnDistributedCachesResponse model = new MsgVpnDistributedCachesResponse(); - - /** - * Model tests for MsgVpnDistributedCachesResponse - */ - @Test - public void testMsgVpnDistributedCachesResponse() { - // TODO: test MsgVpnDistributedCachesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeLinksTest.java deleted file mode 100644 index 5ee7b141c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDmrBridgeLinks - */ -public class MsgVpnDmrBridgeLinksTest { - private final MsgVpnDmrBridgeLinks model = new MsgVpnDmrBridgeLinks(); - - /** - * Model tests for MsgVpnDmrBridgeLinks - */ - @Test - public void testMsgVpnDmrBridgeLinks() { - // TODO: test MsgVpnDmrBridgeLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeResponseTest.java deleted file mode 100644 index 666b25cf5..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridgeLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDmrBridgeResponse - */ -public class MsgVpnDmrBridgeResponseTest { - private final MsgVpnDmrBridgeResponse model = new MsgVpnDmrBridgeResponse(); - - /** - * Model tests for MsgVpnDmrBridgeResponse - */ - @Test - public void testMsgVpnDmrBridgeResponse() { - // TODO: test MsgVpnDmrBridgeResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeTest.java deleted file mode 100644 index 880aef333..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgeTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDmrBridge - */ -public class MsgVpnDmrBridgeTest { - private final MsgVpnDmrBridge model = new MsgVpnDmrBridge(); - - /** - * Model tests for MsgVpnDmrBridge - */ - @Test - public void testMsgVpnDmrBridge() { - // TODO: test MsgVpnDmrBridge - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'remoteMsgVpnName' - */ - @Test - public void remoteMsgVpnNameTest() { - // TODO: test remoteMsgVpnName - } - - /** - * Test the property 'remoteNodeName' - */ - @Test - public void remoteNodeNameTest() { - // TODO: test remoteNodeName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgesResponseTest.java deleted file mode 100644 index 1cb6032d6..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnDmrBridgesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridge; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnDmrBridgeLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnDmrBridgesResponse - */ -public class MsgVpnDmrBridgesResponseTest { - private final MsgVpnDmrBridgesResponse model = new MsgVpnDmrBridgesResponse(); - - /** - * Model tests for MsgVpnDmrBridgesResponse - */ - @Test - public void testMsgVpnDmrBridgesResponse() { - // TODO: test MsgVpnDmrBridgesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoriesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoriesResponseTest.java deleted file mode 100644 index 4acbeab15..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoriesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactory; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactoryLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnJndiConnectionFactoriesResponse - */ -public class MsgVpnJndiConnectionFactoriesResponseTest { - private final MsgVpnJndiConnectionFactoriesResponse model = new MsgVpnJndiConnectionFactoriesResponse(); - - /** - * Model tests for MsgVpnJndiConnectionFactoriesResponse - */ - @Test - public void testMsgVpnJndiConnectionFactoriesResponse() { - // TODO: test MsgVpnJndiConnectionFactoriesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryLinksTest.java deleted file mode 100644 index 910a10a3a..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnJndiConnectionFactoryLinks - */ -public class MsgVpnJndiConnectionFactoryLinksTest { - private final MsgVpnJndiConnectionFactoryLinks model = new MsgVpnJndiConnectionFactoryLinks(); - - /** - * Model tests for MsgVpnJndiConnectionFactoryLinks - */ - @Test - public void testMsgVpnJndiConnectionFactoryLinks() { - // TODO: test MsgVpnJndiConnectionFactoryLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryResponseTest.java deleted file mode 100644 index 33ec9768e..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactory; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiConnectionFactoryLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnJndiConnectionFactoryResponse - */ -public class MsgVpnJndiConnectionFactoryResponseTest { - private final MsgVpnJndiConnectionFactoryResponse model = new MsgVpnJndiConnectionFactoryResponse(); - - /** - * Model tests for MsgVpnJndiConnectionFactoryResponse - */ - @Test - public void testMsgVpnJndiConnectionFactoryResponse() { - // TODO: test MsgVpnJndiConnectionFactoryResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryTest.java deleted file mode 100644 index b91a3e244..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiConnectionFactoryTest.java +++ /dev/null @@ -1,368 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnJndiConnectionFactory - */ -public class MsgVpnJndiConnectionFactoryTest { - private final MsgVpnJndiConnectionFactory model = new MsgVpnJndiConnectionFactory(); - - /** - * Model tests for MsgVpnJndiConnectionFactory - */ - @Test - public void testMsgVpnJndiConnectionFactory() { - // TODO: test MsgVpnJndiConnectionFactory - } - - /** - * Test the property 'allowDuplicateClientIdEnabled' - */ - @Test - public void allowDuplicateClientIdEnabledTest() { - // TODO: test allowDuplicateClientIdEnabled - } - - /** - * Test the property 'clientDescription' - */ - @Test - public void clientDescriptionTest() { - // TODO: test clientDescription - } - - /** - * Test the property 'clientId' - */ - @Test - public void clientIdTest() { - // TODO: test clientId - } - - /** - * Test the property 'connectionFactoryName' - */ - @Test - public void connectionFactoryNameTest() { - // TODO: test connectionFactoryName - } - - /** - * Test the property 'dtoReceiveOverrideEnabled' - */ - @Test - public void dtoReceiveOverrideEnabledTest() { - // TODO: test dtoReceiveOverrideEnabled - } - - /** - * Test the property 'dtoReceiveSubscriberLocalPriority' - */ - @Test - public void dtoReceiveSubscriberLocalPriorityTest() { - // TODO: test dtoReceiveSubscriberLocalPriority - } - - /** - * Test the property 'dtoReceiveSubscriberNetworkPriority' - */ - @Test - public void dtoReceiveSubscriberNetworkPriorityTest() { - // TODO: test dtoReceiveSubscriberNetworkPriority - } - - /** - * Test the property 'dtoSendEnabled' - */ - @Test - public void dtoSendEnabledTest() { - // TODO: test dtoSendEnabled - } - - /** - * Test the property 'dynamicEndpointCreateDurableEnabled' - */ - @Test - public void dynamicEndpointCreateDurableEnabledTest() { - // TODO: test dynamicEndpointCreateDurableEnabled - } - - /** - * Test the property 'dynamicEndpointRespectTtlEnabled' - */ - @Test - public void dynamicEndpointRespectTtlEnabledTest() { - // TODO: test dynamicEndpointRespectTtlEnabled - } - - /** - * Test the property 'guaranteedReceiveAckTimeout' - */ - @Test - public void guaranteedReceiveAckTimeoutTest() { - // TODO: test guaranteedReceiveAckTimeout - } - - /** - * Test the property 'guaranteedReceiveReconnectRetryCount' - */ - @Test - public void guaranteedReceiveReconnectRetryCountTest() { - // TODO: test guaranteedReceiveReconnectRetryCount - } - - /** - * Test the property 'guaranteedReceiveReconnectRetryWait' - */ - @Test - public void guaranteedReceiveReconnectRetryWaitTest() { - // TODO: test guaranteedReceiveReconnectRetryWait - } - - /** - * Test the property 'guaranteedReceiveWindowSize' - */ - @Test - public void guaranteedReceiveWindowSizeTest() { - // TODO: test guaranteedReceiveWindowSize - } - - /** - * Test the property 'guaranteedReceiveWindowSizeAckThreshold' - */ - @Test - public void guaranteedReceiveWindowSizeAckThresholdTest() { - // TODO: test guaranteedReceiveWindowSizeAckThreshold - } - - /** - * Test the property 'guaranteedSendAckTimeout' - */ - @Test - public void guaranteedSendAckTimeoutTest() { - // TODO: test guaranteedSendAckTimeout - } - - /** - * Test the property 'guaranteedSendWindowSize' - */ - @Test - public void guaranteedSendWindowSizeTest() { - // TODO: test guaranteedSendWindowSize - } - - /** - * Test the property 'messagingDefaultDeliveryMode' - */ - @Test - public void messagingDefaultDeliveryModeTest() { - // TODO: test messagingDefaultDeliveryMode - } - - /** - * Test the property 'messagingDefaultDmqEligibleEnabled' - */ - @Test - public void messagingDefaultDmqEligibleEnabledTest() { - // TODO: test messagingDefaultDmqEligibleEnabled - } - - /** - * Test the property 'messagingDefaultElidingEligibleEnabled' - */ - @Test - public void messagingDefaultElidingEligibleEnabledTest() { - // TODO: test messagingDefaultElidingEligibleEnabled - } - - /** - * Test the property 'messagingJmsxUserIdEnabled' - */ - @Test - public void messagingJmsxUserIdEnabledTest() { - // TODO: test messagingJmsxUserIdEnabled - } - - /** - * Test the property 'messagingTextInXmlPayloadEnabled' - */ - @Test - public void messagingTextInXmlPayloadEnabledTest() { - // TODO: test messagingTextInXmlPayloadEnabled - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'transportCompressionLevel' - */ - @Test - public void transportCompressionLevelTest() { - // TODO: test transportCompressionLevel - } - - /** - * Test the property 'transportConnectRetryCount' - */ - @Test - public void transportConnectRetryCountTest() { - // TODO: test transportConnectRetryCount - } - - /** - * Test the property 'transportConnectRetryPerHostCount' - */ - @Test - public void transportConnectRetryPerHostCountTest() { - // TODO: test transportConnectRetryPerHostCount - } - - /** - * Test the property 'transportConnectTimeout' - */ - @Test - public void transportConnectTimeoutTest() { - // TODO: test transportConnectTimeout - } - - /** - * Test the property 'transportDirectTransportEnabled' - */ - @Test - public void transportDirectTransportEnabledTest() { - // TODO: test transportDirectTransportEnabled - } - - /** - * Test the property 'transportKeepaliveCount' - */ - @Test - public void transportKeepaliveCountTest() { - // TODO: test transportKeepaliveCount - } - - /** - * Test the property 'transportKeepaliveEnabled' - */ - @Test - public void transportKeepaliveEnabledTest() { - // TODO: test transportKeepaliveEnabled - } - - /** - * Test the property 'transportKeepaliveInterval' - */ - @Test - public void transportKeepaliveIntervalTest() { - // TODO: test transportKeepaliveInterval - } - - /** - * Test the property 'transportMsgCallbackOnIoThreadEnabled' - */ - @Test - public void transportMsgCallbackOnIoThreadEnabledTest() { - // TODO: test transportMsgCallbackOnIoThreadEnabled - } - - /** - * Test the property 'transportOptimizeDirectEnabled' - */ - @Test - public void transportOptimizeDirectEnabledTest() { - // TODO: test transportOptimizeDirectEnabled - } - - /** - * Test the property 'transportPort' - */ - @Test - public void transportPortTest() { - // TODO: test transportPort - } - - /** - * Test the property 'transportReadTimeout' - */ - @Test - public void transportReadTimeoutTest() { - // TODO: test transportReadTimeout - } - - /** - * Test the property 'transportReceiveBufferSize' - */ - @Test - public void transportReceiveBufferSizeTest() { - // TODO: test transportReceiveBufferSize - } - - /** - * Test the property 'transportReconnectRetryCount' - */ - @Test - public void transportReconnectRetryCountTest() { - // TODO: test transportReconnectRetryCount - } - - /** - * Test the property 'transportReconnectRetryWait' - */ - @Test - public void transportReconnectRetryWaitTest() { - // TODO: test transportReconnectRetryWait - } - - /** - * Test the property 'transportSendBufferSize' - */ - @Test - public void transportSendBufferSizeTest() { - // TODO: test transportSendBufferSize - } - - /** - * Test the property 'transportTcpNoDelayEnabled' - */ - @Test - public void transportTcpNoDelayEnabledTest() { - // TODO: test transportTcpNoDelayEnabled - } - - /** - * Test the property 'xaEnabled' - */ - @Test - public void xaEnabledTest() { - // TODO: test xaEnabled - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueLinksTest.java deleted file mode 100644 index 050505e3c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnJndiQueueLinks - */ -public class MsgVpnJndiQueueLinksTest { - private final MsgVpnJndiQueueLinks model = new MsgVpnJndiQueueLinks(); - - /** - * Model tests for MsgVpnJndiQueueLinks - */ - @Test - public void testMsgVpnJndiQueueLinks() { - // TODO: test MsgVpnJndiQueueLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueResponseTest.java deleted file mode 100644 index 28546a137..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueueLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnJndiQueueResponse - */ -public class MsgVpnJndiQueueResponseTest { - private final MsgVpnJndiQueueResponse model = new MsgVpnJndiQueueResponse(); - - /** - * Model tests for MsgVpnJndiQueueResponse - */ - @Test - public void testMsgVpnJndiQueueResponse() { - // TODO: test MsgVpnJndiQueueResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueTest.java deleted file mode 100644 index 7d4036adc..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueueTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnJndiQueue - */ -public class MsgVpnJndiQueueTest { - private final MsgVpnJndiQueue model = new MsgVpnJndiQueue(); - - /** - * Model tests for MsgVpnJndiQueue - */ - @Test - public void testMsgVpnJndiQueue() { - // TODO: test MsgVpnJndiQueue - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'physicalName' - */ - @Test - public void physicalNameTest() { - // TODO: test physicalName - } - - /** - * Test the property 'queueName' - */ - @Test - public void queueNameTest() { - // TODO: test queueName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueuesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueuesResponseTest.java deleted file mode 100644 index aaa162793..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiQueuesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiQueueLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnJndiQueuesResponse - */ -public class MsgVpnJndiQueuesResponseTest { - private final MsgVpnJndiQueuesResponse model = new MsgVpnJndiQueuesResponse(); - - /** - * Model tests for MsgVpnJndiQueuesResponse - */ - @Test - public void testMsgVpnJndiQueuesResponse() { - // TODO: test MsgVpnJndiQueuesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicLinksTest.java deleted file mode 100644 index 4b53f9c6e..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnJndiTopicLinks - */ -public class MsgVpnJndiTopicLinksTest { - private final MsgVpnJndiTopicLinks model = new MsgVpnJndiTopicLinks(); - - /** - * Model tests for MsgVpnJndiTopicLinks - */ - @Test - public void testMsgVpnJndiTopicLinks() { - // TODO: test MsgVpnJndiTopicLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicResponseTest.java deleted file mode 100644 index b8bfe5b00..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopicLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnJndiTopicResponse - */ -public class MsgVpnJndiTopicResponseTest { - private final MsgVpnJndiTopicResponse model = new MsgVpnJndiTopicResponse(); - - /** - * Model tests for MsgVpnJndiTopicResponse - */ - @Test - public void testMsgVpnJndiTopicResponse() { - // TODO: test MsgVpnJndiTopicResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicTest.java deleted file mode 100644 index 129cb3483..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnJndiTopic - */ -public class MsgVpnJndiTopicTest { - private final MsgVpnJndiTopic model = new MsgVpnJndiTopic(); - - /** - * Model tests for MsgVpnJndiTopic - */ - @Test - public void testMsgVpnJndiTopic() { - // TODO: test MsgVpnJndiTopic - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'physicalName' - */ - @Test - public void physicalNameTest() { - // TODO: test physicalName - } - - /** - * Test the property 'topicName' - */ - @Test - public void topicNameTest() { - // TODO: test topicName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicsResponseTest.java deleted file mode 100644 index 5733930be..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnJndiTopicsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnJndiTopicLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnJndiTopicsResponse - */ -public class MsgVpnJndiTopicsResponseTest { - private final MsgVpnJndiTopicsResponse model = new MsgVpnJndiTopicsResponse(); - - /** - * Model tests for MsgVpnJndiTopicsResponse - */ - @Test - public void testMsgVpnJndiTopicsResponse() { - // TODO: test MsgVpnJndiTopicsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnLinksTest.java deleted file mode 100644 index 04c4923a4..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnLinksTest.java +++ /dev/null @@ -1,232 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnLinks - */ -public class MsgVpnLinksTest { - private final MsgVpnLinks model = new MsgVpnLinks(); - - /** - * Model tests for MsgVpnLinks - */ - @Test - public void testMsgVpnLinks() { - // TODO: test MsgVpnLinks - } - - /** - * Test the property 'aclProfilesUri' - */ - @Test - public void aclProfilesUriTest() { - // TODO: test aclProfilesUri - } - - /** - * Test the property 'authenticationOauthProfilesUri' - */ - @Test - public void authenticationOauthProfilesUriTest() { - // TODO: test authenticationOauthProfilesUri - } - - /** - * Test the property 'authenticationOauthProvidersUri' - */ - @Test - public void authenticationOauthProvidersUriTest() { - // TODO: test authenticationOauthProvidersUri - } - - /** - * Test the property 'authorizationGroupsUri' - */ - @Test - public void authorizationGroupsUriTest() { - // TODO: test authorizationGroupsUri - } - - /** - * Test the property 'bridgesUri' - */ - @Test - public void bridgesUriTest() { - // TODO: test bridgesUri - } - - /** - * Test the property 'certMatchingRulesUri' - */ - @Test - public void certMatchingRulesUriTest() { - // TODO: test certMatchingRulesUri - } - - /** - * Test the property 'clientProfilesUri' - */ - @Test - public void clientProfilesUriTest() { - // TODO: test clientProfilesUri - } - - /** - * Test the property 'clientUsernamesUri' - */ - @Test - public void clientUsernamesUriTest() { - // TODO: test clientUsernamesUri - } - - /** - * Test the property 'distributedCachesUri' - */ - @Test - public void distributedCachesUriTest() { - // TODO: test distributedCachesUri - } - - /** - * Test the property 'dmrBridgesUri' - */ - @Test - public void dmrBridgesUriTest() { - // TODO: test dmrBridgesUri - } - - /** - * Test the property 'jndiConnectionFactoriesUri' - */ - @Test - public void jndiConnectionFactoriesUriTest() { - // TODO: test jndiConnectionFactoriesUri - } - - /** - * Test the property 'jndiQueuesUri' - */ - @Test - public void jndiQueuesUriTest() { - // TODO: test jndiQueuesUri - } - - /** - * Test the property 'jndiTopicsUri' - */ - @Test - public void jndiTopicsUriTest() { - // TODO: test jndiTopicsUri - } - - /** - * Test the property 'mqttRetainCachesUri' - */ - @Test - public void mqttRetainCachesUriTest() { - // TODO: test mqttRetainCachesUri - } - - /** - * Test the property 'mqttSessionsUri' - */ - @Test - public void mqttSessionsUriTest() { - // TODO: test mqttSessionsUri - } - - /** - * Test the property 'queueTemplatesUri' - */ - @Test - public void queueTemplatesUriTest() { - // TODO: test queueTemplatesUri - } - - /** - * Test the property 'queuesUri' - */ - @Test - public void queuesUriTest() { - // TODO: test queuesUri - } - - /** - * Test the property 'replayLogsUri' - */ - @Test - public void replayLogsUriTest() { - // TODO: test replayLogsUri - } - - /** - * Test the property 'replicatedTopicsUri' - */ - @Test - public void replicatedTopicsUriTest() { - // TODO: test replicatedTopicsUri - } - - /** - * Test the property 'restDeliveryPointsUri' - */ - @Test - public void restDeliveryPointsUriTest() { - // TODO: test restDeliveryPointsUri - } - - /** - * Test the property 'sequencedTopicsUri' - */ - @Test - public void sequencedTopicsUriTest() { - // TODO: test sequencedTopicsUri - } - - /** - * Test the property 'topicEndpointTemplatesUri' - */ - @Test - public void topicEndpointTemplatesUriTest() { - // TODO: test topicEndpointTemplatesUri - } - - /** - * Test the property 'topicEndpointsUri' - */ - @Test - public void topicEndpointsUriTest() { - // TODO: test topicEndpointsUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheLinksTest.java deleted file mode 100644 index 5ddc97782..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnMqttRetainCacheLinks - */ -public class MsgVpnMqttRetainCacheLinksTest { - private final MsgVpnMqttRetainCacheLinks model = new MsgVpnMqttRetainCacheLinks(); - - /** - * Model tests for MsgVpnMqttRetainCacheLinks - */ - @Test - public void testMsgVpnMqttRetainCacheLinks() { - // TODO: test MsgVpnMqttRetainCacheLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheResponseTest.java deleted file mode 100644 index 5f0cc42f5..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCacheLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnMqttRetainCacheResponse - */ -public class MsgVpnMqttRetainCacheResponseTest { - private final MsgVpnMqttRetainCacheResponse model = new MsgVpnMqttRetainCacheResponse(); - - /** - * Model tests for MsgVpnMqttRetainCacheResponse - */ - @Test - public void testMsgVpnMqttRetainCacheResponse() { - // TODO: test MsgVpnMqttRetainCacheResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheTest.java deleted file mode 100644 index 663894f40..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCacheTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnMqttRetainCache - */ -public class MsgVpnMqttRetainCacheTest { - private final MsgVpnMqttRetainCache model = new MsgVpnMqttRetainCache(); - - /** - * Model tests for MsgVpnMqttRetainCache - */ - @Test - public void testMsgVpnMqttRetainCache() { - // TODO: test MsgVpnMqttRetainCache - } - - /** - * Test the property 'cacheName' - */ - @Test - public void cacheNameTest() { - // TODO: test cacheName - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'msgLifetime' - */ - @Test - public void msgLifetimeTest() { - // TODO: test msgLifetime - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCachesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCachesResponseTest.java deleted file mode 100644 index 2c69a871f..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttRetainCachesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCache; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttRetainCacheLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnMqttRetainCachesResponse - */ -public class MsgVpnMqttRetainCachesResponseTest { - private final MsgVpnMqttRetainCachesResponse model = new MsgVpnMqttRetainCachesResponse(); - - /** - * Model tests for MsgVpnMqttRetainCachesResponse - */ - @Test - public void testMsgVpnMqttRetainCachesResponse() { - // TODO: test MsgVpnMqttRetainCachesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionLinksTest.java deleted file mode 100644 index 0ccf5ebe7..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionLinksTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnMqttSessionLinks - */ -public class MsgVpnMqttSessionLinksTest { - private final MsgVpnMqttSessionLinks model = new MsgVpnMqttSessionLinks(); - - /** - * Model tests for MsgVpnMqttSessionLinks - */ - @Test - public void testMsgVpnMqttSessionLinks() { - // TODO: test MsgVpnMqttSessionLinks - } - - /** - * Test the property 'subscriptionsUri' - */ - @Test - public void subscriptionsUriTest() { - // TODO: test subscriptionsUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionResponseTest.java deleted file mode 100644 index d94224878..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSession; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnMqttSessionResponse - */ -public class MsgVpnMqttSessionResponseTest { - private final MsgVpnMqttSessionResponse model = new MsgVpnMqttSessionResponse(); - - /** - * Model tests for MsgVpnMqttSessionResponse - */ - @Test - public void testMsgVpnMqttSessionResponse() { - // TODO: test MsgVpnMqttSessionResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionLinksTest.java deleted file mode 100644 index a7b6e64d9..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnMqttSessionSubscriptionLinks - */ -public class MsgVpnMqttSessionSubscriptionLinksTest { - private final MsgVpnMqttSessionSubscriptionLinks model = new MsgVpnMqttSessionSubscriptionLinks(); - - /** - * Model tests for MsgVpnMqttSessionSubscriptionLinks - */ - @Test - public void testMsgVpnMqttSessionSubscriptionLinks() { - // TODO: test MsgVpnMqttSessionSubscriptionLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionResponseTest.java deleted file mode 100644 index 488bc85ee..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscriptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnMqttSessionSubscriptionResponse - */ -public class MsgVpnMqttSessionSubscriptionResponseTest { - private final MsgVpnMqttSessionSubscriptionResponse model = new MsgVpnMqttSessionSubscriptionResponse(); - - /** - * Model tests for MsgVpnMqttSessionSubscriptionResponse - */ - @Test - public void testMsgVpnMqttSessionSubscriptionResponse() { - // TODO: test MsgVpnMqttSessionSubscriptionResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionTest.java deleted file mode 100644 index f8fd64dce..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionTest.java +++ /dev/null @@ -1,80 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnMqttSessionSubscription - */ -public class MsgVpnMqttSessionSubscriptionTest { - private final MsgVpnMqttSessionSubscription model = new MsgVpnMqttSessionSubscription(); - - /** - * Model tests for MsgVpnMqttSessionSubscription - */ - @Test - public void testMsgVpnMqttSessionSubscription() { - // TODO: test MsgVpnMqttSessionSubscription - } - - /** - * Test the property 'mqttSessionClientId' - */ - @Test - public void mqttSessionClientIdTest() { - // TODO: test mqttSessionClientId - } - - /** - * Test the property 'mqttSessionVirtualRouter' - */ - @Test - public void mqttSessionVirtualRouterTest() { - // TODO: test mqttSessionVirtualRouter - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'subscriptionQos' - */ - @Test - public void subscriptionQosTest() { - // TODO: test subscriptionQos - } - - /** - * Test the property 'subscriptionTopic' - */ - @Test - public void subscriptionTopicTest() { - // TODO: test subscriptionTopic - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionsResponseTest.java deleted file mode 100644 index 1d478defd..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionSubscriptionsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionSubscriptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnMqttSessionSubscriptionsResponse - */ -public class MsgVpnMqttSessionSubscriptionsResponseTest { - private final MsgVpnMqttSessionSubscriptionsResponse model = new MsgVpnMqttSessionSubscriptionsResponse(); - - /** - * Model tests for MsgVpnMqttSessionSubscriptionsResponse - */ - @Test - public void testMsgVpnMqttSessionSubscriptionsResponse() { - // TODO: test MsgVpnMqttSessionSubscriptionsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionTest.java deleted file mode 100644 index 9ec14527b..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionTest.java +++ /dev/null @@ -1,201 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnMqttSession - */ -public class MsgVpnMqttSessionTest { - private final MsgVpnMqttSession model = new MsgVpnMqttSession(); - - /** - * Model tests for MsgVpnMqttSession - */ - @Test - public void testMsgVpnMqttSession() { - // TODO: test MsgVpnMqttSession - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'mqttSessionClientId' - */ - @Test - public void mqttSessionClientIdTest() { - // TODO: test mqttSessionClientId - } - - /** - * Test the property 'mqttSessionVirtualRouter' - */ - @Test - public void mqttSessionVirtualRouterTest() { - // TODO: test mqttSessionVirtualRouter - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'owner' - */ - @Test - public void ownerTest() { - // TODO: test owner - } - - /** - * Test the property 'queueConsumerAckPropagationEnabled' - */ - @Test - public void queueConsumerAckPropagationEnabledTest() { - // TODO: test queueConsumerAckPropagationEnabled - } - - /** - * Test the property 'queueDeadMsgQueue' - */ - @Test - public void queueDeadMsgQueueTest() { - // TODO: test queueDeadMsgQueue - } - - /** - * Test the property 'queueEventBindCountThreshold' - */ - @Test - public void queueEventBindCountThresholdTest() { - // TODO: test queueEventBindCountThreshold - } - - /** - * Test the property 'queueEventMsgSpoolUsageThreshold' - */ - @Test - public void queueEventMsgSpoolUsageThresholdTest() { - // TODO: test queueEventMsgSpoolUsageThreshold - } - - /** - * Test the property 'queueEventRejectLowPriorityMsgLimitThreshold' - */ - @Test - public void queueEventRejectLowPriorityMsgLimitThresholdTest() { - // TODO: test queueEventRejectLowPriorityMsgLimitThreshold - } - - /** - * Test the property 'queueMaxBindCount' - */ - @Test - public void queueMaxBindCountTest() { - // TODO: test queueMaxBindCount - } - - /** - * Test the property 'queueMaxDeliveredUnackedMsgsPerFlow' - */ - @Test - public void queueMaxDeliveredUnackedMsgsPerFlowTest() { - // TODO: test queueMaxDeliveredUnackedMsgsPerFlow - } - - /** - * Test the property 'queueMaxMsgSize' - */ - @Test - public void queueMaxMsgSizeTest() { - // TODO: test queueMaxMsgSize - } - - /** - * Test the property 'queueMaxMsgSpoolUsage' - */ - @Test - public void queueMaxMsgSpoolUsageTest() { - // TODO: test queueMaxMsgSpoolUsage - } - - /** - * Test the property 'queueMaxRedeliveryCount' - */ - @Test - public void queueMaxRedeliveryCountTest() { - // TODO: test queueMaxRedeliveryCount - } - - /** - * Test the property 'queueMaxTtl' - */ - @Test - public void queueMaxTtlTest() { - // TODO: test queueMaxTtl - } - - /** - * Test the property 'queueRejectLowPriorityMsgEnabled' - */ - @Test - public void queueRejectLowPriorityMsgEnabledTest() { - // TODO: test queueRejectLowPriorityMsgEnabled - } - - /** - * Test the property 'queueRejectLowPriorityMsgLimit' - */ - @Test - public void queueRejectLowPriorityMsgLimitTest() { - // TODO: test queueRejectLowPriorityMsgLimit - } - - /** - * Test the property 'queueRejectMsgToSenderOnDiscardBehavior' - */ - @Test - public void queueRejectMsgToSenderOnDiscardBehaviorTest() { - // TODO: test queueRejectMsgToSenderOnDiscardBehavior - } - - /** - * Test the property 'queueRespectTtlEnabled' - */ - @Test - public void queueRespectTtlEnabledTest() { - // TODO: test queueRespectTtlEnabled - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionsResponseTest.java deleted file mode 100644 index 40251f0ff..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnMqttSessionsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSession; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnMqttSessionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnMqttSessionsResponse - */ -public class MsgVpnMqttSessionsResponseTest { - private final MsgVpnMqttSessionsResponse model = new MsgVpnMqttSessionsResponse(); - - /** - * Model tests for MsgVpnMqttSessionsResponse - */ - @Test - public void testMsgVpnMqttSessionsResponse() { - // TODO: test MsgVpnMqttSessionsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueLinksTest.java deleted file mode 100644 index a4a05ccd7..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueLinksTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnQueueLinks - */ -public class MsgVpnQueueLinksTest { - private final MsgVpnQueueLinks model = new MsgVpnQueueLinks(); - - /** - * Model tests for MsgVpnQueueLinks - */ - @Test - public void testMsgVpnQueueLinks() { - // TODO: test MsgVpnQueueLinks - } - - /** - * Test the property 'subscriptionsUri' - */ - @Test - public void subscriptionsUriTest() { - // TODO: test subscriptionsUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueResponseTest.java deleted file mode 100644 index 18977aea0..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnQueueResponse - */ -public class MsgVpnQueueResponseTest { - private final MsgVpnQueueResponse model = new MsgVpnQueueResponse(); - - /** - * Model tests for MsgVpnQueueResponse - */ - @Test - public void testMsgVpnQueueResponse() { - // TODO: test MsgVpnQueueResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionLinksTest.java deleted file mode 100644 index 99d29b1e8..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnQueueSubscriptionLinks - */ -public class MsgVpnQueueSubscriptionLinksTest { - private final MsgVpnQueueSubscriptionLinks model = new MsgVpnQueueSubscriptionLinks(); - - /** - * Model tests for MsgVpnQueueSubscriptionLinks - */ - @Test - public void testMsgVpnQueueSubscriptionLinks() { - // TODO: test MsgVpnQueueSubscriptionLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionResponseTest.java deleted file mode 100644 index 6ae01c867..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscriptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnQueueSubscriptionResponse - */ -public class MsgVpnQueueSubscriptionResponseTest { - private final MsgVpnQueueSubscriptionResponse model = new MsgVpnQueueSubscriptionResponse(); - - /** - * Model tests for MsgVpnQueueSubscriptionResponse - */ - @Test - public void testMsgVpnQueueSubscriptionResponse() { - // TODO: test MsgVpnQueueSubscriptionResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionTest.java deleted file mode 100644 index a3d8eaef7..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnQueueSubscription - */ -public class MsgVpnQueueSubscriptionTest { - private final MsgVpnQueueSubscription model = new MsgVpnQueueSubscription(); - - /** - * Model tests for MsgVpnQueueSubscription - */ - @Test - public void testMsgVpnQueueSubscription() { - // TODO: test MsgVpnQueueSubscription - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'queueName' - */ - @Test - public void queueNameTest() { - // TODO: test queueName - } - - /** - * Test the property 'subscriptionTopic' - */ - @Test - public void subscriptionTopicTest() { - // TODO: test subscriptionTopic - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionsResponseTest.java deleted file mode 100644 index 9801e2981..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueSubscriptionsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueSubscriptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnQueueSubscriptionsResponse - */ -public class MsgVpnQueueSubscriptionsResponseTest { - private final MsgVpnQueueSubscriptionsResponse model = new MsgVpnQueueSubscriptionsResponse(); - - /** - * Model tests for MsgVpnQueueSubscriptionsResponse - */ - @Test - public void testMsgVpnQueueSubscriptionsResponse() { - // TODO: test MsgVpnQueueSubscriptionsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateLinksTest.java deleted file mode 100644 index 355f81327..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnQueueTemplateLinks - */ -public class MsgVpnQueueTemplateLinksTest { - private final MsgVpnQueueTemplateLinks model = new MsgVpnQueueTemplateLinks(); - - /** - * Model tests for MsgVpnQueueTemplateLinks - */ - @Test - public void testMsgVpnQueueTemplateLinks() { - // TODO: test MsgVpnQueueTemplateLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateResponseTest.java deleted file mode 100644 index 55ff90b27..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplateLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnQueueTemplateResponse - */ -public class MsgVpnQueueTemplateResponseTest { - private final MsgVpnQueueTemplateResponse model = new MsgVpnQueueTemplateResponse(); - - /** - * Model tests for MsgVpnQueueTemplateResponse - */ - @Test - public void testMsgVpnQueueTemplateResponse() { - // TODO: test MsgVpnQueueTemplateResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateTest.java deleted file mode 100644 index df49ed7cc..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplateTest.java +++ /dev/null @@ -1,233 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnQueueTemplate - */ -public class MsgVpnQueueTemplateTest { - private final MsgVpnQueueTemplate model = new MsgVpnQueueTemplate(); - - /** - * Model tests for MsgVpnQueueTemplate - */ - @Test - public void testMsgVpnQueueTemplate() { - // TODO: test MsgVpnQueueTemplate - } - - /** - * Test the property 'accessType' - */ - @Test - public void accessTypeTest() { - // TODO: test accessType - } - - /** - * Test the property 'consumerAckPropagationEnabled' - */ - @Test - public void consumerAckPropagationEnabledTest() { - // TODO: test consumerAckPropagationEnabled - } - - /** - * Test the property 'deadMsgQueue' - */ - @Test - public void deadMsgQueueTest() { - // TODO: test deadMsgQueue - } - - /** - * Test the property 'deliveryDelay' - */ - @Test - public void deliveryDelayTest() { - // TODO: test deliveryDelay - } - - /** - * Test the property 'durabilityOverride' - */ - @Test - public void durabilityOverrideTest() { - // TODO: test durabilityOverride - } - - /** - * Test the property 'eventBindCountThreshold' - */ - @Test - public void eventBindCountThresholdTest() { - // TODO: test eventBindCountThreshold - } - - /** - * Test the property 'eventMsgSpoolUsageThreshold' - */ - @Test - public void eventMsgSpoolUsageThresholdTest() { - // TODO: test eventMsgSpoolUsageThreshold - } - - /** - * Test the property 'eventRejectLowPriorityMsgLimitThreshold' - */ - @Test - public void eventRejectLowPriorityMsgLimitThresholdTest() { - // TODO: test eventRejectLowPriorityMsgLimitThreshold - } - - /** - * Test the property 'maxBindCount' - */ - @Test - public void maxBindCountTest() { - // TODO: test maxBindCount - } - - /** - * Test the property 'maxDeliveredUnackedMsgsPerFlow' - */ - @Test - public void maxDeliveredUnackedMsgsPerFlowTest() { - // TODO: test maxDeliveredUnackedMsgsPerFlow - } - - /** - * Test the property 'maxMsgSize' - */ - @Test - public void maxMsgSizeTest() { - // TODO: test maxMsgSize - } - - /** - * Test the property 'maxMsgSpoolUsage' - */ - @Test - public void maxMsgSpoolUsageTest() { - // TODO: test maxMsgSpoolUsage - } - - /** - * Test the property 'maxRedeliveryCount' - */ - @Test - public void maxRedeliveryCountTest() { - // TODO: test maxRedeliveryCount - } - - /** - * Test the property 'maxTtl' - */ - @Test - public void maxTtlTest() { - // TODO: test maxTtl - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'permission' - */ - @Test - public void permissionTest() { - // TODO: test permission - } - - /** - * Test the property 'queueNameFilter' - */ - @Test - public void queueNameFilterTest() { - // TODO: test queueNameFilter - } - - /** - * Test the property 'queueTemplateName' - */ - @Test - public void queueTemplateNameTest() { - // TODO: test queueTemplateName - } - - /** - * Test the property 'redeliveryEnabled' - */ - @Test - public void redeliveryEnabledTest() { - // TODO: test redeliveryEnabled - } - - /** - * Test the property 'rejectLowPriorityMsgEnabled' - */ - @Test - public void rejectLowPriorityMsgEnabledTest() { - // TODO: test rejectLowPriorityMsgEnabled - } - - /** - * Test the property 'rejectLowPriorityMsgLimit' - */ - @Test - public void rejectLowPriorityMsgLimitTest() { - // TODO: test rejectLowPriorityMsgLimit - } - - /** - * Test the property 'rejectMsgToSenderOnDiscardBehavior' - */ - @Test - public void rejectMsgToSenderOnDiscardBehaviorTest() { - // TODO: test rejectMsgToSenderOnDiscardBehavior - } - - /** - * Test the property 'respectMsgPriorityEnabled' - */ - @Test - public void respectMsgPriorityEnabledTest() { - // TODO: test respectMsgPriorityEnabled - } - - /** - * Test the property 'respectTtlEnabled' - */ - @Test - public void respectTtlEnabledTest() { - // TODO: test respectTtlEnabled - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplatesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplatesResponseTest.java deleted file mode 100644 index 6652788d7..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTemplatesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueTemplateLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnQueueTemplatesResponse - */ -public class MsgVpnQueueTemplatesResponseTest { - private final MsgVpnQueueTemplatesResponse model = new MsgVpnQueueTemplatesResponse(); - - /** - * Model tests for MsgVpnQueueTemplatesResponse - */ - @Test - public void testMsgVpnQueueTemplatesResponse() { - // TODO: test MsgVpnQueueTemplatesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTest.java deleted file mode 100644 index 17e8252c3..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueueTest.java +++ /dev/null @@ -1,249 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnQueue - */ -public class MsgVpnQueueTest { - private final MsgVpnQueue model = new MsgVpnQueue(); - - /** - * Model tests for MsgVpnQueue - */ - @Test - public void testMsgVpnQueue() { - // TODO: test MsgVpnQueue - } - - /** - * Test the property 'accessType' - */ - @Test - public void accessTypeTest() { - // TODO: test accessType - } - - /** - * Test the property 'consumerAckPropagationEnabled' - */ - @Test - public void consumerAckPropagationEnabledTest() { - // TODO: test consumerAckPropagationEnabled - } - - /** - * Test the property 'deadMsgQueue' - */ - @Test - public void deadMsgQueueTest() { - // TODO: test deadMsgQueue - } - - /** - * Test the property 'deliveryCountEnabled' - */ - @Test - public void deliveryCountEnabledTest() { - // TODO: test deliveryCountEnabled - } - - /** - * Test the property 'deliveryDelay' - */ - @Test - public void deliveryDelayTest() { - // TODO: test deliveryDelay - } - - /** - * Test the property 'egressEnabled' - */ - @Test - public void egressEnabledTest() { - // TODO: test egressEnabled - } - - /** - * Test the property 'eventBindCountThreshold' - */ - @Test - public void eventBindCountThresholdTest() { - // TODO: test eventBindCountThreshold - } - - /** - * Test the property 'eventMsgSpoolUsageThreshold' - */ - @Test - public void eventMsgSpoolUsageThresholdTest() { - // TODO: test eventMsgSpoolUsageThreshold - } - - /** - * Test the property 'eventRejectLowPriorityMsgLimitThreshold' - */ - @Test - public void eventRejectLowPriorityMsgLimitThresholdTest() { - // TODO: test eventRejectLowPriorityMsgLimitThreshold - } - - /** - * Test the property 'ingressEnabled' - */ - @Test - public void ingressEnabledTest() { - // TODO: test ingressEnabled - } - - /** - * Test the property 'maxBindCount' - */ - @Test - public void maxBindCountTest() { - // TODO: test maxBindCount - } - - /** - * Test the property 'maxDeliveredUnackedMsgsPerFlow' - */ - @Test - public void maxDeliveredUnackedMsgsPerFlowTest() { - // TODO: test maxDeliveredUnackedMsgsPerFlow - } - - /** - * Test the property 'maxMsgSize' - */ - @Test - public void maxMsgSizeTest() { - // TODO: test maxMsgSize - } - - /** - * Test the property 'maxMsgSpoolUsage' - */ - @Test - public void maxMsgSpoolUsageTest() { - // TODO: test maxMsgSpoolUsage - } - - /** - * Test the property 'maxRedeliveryCount' - */ - @Test - public void maxRedeliveryCountTest() { - // TODO: test maxRedeliveryCount - } - - /** - * Test the property 'maxTtl' - */ - @Test - public void maxTtlTest() { - // TODO: test maxTtl - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'owner' - */ - @Test - public void ownerTest() { - // TODO: test owner - } - - /** - * Test the property 'permission' - */ - @Test - public void permissionTest() { - // TODO: test permission - } - - /** - * Test the property 'queueName' - */ - @Test - public void queueNameTest() { - // TODO: test queueName - } - - /** - * Test the property 'redeliveryEnabled' - */ - @Test - public void redeliveryEnabledTest() { - // TODO: test redeliveryEnabled - } - - /** - * Test the property 'rejectLowPriorityMsgEnabled' - */ - @Test - public void rejectLowPriorityMsgEnabledTest() { - // TODO: test rejectLowPriorityMsgEnabled - } - - /** - * Test the property 'rejectLowPriorityMsgLimit' - */ - @Test - public void rejectLowPriorityMsgLimitTest() { - // TODO: test rejectLowPriorityMsgLimit - } - - /** - * Test the property 'rejectMsgToSenderOnDiscardBehavior' - */ - @Test - public void rejectMsgToSenderOnDiscardBehaviorTest() { - // TODO: test rejectMsgToSenderOnDiscardBehavior - } - - /** - * Test the property 'respectMsgPriorityEnabled' - */ - @Test - public void respectMsgPriorityEnabledTest() { - // TODO: test respectMsgPriorityEnabled - } - - /** - * Test the property 'respectTtlEnabled' - */ - @Test - public void respectTtlEnabledTest() { - // TODO: test respectTtlEnabled - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueuesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueuesResponseTest.java deleted file mode 100644 index 79c0f092a..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnQueuesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnQueueLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnQueuesResponse - */ -public class MsgVpnQueuesResponseTest { - private final MsgVpnQueuesResponse model = new MsgVpnQueuesResponse(); - - /** - * Model tests for MsgVpnQueuesResponse - */ - @Test - public void testMsgVpnQueuesResponse() { - // TODO: test MsgVpnQueuesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogLinksTest.java deleted file mode 100644 index a53d1c61d..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogLinksTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnReplayLogLinks - */ -public class MsgVpnReplayLogLinksTest { - private final MsgVpnReplayLogLinks model = new MsgVpnReplayLogLinks(); - - /** - * Model tests for MsgVpnReplayLogLinks - */ - @Test - public void testMsgVpnReplayLogLinks() { - // TODO: test MsgVpnReplayLogLinks - } - - /** - * Test the property 'topicFilterSubscriptionsUri' - */ - @Test - public void topicFilterSubscriptionsUriTest() { - // TODO: test topicFilterSubscriptionsUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogResponseTest.java deleted file mode 100644 index 8e7ccd0fc..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLog; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnReplayLogResponse - */ -public class MsgVpnReplayLogResponseTest { - private final MsgVpnReplayLogResponse model = new MsgVpnReplayLogResponse(); - - /** - * Model tests for MsgVpnReplayLogResponse - */ - @Test - public void testMsgVpnReplayLogResponse() { - // TODO: test MsgVpnReplayLogResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTest.java deleted file mode 100644 index ec4633885..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTest.java +++ /dev/null @@ -1,88 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnReplayLog - */ -public class MsgVpnReplayLogTest { - private final MsgVpnReplayLog model = new MsgVpnReplayLog(); - - /** - * Model tests for MsgVpnReplayLog - */ - @Test - public void testMsgVpnReplayLog() { - // TODO: test MsgVpnReplayLog - } - - /** - * Test the property 'egressEnabled' - */ - @Test - public void egressEnabledTest() { - // TODO: test egressEnabled - } - - /** - * Test the property 'ingressEnabled' - */ - @Test - public void ingressEnabledTest() { - // TODO: test ingressEnabled - } - - /** - * Test the property 'maxSpoolUsage' - */ - @Test - public void maxSpoolUsageTest() { - // TODO: test maxSpoolUsage - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'replayLogName' - */ - @Test - public void replayLogNameTest() { - // TODO: test replayLogName - } - - /** - * Test the property 'topicFilterEnabled' - */ - @Test - public void topicFilterEnabledTest() { - // TODO: test topicFilterEnabled - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionLinksTest.java deleted file mode 100644 index a30d1edb7..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnReplayLogTopicFilterSubscriptionLinks - */ -public class MsgVpnReplayLogTopicFilterSubscriptionLinksTest { - private final MsgVpnReplayLogTopicFilterSubscriptionLinks model = new MsgVpnReplayLogTopicFilterSubscriptionLinks(); - - /** - * Model tests for MsgVpnReplayLogTopicFilterSubscriptionLinks - */ - @Test - public void testMsgVpnReplayLogTopicFilterSubscriptionLinks() { - // TODO: test MsgVpnReplayLogTopicFilterSubscriptionLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionResponseTest.java deleted file mode 100644 index 568bb4089..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscriptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnReplayLogTopicFilterSubscriptionResponse - */ -public class MsgVpnReplayLogTopicFilterSubscriptionResponseTest { - private final MsgVpnReplayLogTopicFilterSubscriptionResponse model = new MsgVpnReplayLogTopicFilterSubscriptionResponse(); - - /** - * Model tests for MsgVpnReplayLogTopicFilterSubscriptionResponse - */ - @Test - public void testMsgVpnReplayLogTopicFilterSubscriptionResponse() { - // TODO: test MsgVpnReplayLogTopicFilterSubscriptionResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionTest.java deleted file mode 100644 index d67001f0d..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnReplayLogTopicFilterSubscription - */ -public class MsgVpnReplayLogTopicFilterSubscriptionTest { - private final MsgVpnReplayLogTopicFilterSubscription model = new MsgVpnReplayLogTopicFilterSubscription(); - - /** - * Model tests for MsgVpnReplayLogTopicFilterSubscription - */ - @Test - public void testMsgVpnReplayLogTopicFilterSubscription() { - // TODO: test MsgVpnReplayLogTopicFilterSubscription - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'replayLogName' - */ - @Test - public void replayLogNameTest() { - // TODO: test replayLogName - } - - /** - * Test the property 'topicFilterSubscription' - */ - @Test - public void topicFilterSubscriptionTest() { - // TODO: test topicFilterSubscription - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionsResponseTest.java deleted file mode 100644 index 9899ba534..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogTopicFilterSubscriptionsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscription; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogTopicFilterSubscriptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnReplayLogTopicFilterSubscriptionsResponse - */ -public class MsgVpnReplayLogTopicFilterSubscriptionsResponseTest { - private final MsgVpnReplayLogTopicFilterSubscriptionsResponse model = new MsgVpnReplayLogTopicFilterSubscriptionsResponse(); - - /** - * Model tests for MsgVpnReplayLogTopicFilterSubscriptionsResponse - */ - @Test - public void testMsgVpnReplayLogTopicFilterSubscriptionsResponse() { - // TODO: test MsgVpnReplayLogTopicFilterSubscriptionsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogsResponseTest.java deleted file mode 100644 index 745f9ea83..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplayLogsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLog; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplayLogLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnReplayLogsResponse - */ -public class MsgVpnReplayLogsResponseTest { - private final MsgVpnReplayLogsResponse model = new MsgVpnReplayLogsResponse(); - - /** - * Model tests for MsgVpnReplayLogsResponse - */ - @Test - public void testMsgVpnReplayLogsResponse() { - // TODO: test MsgVpnReplayLogsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicLinksTest.java deleted file mode 100644 index 96ad4b79b..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnReplicatedTopicLinks - */ -public class MsgVpnReplicatedTopicLinksTest { - private final MsgVpnReplicatedTopicLinks model = new MsgVpnReplicatedTopicLinks(); - - /** - * Model tests for MsgVpnReplicatedTopicLinks - */ - @Test - public void testMsgVpnReplicatedTopicLinks() { - // TODO: test MsgVpnReplicatedTopicLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicResponseTest.java deleted file mode 100644 index e724c1be4..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopicLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnReplicatedTopicResponse - */ -public class MsgVpnReplicatedTopicResponseTest { - private final MsgVpnReplicatedTopicResponse model = new MsgVpnReplicatedTopicResponse(); - - /** - * Model tests for MsgVpnReplicatedTopicResponse - */ - @Test - public void testMsgVpnReplicatedTopicResponse() { - // TODO: test MsgVpnReplicatedTopicResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicTest.java deleted file mode 100644 index 8b69b4a16..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnReplicatedTopic - */ -public class MsgVpnReplicatedTopicTest { - private final MsgVpnReplicatedTopic model = new MsgVpnReplicatedTopic(); - - /** - * Model tests for MsgVpnReplicatedTopic - */ - @Test - public void testMsgVpnReplicatedTopic() { - // TODO: test MsgVpnReplicatedTopic - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'replicatedTopic' - */ - @Test - public void replicatedTopicTest() { - // TODO: test replicatedTopic - } - - /** - * Test the property 'replicationMode' - */ - @Test - public void replicationModeTest() { - // TODO: test replicationMode - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicsResponseTest.java deleted file mode 100644 index 0cb0329bc..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnReplicatedTopicsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnReplicatedTopicLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnReplicatedTopicsResponse - */ -public class MsgVpnReplicatedTopicsResponseTest { - private final MsgVpnReplicatedTopicsResponse model = new MsgVpnReplicatedTopicsResponse(); - - /** - * Model tests for MsgVpnReplicatedTopicsResponse - */ - @Test - public void testMsgVpnReplicatedTopicsResponse() { - // TODO: test MsgVpnReplicatedTopicsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnResponseTest.java deleted file mode 100644 index 3ba61512f..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnResponse - */ -public class MsgVpnResponseTest { - private final MsgVpnResponse model = new MsgVpnResponse(); - - /** - * Model tests for MsgVpnResponse - */ - @Test - public void testMsgVpnResponse() { - // TODO: test MsgVpnResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointLinksTest.java deleted file mode 100644 index b8eb520f3..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointLinksTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointLinks - */ -public class MsgVpnRestDeliveryPointLinksTest { - private final MsgVpnRestDeliveryPointLinks model = new MsgVpnRestDeliveryPointLinks(); - - /** - * Model tests for MsgVpnRestDeliveryPointLinks - */ - @Test - public void testMsgVpnRestDeliveryPointLinks() { - // TODO: test MsgVpnRestDeliveryPointLinks - } - - /** - * Test the property 'queueBindingsUri' - */ - @Test - public void queueBindingsUriTest() { - // TODO: test queueBindingsUri - } - - /** - * Test the property 'restConsumersUri' - */ - @Test - public void restConsumersUriTest() { - // TODO: test restConsumersUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingLinksTest.java deleted file mode 100644 index 01294b964..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingLinksTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointQueueBindingLinks - */ -public class MsgVpnRestDeliveryPointQueueBindingLinksTest { - private final MsgVpnRestDeliveryPointQueueBindingLinks model = new MsgVpnRestDeliveryPointQueueBindingLinks(); - - /** - * Model tests for MsgVpnRestDeliveryPointQueueBindingLinks - */ - @Test - public void testMsgVpnRestDeliveryPointQueueBindingLinks() { - // TODO: test MsgVpnRestDeliveryPointQueueBindingLinks - } - - /** - * Test the property 'requestHeadersUri' - */ - @Test - public void requestHeadersUriTest() { - // TODO: test requestHeadersUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinksTest.java deleted file mode 100644 index d944689e2..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks - */ -public class MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinksTest { - private final MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks model = new MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks(); - - /** - * Model tests for MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks - */ - @Test - public void testMsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks() { - // TODO: test MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponseTest.java deleted file mode 100644 index f212397d1..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeader; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - */ -public class MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponseTest { - private final MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse model = new MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse(); - - /** - * Model tests for MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - */ - @Test - public void testMsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse() { - // TODO: test MsgVpnRestDeliveryPointQueueBindingRequestHeaderResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderTest.java deleted file mode 100644 index c5ca13d99..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeaderTest.java +++ /dev/null @@ -1,80 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointQueueBindingRequestHeader - */ -public class MsgVpnRestDeliveryPointQueueBindingRequestHeaderTest { - private final MsgVpnRestDeliveryPointQueueBindingRequestHeader model = new MsgVpnRestDeliveryPointQueueBindingRequestHeader(); - - /** - * Model tests for MsgVpnRestDeliveryPointQueueBindingRequestHeader - */ - @Test - public void testMsgVpnRestDeliveryPointQueueBindingRequestHeader() { - // TODO: test MsgVpnRestDeliveryPointQueueBindingRequestHeader - } - - /** - * Test the property 'headerName' - */ - @Test - public void headerNameTest() { - // TODO: test headerName - } - - /** - * Test the property 'headerValue' - */ - @Test - public void headerValueTest() { - // TODO: test headerValue - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'queueBindingName' - */ - @Test - public void queueBindingNameTest() { - // TODO: test queueBindingName - } - - /** - * Test the property 'restDeliveryPointName' - */ - @Test - public void restDeliveryPointNameTest() { - // TODO: test restDeliveryPointName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponseTest.java deleted file mode 100644 index 2170b2b74..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeader; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingRequestHeaderLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse - */ -public class MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponseTest { - private final MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse model = new MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse(); - - /** - * Model tests for MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse - */ - @Test - public void testMsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse() { - // TODO: test MsgVpnRestDeliveryPointQueueBindingRequestHeadersResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingResponseTest.java deleted file mode 100644 index fcbe2518c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBinding; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointQueueBindingResponse - */ -public class MsgVpnRestDeliveryPointQueueBindingResponseTest { - private final MsgVpnRestDeliveryPointQueueBindingResponse model = new MsgVpnRestDeliveryPointQueueBindingResponse(); - - /** - * Model tests for MsgVpnRestDeliveryPointQueueBindingResponse - */ - @Test - public void testMsgVpnRestDeliveryPointQueueBindingResponse() { - // TODO: test MsgVpnRestDeliveryPointQueueBindingResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingTest.java deleted file mode 100644 index 73381f74a..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingTest.java +++ /dev/null @@ -1,88 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointQueueBinding - */ -public class MsgVpnRestDeliveryPointQueueBindingTest { - private final MsgVpnRestDeliveryPointQueueBinding model = new MsgVpnRestDeliveryPointQueueBinding(); - - /** - * Model tests for MsgVpnRestDeliveryPointQueueBinding - */ - @Test - public void testMsgVpnRestDeliveryPointQueueBinding() { - // TODO: test MsgVpnRestDeliveryPointQueueBinding - } - - /** - * Test the property 'gatewayReplaceTargetAuthorityEnabled' - */ - @Test - public void gatewayReplaceTargetAuthorityEnabledTest() { - // TODO: test gatewayReplaceTargetAuthorityEnabled - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'postRequestTarget' - */ - @Test - public void postRequestTargetTest() { - // TODO: test postRequestTarget - } - - /** - * Test the property 'queueBindingName' - */ - @Test - public void queueBindingNameTest() { - // TODO: test queueBindingName - } - - /** - * Test the property 'requestTargetEvaluation' - */ - @Test - public void requestTargetEvaluationTest() { - // TODO: test requestTargetEvaluation - } - - /** - * Test the property 'restDeliveryPointName' - */ - @Test - public void restDeliveryPointNameTest() { - // TODO: test restDeliveryPointName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingsResponseTest.java deleted file mode 100644 index 033ea2cbf..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointQueueBindingsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBinding; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointQueueBindingLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointQueueBindingsResponse - */ -public class MsgVpnRestDeliveryPointQueueBindingsResponseTest { - private final MsgVpnRestDeliveryPointQueueBindingsResponse model = new MsgVpnRestDeliveryPointQueueBindingsResponse(); - - /** - * Model tests for MsgVpnRestDeliveryPointQueueBindingsResponse - */ - @Test - public void testMsgVpnRestDeliveryPointQueueBindingsResponse() { - // TODO: test MsgVpnRestDeliveryPointQueueBindingsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointResponseTest.java deleted file mode 100644 index 28ba91324..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointResponse - */ -public class MsgVpnRestDeliveryPointResponseTest { - private final MsgVpnRestDeliveryPointResponse model = new MsgVpnRestDeliveryPointResponse(); - - /** - * Model tests for MsgVpnRestDeliveryPointResponse - */ - @Test - public void testMsgVpnRestDeliveryPointResponse() { - // TODO: test MsgVpnRestDeliveryPointResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerLinksTest.java deleted file mode 100644 index 3a620eab0..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerLinksTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointRestConsumerLinks - */ -public class MsgVpnRestDeliveryPointRestConsumerLinksTest { - private final MsgVpnRestDeliveryPointRestConsumerLinks model = new MsgVpnRestDeliveryPointRestConsumerLinks(); - - /** - * Model tests for MsgVpnRestDeliveryPointRestConsumerLinks - */ - @Test - public void testMsgVpnRestDeliveryPointRestConsumerLinks() { - // TODO: test MsgVpnRestDeliveryPointRestConsumerLinks - } - - /** - * Test the property 'oauthJwtClaimsUri' - */ - @Test - public void oauthJwtClaimsUriTest() { - // TODO: test oauthJwtClaimsUri - } - - /** - * Test the property 'tlsTrustedCommonNamesUri' - */ - @Test - public void tlsTrustedCommonNamesUriTest() { - // TODO: test tlsTrustedCommonNamesUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinksTest.java deleted file mode 100644 index 0e550b5e1..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks - */ -public class MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinksTest { - private final MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks model = new MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks(); - - /** - * Model tests for MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks - */ - @Test - public void testMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks() { - // TODO: test MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponseTest.java deleted file mode 100644 index dc7630ea5..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse - */ -public class MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponseTest { - private final MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse model = new MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse(); - - /** - * Model tests for MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse - */ - @Test - public void testMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse() { - // TODO: test MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimTest.java deleted file mode 100644 index d15407a14..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimTest.java +++ /dev/null @@ -1,80 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - */ -public class MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimTest { - private final MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim model = new MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim(); - - /** - * Model tests for MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - */ - @Test - public void testMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim() { - // TODO: test MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'oauthJwtClaimName' - */ - @Test - public void oauthJwtClaimNameTest() { - // TODO: test oauthJwtClaimName - } - - /** - * Test the property 'oauthJwtClaimValue' - */ - @Test - public void oauthJwtClaimValueTest() { - // TODO: test oauthJwtClaimValue - } - - /** - * Test the property 'restConsumerName' - */ - @Test - public void restConsumerNameTest() { - // TODO: test restConsumerName - } - - /** - * Test the property 'restDeliveryPointName' - */ - @Test - public void restDeliveryPointNameTest() { - // TODO: test restDeliveryPointName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponseTest.java deleted file mode 100644 index bdac2f544..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse - */ -public class MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponseTest { - private final MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse model = new MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse(); - - /** - * Model tests for MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse - */ - @Test - public void testMsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse() { - // TODO: test MsgVpnRestDeliveryPointRestConsumerOauthJwtClaimsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerResponseTest.java deleted file mode 100644 index 32383b66e..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumer; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointRestConsumerResponse - */ -public class MsgVpnRestDeliveryPointRestConsumerResponseTest { - private final MsgVpnRestDeliveryPointRestConsumerResponse model = new MsgVpnRestDeliveryPointRestConsumerResponse(); - - /** - * Model tests for MsgVpnRestDeliveryPointRestConsumerResponse - */ - @Test - public void testMsgVpnRestDeliveryPointRestConsumerResponse() { - // TODO: test MsgVpnRestDeliveryPointRestConsumerResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTest.java deleted file mode 100644 index 5840ea001..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTest.java +++ /dev/null @@ -1,280 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointRestConsumer - */ -public class MsgVpnRestDeliveryPointRestConsumerTest { - private final MsgVpnRestDeliveryPointRestConsumer model = new MsgVpnRestDeliveryPointRestConsumer(); - - /** - * Model tests for MsgVpnRestDeliveryPointRestConsumer - */ - @Test - public void testMsgVpnRestDeliveryPointRestConsumer() { - // TODO: test MsgVpnRestDeliveryPointRestConsumer - } - - /** - * Test the property 'authenticationAwsAccessKeyId' - */ - @Test - public void authenticationAwsAccessKeyIdTest() { - // TODO: test authenticationAwsAccessKeyId - } - - /** - * Test the property 'authenticationAwsRegion' - */ - @Test - public void authenticationAwsRegionTest() { - // TODO: test authenticationAwsRegion - } - - /** - * Test the property 'authenticationAwsSecretAccessKey' - */ - @Test - public void authenticationAwsSecretAccessKeyTest() { - // TODO: test authenticationAwsSecretAccessKey - } - - /** - * Test the property 'authenticationAwsService' - */ - @Test - public void authenticationAwsServiceTest() { - // TODO: test authenticationAwsService - } - - /** - * Test the property 'authenticationClientCertContent' - */ - @Test - public void authenticationClientCertContentTest() { - // TODO: test authenticationClientCertContent - } - - /** - * Test the property 'authenticationClientCertPassword' - */ - @Test - public void authenticationClientCertPasswordTest() { - // TODO: test authenticationClientCertPassword - } - - /** - * Test the property 'authenticationHttpBasicPassword' - */ - @Test - public void authenticationHttpBasicPasswordTest() { - // TODO: test authenticationHttpBasicPassword - } - - /** - * Test the property 'authenticationHttpBasicUsername' - */ - @Test - public void authenticationHttpBasicUsernameTest() { - // TODO: test authenticationHttpBasicUsername - } - - /** - * Test the property 'authenticationHttpHeaderName' - */ - @Test - public void authenticationHttpHeaderNameTest() { - // TODO: test authenticationHttpHeaderName - } - - /** - * Test the property 'authenticationHttpHeaderValue' - */ - @Test - public void authenticationHttpHeaderValueTest() { - // TODO: test authenticationHttpHeaderValue - } - - /** - * Test the property 'authenticationOauthClientId' - */ - @Test - public void authenticationOauthClientIdTest() { - // TODO: test authenticationOauthClientId - } - - /** - * Test the property 'authenticationOauthClientScope' - */ - @Test - public void authenticationOauthClientScopeTest() { - // TODO: test authenticationOauthClientScope - } - - /** - * Test the property 'authenticationOauthClientSecret' - */ - @Test - public void authenticationOauthClientSecretTest() { - // TODO: test authenticationOauthClientSecret - } - - /** - * Test the property 'authenticationOauthClientTokenEndpoint' - */ - @Test - public void authenticationOauthClientTokenEndpointTest() { - // TODO: test authenticationOauthClientTokenEndpoint - } - - /** - * Test the property 'authenticationOauthJwtSecretKey' - */ - @Test - public void authenticationOauthJwtSecretKeyTest() { - // TODO: test authenticationOauthJwtSecretKey - } - - /** - * Test the property 'authenticationOauthJwtTokenEndpoint' - */ - @Test - public void authenticationOauthJwtTokenEndpointTest() { - // TODO: test authenticationOauthJwtTokenEndpoint - } - - /** - * Test the property 'authenticationScheme' - */ - @Test - public void authenticationSchemeTest() { - // TODO: test authenticationScheme - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'httpMethod' - */ - @Test - public void httpMethodTest() { - // TODO: test httpMethod - } - - /** - * Test the property 'localInterface' - */ - @Test - public void localInterfaceTest() { - // TODO: test localInterface - } - - /** - * Test the property 'maxPostWaitTime' - */ - @Test - public void maxPostWaitTimeTest() { - // TODO: test maxPostWaitTime - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'outgoingConnectionCount' - */ - @Test - public void outgoingConnectionCountTest() { - // TODO: test outgoingConnectionCount - } - - /** - * Test the property 'remoteHost' - */ - @Test - public void remoteHostTest() { - // TODO: test remoteHost - } - - /** - * Test the property 'remotePort' - */ - @Test - public void remotePortTest() { - // TODO: test remotePort - } - - /** - * Test the property 'restConsumerName' - */ - @Test - public void restConsumerNameTest() { - // TODO: test restConsumerName - } - - /** - * Test the property 'restDeliveryPointName' - */ - @Test - public void restDeliveryPointNameTest() { - // TODO: test restDeliveryPointName - } - - /** - * Test the property 'retryDelay' - */ - @Test - public void retryDelayTest() { - // TODO: test retryDelay - } - - /** - * Test the property 'tlsCipherSuiteList' - */ - @Test - public void tlsCipherSuiteListTest() { - // TODO: test tlsCipherSuiteList - } - - /** - * Test the property 'tlsEnabled' - */ - @Test - public void tlsEnabledTest() { - // TODO: test tlsEnabled - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinksTest.java deleted file mode 100644 index f19f102c9..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks - */ -public class MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinksTest { - private final MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks model = new MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks(); - - /** - * Model tests for MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks - */ - @Test - public void testMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks() { - // TODO: test MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponseTest.java deleted file mode 100644 index e3581a5c1..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse - */ -public class MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponseTest { - private final MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse model = new MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse(); - - /** - * Model tests for MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse - */ - @Test - public void testMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse() { - // TODO: test MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameTest.java deleted file mode 100644 index 936441b49..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - */ -public class MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameTest { - private final MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName model = new MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName(); - - /** - * Model tests for MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - */ - @Test - public void testMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName() { - // TODO: test MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'restConsumerName' - */ - @Test - public void restConsumerNameTest() { - // TODO: test restConsumerName - } - - /** - * Test the property 'restDeliveryPointName' - */ - @Test - public void restDeliveryPointNameTest() { - // TODO: test restDeliveryPointName - } - - /** - * Test the property 'tlsTrustedCommonName' - */ - @Test - public void tlsTrustedCommonNameTest() { - // TODO: test tlsTrustedCommonName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponseTest.java deleted file mode 100644 index 16a7e08fc..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNameLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse - */ -public class MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponseTest { - private final MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse model = new MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse(); - - /** - * Model tests for MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse - */ - @Test - public void testMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse() { - // TODO: test MsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNamesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumersResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumersResponseTest.java deleted file mode 100644 index 3bdeb1531..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointRestConsumersResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumer; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointRestConsumerLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointRestConsumersResponse - */ -public class MsgVpnRestDeliveryPointRestConsumersResponseTest { - private final MsgVpnRestDeliveryPointRestConsumersResponse model = new MsgVpnRestDeliveryPointRestConsumersResponse(); - - /** - * Model tests for MsgVpnRestDeliveryPointRestConsumersResponse - */ - @Test - public void testMsgVpnRestDeliveryPointRestConsumersResponse() { - // TODO: test MsgVpnRestDeliveryPointRestConsumersResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointTest.java deleted file mode 100644 index 1ff9df0d6..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointTest.java +++ /dev/null @@ -1,88 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPoint - */ -public class MsgVpnRestDeliveryPointTest { - private final MsgVpnRestDeliveryPoint model = new MsgVpnRestDeliveryPoint(); - - /** - * Model tests for MsgVpnRestDeliveryPoint - */ - @Test - public void testMsgVpnRestDeliveryPoint() { - // TODO: test MsgVpnRestDeliveryPoint - } - - /** - * Test the property 'clientProfileName' - */ - @Test - public void clientProfileNameTest() { - // TODO: test clientProfileName - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'restDeliveryPointName' - */ - @Test - public void restDeliveryPointNameTest() { - // TODO: test restDeliveryPointName - } - - /** - * Test the property 'service' - */ - @Test - public void serviceTest() { - // TODO: test service - } - - /** - * Test the property 'vendor' - */ - @Test - public void vendorTest() { - // TODO: test vendor - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointsResponseTest.java deleted file mode 100644 index c73390c3a..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnRestDeliveryPointsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnRestDeliveryPointLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnRestDeliveryPointsResponse - */ -public class MsgVpnRestDeliveryPointsResponseTest { - private final MsgVpnRestDeliveryPointsResponse model = new MsgVpnRestDeliveryPointsResponse(); - - /** - * Model tests for MsgVpnRestDeliveryPointsResponse - */ - @Test - public void testMsgVpnRestDeliveryPointsResponse() { - // TODO: test MsgVpnRestDeliveryPointsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicLinksTest.java deleted file mode 100644 index 8cdee44ce..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnSequencedTopicLinks - */ -public class MsgVpnSequencedTopicLinksTest { - private final MsgVpnSequencedTopicLinks model = new MsgVpnSequencedTopicLinks(); - - /** - * Model tests for MsgVpnSequencedTopicLinks - */ - @Test - public void testMsgVpnSequencedTopicLinks() { - // TODO: test MsgVpnSequencedTopicLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicResponseTest.java deleted file mode 100644 index f1ed0398b..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopicLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnSequencedTopicResponse - */ -public class MsgVpnSequencedTopicResponseTest { - private final MsgVpnSequencedTopicResponse model = new MsgVpnSequencedTopicResponse(); - - /** - * Model tests for MsgVpnSequencedTopicResponse - */ - @Test - public void testMsgVpnSequencedTopicResponse() { - // TODO: test MsgVpnSequencedTopicResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicTest.java deleted file mode 100644 index 2c25b5e55..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnSequencedTopic - */ -public class MsgVpnSequencedTopicTest { - private final MsgVpnSequencedTopic model = new MsgVpnSequencedTopic(); - - /** - * Model tests for MsgVpnSequencedTopic - */ - @Test - public void testMsgVpnSequencedTopic() { - // TODO: test MsgVpnSequencedTopic - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'sequencedTopic' - */ - @Test - public void sequencedTopicTest() { - // TODO: test sequencedTopic - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicsResponseTest.java deleted file mode 100644 index 2a0b72e7a..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnSequencedTopicsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopic; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnSequencedTopicLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnSequencedTopicsResponse - */ -public class MsgVpnSequencedTopicsResponseTest { - private final MsgVpnSequencedTopicsResponse model = new MsgVpnSequencedTopicsResponse(); - - /** - * Model tests for MsgVpnSequencedTopicsResponse - */ - @Test - public void testMsgVpnSequencedTopicsResponse() { - // TODO: test MsgVpnSequencedTopicsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTest.java deleted file mode 100644 index 7d16c2aed..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTest.java +++ /dev/null @@ -1,1010 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThresholdByValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpn - */ -public class MsgVpnTest { - private final MsgVpn model = new MsgVpn(); - - /** - * Model tests for MsgVpn - */ - @Test - public void testMsgVpn() { - // TODO: test MsgVpn - } - - /** - * Test the property 'alias' - */ - @Test - public void aliasTest() { - // TODO: test alias - } - - /** - * Test the property 'authenticationBasicEnabled' - */ - @Test - public void authenticationBasicEnabledTest() { - // TODO: test authenticationBasicEnabled - } - - /** - * Test the property 'authenticationBasicProfileName' - */ - @Test - public void authenticationBasicProfileNameTest() { - // TODO: test authenticationBasicProfileName - } - - /** - * Test the property 'authenticationBasicRadiusDomain' - */ - @Test - public void authenticationBasicRadiusDomainTest() { - // TODO: test authenticationBasicRadiusDomain - } - - /** - * Test the property 'authenticationBasicType' - */ - @Test - public void authenticationBasicTypeTest() { - // TODO: test authenticationBasicType - } - - /** - * Test the property 'authenticationClientCertAllowApiProvidedUsernameEnabled' - */ - @Test - public void authenticationClientCertAllowApiProvidedUsernameEnabledTest() { - // TODO: test authenticationClientCertAllowApiProvidedUsernameEnabled - } - - /** - * Test the property 'authenticationClientCertCertificateMatchingRulesEnabled' - */ - @Test - public void authenticationClientCertCertificateMatchingRulesEnabledTest() { - // TODO: test authenticationClientCertCertificateMatchingRulesEnabled - } - - /** - * Test the property 'authenticationClientCertEnabled' - */ - @Test - public void authenticationClientCertEnabledTest() { - // TODO: test authenticationClientCertEnabled - } - - /** - * Test the property 'authenticationClientCertMaxChainDepth' - */ - @Test - public void authenticationClientCertMaxChainDepthTest() { - // TODO: test authenticationClientCertMaxChainDepth - } - - /** - * Test the property 'authenticationClientCertRevocationCheckMode' - */ - @Test - public void authenticationClientCertRevocationCheckModeTest() { - // TODO: test authenticationClientCertRevocationCheckMode - } - - /** - * Test the property 'authenticationClientCertUsernameSource' - */ - @Test - public void authenticationClientCertUsernameSourceTest() { - // TODO: test authenticationClientCertUsernameSource - } - - /** - * Test the property 'authenticationClientCertValidateDateEnabled' - */ - @Test - public void authenticationClientCertValidateDateEnabledTest() { - // TODO: test authenticationClientCertValidateDateEnabled - } - - /** - * Test the property 'authenticationKerberosAllowApiProvidedUsernameEnabled' - */ - @Test - public void authenticationKerberosAllowApiProvidedUsernameEnabledTest() { - // TODO: test authenticationKerberosAllowApiProvidedUsernameEnabled - } - - /** - * Test the property 'authenticationKerberosEnabled' - */ - @Test - public void authenticationKerberosEnabledTest() { - // TODO: test authenticationKerberosEnabled - } - - /** - * Test the property 'authenticationOauthDefaultProfileName' - */ - @Test - public void authenticationOauthDefaultProfileNameTest() { - // TODO: test authenticationOauthDefaultProfileName - } - - /** - * Test the property 'authenticationOauthDefaultProviderName' - */ - @Test - public void authenticationOauthDefaultProviderNameTest() { - // TODO: test authenticationOauthDefaultProviderName - } - - /** - * Test the property 'authenticationOauthEnabled' - */ - @Test - public void authenticationOauthEnabledTest() { - // TODO: test authenticationOauthEnabled - } - - /** - * Test the property 'authorizationLdapGroupMembershipAttributeName' - */ - @Test - public void authorizationLdapGroupMembershipAttributeNameTest() { - // TODO: test authorizationLdapGroupMembershipAttributeName - } - - /** - * Test the property 'authorizationLdapTrimClientUsernameDomainEnabled' - */ - @Test - public void authorizationLdapTrimClientUsernameDomainEnabledTest() { - // TODO: test authorizationLdapTrimClientUsernameDomainEnabled - } - - /** - * Test the property 'authorizationProfileName' - */ - @Test - public void authorizationProfileNameTest() { - // TODO: test authorizationProfileName - } - - /** - * Test the property 'authorizationType' - */ - @Test - public void authorizationTypeTest() { - // TODO: test authorizationType - } - - /** - * Test the property 'bridgingTlsServerCertEnforceTrustedCommonNameEnabled' - */ - @Test - public void bridgingTlsServerCertEnforceTrustedCommonNameEnabledTest() { - // TODO: test bridgingTlsServerCertEnforceTrustedCommonNameEnabled - } - - /** - * Test the property 'bridgingTlsServerCertMaxChainDepth' - */ - @Test - public void bridgingTlsServerCertMaxChainDepthTest() { - // TODO: test bridgingTlsServerCertMaxChainDepth - } - - /** - * Test the property 'bridgingTlsServerCertValidateDateEnabled' - */ - @Test - public void bridgingTlsServerCertValidateDateEnabledTest() { - // TODO: test bridgingTlsServerCertValidateDateEnabled - } - - /** - * Test the property 'bridgingTlsServerCertValidateNameEnabled' - */ - @Test - public void bridgingTlsServerCertValidateNameEnabledTest() { - // TODO: test bridgingTlsServerCertValidateNameEnabled - } - - /** - * Test the property 'distributedCacheManagementEnabled' - */ - @Test - public void distributedCacheManagementEnabledTest() { - // TODO: test distributedCacheManagementEnabled - } - - /** - * Test the property 'dmrEnabled' - */ - @Test - public void dmrEnabledTest() { - // TODO: test dmrEnabled - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'eventConnectionCountThreshold' - */ - @Test - public void eventConnectionCountThresholdTest() { - // TODO: test eventConnectionCountThreshold - } - - /** - * Test the property 'eventEgressFlowCountThreshold' - */ - @Test - public void eventEgressFlowCountThresholdTest() { - // TODO: test eventEgressFlowCountThreshold - } - - /** - * Test the property 'eventEgressMsgRateThreshold' - */ - @Test - public void eventEgressMsgRateThresholdTest() { - // TODO: test eventEgressMsgRateThreshold - } - - /** - * Test the property 'eventEndpointCountThreshold' - */ - @Test - public void eventEndpointCountThresholdTest() { - // TODO: test eventEndpointCountThreshold - } - - /** - * Test the property 'eventIngressFlowCountThreshold' - */ - @Test - public void eventIngressFlowCountThresholdTest() { - // TODO: test eventIngressFlowCountThreshold - } - - /** - * Test the property 'eventIngressMsgRateThreshold' - */ - @Test - public void eventIngressMsgRateThresholdTest() { - // TODO: test eventIngressMsgRateThreshold - } - - /** - * Test the property 'eventLargeMsgThreshold' - */ - @Test - public void eventLargeMsgThresholdTest() { - // TODO: test eventLargeMsgThreshold - } - - /** - * Test the property 'eventLogTag' - */ - @Test - public void eventLogTagTest() { - // TODO: test eventLogTag - } - - /** - * Test the property 'eventMsgSpoolUsageThreshold' - */ - @Test - public void eventMsgSpoolUsageThresholdTest() { - // TODO: test eventMsgSpoolUsageThreshold - } - - /** - * Test the property 'eventPublishClientEnabled' - */ - @Test - public void eventPublishClientEnabledTest() { - // TODO: test eventPublishClientEnabled - } - - /** - * Test the property 'eventPublishMsgVpnEnabled' - */ - @Test - public void eventPublishMsgVpnEnabledTest() { - // TODO: test eventPublishMsgVpnEnabled - } - - /** - * Test the property 'eventPublishSubscriptionMode' - */ - @Test - public void eventPublishSubscriptionModeTest() { - // TODO: test eventPublishSubscriptionMode - } - - /** - * Test the property 'eventPublishTopicFormatMqttEnabled' - */ - @Test - public void eventPublishTopicFormatMqttEnabledTest() { - // TODO: test eventPublishTopicFormatMqttEnabled - } - - /** - * Test the property 'eventPublishTopicFormatSmfEnabled' - */ - @Test - public void eventPublishTopicFormatSmfEnabledTest() { - // TODO: test eventPublishTopicFormatSmfEnabled - } - - /** - * Test the property 'eventServiceAmqpConnectionCountThreshold' - */ - @Test - public void eventServiceAmqpConnectionCountThresholdTest() { - // TODO: test eventServiceAmqpConnectionCountThreshold - } - - /** - * Test the property 'eventServiceMqttConnectionCountThreshold' - */ - @Test - public void eventServiceMqttConnectionCountThresholdTest() { - // TODO: test eventServiceMqttConnectionCountThreshold - } - - /** - * Test the property 'eventServiceRestIncomingConnectionCountThreshold' - */ - @Test - public void eventServiceRestIncomingConnectionCountThresholdTest() { - // TODO: test eventServiceRestIncomingConnectionCountThreshold - } - - /** - * Test the property 'eventServiceSmfConnectionCountThreshold' - */ - @Test - public void eventServiceSmfConnectionCountThresholdTest() { - // TODO: test eventServiceSmfConnectionCountThreshold - } - - /** - * Test the property 'eventServiceWebConnectionCountThreshold' - */ - @Test - public void eventServiceWebConnectionCountThresholdTest() { - // TODO: test eventServiceWebConnectionCountThreshold - } - - /** - * Test the property 'eventSubscriptionCountThreshold' - */ - @Test - public void eventSubscriptionCountThresholdTest() { - // TODO: test eventSubscriptionCountThreshold - } - - /** - * Test the property 'eventTransactedSessionCountThreshold' - */ - @Test - public void eventTransactedSessionCountThresholdTest() { - // TODO: test eventTransactedSessionCountThreshold - } - - /** - * Test the property 'eventTransactionCountThreshold' - */ - @Test - public void eventTransactionCountThresholdTest() { - // TODO: test eventTransactionCountThreshold - } - - /** - * Test the property 'exportSubscriptionsEnabled' - */ - @Test - public void exportSubscriptionsEnabledTest() { - // TODO: test exportSubscriptionsEnabled - } - - /** - * Test the property 'jndiEnabled' - */ - @Test - public void jndiEnabledTest() { - // TODO: test jndiEnabled - } - - /** - * Test the property 'maxConnectionCount' - */ - @Test - public void maxConnectionCountTest() { - // TODO: test maxConnectionCount - } - - /** - * Test the property 'maxEgressFlowCount' - */ - @Test - public void maxEgressFlowCountTest() { - // TODO: test maxEgressFlowCount - } - - /** - * Test the property 'maxEndpointCount' - */ - @Test - public void maxEndpointCountTest() { - // TODO: test maxEndpointCount - } - - /** - * Test the property 'maxIngressFlowCount' - */ - @Test - public void maxIngressFlowCountTest() { - // TODO: test maxIngressFlowCount - } - - /** - * Test the property 'maxMsgSpoolUsage' - */ - @Test - public void maxMsgSpoolUsageTest() { - // TODO: test maxMsgSpoolUsage - } - - /** - * Test the property 'maxSubscriptionCount' - */ - @Test - public void maxSubscriptionCountTest() { - // TODO: test maxSubscriptionCount - } - - /** - * Test the property 'maxTransactedSessionCount' - */ - @Test - public void maxTransactedSessionCountTest() { - // TODO: test maxTransactedSessionCount - } - - /** - * Test the property 'maxTransactionCount' - */ - @Test - public void maxTransactionCountTest() { - // TODO: test maxTransactionCount - } - - /** - * Test the property 'mqttRetainMaxMemory' - */ - @Test - public void mqttRetainMaxMemoryTest() { - // TODO: test mqttRetainMaxMemory - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'replicationAckPropagationIntervalMsgCount' - */ - @Test - public void replicationAckPropagationIntervalMsgCountTest() { - // TODO: test replicationAckPropagationIntervalMsgCount - } - - /** - * Test the property 'replicationBridgeAuthenticationBasicClientUsername' - */ - @Test - public void replicationBridgeAuthenticationBasicClientUsernameTest() { - // TODO: test replicationBridgeAuthenticationBasicClientUsername - } - - /** - * Test the property 'replicationBridgeAuthenticationBasicPassword' - */ - @Test - public void replicationBridgeAuthenticationBasicPasswordTest() { - // TODO: test replicationBridgeAuthenticationBasicPassword - } - - /** - * Test the property 'replicationBridgeAuthenticationClientCertContent' - */ - @Test - public void replicationBridgeAuthenticationClientCertContentTest() { - // TODO: test replicationBridgeAuthenticationClientCertContent - } - - /** - * Test the property 'replicationBridgeAuthenticationClientCertPassword' - */ - @Test - public void replicationBridgeAuthenticationClientCertPasswordTest() { - // TODO: test replicationBridgeAuthenticationClientCertPassword - } - - /** - * Test the property 'replicationBridgeAuthenticationScheme' - */ - @Test - public void replicationBridgeAuthenticationSchemeTest() { - // TODO: test replicationBridgeAuthenticationScheme - } - - /** - * Test the property 'replicationBridgeCompressedDataEnabled' - */ - @Test - public void replicationBridgeCompressedDataEnabledTest() { - // TODO: test replicationBridgeCompressedDataEnabled - } - - /** - * Test the property 'replicationBridgeEgressFlowWindowSize' - */ - @Test - public void replicationBridgeEgressFlowWindowSizeTest() { - // TODO: test replicationBridgeEgressFlowWindowSize - } - - /** - * Test the property 'replicationBridgeRetryDelay' - */ - @Test - public void replicationBridgeRetryDelayTest() { - // TODO: test replicationBridgeRetryDelay - } - - /** - * Test the property 'replicationBridgeTlsEnabled' - */ - @Test - public void replicationBridgeTlsEnabledTest() { - // TODO: test replicationBridgeTlsEnabled - } - - /** - * Test the property 'replicationBridgeUnidirectionalClientProfileName' - */ - @Test - public void replicationBridgeUnidirectionalClientProfileNameTest() { - // TODO: test replicationBridgeUnidirectionalClientProfileName - } - - /** - * Test the property 'replicationEnabled' - */ - @Test - public void replicationEnabledTest() { - // TODO: test replicationEnabled - } - - /** - * Test the property 'replicationEnabledQueueBehavior' - */ - @Test - public void replicationEnabledQueueBehaviorTest() { - // TODO: test replicationEnabledQueueBehavior - } - - /** - * Test the property 'replicationQueueMaxMsgSpoolUsage' - */ - @Test - public void replicationQueueMaxMsgSpoolUsageTest() { - // TODO: test replicationQueueMaxMsgSpoolUsage - } - - /** - * Test the property 'replicationQueueRejectMsgToSenderOnDiscardEnabled' - */ - @Test - public void replicationQueueRejectMsgToSenderOnDiscardEnabledTest() { - // TODO: test replicationQueueRejectMsgToSenderOnDiscardEnabled - } - - /** - * Test the property 'replicationRejectMsgWhenSyncIneligibleEnabled' - */ - @Test - public void replicationRejectMsgWhenSyncIneligibleEnabledTest() { - // TODO: test replicationRejectMsgWhenSyncIneligibleEnabled - } - - /** - * Test the property 'replicationRole' - */ - @Test - public void replicationRoleTest() { - // TODO: test replicationRole - } - - /** - * Test the property 'replicationTransactionMode' - */ - @Test - public void replicationTransactionModeTest() { - // TODO: test replicationTransactionMode - } - - /** - * Test the property 'restTlsServerCertEnforceTrustedCommonNameEnabled' - */ - @Test - public void restTlsServerCertEnforceTrustedCommonNameEnabledTest() { - // TODO: test restTlsServerCertEnforceTrustedCommonNameEnabled - } - - /** - * Test the property 'restTlsServerCertMaxChainDepth' - */ - @Test - public void restTlsServerCertMaxChainDepthTest() { - // TODO: test restTlsServerCertMaxChainDepth - } - - /** - * Test the property 'restTlsServerCertValidateDateEnabled' - */ - @Test - public void restTlsServerCertValidateDateEnabledTest() { - // TODO: test restTlsServerCertValidateDateEnabled - } - - /** - * Test the property 'restTlsServerCertValidateNameEnabled' - */ - @Test - public void restTlsServerCertValidateNameEnabledTest() { - // TODO: test restTlsServerCertValidateNameEnabled - } - - /** - * Test the property 'sempOverMsgBusAdminClientEnabled' - */ - @Test - public void sempOverMsgBusAdminClientEnabledTest() { - // TODO: test sempOverMsgBusAdminClientEnabled - } - - /** - * Test the property 'sempOverMsgBusAdminDistributedCacheEnabled' - */ - @Test - public void sempOverMsgBusAdminDistributedCacheEnabledTest() { - // TODO: test sempOverMsgBusAdminDistributedCacheEnabled - } - - /** - * Test the property 'sempOverMsgBusAdminEnabled' - */ - @Test - public void sempOverMsgBusAdminEnabledTest() { - // TODO: test sempOverMsgBusAdminEnabled - } - - /** - * Test the property 'sempOverMsgBusEnabled' - */ - @Test - public void sempOverMsgBusEnabledTest() { - // TODO: test sempOverMsgBusEnabled - } - - /** - * Test the property 'sempOverMsgBusShowEnabled' - */ - @Test - public void sempOverMsgBusShowEnabledTest() { - // TODO: test sempOverMsgBusShowEnabled - } - - /** - * Test the property 'serviceAmqpMaxConnectionCount' - */ - @Test - public void serviceAmqpMaxConnectionCountTest() { - // TODO: test serviceAmqpMaxConnectionCount - } - - /** - * Test the property 'serviceAmqpPlainTextEnabled' - */ - @Test - public void serviceAmqpPlainTextEnabledTest() { - // TODO: test serviceAmqpPlainTextEnabled - } - - /** - * Test the property 'serviceAmqpPlainTextListenPort' - */ - @Test - public void serviceAmqpPlainTextListenPortTest() { - // TODO: test serviceAmqpPlainTextListenPort - } - - /** - * Test the property 'serviceAmqpTlsEnabled' - */ - @Test - public void serviceAmqpTlsEnabledTest() { - // TODO: test serviceAmqpTlsEnabled - } - - /** - * Test the property 'serviceAmqpTlsListenPort' - */ - @Test - public void serviceAmqpTlsListenPortTest() { - // TODO: test serviceAmqpTlsListenPort - } - - /** - * Test the property 'serviceMqttAuthenticationClientCertRequest' - */ - @Test - public void serviceMqttAuthenticationClientCertRequestTest() { - // TODO: test serviceMqttAuthenticationClientCertRequest - } - - /** - * Test the property 'serviceMqttMaxConnectionCount' - */ - @Test - public void serviceMqttMaxConnectionCountTest() { - // TODO: test serviceMqttMaxConnectionCount - } - - /** - * Test the property 'serviceMqttPlainTextEnabled' - */ - @Test - public void serviceMqttPlainTextEnabledTest() { - // TODO: test serviceMqttPlainTextEnabled - } - - /** - * Test the property 'serviceMqttPlainTextListenPort' - */ - @Test - public void serviceMqttPlainTextListenPortTest() { - // TODO: test serviceMqttPlainTextListenPort - } - - /** - * Test the property 'serviceMqttTlsEnabled' - */ - @Test - public void serviceMqttTlsEnabledTest() { - // TODO: test serviceMqttTlsEnabled - } - - /** - * Test the property 'serviceMqttTlsListenPort' - */ - @Test - public void serviceMqttTlsListenPortTest() { - // TODO: test serviceMqttTlsListenPort - } - - /** - * Test the property 'serviceMqttTlsWebSocketEnabled' - */ - @Test - public void serviceMqttTlsWebSocketEnabledTest() { - // TODO: test serviceMqttTlsWebSocketEnabled - } - - /** - * Test the property 'serviceMqttTlsWebSocketListenPort' - */ - @Test - public void serviceMqttTlsWebSocketListenPortTest() { - // TODO: test serviceMqttTlsWebSocketListenPort - } - - /** - * Test the property 'serviceMqttWebSocketEnabled' - */ - @Test - public void serviceMqttWebSocketEnabledTest() { - // TODO: test serviceMqttWebSocketEnabled - } - - /** - * Test the property 'serviceMqttWebSocketListenPort' - */ - @Test - public void serviceMqttWebSocketListenPortTest() { - // TODO: test serviceMqttWebSocketListenPort - } - - /** - * Test the property 'serviceRestIncomingAuthenticationClientCertRequest' - */ - @Test - public void serviceRestIncomingAuthenticationClientCertRequestTest() { - // TODO: test serviceRestIncomingAuthenticationClientCertRequest - } - - /** - * Test the property 'serviceRestIncomingAuthorizationHeaderHandling' - */ - @Test - public void serviceRestIncomingAuthorizationHeaderHandlingTest() { - // TODO: test serviceRestIncomingAuthorizationHeaderHandling - } - - /** - * Test the property 'serviceRestIncomingMaxConnectionCount' - */ - @Test - public void serviceRestIncomingMaxConnectionCountTest() { - // TODO: test serviceRestIncomingMaxConnectionCount - } - - /** - * Test the property 'serviceRestIncomingPlainTextEnabled' - */ - @Test - public void serviceRestIncomingPlainTextEnabledTest() { - // TODO: test serviceRestIncomingPlainTextEnabled - } - - /** - * Test the property 'serviceRestIncomingPlainTextListenPort' - */ - @Test - public void serviceRestIncomingPlainTextListenPortTest() { - // TODO: test serviceRestIncomingPlainTextListenPort - } - - /** - * Test the property 'serviceRestIncomingTlsEnabled' - */ - @Test - public void serviceRestIncomingTlsEnabledTest() { - // TODO: test serviceRestIncomingTlsEnabled - } - - /** - * Test the property 'serviceRestIncomingTlsListenPort' - */ - @Test - public void serviceRestIncomingTlsListenPortTest() { - // TODO: test serviceRestIncomingTlsListenPort - } - - /** - * Test the property 'serviceRestMode' - */ - @Test - public void serviceRestModeTest() { - // TODO: test serviceRestMode - } - - /** - * Test the property 'serviceRestOutgoingMaxConnectionCount' - */ - @Test - public void serviceRestOutgoingMaxConnectionCountTest() { - // TODO: test serviceRestOutgoingMaxConnectionCount - } - - /** - * Test the property 'serviceSmfMaxConnectionCount' - */ - @Test - public void serviceSmfMaxConnectionCountTest() { - // TODO: test serviceSmfMaxConnectionCount - } - - /** - * Test the property 'serviceSmfPlainTextEnabled' - */ - @Test - public void serviceSmfPlainTextEnabledTest() { - // TODO: test serviceSmfPlainTextEnabled - } - - /** - * Test the property 'serviceSmfTlsEnabled' - */ - @Test - public void serviceSmfTlsEnabledTest() { - // TODO: test serviceSmfTlsEnabled - } - - /** - * Test the property 'serviceWebAuthenticationClientCertRequest' - */ - @Test - public void serviceWebAuthenticationClientCertRequestTest() { - // TODO: test serviceWebAuthenticationClientCertRequest - } - - /** - * Test the property 'serviceWebMaxConnectionCount' - */ - @Test - public void serviceWebMaxConnectionCountTest() { - // TODO: test serviceWebMaxConnectionCount - } - - /** - * Test the property 'serviceWebPlainTextEnabled' - */ - @Test - public void serviceWebPlainTextEnabledTest() { - // TODO: test serviceWebPlainTextEnabled - } - - /** - * Test the property 'serviceWebTlsEnabled' - */ - @Test - public void serviceWebTlsEnabledTest() { - // TODO: test serviceWebTlsEnabled - } - - /** - * Test the property 'tlsAllowDowngradeToPlainTextEnabled' - */ - @Test - public void tlsAllowDowngradeToPlainTextEnabledTest() { - // TODO: test tlsAllowDowngradeToPlainTextEnabled - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointLinksTest.java deleted file mode 100644 index ad283861c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnTopicEndpointLinks - */ -public class MsgVpnTopicEndpointLinksTest { - private final MsgVpnTopicEndpointLinks model = new MsgVpnTopicEndpointLinks(); - - /** - * Model tests for MsgVpnTopicEndpointLinks - */ - @Test - public void testMsgVpnTopicEndpointLinks() { - // TODO: test MsgVpnTopicEndpointLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointResponseTest.java deleted file mode 100644 index c06721cb8..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnTopicEndpointResponse - */ -public class MsgVpnTopicEndpointResponseTest { - private final MsgVpnTopicEndpointResponse model = new MsgVpnTopicEndpointResponse(); - - /** - * Model tests for MsgVpnTopicEndpointResponse - */ - @Test - public void testMsgVpnTopicEndpointResponse() { - // TODO: test MsgVpnTopicEndpointResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateLinksTest.java deleted file mode 100644 index 4d963352b..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnTopicEndpointTemplateLinks - */ -public class MsgVpnTopicEndpointTemplateLinksTest { - private final MsgVpnTopicEndpointTemplateLinks model = new MsgVpnTopicEndpointTemplateLinks(); - - /** - * Model tests for MsgVpnTopicEndpointTemplateLinks - */ - @Test - public void testMsgVpnTopicEndpointTemplateLinks() { - // TODO: test MsgVpnTopicEndpointTemplateLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateResponseTest.java deleted file mode 100644 index e6551cb12..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplateLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnTopicEndpointTemplateResponse - */ -public class MsgVpnTopicEndpointTemplateResponseTest { - private final MsgVpnTopicEndpointTemplateResponse model = new MsgVpnTopicEndpointTemplateResponse(); - - /** - * Model tests for MsgVpnTopicEndpointTemplateResponse - */ - @Test - public void testMsgVpnTopicEndpointTemplateResponse() { - // TODO: test MsgVpnTopicEndpointTemplateResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateTest.java deleted file mode 100644 index 5d2a65c93..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplateTest.java +++ /dev/null @@ -1,225 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnTopicEndpointTemplate - */ -public class MsgVpnTopicEndpointTemplateTest { - private final MsgVpnTopicEndpointTemplate model = new MsgVpnTopicEndpointTemplate(); - - /** - * Model tests for MsgVpnTopicEndpointTemplate - */ - @Test - public void testMsgVpnTopicEndpointTemplate() { - // TODO: test MsgVpnTopicEndpointTemplate - } - - /** - * Test the property 'accessType' - */ - @Test - public void accessTypeTest() { - // TODO: test accessType - } - - /** - * Test the property 'consumerAckPropagationEnabled' - */ - @Test - public void consumerAckPropagationEnabledTest() { - // TODO: test consumerAckPropagationEnabled - } - - /** - * Test the property 'deadMsgQueue' - */ - @Test - public void deadMsgQueueTest() { - // TODO: test deadMsgQueue - } - - /** - * Test the property 'deliveryDelay' - */ - @Test - public void deliveryDelayTest() { - // TODO: test deliveryDelay - } - - /** - * Test the property 'eventBindCountThreshold' - */ - @Test - public void eventBindCountThresholdTest() { - // TODO: test eventBindCountThreshold - } - - /** - * Test the property 'eventMsgSpoolUsageThreshold' - */ - @Test - public void eventMsgSpoolUsageThresholdTest() { - // TODO: test eventMsgSpoolUsageThreshold - } - - /** - * Test the property 'eventRejectLowPriorityMsgLimitThreshold' - */ - @Test - public void eventRejectLowPriorityMsgLimitThresholdTest() { - // TODO: test eventRejectLowPriorityMsgLimitThreshold - } - - /** - * Test the property 'maxBindCount' - */ - @Test - public void maxBindCountTest() { - // TODO: test maxBindCount - } - - /** - * Test the property 'maxDeliveredUnackedMsgsPerFlow' - */ - @Test - public void maxDeliveredUnackedMsgsPerFlowTest() { - // TODO: test maxDeliveredUnackedMsgsPerFlow - } - - /** - * Test the property 'maxMsgSize' - */ - @Test - public void maxMsgSizeTest() { - // TODO: test maxMsgSize - } - - /** - * Test the property 'maxMsgSpoolUsage' - */ - @Test - public void maxMsgSpoolUsageTest() { - // TODO: test maxMsgSpoolUsage - } - - /** - * Test the property 'maxRedeliveryCount' - */ - @Test - public void maxRedeliveryCountTest() { - // TODO: test maxRedeliveryCount - } - - /** - * Test the property 'maxTtl' - */ - @Test - public void maxTtlTest() { - // TODO: test maxTtl - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'permission' - */ - @Test - public void permissionTest() { - // TODO: test permission - } - - /** - * Test the property 'redeliveryEnabled' - */ - @Test - public void redeliveryEnabledTest() { - // TODO: test redeliveryEnabled - } - - /** - * Test the property 'rejectLowPriorityMsgEnabled' - */ - @Test - public void rejectLowPriorityMsgEnabledTest() { - // TODO: test rejectLowPriorityMsgEnabled - } - - /** - * Test the property 'rejectLowPriorityMsgLimit' - */ - @Test - public void rejectLowPriorityMsgLimitTest() { - // TODO: test rejectLowPriorityMsgLimit - } - - /** - * Test the property 'rejectMsgToSenderOnDiscardBehavior' - */ - @Test - public void rejectMsgToSenderOnDiscardBehaviorTest() { - // TODO: test rejectMsgToSenderOnDiscardBehavior - } - - /** - * Test the property 'respectMsgPriorityEnabled' - */ - @Test - public void respectMsgPriorityEnabledTest() { - // TODO: test respectMsgPriorityEnabled - } - - /** - * Test the property 'respectTtlEnabled' - */ - @Test - public void respectTtlEnabledTest() { - // TODO: test respectTtlEnabled - } - - /** - * Test the property 'topicEndpointNameFilter' - */ - @Test - public void topicEndpointNameFilterTest() { - // TODO: test topicEndpointNameFilter - } - - /** - * Test the property 'topicEndpointTemplateName' - */ - @Test - public void topicEndpointTemplateNameTest() { - // TODO: test topicEndpointTemplateName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplatesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplatesResponseTest.java deleted file mode 100644 index c3de2dc92..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTemplatesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplate; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointTemplateLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnTopicEndpointTemplatesResponse - */ -public class MsgVpnTopicEndpointTemplatesResponseTest { - private final MsgVpnTopicEndpointTemplatesResponse model = new MsgVpnTopicEndpointTemplatesResponse(); - - /** - * Model tests for MsgVpnTopicEndpointTemplatesResponse - */ - @Test - public void testMsgVpnTopicEndpointTemplatesResponse() { - // TODO: test MsgVpnTopicEndpointTemplatesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTest.java deleted file mode 100644 index 73f0ef768..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointTest.java +++ /dev/null @@ -1,249 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.EventThreshold; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnTopicEndpoint - */ -public class MsgVpnTopicEndpointTest { - private final MsgVpnTopicEndpoint model = new MsgVpnTopicEndpoint(); - - /** - * Model tests for MsgVpnTopicEndpoint - */ - @Test - public void testMsgVpnTopicEndpoint() { - // TODO: test MsgVpnTopicEndpoint - } - - /** - * Test the property 'accessType' - */ - @Test - public void accessTypeTest() { - // TODO: test accessType - } - - /** - * Test the property 'consumerAckPropagationEnabled' - */ - @Test - public void consumerAckPropagationEnabledTest() { - // TODO: test consumerAckPropagationEnabled - } - - /** - * Test the property 'deadMsgQueue' - */ - @Test - public void deadMsgQueueTest() { - // TODO: test deadMsgQueue - } - - /** - * Test the property 'deliveryCountEnabled' - */ - @Test - public void deliveryCountEnabledTest() { - // TODO: test deliveryCountEnabled - } - - /** - * Test the property 'deliveryDelay' - */ - @Test - public void deliveryDelayTest() { - // TODO: test deliveryDelay - } - - /** - * Test the property 'egressEnabled' - */ - @Test - public void egressEnabledTest() { - // TODO: test egressEnabled - } - - /** - * Test the property 'eventBindCountThreshold' - */ - @Test - public void eventBindCountThresholdTest() { - // TODO: test eventBindCountThreshold - } - - /** - * Test the property 'eventRejectLowPriorityMsgLimitThreshold' - */ - @Test - public void eventRejectLowPriorityMsgLimitThresholdTest() { - // TODO: test eventRejectLowPriorityMsgLimitThreshold - } - - /** - * Test the property 'eventSpoolUsageThreshold' - */ - @Test - public void eventSpoolUsageThresholdTest() { - // TODO: test eventSpoolUsageThreshold - } - - /** - * Test the property 'ingressEnabled' - */ - @Test - public void ingressEnabledTest() { - // TODO: test ingressEnabled - } - - /** - * Test the property 'maxBindCount' - */ - @Test - public void maxBindCountTest() { - // TODO: test maxBindCount - } - - /** - * Test the property 'maxDeliveredUnackedMsgsPerFlow' - */ - @Test - public void maxDeliveredUnackedMsgsPerFlowTest() { - // TODO: test maxDeliveredUnackedMsgsPerFlow - } - - /** - * Test the property 'maxMsgSize' - */ - @Test - public void maxMsgSizeTest() { - // TODO: test maxMsgSize - } - - /** - * Test the property 'maxRedeliveryCount' - */ - @Test - public void maxRedeliveryCountTest() { - // TODO: test maxRedeliveryCount - } - - /** - * Test the property 'maxSpoolUsage' - */ - @Test - public void maxSpoolUsageTest() { - // TODO: test maxSpoolUsage - } - - /** - * Test the property 'maxTtl' - */ - @Test - public void maxTtlTest() { - // TODO: test maxTtl - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'owner' - */ - @Test - public void ownerTest() { - // TODO: test owner - } - - /** - * Test the property 'permission' - */ - @Test - public void permissionTest() { - // TODO: test permission - } - - /** - * Test the property 'redeliveryEnabled' - */ - @Test - public void redeliveryEnabledTest() { - // TODO: test redeliveryEnabled - } - - /** - * Test the property 'rejectLowPriorityMsgEnabled' - */ - @Test - public void rejectLowPriorityMsgEnabledTest() { - // TODO: test rejectLowPriorityMsgEnabled - } - - /** - * Test the property 'rejectLowPriorityMsgLimit' - */ - @Test - public void rejectLowPriorityMsgLimitTest() { - // TODO: test rejectLowPriorityMsgLimit - } - - /** - * Test the property 'rejectMsgToSenderOnDiscardBehavior' - */ - @Test - public void rejectMsgToSenderOnDiscardBehaviorTest() { - // TODO: test rejectMsgToSenderOnDiscardBehavior - } - - /** - * Test the property 'respectMsgPriorityEnabled' - */ - @Test - public void respectMsgPriorityEnabledTest() { - // TODO: test respectMsgPriorityEnabled - } - - /** - * Test the property 'respectTtlEnabled' - */ - @Test - public void respectTtlEnabledTest() { - // TODO: test respectTtlEnabled - } - - /** - * Test the property 'topicEndpointName' - */ - @Test - public void topicEndpointNameTest() { - // TODO: test topicEndpointName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointsResponseTest.java deleted file mode 100644 index acedb81bc..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnTopicEndpointsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpoint; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnTopicEndpointLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnTopicEndpointsResponse - */ -public class MsgVpnTopicEndpointsResponseTest { - private final MsgVpnTopicEndpointsResponse model = new MsgVpnTopicEndpointsResponse(); - - /** - * Model tests for MsgVpnTopicEndpointsResponse - */ - @Test - public void testMsgVpnTopicEndpointsResponse() { - // TODO: test MsgVpnTopicEndpointsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnsResponseTest.java deleted file mode 100644 index 0ad53a25f..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/MsgVpnsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpn; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.MsgVpnLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for MsgVpnsResponse - */ -public class MsgVpnsResponseTest { - private final MsgVpnsResponse model = new MsgVpnsResponse(); - - /** - * Model tests for MsgVpnsResponse - */ - @Test - public void testMsgVpnsResponse() { - // TODO: test MsgVpnsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupLinksTest.java deleted file mode 100644 index d3204248d..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupLinksTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileAccessLevelGroupLinks - */ -public class OauthProfileAccessLevelGroupLinksTest { - private final OauthProfileAccessLevelGroupLinks model = new OauthProfileAccessLevelGroupLinks(); - - /** - * Model tests for OauthProfileAccessLevelGroupLinks - */ - @Test - public void testOauthProfileAccessLevelGroupLinks() { - // TODO: test OauthProfileAccessLevelGroupLinks - } - - /** - * Test the property 'msgVpnAccessLevelExceptionsUri' - */ - @Test - public void msgVpnAccessLevelExceptionsUriTest() { - // TODO: test msgVpnAccessLevelExceptionsUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinksTest.java deleted file mode 100644 index b1f56901e..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks - */ -public class OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinksTest { - private final OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks model = new OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks(); - - /** - * Model tests for OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks - */ - @Test - public void testOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks() { - // TODO: test OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponseTest.java deleted file mode 100644 index 445bf3e39..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse - */ -public class OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponseTest { - private final OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse model = new OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse(); - - /** - * Model tests for OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse - */ - @Test - public void testOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse() { - // TODO: test OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionTest.java deleted file mode 100644 index b395b7c4a..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileAccessLevelGroupMsgVpnAccessLevelException - */ -public class OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionTest { - private final OauthProfileAccessLevelGroupMsgVpnAccessLevelException model = new OauthProfileAccessLevelGroupMsgVpnAccessLevelException(); - - /** - * Model tests for OauthProfileAccessLevelGroupMsgVpnAccessLevelException - */ - @Test - public void testOauthProfileAccessLevelGroupMsgVpnAccessLevelException() { - // TODO: test OauthProfileAccessLevelGroupMsgVpnAccessLevelException - } - - /** - * Test the property 'accessLevel' - */ - @Test - public void accessLevelTest() { - // TODO: test accessLevel - } - - /** - * Test the property 'groupName' - */ - @Test - public void groupNameTest() { - // TODO: test groupName - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'oauthProfileName' - */ - @Test - public void oauthProfileNameTest() { - // TODO: test oauthProfileName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponseTest.java deleted file mode 100644 index 58a8580bb..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse - */ -public class OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponseTest { - private final OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse model = new OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse(); - - /** - * Model tests for OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse - */ - @Test - public void testOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse() { - // TODO: test OauthProfileAccessLevelGroupMsgVpnAccessLevelExceptionsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupResponseTest.java deleted file mode 100644 index 16f02a630..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileAccessLevelGroupResponse - */ -public class OauthProfileAccessLevelGroupResponseTest { - private final OauthProfileAccessLevelGroupResponse model = new OauthProfileAccessLevelGroupResponse(); - - /** - * Model tests for OauthProfileAccessLevelGroupResponse - */ - @Test - public void testOauthProfileAccessLevelGroupResponse() { - // TODO: test OauthProfileAccessLevelGroupResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupTest.java deleted file mode 100644 index 3ece0e249..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupTest.java +++ /dev/null @@ -1,80 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileAccessLevelGroup - */ -public class OauthProfileAccessLevelGroupTest { - private final OauthProfileAccessLevelGroup model = new OauthProfileAccessLevelGroup(); - - /** - * Model tests for OauthProfileAccessLevelGroup - */ - @Test - public void testOauthProfileAccessLevelGroup() { - // TODO: test OauthProfileAccessLevelGroup - } - - /** - * Test the property 'description' - */ - @Test - public void descriptionTest() { - // TODO: test description - } - - /** - * Test the property 'globalAccessLevel' - */ - @Test - public void globalAccessLevelTest() { - // TODO: test globalAccessLevel - } - - /** - * Test the property 'groupName' - */ - @Test - public void groupNameTest() { - // TODO: test groupName - } - - /** - * Test the property 'msgVpnAccessLevel' - */ - @Test - public void msgVpnAccessLevelTest() { - // TODO: test msgVpnAccessLevel - } - - /** - * Test the property 'oauthProfileName' - */ - @Test - public void oauthProfileNameTest() { - // TODO: test oauthProfileName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupsResponseTest.java deleted file mode 100644 index 2ffbb9951..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileAccessLevelGroupsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroup; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileAccessLevelGroupLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileAccessLevelGroupsResponse - */ -public class OauthProfileAccessLevelGroupsResponseTest { - private final OauthProfileAccessLevelGroupsResponse model = new OauthProfileAccessLevelGroupsResponse(); - - /** - * Model tests for OauthProfileAccessLevelGroupsResponse - */ - @Test - public void testOauthProfileAccessLevelGroupsResponse() { - // TODO: test OauthProfileAccessLevelGroupsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostLinksTest.java deleted file mode 100644 index 23c0b93bd..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileClientAllowedHostLinks - */ -public class OauthProfileClientAllowedHostLinksTest { - private final OauthProfileClientAllowedHostLinks model = new OauthProfileClientAllowedHostLinks(); - - /** - * Model tests for OauthProfileClientAllowedHostLinks - */ - @Test - public void testOauthProfileClientAllowedHostLinks() { - // TODO: test OauthProfileClientAllowedHostLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostResponseTest.java deleted file mode 100644 index 37414dda9..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHost; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHostLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileClientAllowedHostResponse - */ -public class OauthProfileClientAllowedHostResponseTest { - private final OauthProfileClientAllowedHostResponse model = new OauthProfileClientAllowedHostResponse(); - - /** - * Model tests for OauthProfileClientAllowedHostResponse - */ - @Test - public void testOauthProfileClientAllowedHostResponse() { - // TODO: test OauthProfileClientAllowedHostResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostTest.java deleted file mode 100644 index d2ab99961..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileClientAllowedHost - */ -public class OauthProfileClientAllowedHostTest { - private final OauthProfileClientAllowedHost model = new OauthProfileClientAllowedHost(); - - /** - * Model tests for OauthProfileClientAllowedHost - */ - @Test - public void testOauthProfileClientAllowedHost() { - // TODO: test OauthProfileClientAllowedHost - } - - /** - * Test the property 'allowedHost' - */ - @Test - public void allowedHostTest() { - // TODO: test allowedHost - } - - /** - * Test the property 'oauthProfileName' - */ - @Test - public void oauthProfileNameTest() { - // TODO: test oauthProfileName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostsResponseTest.java deleted file mode 100644 index 3b023e600..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAllowedHostsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHost; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAllowedHostLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileClientAllowedHostsResponse - */ -public class OauthProfileClientAllowedHostsResponseTest { - private final OauthProfileClientAllowedHostsResponse model = new OauthProfileClientAllowedHostsResponse(); - - /** - * Model tests for OauthProfileClientAllowedHostsResponse - */ - @Test - public void testOauthProfileClientAllowedHostsResponse() { - // TODO: test OauthProfileClientAllowedHostsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterLinksTest.java deleted file mode 100644 index f6cac3007..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileClientAuthorizationParameterLinks - */ -public class OauthProfileClientAuthorizationParameterLinksTest { - private final OauthProfileClientAuthorizationParameterLinks model = new OauthProfileClientAuthorizationParameterLinks(); - - /** - * Model tests for OauthProfileClientAuthorizationParameterLinks - */ - @Test - public void testOauthProfileClientAuthorizationParameterLinks() { - // TODO: test OauthProfileClientAuthorizationParameterLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterResponseTest.java deleted file mode 100644 index 2754037bf..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParameter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParameterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileClientAuthorizationParameterResponse - */ -public class OauthProfileClientAuthorizationParameterResponseTest { - private final OauthProfileClientAuthorizationParameterResponse model = new OauthProfileClientAuthorizationParameterResponse(); - - /** - * Model tests for OauthProfileClientAuthorizationParameterResponse - */ - @Test - public void testOauthProfileClientAuthorizationParameterResponse() { - // TODO: test OauthProfileClientAuthorizationParameterResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterTest.java deleted file mode 100644 index c6e6022f0..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParameterTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileClientAuthorizationParameter - */ -public class OauthProfileClientAuthorizationParameterTest { - private final OauthProfileClientAuthorizationParameter model = new OauthProfileClientAuthorizationParameter(); - - /** - * Model tests for OauthProfileClientAuthorizationParameter - */ - @Test - public void testOauthProfileClientAuthorizationParameter() { - // TODO: test OauthProfileClientAuthorizationParameter - } - - /** - * Test the property 'authorizationParameterName' - */ - @Test - public void authorizationParameterNameTest() { - // TODO: test authorizationParameterName - } - - /** - * Test the property 'authorizationParameterValue' - */ - @Test - public void authorizationParameterValueTest() { - // TODO: test authorizationParameterValue - } - - /** - * Test the property 'oauthProfileName' - */ - @Test - public void oauthProfileNameTest() { - // TODO: test oauthProfileName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParametersResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParametersResponseTest.java deleted file mode 100644 index df8a7f26d..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientAuthorizationParametersResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParameter; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientAuthorizationParameterLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileClientAuthorizationParametersResponse - */ -public class OauthProfileClientAuthorizationParametersResponseTest { - private final OauthProfileClientAuthorizationParametersResponse model = new OauthProfileClientAuthorizationParametersResponse(); - - /** - * Model tests for OauthProfileClientAuthorizationParametersResponse - */ - @Test - public void testOauthProfileClientAuthorizationParametersResponse() { - // TODO: test OauthProfileClientAuthorizationParametersResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimLinksTest.java deleted file mode 100644 index 358292043..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileClientRequiredClaimLinks - */ -public class OauthProfileClientRequiredClaimLinksTest { - private final OauthProfileClientRequiredClaimLinks model = new OauthProfileClientRequiredClaimLinks(); - - /** - * Model tests for OauthProfileClientRequiredClaimLinks - */ - @Test - public void testOauthProfileClientRequiredClaimLinks() { - // TODO: test OauthProfileClientRequiredClaimLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimResponseTest.java deleted file mode 100644 index 06acd3678..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileClientRequiredClaimResponse - */ -public class OauthProfileClientRequiredClaimResponseTest { - private final OauthProfileClientRequiredClaimResponse model = new OauthProfileClientRequiredClaimResponse(); - - /** - * Model tests for OauthProfileClientRequiredClaimResponse - */ - @Test - public void testOauthProfileClientRequiredClaimResponse() { - // TODO: test OauthProfileClientRequiredClaimResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimTest.java deleted file mode 100644 index 7f225d7a3..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileClientRequiredClaim - */ -public class OauthProfileClientRequiredClaimTest { - private final OauthProfileClientRequiredClaim model = new OauthProfileClientRequiredClaim(); - - /** - * Model tests for OauthProfileClientRequiredClaim - */ - @Test - public void testOauthProfileClientRequiredClaim() { - // TODO: test OauthProfileClientRequiredClaim - } - - /** - * Test the property 'clientRequiredClaimName' - */ - @Test - public void clientRequiredClaimNameTest() { - // TODO: test clientRequiredClaimName - } - - /** - * Test the property 'clientRequiredClaimValue' - */ - @Test - public void clientRequiredClaimValueTest() { - // TODO: test clientRequiredClaimValue - } - - /** - * Test the property 'oauthProfileName' - */ - @Test - public void oauthProfileNameTest() { - // TODO: test oauthProfileName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimsResponseTest.java deleted file mode 100644 index 8c482e92f..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileClientRequiredClaimsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileClientRequiredClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileClientRequiredClaimsResponse - */ -public class OauthProfileClientRequiredClaimsResponseTest { - private final OauthProfileClientRequiredClaimsResponse model = new OauthProfileClientRequiredClaimsResponse(); - - /** - * Model tests for OauthProfileClientRequiredClaimsResponse - */ - @Test - public void testOauthProfileClientRequiredClaimsResponse() { - // TODO: test OauthProfileClientRequiredClaimsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionLinksTest.java deleted file mode 100644 index dd65950d0..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileDefaultMsgVpnAccessLevelExceptionLinks - */ -public class OauthProfileDefaultMsgVpnAccessLevelExceptionLinksTest { - private final OauthProfileDefaultMsgVpnAccessLevelExceptionLinks model = new OauthProfileDefaultMsgVpnAccessLevelExceptionLinks(); - - /** - * Model tests for OauthProfileDefaultMsgVpnAccessLevelExceptionLinks - */ - @Test - public void testOauthProfileDefaultMsgVpnAccessLevelExceptionLinks() { - // TODO: test OauthProfileDefaultMsgVpnAccessLevelExceptionLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionResponseTest.java deleted file mode 100644 index 509e767a5..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileDefaultMsgVpnAccessLevelExceptionResponse - */ -public class OauthProfileDefaultMsgVpnAccessLevelExceptionResponseTest { - private final OauthProfileDefaultMsgVpnAccessLevelExceptionResponse model = new OauthProfileDefaultMsgVpnAccessLevelExceptionResponse(); - - /** - * Model tests for OauthProfileDefaultMsgVpnAccessLevelExceptionResponse - */ - @Test - public void testOauthProfileDefaultMsgVpnAccessLevelExceptionResponse() { - // TODO: test OauthProfileDefaultMsgVpnAccessLevelExceptionResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionTest.java deleted file mode 100644 index bd817a08d..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileDefaultMsgVpnAccessLevelException - */ -public class OauthProfileDefaultMsgVpnAccessLevelExceptionTest { - private final OauthProfileDefaultMsgVpnAccessLevelException model = new OauthProfileDefaultMsgVpnAccessLevelException(); - - /** - * Model tests for OauthProfileDefaultMsgVpnAccessLevelException - */ - @Test - public void testOauthProfileDefaultMsgVpnAccessLevelException() { - // TODO: test OauthProfileDefaultMsgVpnAccessLevelException - } - - /** - * Test the property 'accessLevel' - */ - @Test - public void accessLevelTest() { - // TODO: test accessLevel - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'oauthProfileName' - */ - @Test - public void oauthProfileNameTest() { - // TODO: test oauthProfileName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionsResponseTest.java deleted file mode 100644 index cd3e58b4c..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileDefaultMsgVpnAccessLevelExceptionsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelException; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileDefaultMsgVpnAccessLevelExceptionLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse - */ -public class OauthProfileDefaultMsgVpnAccessLevelExceptionsResponseTest { - private final OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse model = new OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse(); - - /** - * Model tests for OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse - */ - @Test - public void testOauthProfileDefaultMsgVpnAccessLevelExceptionsResponse() { - // TODO: test OauthProfileDefaultMsgVpnAccessLevelExceptionsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileLinksTest.java deleted file mode 100644 index 6fa395ca0..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileLinksTest.java +++ /dev/null @@ -1,96 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileLinks - */ -public class OauthProfileLinksTest { - private final OauthProfileLinks model = new OauthProfileLinks(); - - /** - * Model tests for OauthProfileLinks - */ - @Test - public void testOauthProfileLinks() { - // TODO: test OauthProfileLinks - } - - /** - * Test the property 'accessLevelGroupsUri' - */ - @Test - public void accessLevelGroupsUriTest() { - // TODO: test accessLevelGroupsUri - } - - /** - * Test the property 'clientAllowedHostsUri' - */ - @Test - public void clientAllowedHostsUriTest() { - // TODO: test clientAllowedHostsUri - } - - /** - * Test the property 'clientAuthorizationParametersUri' - */ - @Test - public void clientAuthorizationParametersUriTest() { - // TODO: test clientAuthorizationParametersUri - } - - /** - * Test the property 'clientRequiredClaimsUri' - */ - @Test - public void clientRequiredClaimsUriTest() { - // TODO: test clientRequiredClaimsUri - } - - /** - * Test the property 'defaultMsgVpnAccessLevelExceptionsUri' - */ - @Test - public void defaultMsgVpnAccessLevelExceptionsUriTest() { - // TODO: test defaultMsgVpnAccessLevelExceptionsUri - } - - /** - * Test the property 'resourceServerRequiredClaimsUri' - */ - @Test - public void resourceServerRequiredClaimsUriTest() { - // TODO: test resourceServerRequiredClaimsUri - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimLinksTest.java deleted file mode 100644 index 5c4570bde..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileResourceServerRequiredClaimLinks - */ -public class OauthProfileResourceServerRequiredClaimLinksTest { - private final OauthProfileResourceServerRequiredClaimLinks model = new OauthProfileResourceServerRequiredClaimLinks(); - - /** - * Model tests for OauthProfileResourceServerRequiredClaimLinks - */ - @Test - public void testOauthProfileResourceServerRequiredClaimLinks() { - // TODO: test OauthProfileResourceServerRequiredClaimLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimResponseTest.java deleted file mode 100644 index eb009d013..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileResourceServerRequiredClaimResponse - */ -public class OauthProfileResourceServerRequiredClaimResponseTest { - private final OauthProfileResourceServerRequiredClaimResponse model = new OauthProfileResourceServerRequiredClaimResponse(); - - /** - * Model tests for OauthProfileResourceServerRequiredClaimResponse - */ - @Test - public void testOauthProfileResourceServerRequiredClaimResponse() { - // TODO: test OauthProfileResourceServerRequiredClaimResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimTest.java deleted file mode 100644 index be37e58b4..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileResourceServerRequiredClaim - */ -public class OauthProfileResourceServerRequiredClaimTest { - private final OauthProfileResourceServerRequiredClaim model = new OauthProfileResourceServerRequiredClaim(); - - /** - * Model tests for OauthProfileResourceServerRequiredClaim - */ - @Test - public void testOauthProfileResourceServerRequiredClaim() { - // TODO: test OauthProfileResourceServerRequiredClaim - } - - /** - * Test the property 'oauthProfileName' - */ - @Test - public void oauthProfileNameTest() { - // TODO: test oauthProfileName - } - - /** - * Test the property 'resourceServerRequiredClaimName' - */ - @Test - public void resourceServerRequiredClaimNameTest() { - // TODO: test resourceServerRequiredClaimName - } - - /** - * Test the property 'resourceServerRequiredClaimValue' - */ - @Test - public void resourceServerRequiredClaimValueTest() { - // TODO: test resourceServerRequiredClaimValue - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimsResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimsResponseTest.java deleted file mode 100644 index cdc2bc3b3..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResourceServerRequiredClaimsResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaim; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileResourceServerRequiredClaimLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileResourceServerRequiredClaimsResponse - */ -public class OauthProfileResourceServerRequiredClaimsResponseTest { - private final OauthProfileResourceServerRequiredClaimsResponse model = new OauthProfileResourceServerRequiredClaimsResponse(); - - /** - * Model tests for OauthProfileResourceServerRequiredClaimsResponse - */ - @Test - public void testOauthProfileResourceServerRequiredClaimsResponse() { - // TODO: test OauthProfileResourceServerRequiredClaimsResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResponseTest.java deleted file mode 100644 index fa27e5795..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfileResponse - */ -public class OauthProfileResponseTest { - private final OauthProfileResponse model = new OauthProfileResponse(); - - /** - * Model tests for OauthProfileResponse - */ - @Test - public void testOauthProfileResponse() { - // TODO: test OauthProfileResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileTest.java deleted file mode 100644 index 597c95316..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfileTest.java +++ /dev/null @@ -1,352 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfile - */ -public class OauthProfileTest { - private final OauthProfile model = new OauthProfile(); - - /** - * Model tests for OauthProfile - */ - @Test - public void testOauthProfile() { - // TODO: test OauthProfile - } - - /** - * Test the property 'accessLevelGroupsClaimName' - */ - @Test - public void accessLevelGroupsClaimNameTest() { - // TODO: test accessLevelGroupsClaimName - } - - /** - * Test the property 'clientId' - */ - @Test - public void clientIdTest() { - // TODO: test clientId - } - - /** - * Test the property 'clientRedirectUri' - */ - @Test - public void clientRedirectUriTest() { - // TODO: test clientRedirectUri - } - - /** - * Test the property 'clientRequiredType' - */ - @Test - public void clientRequiredTypeTest() { - // TODO: test clientRequiredType - } - - /** - * Test the property 'clientScope' - */ - @Test - public void clientScopeTest() { - // TODO: test clientScope - } - - /** - * Test the property 'clientSecret' - */ - @Test - public void clientSecretTest() { - // TODO: test clientSecret - } - - /** - * Test the property 'clientValidateTypeEnabled' - */ - @Test - public void clientValidateTypeEnabledTest() { - // TODO: test clientValidateTypeEnabled - } - - /** - * Test the property 'defaultGlobalAccessLevel' - */ - @Test - public void defaultGlobalAccessLevelTest() { - // TODO: test defaultGlobalAccessLevel - } - - /** - * Test the property 'defaultMsgVpnAccessLevel' - */ - @Test - public void defaultMsgVpnAccessLevelTest() { - // TODO: test defaultMsgVpnAccessLevel - } - - /** - * Test the property 'displayName' - */ - @Test - public void displayNameTest() { - // TODO: test displayName - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'endpointAuthorization' - */ - @Test - public void endpointAuthorizationTest() { - // TODO: test endpointAuthorization - } - - /** - * Test the property 'endpointDiscovery' - */ - @Test - public void endpointDiscoveryTest() { - // TODO: test endpointDiscovery - } - - /** - * Test the property 'endpointDiscoveryRefreshInterval' - */ - @Test - public void endpointDiscoveryRefreshIntervalTest() { - // TODO: test endpointDiscoveryRefreshInterval - } - - /** - * Test the property 'endpointIntrospection' - */ - @Test - public void endpointIntrospectionTest() { - // TODO: test endpointIntrospection - } - - /** - * Test the property 'endpointIntrospectionTimeout' - */ - @Test - public void endpointIntrospectionTimeoutTest() { - // TODO: test endpointIntrospectionTimeout - } - - /** - * Test the property 'endpointJwks' - */ - @Test - public void endpointJwksTest() { - // TODO: test endpointJwks - } - - /** - * Test the property 'endpointJwksRefreshInterval' - */ - @Test - public void endpointJwksRefreshIntervalTest() { - // TODO: test endpointJwksRefreshInterval - } - - /** - * Test the property 'endpointToken' - */ - @Test - public void endpointTokenTest() { - // TODO: test endpointToken - } - - /** - * Test the property 'endpointTokenTimeout' - */ - @Test - public void endpointTokenTimeoutTest() { - // TODO: test endpointTokenTimeout - } - - /** - * Test the property 'endpointUserinfo' - */ - @Test - public void endpointUserinfoTest() { - // TODO: test endpointUserinfo - } - - /** - * Test the property 'endpointUserinfoTimeout' - */ - @Test - public void endpointUserinfoTimeoutTest() { - // TODO: test endpointUserinfoTimeout - } - - /** - * Test the property 'interactiveEnabled' - */ - @Test - public void interactiveEnabledTest() { - // TODO: test interactiveEnabled - } - - /** - * Test the property 'interactivePromptForExpiredSession' - */ - @Test - public void interactivePromptForExpiredSessionTest() { - // TODO: test interactivePromptForExpiredSession - } - - /** - * Test the property 'interactivePromptForNewSession' - */ - @Test - public void interactivePromptForNewSessionTest() { - // TODO: test interactivePromptForNewSession - } - - /** - * Test the property 'issuer' - */ - @Test - public void issuerTest() { - // TODO: test issuer - } - - /** - * Test the property 'oauthProfileName' - */ - @Test - public void oauthProfileNameTest() { - // TODO: test oauthProfileName - } - - /** - * Test the property 'oauthRole' - */ - @Test - public void oauthRoleTest() { - // TODO: test oauthRole - } - - /** - * Test the property 'resourceServerParseAccessTokenEnabled' - */ - @Test - public void resourceServerParseAccessTokenEnabledTest() { - // TODO: test resourceServerParseAccessTokenEnabled - } - - /** - * Test the property 'resourceServerRequiredAudience' - */ - @Test - public void resourceServerRequiredAudienceTest() { - // TODO: test resourceServerRequiredAudience - } - - /** - * Test the property 'resourceServerRequiredIssuer' - */ - @Test - public void resourceServerRequiredIssuerTest() { - // TODO: test resourceServerRequiredIssuer - } - - /** - * Test the property 'resourceServerRequiredScope' - */ - @Test - public void resourceServerRequiredScopeTest() { - // TODO: test resourceServerRequiredScope - } - - /** - * Test the property 'resourceServerRequiredType' - */ - @Test - public void resourceServerRequiredTypeTest() { - // TODO: test resourceServerRequiredType - } - - /** - * Test the property 'resourceServerValidateAudienceEnabled' - */ - @Test - public void resourceServerValidateAudienceEnabledTest() { - // TODO: test resourceServerValidateAudienceEnabled - } - - /** - * Test the property 'resourceServerValidateIssuerEnabled' - */ - @Test - public void resourceServerValidateIssuerEnabledTest() { - // TODO: test resourceServerValidateIssuerEnabled - } - - /** - * Test the property 'resourceServerValidateScopeEnabled' - */ - @Test - public void resourceServerValidateScopeEnabledTest() { - // TODO: test resourceServerValidateScopeEnabled - } - - /** - * Test the property 'resourceServerValidateTypeEnabled' - */ - @Test - public void resourceServerValidateTypeEnabledTest() { - // TODO: test resourceServerValidateTypeEnabled - } - - /** - * Test the property 'sempEnabled' - */ - @Test - public void sempEnabledTest() { - // TODO: test sempEnabled - } - - /** - * Test the property 'usernameClaimName' - */ - @Test - public void usernameClaimNameTest() { - // TODO: test usernameClaimName - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfilesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfilesResponseTest.java deleted file mode 100644 index 2c75fa7c5..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/OauthProfilesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfile; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.OauthProfileLinks; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for OauthProfilesResponse - */ -public class OauthProfilesResponseTest { - private final OauthProfilesResponse model = new OauthProfilesResponse(); - - /** - * Model tests for OauthProfilesResponse - */ - @Test - public void testOauthProfilesResponse() { - // TODO: test OauthProfilesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempErrorTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempErrorTest.java deleted file mode 100644 index d3b5db5bf..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempErrorTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for SempError - */ -public class SempErrorTest { - private final SempError model = new SempError(); - - /** - * Model tests for SempError - */ - @Test - public void testSempError() { - // TODO: test SempError - } - - /** - * Test the property 'code' - */ - @Test - public void codeTest() { - // TODO: test code - } - - /** - * Test the property 'description' - */ - @Test - public void descriptionTest() { - // TODO: test description - } - - /** - * Test the property 'status' - */ - @Test - public void statusTest() { - // TODO: test status - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempMetaOnlyResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempMetaOnlyResponseTest.java deleted file mode 100644 index 1a84f0cad..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempMetaOnlyResponseTest.java +++ /dev/null @@ -1,49 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for SempMetaOnlyResponse - */ -public class SempMetaOnlyResponseTest { - private final SempMetaOnlyResponse model = new SempMetaOnlyResponse(); - - /** - * Model tests for SempMetaOnlyResponse - */ - @Test - public void testSempMetaOnlyResponse() { - // TODO: test SempMetaOnlyResponse - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempMetaTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempMetaTest.java deleted file mode 100644 index 7d78e7e16..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempMetaTest.java +++ /dev/null @@ -1,83 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempError; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempPaging; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempRequest; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for SempMeta - */ -public class SempMetaTest { - private final SempMeta model = new SempMeta(); - - /** - * Model tests for SempMeta - */ - @Test - public void testSempMeta() { - // TODO: test SempMeta - } - - /** - * Test the property 'count' - */ - @Test - public void countTest() { - // TODO: test count - } - - /** - * Test the property 'error' - */ - @Test - public void errorTest() { - // TODO: test error - } - - /** - * Test the property 'paging' - */ - @Test - public void pagingTest() { - // TODO: test paging - } - - /** - * Test the property 'request' - */ - @Test - public void requestTest() { - // TODO: test request - } - - /** - * Test the property 'responseCode' - */ - @Test - public void responseCodeTest() { - // TODO: test responseCode - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempPagingTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempPagingTest.java deleted file mode 100644 index 1a09fa125..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempPagingTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for SempPaging - */ -public class SempPagingTest { - private final SempPaging model = new SempPaging(); - - /** - * Model tests for SempPaging - */ - @Test - public void testSempPaging() { - // TODO: test SempPaging - } - - /** - * Test the property 'cursorQuery' - */ - @Test - public void cursorQueryTest() { - // TODO: test cursorQuery - } - - /** - * Test the property 'nextPageUri' - */ - @Test - public void nextPageUriTest() { - // TODO: test nextPageUri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempRequestTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempRequestTest.java deleted file mode 100644 index 0f53ce4e7..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SempRequestTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for SempRequest - */ -public class SempRequestTest { - private final SempRequest model = new SempRequest(); - - /** - * Model tests for SempRequest - */ - @Test - public void testSempRequest() { - // TODO: test SempRequest - } - - /** - * Test the property 'method' - */ - @Test - public void methodTest() { - // TODO: test method - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationLinksTest.java deleted file mode 100644 index 846912373..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for SystemInformationLinks - */ -public class SystemInformationLinksTest { - private final SystemInformationLinks model = new SystemInformationLinks(); - - /** - * Model tests for SystemInformationLinks - */ - @Test - public void testSystemInformationLinks() { - // TODO: test SystemInformationLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationResponseTest.java deleted file mode 100644 index 499b256c8..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SystemInformation; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SystemInformationLinks; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for SystemInformationResponse - */ -public class SystemInformationResponseTest { - private final SystemInformationResponse model = new SystemInformationResponse(); - - /** - * Model tests for SystemInformationResponse - */ - @Test - public void testSystemInformationResponse() { - // TODO: test SystemInformationResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationTest.java deleted file mode 100644 index d0b87e1cd..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/SystemInformationTest.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for SystemInformation - */ -public class SystemInformationTest { - private final SystemInformation model = new SystemInformation(); - - /** - * Model tests for SystemInformation - */ - @Test - public void testSystemInformation() { - // TODO: test SystemInformation - } - - /** - * Test the property 'platform' - */ - @Test - public void platformTest() { - // TODO: test platform - } - - /** - * Test the property 'sempVersion' - */ - @Test - public void sempVersionTest() { - // TODO: test sempVersion - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameLinksTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameLinksTest.java deleted file mode 100644 index e5ef160ac..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameLinksTest.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for VirtualHostnameLinks - */ -public class VirtualHostnameLinksTest { - private final VirtualHostnameLinks model = new VirtualHostnameLinks(); - - /** - * Model tests for VirtualHostnameLinks - */ - @Test - public void testVirtualHostnameLinks() { - // TODO: test VirtualHostnameLinks - } - - /** - * Test the property 'uri' - */ - @Test - public void uriTest() { - // TODO: test uri - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameResponseTest.java deleted file mode 100644 index 3067980d6..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameResponseTest.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostname; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostnameLinks; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for VirtualHostnameResponse - */ -public class VirtualHostnameResponseTest { - private final VirtualHostnameResponse model = new VirtualHostnameResponse(); - - /** - * Model tests for VirtualHostnameResponse - */ - @Test - public void testVirtualHostnameResponse() { - // TODO: test VirtualHostnameResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameTest.java deleted file mode 100644 index b54d8627f..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnameTest.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for VirtualHostname - */ -public class VirtualHostnameTest { - private final VirtualHostname model = new VirtualHostname(); - - /** - * Model tests for VirtualHostname - */ - @Test - public void testVirtualHostname() { - // TODO: test VirtualHostname - } - - /** - * Test the property 'enabled' - */ - @Test - public void enabledTest() { - // TODO: test enabled - } - - /** - * Test the property 'msgVpnName' - */ - @Test - public void msgVpnNameTest() { - // TODO: test msgVpnName - } - - /** - * Test the property 'virtualHostname' - */ - @Test - public void virtualHostnameTest() { - // TODO: test virtualHostname - } - -} diff --git a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnamesResponseTest.java b/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnamesResponseTest.java deleted file mode 100644 index deda9a906..000000000 --- a/service/solace-config-client/src/test/java/com/solace/maas/ep/event/management/agent/plugin/solaceconfig/processor/semp/model/VirtualHostnamesResponseTest.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * SEMP (Solace Element Management Protocol) - * SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. SEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API: API|Base Path|Purpose|Comments :---|:---|:---|:--- Configuration|/SEMP/v2/config|Reading and writing config state|See note 2 The following APIs are also available: API|Base Path|Purpose|Comments :---|:---|:---|:--- Action|/SEMP/v2/action|Performing actions|See note 2 Monitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2 Resources are always nouns, with individual objects being singular and collections being plural. Objects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. Actions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`. Some examples: ``` /SEMP/v2/config/msgVpns ; MsgVpn collection /SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\" /SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\" /SEMP/v2/config/msgVpns/a/queues/b ; Queue object named \"b\" in MsgVpn \"a\" /SEMP/v2/action/msgVpns/a/queues/b/startReplay ; Action that starts a replay on Queue \"b\" in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\" /SEMP/v2/monitor/msgVpns/a/clients/c ; Client object named \"c\" in MsgVpn \"a\" ``` ## Collection Resources Collections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource. ## Object and Action Resources Objects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself. Actions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API. Attributes in an object or action may have any combination of the following properties: Property|Meaning|Comments :---|:---|:--- Identifying|Attribute is involved in unique identification of the object, and appears in its URI| Const|Attribute value can only be chosen during object creation| Required|Attribute must be provided in the request| Read-Only|Attribute can only be read, not written.|See note 3 Write-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property Requires-Disable|Attribute can only be changed when object is disabled| Deprecated|Attribute is deprecated, and will disappear in the next SEMP version| Opaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation In some requests, certain attributes may only be provided in certain combinations with other attributes: Relationship|Meaning :---|:--- Requires|Attribute may only be changed by a request if a particular attribute or combination of attributes is also provided in the request Conflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request In the monitoring API, any non-identifying attribute may not be returned in a GET. ## HTTP Methods The following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs: Method|Resource|Meaning|Request Body|Response Body|Notes :---|:---|:---|:---|:---|:--- POST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned PUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4) PUT|Action|Performs action|Action arguments|Action metadata| PATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned DELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned GET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned GET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code ## Common Query Parameters The following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example: ``` ; Request for the MsgVpns collection using two hypothetical query parameters ; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively /SEMP/v2/config/msgVpns?q1=val1&q2=val2 ``` ### select Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired. The value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned. All attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object. Names may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`). Some examples: ``` ; List of all MsgVpn names /SEMP/v2/config/msgVpns?select=msgVpnName ; List of all MsgVpn and their attributes except for their names /SEMP/v2/config/msgVpns?select=-msgVpnName ; Authentication attributes of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance?select=authentication* ; All attributes of MsgVpn \"finance\" except for authentication attributes /SEMP/v2/config/msgVpns/finance?select=-authentication* ; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\" /SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission ``` ### where Include in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions. The value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form: ``` expression = attribute-name OP value OP = '==' | '!=' | '<' | '>' | '<=' | '>=' ``` `value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`. Greater-than and less-than comparisons only work for numbers. A `*` in a string `value` is interpreted as a wildcard (zero or more characters). Some examples: ``` ; Only enabled MsgVpns /SEMP/v2/config/msgVpns?where=enabled==true ; Only MsgVpns using basic non-LDAP authentication /SEMP/v2/config/msgVpns?where=authenticationBasicEnabled==true,authenticationBasicType!=ldap ; Only MsgVpns that allow more than 100 client connections /SEMP/v2/config/msgVpns?where=maxConnectionCount>100 ; Only MsgVpns with msgVpnName starting with \"B\": /SEMP/v2/config/msgVpns?where=msgVpnName==B* ``` ### count Limit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time. `count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging. For example: ``` ; Up to 25 MsgVpns /SEMP/v2/config/msgVpns?count=25 ``` ### cursor The cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below. When a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects. Applications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty. ### opaquePassword Attributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as: 1. the same password that was used to retrieve the opaque attribute values is provided; and 2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values. The password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters. The query parameter can only be used in the configuration API, and only over HTTPS. ## Authentication When a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication. When HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session. There are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session. If certain attributes—such as a user's password—are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required. A client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint. Sessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored. ## Help Visit [our website](https://solace.com) to learn more about Solace. You can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/). If you need additional support, please contact us at [support@solace.com](mailto:support@solace.com). ## Notes Note|Description :---:|:--- 1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\" 2|This API is partially implemented. Only a subset of all objects are available. 3|Read-only attributes may appear in POST and PUT/PATCH requests. However, if a read-only attribute is not marked as identifying, it will be ignored during a PUT/PATCH. 4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request. - * - * The version of the OpenAPI document: 2.28 - * Contact: support@solace.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonTypeName; -import com.fasterxml.jackson.annotation.JsonValue; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.SempMeta; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostname; -import com.solace.maas.ep.event.management.agent.plugin.solaceconfig.processor.semp.model.VirtualHostnameLinks; -import java.util.ArrayList; -import java.util.List; -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; - - -/** - * Model tests for VirtualHostnamesResponse - */ -public class VirtualHostnamesResponseTest { - private final VirtualHostnamesResponse model = new VirtualHostnamesResponse(); - - /** - * Model tests for VirtualHostnamesResponse - */ - @Test - public void testVirtualHostnamesResponse() { - // TODO: test VirtualHostnamesResponse - } - - /** - * Test the property 'data' - */ - @Test - public void dataTest() { - // TODO: test data - } - - /** - * Test the property 'links' - */ - @Test - public void linksTest() { - // TODO: test links - } - - /** - * Test the property 'meta' - */ - @Test - public void metaTest() { - // TODO: test meta - } - -}